/*

 * Copyright (C) 2008 Apple Inc. All Rights Reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 * 1. Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 * 2. Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 *

 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR

 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY

 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

 */

#import "config.h"

#import "DumpRenderTree.h"

#import "AccessibilityUIElement.h"

#import <Foundation/Foundation.h>

#import <JavaScriptCore/JSRetainPtr.h>

#import <JavaScriptCore/JSStringRef.h>

#import <JavaScriptCore/JSStringRefCF.h>

#import <WebKit/WebFrame.h>

#import <WebKit/WebHTMLView.h>

#import <WebKit/WebTypesInternal.h>

#import <wtf/RetainPtr.h>

#import <wtf/Vector.h>

#ifdef BUILDING_ON_TIGER

#define NSAccessibilityValueDescriptionAttribute @"AXValueDescription"

#endif

#ifndef NSAccessibilityOwnsAttribute

#define NSAccessibilityOwnsAttribute @"AXOwns"

#endif

#ifndef NSAccessibilityGrabbedAttribute

#define NSAccessibilityGrabbedAttribute @"AXGrabbed"

#endif

#ifndef NSAccessibilityDropEffectsAttribute

#define NSAccessibilityDropEffectsAttribute @"AXDropEffects"

#endif

// If an unsupported attribute is passed in, it will raise an accessibility exception. These are usually caught by the Accessibility Runtime to inform

// the AX client app of the error. However, DRT is the AX client app, so it must catch these exceptions.

#define BEGIN_AX_OBJC_EXCEPTIONS @try {

#define END_AX_OBJC_EXCEPTIONS } @catch(NSException *e) { if (![[e name] isEqualToString:NSAccessibilityException]) @throw; }

typedef void (*AXPostedNotificationCallback)(id element, NSString* notification, void* context);

@interface NSObject (WebKitAccessibilityAdditions)

- (NSArray *)accessibilityArrayAttributeValues:(NSString *)attribute index:(NSUInteger)index maxCount:(NSUInteger)maxCount;

- (void)accessibilitySetShouldRepostNotifications:(BOOL)repost;

- (NSUInteger)accessibilityIndexOfChild:(id)child;

- (NSUInteger)accessibilityArrayAttributeCount:(NSString *)attribute;

@end

@interface NSString (JSStringRefAdditions)

+ (NSString *)stringWithJSStringRef:(JSStringRef)jsStringRef;

- (JSStringRef)createJSStringRef;

@end

@implementation NSString (JSStringRefAdditions)

+ (NSString *)stringWithJSStringRef:(JSStringRef)jsStringRef

{

    if (!jsStringRef)

        return NULL;

    CFStringRef cfString = JSStringCopyCFString(kCFAllocatorDefault, jsStringRef);

    return [(NSString *)cfString autorelease];

}

- (JSStringRef)createJSStringRef

{

    return JSStringCreateWithCFString((CFStringRef)self);

}

@end

@interface AccessibilityNotificationHandler : NSObject

{

    id m_platformElement;

    JSObjectRef m_notificationFunctionCallback;

}

@end

@implementation AccessibilityNotificationHandler

- (id)initWithPlatformElement:(id)platformElement

{

    self = [super init];

    m_platformElement = platformElement;

    // Once an object starts requesting notifications, it's on for the duration of the program.

    // This is to avoid any race conditions between tests turning this flag on and off. Instead

    // AccessibilityNotificationHandler can just listen when they want to.

    [m_platformElement accessibilitySetShouldRepostNotifications:YES];

    [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_notificationReceived:) name:@"AXDRTNotification" object:nil];

    return self;

}

- (void)dealloc

{

    [[NSNotificationCenter defaultCenter] removeObserver:self];

    JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);

    m_notificationFunctionCallback = 0;

    [super dealloc];

}

- (void)_notificationReceived:(NSNotification *)notification

{

    NSString *notificationName = [[notification userInfo] objectForKey:@"notificationName"];

    if (!notificationName)

        return;

    JSRetainPtr<JSStringRef> jsNotification(Adopt, [notificationName createJSStringRef]);

    JSValueRef argument = JSValueMakeString([mainFrame globalContext], jsNotification.get());

    JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 1, &argument, 0);

}

- (void)setCallback:(JSObjectRef)callback

{

    if (!callback)

        return;

    // Release the old callback.

    if (m_notificationFunctionCallback) 

        JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);

    m_notificationFunctionCallback = callback;

    JSValueProtect([mainFrame globalContext], m_notificationFunctionCallback);

}

@end

AccessibilityUIElement::AccessibilityUIElement(PlatformUIElement element)

    : m_element(element)

    , m_notificationHandler(0)

{

    // FIXME: ap@webkit.org says ObjC objects need to be CFRetained/CFRelease to be GC-compliant on the mac.

    [m_element retain];

}

AccessibilityUIElement::AccessibilityUIElement(const AccessibilityUIElement& other)

    : m_element(other.m_element)

    , m_notificationHandler(0)

{

    [m_element retain];

}

AccessibilityUIElement::~AccessibilityUIElement()

{

    // The notification handler should be nil because removeNotificationListener() should have been called in the test.

    ASSERT(!m_notificationHandler);

    [m_element release];

}

static NSString* descriptionOfValue(id valueObject, id focusedAccessibilityObject)

{

    if (!valueObject)

        return NULL;

    if ([valueObject isKindOfClass:[NSArray class]])

        return [NSString stringWithFormat:@"<array of size %d>", [(NSArray*)valueObject count]];

    if ([valueObject isKindOfClass:[NSNumber class]])

        return [(NSNumber*)valueObject stringValue];

    if ([valueObject isKindOfClass:[NSValue class]]) {

        NSString* type = [NSString stringWithCString:[valueObject objCType] encoding:NSASCIIStringEncoding];

        NSValue* value = (NSValue*)valueObject;

        if ([type rangeOfString:@"NSRect"].length > 0)

            return [NSString stringWithFormat:@"NSRect: %@", NSStringFromRect([value rectValue])];

        if ([type rangeOfString:@"NSPoint"].length > 0)

            return [NSString stringWithFormat:@"NSPoint: %@", NSStringFromPoint([value pointValue])];

        if ([type rangeOfString:@"NSSize"].length > 0)

            return [NSString stringWithFormat:@"NSSize: %@", NSStringFromSize([value sizeValue])];

        if ([type rangeOfString:@"NSRange"].length > 0)

            return [NSString stringWithFormat:@"NSRange: %@", NSStringFromRange([value rangeValue])];

    }

    // Strip absolute URL paths

    NSString* description = [valueObject description];

    NSRange range = [description rangeOfString:@"LayoutTests"];

    if (range.length)

        return [description substringFromIndex:range.location];

    // Strip pointer locations

    if ([description rangeOfString:@"0x"].length) {

        NSString* role = [focusedAccessibilityObject accessibilityAttributeValue:NSAccessibilityRoleAttribute];

        NSString* title = [focusedAccessibilityObject accessibilityAttributeValue:NSAccessibilityTitleAttribute];

        if ([title length])

            return [NSString stringWithFormat:@"<%@: '%@'>", role, title];

        return [NSString stringWithFormat:@"<%@>", role];

    }

    return [valueObject description];

}

static NSString* attributesOfElement(id accessibilityObject)

{

    NSArray* supportedAttributes = [accessibilityObject accessibilityAttributeNames];

    NSMutableString* attributesString = [NSMutableString string];

    for (NSUInteger i = 0; i < [supportedAttributes count]; ++i) {

        NSString* attribute = [supportedAttributes objectAtIndex:i];

        // Right now, position provides useless and screen-specific information, so we do not

        // want to include it for the sake of universally passing tests.

        if ([attribute isEqualToString:@"AXPosition"])

            continue;

        // accessibilityAttributeValue: can throw an if an attribute is not returned.

        // For DumpRenderTree's purpose, we should ignore those exceptions

        BEGIN_AX_OBJC_EXCEPTIONS

        id valueObject = [accessibilityObject accessibilityAttributeValue:attribute];

        NSString* value = descriptionOfValue(valueObject, accessibilityObject);

        [attributesString appendFormat:@"%@: %@\n", attribute, value];

        END_AX_OBJC_EXCEPTIONS

    }

    return attributesString;

}

static JSStringRef concatenateAttributeAndValue(NSString* attribute, NSString* value)

{

    Vector<UniChar> buffer([attribute length]);

    [attribute getCharacters:buffer.data()];

    buffer.append(':');

    buffer.append(' ');

    Vector<UniChar> valueBuffer([value length]);

    [value getCharacters:valueBuffer.data()];

    buffer.append(valueBuffer);

    return JSStringCreateWithCharacters(buffer.data(), buffer.size());

}

static void convertNSArrayToVector(NSArray* array, Vector<AccessibilityUIElement>& elementVector)

{

    NSUInteger count = [array count];

    for (NSUInteger i = 0; i < count; ++i)

        elementVector.append(AccessibilityUIElement([array objectAtIndex:i]));

}

static JSStringRef descriptionOfElements(Vector<AccessibilityUIElement>& elementVector)

{

    NSMutableString* allElementString = [NSMutableString string];

    size_t size = elementVector.size();

    for (size_t i = 0; i < size; ++i) {

        NSString* attributes = attributesOfElement(elementVector[i].platformUIElement());

        [allElementString appendFormat:@"%@\n------------\n", attributes];

    }

    return [allElementString createJSStringRef];

}

void AccessibilityUIElement::getLinkedUIElements(Vector<AccessibilityUIElement>& elementVector)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* linkedElements = [m_element accessibilityAttributeValue:NSAccessibilityLinkedUIElementsAttribute];

    convertNSArrayToVector(linkedElements, elementVector);

    END_AX_OBJC_EXCEPTIONS

}

void AccessibilityUIElement::getDocumentLinks(Vector<AccessibilityUIElement>& elementVector)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* linkElements = [m_element accessibilityAttributeValue:@"AXLinkUIElements"];

    convertNSArrayToVector(linkElements, elementVector);

    END_AX_OBJC_EXCEPTIONS

}

void AccessibilityUIElement::getChildren(Vector<AccessibilityUIElement>& elementVector)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* children = [m_element accessibilityAttributeValue:NSAccessibilityChildrenAttribute];

    convertNSArrayToVector(children, elementVector);

    END_AX_OBJC_EXCEPTIONS

}

void AccessibilityUIElement::getChildrenWithRange(Vector<AccessibilityUIElement>& elementVector, unsigned location, unsigned length)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* children = [m_element accessibilityArrayAttributeValues:NSAccessibilityChildrenAttribute index:location maxCount:length];

    convertNSArrayToVector(children, elementVector);

    END_AX_OBJC_EXCEPTIONS

}

int AccessibilityUIElement::childrenCount()

{

    Vector<AccessibilityUIElement> children;

    getChildren(children);

    return children.size();

}

AccessibilityUIElement AccessibilityUIElement::elementAtPoint(int x, int y)

{

    id element = [m_element accessibilityHitTest:NSMakePoint(x, y)];

    if (!element)

        return nil;

    return AccessibilityUIElement(element); 

}

unsigned AccessibilityUIElement::indexOfChild(AccessibilityUIElement* element)

{

    return [m_element accessibilityIndexOfChild:element->platformUIElement()];

}

AccessibilityUIElement AccessibilityUIElement::getChildAtIndex(unsigned index)

{

    Vector<AccessibilityUIElement> children;

    getChildrenWithRange(children, index, 1);

    if (children.size() == 1)

        return children[0];

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::linkedUIElementAtIndex(unsigned index)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* objects = [m_element accessibilityAttributeValue:NSAccessibilityLinkedUIElementsAttribute];

    if (index < [objects count])

        return [objects objectAtIndex:index];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::ariaOwnsElementAtIndex(unsigned index)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* objects = [m_element accessibilityAttributeValue:NSAccessibilityOwnsAttribute];

    if (index < [objects count])

        return [objects objectAtIndex:index];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::ariaFlowToElementAtIndex(unsigned index)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* objects = [m_element accessibilityAttributeValue:NSAccessibilityLinkedUIElementsAttribute];

    if (index < [objects count])

        return [objects objectAtIndex:index];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::disclosedRowAtIndex(unsigned index)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* rows = [m_element accessibilityAttributeValue:NSAccessibilityDisclosedRowsAttribute];

    if (index < [rows count])

        return [rows objectAtIndex:index];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::selectedRowAtIndex(unsigned index)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSArray* rows = [m_element accessibilityAttributeValue:NSAccessibilitySelectedRowsAttribute];

    if (index < [rows count])

        return [rows objectAtIndex:index];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::titleUIElement()

{

    BEGIN_AX_OBJC_EXCEPTIONS

    id accessibilityObject = [m_element accessibilityAttributeValue:NSAccessibilityTitleUIElementAttribute];

    if (accessibilityObject)

        return AccessibilityUIElement(accessibilityObject);

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::parentElement()

{

    BEGIN_AX_OBJC_EXCEPTIONS

    id accessibilityObject = [m_element accessibilityAttributeValue:NSAccessibilityParentAttribute];

    if (accessibilityObject)

        return AccessibilityUIElement(accessibilityObject);

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

AccessibilityUIElement AccessibilityUIElement::disclosedByRow()

{

    BEGIN_AX_OBJC_EXCEPTIONS

    id accessibilityObject = [m_element accessibilityAttributeValue:NSAccessibilityDisclosedByRowAttribute];

    if (accessibilityObject)

        return AccessibilityUIElement(accessibilityObject);

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

JSStringRef AccessibilityUIElement::attributesOfLinkedUIElements()

{

    Vector<AccessibilityUIElement> linkedElements;

    getLinkedUIElements(linkedElements);

    return descriptionOfElements(linkedElements);

}

JSStringRef AccessibilityUIElement::attributesOfDocumentLinks()

{

    Vector<AccessibilityUIElement> linkElements;

    getDocumentLinks(linkElements);

    return descriptionOfElements(linkElements);

}

JSStringRef AccessibilityUIElement::attributesOfChildren()

{

    Vector<AccessibilityUIElement> children;

    getChildren(children);

    return descriptionOfElements(children);

}

JSStringRef AccessibilityUIElement::allAttributes()

{

    NSString* attributes = attributesOfElement(m_element);

    return [attributes createJSStringRef];

}

JSStringRef AccessibilityUIElement::stringAttributeValue(JSStringRef attribute)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    id value = [m_element accessibilityAttributeValue:[NSString stringWithJSStringRef:attribute]];

    if ([value isKindOfClass:[NSString class]])

        return [value createJSStringRef];

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

bool AccessibilityUIElement::boolAttributeValue(JSStringRef attribute)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    id value = [m_element accessibilityAttributeValue:[NSString stringWithJSStringRef:attribute]];

    if ([value isKindOfClass:[NSNumber class]])

        return [value boolValue];

    END_AX_OBJC_EXCEPTIONS

    return false;

}

bool AccessibilityUIElement::isAttributeSettable(JSStringRef attribute)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    return [m_element accessibilityIsAttributeSettable:[NSString stringWithJSStringRef:attribute]];

    END_AX_OBJC_EXCEPTIONS

    return false;

}

bool AccessibilityUIElement::isAttributeSupported(JSStringRef attribute)

{

    BEGIN_AX_OBJC_EXCEPTIONS

    return [[m_element accessibilityAttributeNames] containsObject:[NSString stringWithJSStringRef:attribute]];

    END_AX_OBJC_EXCEPTIONS

    return false;

}

JSStringRef AccessibilityUIElement::parameterizedAttributeNames()

{

    NSArray* supportedParameterizedAttributes = [m_element accessibilityParameterizedAttributeNames];

    NSMutableString* attributesString = [NSMutableString string];

    for (NSUInteger i = 0; i < [supportedParameterizedAttributes count]; ++i) {

        [attributesString appendFormat:@"%@\n", [supportedParameterizedAttributes objectAtIndex:i]];

    }

    return [attributesString createJSStringRef];

}

JSStringRef AccessibilityUIElement::role()

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSString *role = descriptionOfValue([m_element accessibilityAttributeValue:NSAccessibilityRoleAttribute], m_element);

    return concatenateAttributeAndValue(@"AXRole", role);

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

JSStringRef AccessibilityUIElement::subrole()

{

    BEGIN_AX_OBJC_EXCEPTIONS

    NSString* role = descriptionOfValue([m_element accessibilityAttributeValue:NSAccessibilitySubroleAttribute], m_element);

    return concatenateAttributeAndValue(@"AXSubrole", role);

    END_AX_OBJC_EXCEPTIONS

    return 0;

}

JSStringRef AccessibilityUIElement::roleDescription()

{

    BEGIN_AX_OBJC_EXCEPTIONS