cefaa43bdfe203ae4dc6a0496310eaa95d764eb3
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / AccessibilityController.h
1 /*
2  * Copyright (C) 2011 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "AccessibilityUIElement.h"
29 #include "JSWrappable.h"
30 #include <JavaScriptCore/JSObjectRef.h>
31 #include <wtf/Condition.h>
32 #include <wtf/FastMalloc.h>
33 #include <wtf/Platform.h>
34 #include <wtf/Threading.h>
35 #include <wtf/threads/BinarySemaphore.h>
36
37 #if USE(ATK)
38 #include "AccessibilityNotificationHandlerAtk.h"
39 #endif
40
41 namespace WTR {
42     
43 class AccessibilityController : public JSWrappable {
44 public:
45     static Ref<AccessibilityController> create();
46     ~AccessibilityController();
47
48     void makeWindowObject(JSContextRef, JSObjectRef windowObject, JSValueRef* exception);
49     virtual JSClassRef wrapperClass();
50     
51     // Enhanced accessibility.
52     void enableEnhancedAccessibility(bool);
53     bool enhancedAccessibilityEnabled();
54     
55     JSRetainPtr<JSStringRef> platformName();
56
57     // Controller Methods - platform-independent implementations.
58 #if HAVE(ACCESSIBILITY)
59     Ref<AccessibilityUIElement> rootElement();
60     Ref<AccessibilityUIElement> focusedElement();
61 #endif
62     RefPtr<AccessibilityUIElement> elementAtPoint(int x, int y);
63     RefPtr<AccessibilityUIElement> accessibleElementById(JSStringRef idAttribute);
64
65 #if PLATFORM(COCOA)
66     void executeOnAXThreadIfPossible(Function<void()>&&);
67 #endif
68
69     bool addNotificationListener(JSValueRef functionCallback);
70     bool removeNotificationListener();
71
72     // Here for consistency with DRT. Not implemented because they don't do anything on the Mac.
73     void logFocusEvents() { }
74     void logValueChangeEvents() { }
75     void logScrollingStartEvents() { }
76     void logAccessibilityEvents() { };
77
78     void resetToConsistentState();
79
80 #if !HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(WPE))
81     RefPtr<AccessibilityUIElement> rootElement() { return nullptr; }
82     RefPtr<AccessibilityUIElement> focusedElement() { return nullptr; }
83 #endif
84
85 private:
86     AccessibilityController();
87
88 #if PLATFORM(COCOA)
89     RetainPtr<NotificationHandler> m_globalNotificationHandler;
90 #elif USE(ATK)
91     RefPtr<AccessibilityNotificationHandler> m_globalNotificationHandler;
92 #endif
93
94 #if PLATFORM(COCOA)
95     // _AXUIElementUseSecondaryAXThread and _AXUIElementRequestServicedBySecondaryAXThread
96     // do not work for WebKitTestRunner since this is calling directly into
97     // WebCore/accessibility via JavaScript without going through HIServices.
98     // Thus to simulate the behavior of HIServices, AccessibilityController is spawning a secondary thread to service the JavaScript requests.
99     // The following flag allows to run the very first request in the main
100     // thread and all subsequent requests in the secondary thread. this is what
101     // the behavior would be if using HIServices.
102     // The first request has to be served in the main thread in order to build
103     // the AXIsolatedTree.
104     bool m_useAXThread { false };
105     BinarySemaphore m_semaphore;
106 #endif
107 };
108
109 #if PLATFORM(COCOA)
110
111 class AXThread {
112     WTF_MAKE_NONCOPYABLE(AXThread);
113
114 public:
115     static bool isCurrentThread();
116     static void dispatch(Function<void()>&&);
117
118     // Will dispatch the given function on the main thread once all pending functions
119     // on the AX thread have finished executing. Used for synchronization purposes.
120     static void dispatchBarrier(Function<void()>&&);
121
122 private:
123     friend NeverDestroyed<AXThread>;
124
125     AXThread();
126
127     static AXThread& singleton();
128
129     void createThreadIfNeeded();
130     void dispatchFunctionsFromAXThread();
131
132     void initializeRunLoop();
133     void wakeUpRunLoop();
134
135 #if PLATFORM(COCOA)
136     static void threadRunLoopSourceCallback(void* AXThread);
137     void threadRunLoopSourceCallback();
138 #endif
139
140     RefPtr<Thread> m_thread;
141
142     Condition m_initializeRunLoopConditionVariable;
143     Lock m_initializeRunLoopMutex;
144
145     Lock m_functionsMutex;
146     Vector<Function<void()>> m_functions;
147
148 #if PLATFORM(COCOA)
149     // FIXME: We should use WebCore::RunLoop here.
150     RetainPtr<CFRunLoopRef> m_threadRunLoop;
151     RetainPtr<CFRunLoopSourceRef> m_threadRunLoopSource;
152 #else
153     RunLoop* m_runLoop { nullptr };
154 #endif
155 };
156
157 #endif // PLATFORM(COCOA)
158
159 } // namespace WTR