e83ad675761074cb338536580c721f8e49c23ba2
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / mac / AccessibilityControllerMac.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 "AccessibilityController.h"
33
34 #import "AccessibilityCommonMac.h"
35 #import "AccessibilityNotificationHandler.h"
36 #import "InjectedBundle.h"
37 #import "InjectedBundlePage.h"
38 #import <JavaScriptCore/JSStringRefCF.h>
39 #import <WebKit/WKBundle.h>
40 #import <WebKit/WKBundlePage.h>
41 #import <WebKit/WKBundlePagePrivate.h>
42
43 namespace WTR {
44
45 bool AccessibilityController::addNotificationListener(JSValueRef functionCallback)
46 {
47     if (!functionCallback)
48         return false;
49
50     if (m_globalNotificationHandler)
51         return false;
52
53     m_globalNotificationHandler = adoptNS([[AccessibilityNotificationHandler alloc] init]);
54     [m_globalNotificationHandler.get() setCallback:functionCallback];
55     [m_globalNotificationHandler.get() startObserving];
56
57     return true;
58 }
59
60 bool AccessibilityController::removeNotificationListener()
61 {
62     ASSERT(m_globalNotificationHandler);
63     
64     [m_globalNotificationHandler.get() stopObserving];
65     m_globalNotificationHandler.clear();
66
67     return true;
68 }
69
70 void AccessibilityController::resetToConsistentState()
71 {
72     if (m_globalNotificationHandler)
73         removeNotificationListener();
74 }
75
76 static id findAccessibleObjectById(id obj, NSString *idAttribute)
77 {
78     BEGIN_AX_OBJC_EXCEPTIONS
79     id objIdAttribute = [obj accessibilityAttributeValue:@"AXDRTElementIdAttribute"];
80     if ([objIdAttribute isKindOfClass:[NSString class]] && [objIdAttribute isEqualToString:idAttribute])
81         return obj;
82     END_AX_OBJC_EXCEPTIONS
83
84     BEGIN_AX_OBJC_EXCEPTIONS
85     NSArray *children = [obj accessibilityAttributeValue:NSAccessibilityChildrenAttribute];
86     NSUInteger childrenCount = [children count];
87     for (NSUInteger i = 0; i < childrenCount; ++i) {
88         id result = findAccessibleObjectById([children objectAtIndex:i], idAttribute);
89         if (result)
90             return result;
91     }
92     END_AX_OBJC_EXCEPTIONS
93
94     return nullptr;
95 }
96
97 RefPtr<AccessibilityUIElement> AccessibilityController::accessibleElementById(JSStringRef idAttribute)
98 {
99     WKBundlePageRef page = InjectedBundle::singleton().page()->page();
100     PlatformUIElement root = nullptr;
101
102     executeOnAXThreadIfPossible([&page, &root] {
103         root = static_cast<PlatformUIElement>(WKAccessibilityRootObject(page));
104     });
105
106     // Now that we have a root and the isolated tree is generated, set
107     // m_useAXThread to true for next request to be handled in the secondary thread.
108     if (WKAccessibilityCanUseSecondaryAXThread(InjectedBundle::singleton().page()->page()))
109         m_useAXThread = true;
110
111     id result;
112     executeOnAXThreadIfPossible([&root, &idAttribute, &result] {
113         result = findAccessibleObjectById(root, [NSString stringWithJSStringRef:idAttribute]);
114     });
115
116     if (result)
117         return AccessibilityUIElement::create(result);
118     return nullptr;
119 }
120
121 JSRetainPtr<JSStringRef> AccessibilityController::platformName()
122 {
123     return adopt(JSStringCreateWithUTF8CString("mac"));
124 }
125
126 // AXThread implementation
127
128 void AXThread::initializeRunLoop()
129 {
130     // Initialize the run loop.
131     {
132         auto locker = holdLock(m_initializeRunLoopMutex);
133
134         m_threadRunLoop = CFRunLoopGetCurrent();
135
136         CFRunLoopSourceContext context = { 0, this, 0, 0, 0, 0, 0, 0, 0, threadRunLoopSourceCallback };
137         m_threadRunLoopSource = adoptCF(CFRunLoopSourceCreate(0, 0, &context));
138         CFRunLoopAddSource(CFRunLoopGetCurrent(), m_threadRunLoopSource.get(), kCFRunLoopDefaultMode);
139
140         m_initializeRunLoopConditionVariable.notifyAll();
141     }
142
143     ASSERT(isCurrentThread());
144
145     CFRunLoopRun();
146 }
147
148 void AXThread::wakeUpRunLoop()
149 {
150     CFRunLoopSourceSignal(m_threadRunLoopSource.get());
151     CFRunLoopWakeUp(m_threadRunLoop.get());
152 }
153
154 void AXThread::threadRunLoopSourceCallback(void* axThread)
155 {
156     static_cast<AXThread*>(axThread)->threadRunLoopSourceCallback();
157 }
158
159 void AXThread::threadRunLoopSourceCallback()
160 {
161     @autoreleasepool {
162         dispatchFunctionsFromAXThread();
163     }
164 }
165
166 } // namespace WTR