[iOS] Upstream changes in Tools/DumpRenderTree
[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 <wtf/RetainPtr.h>
41
42 @interface NSObject (WebAccessibilityObjectWrapperAdditions)
43 + (void)accessibilitySetShouldRepostNotifications:(BOOL)repost;
44 @end
45
46 @interface NSString (JSStringRefAdditions)
47 - (JSStringRef)createJSStringRef;
48 @end
49
50 @implementation NSString (JSStringRefAdditions)
51
52 - (JSStringRef)createJSStringRef
53 {
54     return JSStringCreateWithCFString((CFStringRef)self);
55 }
56
57 @end
58
59 @implementation AccessibilityNotificationHandler
60
61 - (id)init
62 {
63     if (!(self = [super init]))
64         return nil;
65
66     m_platformElement = nil;
67     return self;
68 }
69
70 - (void)setPlatformElement:(id)platformElement
71 {
72     m_platformElement = platformElement;
73 }
74
75 - (void)dealloc
76 {
77     [[NSNotificationCenter defaultCenter] removeObserver:self];
78     JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);
79     m_notificationFunctionCallback = 0;
80     
81     [super dealloc];
82 }
83
84 - (void)setCallback:(JSObjectRef)callback
85 {
86     if (!callback)
87         return;
88  
89     if (m_notificationFunctionCallback) 
90         JSValueUnprotect([mainFrame globalContext], m_notificationFunctionCallback);
91     
92     m_notificationFunctionCallback = callback;
93     JSValueProtect([mainFrame globalContext], m_notificationFunctionCallback);
94 }
95
96 - (void)startObserving
97 {
98     // Once we start requesting notifications, it's on for the duration of the program.
99     // This is to avoid any race conditions between tests turning this flag on and off. Instead
100     // AccessibilityNotificationHandler can ignore events it doesn't care about.
101     id webAccessibilityObjectWrapperClass = NSClassFromString(@"WebAccessibilityObjectWrapper");
102     ASSERT(webAccessibilityObjectWrapperClass);
103     [webAccessibilityObjectWrapperClass accessibilitySetShouldRepostNotifications:YES];
104     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_notificationReceived:) name:@"AXDRTNotification" object:nil];
105 }
106
107 - (void)_notificationReceived:(NSNotification *)notification
108 {
109     NSString *notificationName = [[notification userInfo] objectForKey:@"notificationName"];
110     if (!notificationName)
111         return;
112     if (m_platformElement && m_platformElement != [notification object])
113         return;
114
115     JSRetainPtr<JSStringRef> jsNotification(Adopt, [notificationName createJSStringRef]);
116     JSValueRef notificationNameArgument = JSValueMakeString([mainFrame globalContext], jsNotification.get());
117     if (m_platformElement) {
118         // Listener for one element just gets one argument, the notification name.
119         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 1, &notificationNameArgument, 0);
120     } else {
121         // A global listener gets the element and the notification name as arguments.
122         JSValueRef arguments[2];
123         arguments[0] = AccessibilityUIElement::makeJSAccessibilityUIElement([mainFrame globalContext], AccessibilityUIElement([notification object]));
124         arguments[1] = notificationNameArgument;
125         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 2, arguments, 0);
126     }
127 }
128
129 @end
130