Source/JavaScriptCore:
[WebKit-https.git] / Tools / DumpRenderTree / mac / AccessibilityNotificationHandler.mm
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #import "config.h"
32 #import "DumpRenderTree.h"
33 #import "AccessibilityNotificationHandler.h"
34 #import "AccessibilityUIElement.h"
35
36 #import <JavaScriptCore/JSRetainPtr.h>
37 #import <JavaScriptCore/JSStringRef.h>
38 #import <JavaScriptCore/JSStringRefCF.h>
39 #import <WebKit/WebFrame.h>
40 #import <objc/runtime.h>
41 #import <wtf/RetainPtr.h>
42
43 @interface NSObject (WebAccessibilityObjectWrapperAdditions)
44 + (void)accessibilitySetShouldRepostNotifications:(BOOL)repost;
45 @end
46
47 @interface NSString (JSStringRefAdditions)
48 - (JSStringRef)createJSStringRef;
49 @end
50
51 @implementation NSString (JSStringRefAdditions)
52
53 - (JSStringRef)createJSStringRef
54 {
55     return JSStringCreateWithCFString((CFStringRef)self);
56 }
57
58 @end
59
60 @implementation AccessibilityNotificationHandler
61
62 - (id)init
63 {
64     if (!(self = [super init]))
65         return nil;
66
67     m_platformElement = nil;
68     return self;
69 }
70
71 - (void)setPlatformElement:(id)platformElement
72 {
73     m_platformElement = platformElement;
74 }
75
76 - (void)dealloc
77 {
78     [[NSNotificationCenter defaultCenter] removeObserver:self];
79     JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);
80     m_notificationFunctionCallback = 0;
81     
82     [super dealloc];
83 }
84
85 - (void)setCallback:(JSObjectRef)callback
86 {
87     if (!callback)
88         return;
89  
90     if (m_notificationFunctionCallback) 
91         JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);
92     
93     m_notificationFunctionCallback = callback;
94     JSValueProtect([mainFrame globalContext], m_notificationFunctionCallback);
95 }
96
97 static Class webAccessibilityObjectWrapperClass()
98 {
99     static Class cls = objc_getClass("WebAccessibilityObjectWrapper");
100     ASSERT(cls);
101     return cls;
102 }
103
104 - (void)startObserving
105 {
106     // Once we start requesting notifications, it's on for the duration of the program.
107     // This is to avoid any race conditions between tests turning this flag on and off. Instead
108     // AccessibilityNotificationHandler can ignore events it doesn't care about.
109     [webAccessibilityObjectWrapperClass() accessibilitySetShouldRepostNotifications:YES];
110     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_notificationReceived:) name:@"AXDRTNotification" object:nil];
111 }
112
113 - (void)stopObserving
114 {
115     [[NSNotificationCenter defaultCenter] removeObserver:self];
116 }
117
118 static JSValueRef makeValueRefForValue(JSContextRef context, id value)
119 {
120     if ([value isKindOfClass:[NSString class]])
121         return JSValueMakeString(context, adopt([value createJSStringRef]).get());
122     if ([value isKindOfClass:[NSNumber class]]) {
123         if (!strcmp([value objCType], @encode(BOOL)))
124             return JSValueMakeBoolean(context, [value boolValue]);
125         return JSValueMakeNumber(context, [value doubleValue]);
126     }
127     if ([value isKindOfClass:webAccessibilityObjectWrapperClass()])
128         return AccessibilityUIElement::makeJSAccessibilityUIElement(context, value);
129     if ([value isKindOfClass:[NSDictionary class]])
130         return makeObjectRefForDictionary(context, value);
131     if ([value isKindOfClass:[NSArray class]])
132         return makeArrayRefForArray(context, value);
133     return nullptr;
134 }
135
136 static JSValueRef makeArrayRefForArray(JSContextRef context, NSArray *array)
137 {
138     NSUInteger count = array.count;
139     JSValueRef arguments[count];
140
141     for (NSUInteger i = 0; i < count; i++)
142         arguments[i] = makeValueRefForValue(context, [array objectAtIndex:i]);
143
144     return JSObjectMakeArray(context, count, arguments, nullptr);
145 }
146
147 static JSValueRef makeObjectRefForDictionary(JSContextRef context, NSDictionary *dictionary)
148 {
149     JSObjectRef object = JSObjectMake(context, nullptr, nullptr);
150
151     [dictionary enumerateKeysAndObjectsUsingBlock:^(NSString *key, id obj, BOOL *stop)
152     {
153         if (JSValueRef propertyValue = makeValueRefForValue(context, obj))
154             JSObjectSetProperty(context, object, adopt([key createJSStringRef]).get(), propertyValue, kJSPropertyAttributeNone, nullptr);
155     }];
156
157     return object;
158 }
159
160 - (void)_notificationReceived:(NSNotification *)notification
161 {
162     NSString *notificationName = [[notification userInfo] objectForKey:@"notificationName"];
163     if (!notificationName)
164         return;
165     if (m_platformElement && m_platformElement != [notification object])
166         return;
167
168     NSDictionary *userInfo = [[notification userInfo] objectForKey:@"userInfo"];
169
170     JSValueRef notificationNameArgument = JSValueMakeString([mainFrame globalContext], adopt([notificationName createJSStringRef]).get());
171     JSValueRef userInfoArgument = makeObjectRefForDictionary([mainFrame globalContext], userInfo);
172     if (m_platformElement) {
173         // Listener for one element gets the notification name and userInfo.
174         JSValueRef arguments[2];
175         arguments[0] = notificationNameArgument;
176         arguments[1] = userInfoArgument;
177         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 2, arguments, 0);
178     } else {
179         // A global listener gets the element, notification name and userInfo.
180         JSValueRef arguments[3];
181         arguments[0] = AccessibilityUIElement::makeJSAccessibilityUIElement([mainFrame globalContext], AccessibilityUIElement([notification object]));
182         arguments[1] = notificationNameArgument;
183         arguments[2] = userInfoArgument;
184         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 2, arguments, 0);
185     }
186 }
187
188 @end
189