Disable accessibility notifications after each test
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / 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 "InjectedBundle.h"
33 #import "InjectedBundlePage.h"
34 #import "JSWrapper.h"
35 #import "AccessibilityNotificationHandler.h"
36 #import "AccessibilityUIElement.h"
37
38 #import <JavaScriptCore/JSRetainPtr.h>
39 #import <JavaScriptCore/JSStringRef.h>
40 #import <JavaScriptCore/JSStringRefCF.h>
41 #import <WebKit2/WKBundleFrame.h>
42 #import <wtf/RetainPtr.h>
43
44 @interface NSObject (WebAccessibilityObjectWrapperAdditions)
45 + (void)accessibilitySetShouldRepostNotifications:(BOOL)repost;
46 @end
47
48 @interface NSString (JSStringRefAdditions)
49 - (JSStringRef)createJSStringRef;
50 @end
51
52 @implementation NSString (JSStringRefAdditions)
53
54 - (JSStringRef)createJSStringRef
55 {
56     return JSStringCreateWithCFString((CFStringRef)self);
57 }
58
59 @end
60
61 @implementation AccessibilityNotificationHandler
62
63 - (id)init
64 {
65     if (!(self = [super init]))
66         return nil;
67
68     return self;
69 }
70
71 - (void)setPlatformElement:(id)platformElement
72 {
73     m_platformElement = platformElement;
74 }
75
76 - (void)dealloc
77 {
78     [self stopObserving];
79
80     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(WTR::InjectedBundle::shared().page()->page());
81     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
82
83     JSValueUnprotect(context, m_notificationFunctionCallback);
84     m_notificationFunctionCallback = 0;
85
86     [super dealloc];
87 }
88
89 - (void)setCallback:(JSValueRef)callback
90 {
91     if (!callback)
92         return;
93
94     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(WTR::InjectedBundle::shared().page()->page());
95     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
96
97     if (m_notificationFunctionCallback)
98         JSValueUnprotect(context, m_notificationFunctionCallback);
99
100     m_notificationFunctionCallback = callback;
101     JSValueProtect(context, m_notificationFunctionCallback);
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     id webAccessibilityObjectWrapperClass = NSClassFromString(@"WebAccessibilityObjectWrapper");
110     ASSERT(webAccessibilityObjectWrapperClass);
111     [webAccessibilityObjectWrapperClass accessibilitySetShouldRepostNotifications:YES];
112     [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_notificationReceived:) name:@"AXDRTNotification" object:nil];
113 }
114
115 - (void)stopObserving
116 {
117     [[NSNotificationCenter defaultCenter] removeObserver:self];
118 }
119
120 - (void)_notificationReceived:(NSNotification *)notification
121 {
122     NSString *notificationName = [[notification userInfo] objectForKey:@"notificationName"];
123     if (!notificationName)
124         return;
125     if (m_platformElement && m_platformElement != [notification object])
126         return;
127
128     WKBundleFrameRef mainFrame = WKBundlePageGetMainFrame(WTR::InjectedBundle::shared().page()->page());
129     JSContextRef context = WKBundleFrameGetJavaScriptContext(mainFrame);
130
131     JSRetainPtr<JSStringRef> jsNotification(Adopt, [notificationName createJSStringRef]);
132     JSValueRef notificationNameArgument = JSValueMakeString(context, jsNotification.get());
133     if (m_platformElement) {
134         // Listener for one element just gets one argument, the notification name.
135         JSObjectCallAsFunction(context, const_cast<JSObjectRef>(m_notificationFunctionCallback), 0, 1, &notificationNameArgument, 0);
136     } else {
137         // A global listener gets the element and the notification name as arguments.
138         JSValueRef arguments[2];
139         arguments[0] = toJS(context, WTF::getPtr(WTR::AccessibilityUIElement::create([notification object])));
140         arguments[1] = notificationNameArgument;
141         JSObjectCallAsFunction(context, const_cast<JSObjectRef>(m_notificationFunctionCallback), 0, 2, arguments, 0);
142     }
143 }
144
145 @end
146