blob: b5321d267aa40f9b61a03d7bffb8ea0909691a3f [file] [log] [blame]
/*
* Copyright (C) 2011 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "JSWrappable.h"
#include <JavaScriptCore/JSObjectRef.h>
#include <JavaScriptCore/JSRetainPtr.h>
#include <wtf/Condition.h>
#include <wtf/FastMalloc.h>
#include <wtf/Platform.h>
#if PLATFORM(COCOA)
#include <wtf/RetainPtr.h>
#endif
#include <wtf/RunLoop.h>
#include <wtf/Threading.h>
#if USE(ATK)
#include "AccessibilityNotificationHandlerAtk.h"
#endif
namespace WTR {
class AccessibilityUIElement;
#if USE(ATSPI)
class AccessibilityNotificationHandler;
#endif
class AccessibilityController : public JSWrappable {
public:
static Ref<AccessibilityController> create();
~AccessibilityController();
void makeWindowObject(JSContextRef);
virtual JSClassRef wrapperClass();
// Enhanced accessibility.
void enableEnhancedAccessibility(bool);
bool enhancedAccessibilityEnabled();
void setIsolatedTreeMode(bool);
JSRetainPtr<JSStringRef> platformName();
// Controller Methods - platform-independent implementations.
#if HAVE(ACCESSIBILITY)
Ref<AccessibilityUIElement> rootElement();
RefPtr<AccessibilityUIElement> focusedElement();
#endif
RefPtr<AccessibilityUIElement> elementAtPoint(int x, int y);
RefPtr<AccessibilityUIElement> accessibleElementById(JSStringRef idAttribute);
#if PLATFORM(COCOA) || USE(ATSPI)
void executeOnAXThreadAndWait(Function<void()>&&);
void executeOnAXThread(Function<void()>&&);
void executeOnMainThread(Function<void()>&&);
#endif
bool addNotificationListener(JSValueRef functionCallback);
bool removeNotificationListener();
void injectAccessibilityPreference(JSStringRef domain, JSStringRef key, JSStringRef value);
// Here for consistency with DRT. Not implemented because they don't do anything on the Mac.
void logFocusEvents() { }
void logValueChangeEvents() { }
void logScrollingStartEvents() { }
void logAccessibilityEvents() { };
void resetToConsistentState();
#if !HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(WPE))
RefPtr<AccessibilityUIElement> rootElement() { return nullptr; }
RefPtr<AccessibilityUIElement> focusedElement() { return nullptr; }
#endif
private:
AccessibilityController();
#if PLATFORM(COCOA)
RetainPtr<id> m_globalNotificationHandler;
#elif USE(ATK)
RefPtr<AccessibilityNotificationHandler> m_globalNotificationHandler;
#elif USE(ATSPI)
std::unique_ptr<AccessibilityNotificationHandler> m_globalNotificationHandler;
#endif
#if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
void updateIsolatedTreeMode();
#if USE(ATSPI)
RunLoop& axRunLoop();
#endif
#if PLATFORM(COCOA)
void spinMainRunLoop() const;
// _AXUIElementUseSecondaryAXThread and _AXUIElementRequestServicedBySecondaryAXThread
// do not work for WebKitTestRunner since this is calling directly into
// WebCore/accessibility via JavaScript without going through HIServices.
// Thus to simulate the behavior of HIServices, AccessibilityController is spawning a secondary thread to service the JavaScript requests.
bool m_useMockAXThread { false };
#endif
bool m_accessibilityIsolatedTreeMode { false };
#if USE(ATSPI)
RunLoop* m_axRunLoop { nullptr };
#endif
#endif
};
#if PLATFORM(COCOA)
class AXThread {
WTF_MAKE_NONCOPYABLE(AXThread);
public:
static bool isCurrentThread();
static void dispatch(Function<void()>&&);
// Will dispatch the given function on the main thread once all pending functions
// on the AX thread have finished executing. Used for synchronization purposes.
static void dispatchBarrier(Function<void()>&&);
private:
friend NeverDestroyed<AXThread>;
AXThread();
static AXThread& singleton();
void createThreadIfNeeded();
void dispatchFunctionsFromAXThread();
void initializeRunLoop();
void wakeUpRunLoop();
#if PLATFORM(COCOA)
static void threadRunLoopSourceCallback(void* AXThread);
void threadRunLoopSourceCallback();
#endif
RefPtr<Thread> m_thread;
Condition m_initializeRunLoopConditionVariable;
Lock m_initializeRunLoopMutex;
Lock m_functionsMutex;
Vector<Function<void()>> m_functions;
#if PLATFORM(COCOA)
// FIXME: We should use WebCore::RunLoop here.
RetainPtr<CFRunLoopRef> m_threadRunLoop;
RetainPtr<CFRunLoopSourceRef> m_threadRunLoopSource;
#else
RunLoop* m_runLoop { nullptr };
#endif
};
#endif // PLATFORM(COCOA)
} // namespace WTR