Source/WebCore: AccessibilityController should support listening to notifications...
[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 <WebKit/WebTypesInternal.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 - (void)startObserving
98 {
99     // Once we start requesting notifications, it's on for the duration of the program.
100     // This is to avoid any race conditions between tests turning this flag on and off. Instead
101     // AccessibilityNotificationHandler can ignore events it doesn't care about.
102     id webAccessibilityObjectWrapperClass = NSClassFromString(@"WebAccessibilityObjectWrapper");
103     ASSERT(webAccessibilityObjectWrapperClass);
104     [webAccessibilityObjectWrapperClass accessibilitySetShouldRepostNotifications:YES];
105     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_notificationReceived:) name:@"AXDRTNotification" object:nil];
106 }
107
108 - (void)_notificationReceived:(NSNotification *)notification
109 {
110     NSString *notificationName = [[notification userInfo] objectForKey:@"notificationName"];
111     if (!notificationName)
112         return;
113     if (m_platformElement && m_platformElement != [notification object])
114         return;
115
116     JSRetainPtr<JSStringRef> jsNotification(Adopt, [notificationName createJSStringRef]);
117     JSValueRef notificationNameArgument = JSValueMakeString([mainFrame globalContext], jsNotification.get());
118     if (m_platformElement) {
119         // Listener for one element just gets one argument, the notification name.
120         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 1, &notificationNameArgument, 0);
121     } else {
122         // A global listener gets the element and the notification name as arguments.
123         JSValueRef arguments[2];
124         arguments[0] = AccessibilityUIElement::makeJSAccessibilityUIElement([mainFrame globalContext], AccessibilityUIElement([notification object]));
125         arguments[1] = notificationNameArgument;
126         JSObjectCallAsFunction([mainFrame globalContext], m_notificationFunctionCallback, 0, 2, arguments, 0);
127     }
128 }
129
130 @end
131