platform/mac/accessibility/aria-multiline.html sometimes asserts in AccessibilityCont...
[WebKit-https.git] / Tools / DumpRenderTree / AccessibilityController.h
1 /*
2  * Copyright (C) 2008, 2009, 2010 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 #ifndef AccessibilityController_h
27 #define AccessibilityController_h
28
29 #include "AccessibilityUIElement.h"
30 #include <JavaScriptCore/JSObjectRef.h>
31 #include <JavaScriptCore/JSRetainPtr.h>
32 #include <string>
33 #include <wtf/HashMap.h>
34 #include <wtf/Platform.h>
35 #if PLATFORM(WIN)
36 #include <windows.h>
37 #endif
38 #if HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(EFL))
39 #include "AccessibilityNotificationHandlerAtk.h"
40 #include <atk/atk.h>
41 #endif
42
43 class AccessibilityController {
44 public:
45     AccessibilityController();
46     ~AccessibilityController();
47
48     void makeWindowObject(JSContextRef context, JSObjectRef windowObject, JSValueRef* exception);
49
50     // Controller Methods - platform-independent implementations
51     AccessibilityUIElement rootElement();
52     AccessibilityUIElement focusedElement();
53     AccessibilityUIElement elementAtPoint(int x, int y);
54     AccessibilityUIElement accessibleElementById(JSStringRef id);
55
56     void setLogFocusEvents(bool);
57     void setLogValueChangeEvents(bool);
58     void setLogScrollingStartEvents(bool);
59     void setLogAccessibilityEvents(bool);
60
61     void resetToConsistentState();
62
63     // Global notification listener, captures notifications on any object.
64     bool addNotificationListener(JSObjectRef functionCallback);
65     void removeNotificationListener();
66
67     JSRetainPtr<JSStringRef> platformName() const;
68
69 #if PLATFORM(WIN)
70     // Helper methods so this class can add the listeners on behalf of AccessibilityUIElement.
71     void winAddNotificationListener(PlatformUIElement, JSObjectRef functionCallback);
72     void winNotificationReceived(PlatformUIElement, const std::string& eventName);
73 #endif
74
75 #if HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(EFL))
76     AtkObject* childElementById(AtkObject* parent, const char* id);
77 #endif
78
79 private:
80     static JSClassRef getJSClass();
81
82 #if PLATFORM(WIN)
83     HWINEVENTHOOK m_focusEventHook;
84     HWINEVENTHOOK m_valueChangeEventHook;
85     HWINEVENTHOOK m_scrollingStartEventHook;
86
87     HWINEVENTHOOK m_allEventsHook;
88     HWINEVENTHOOK m_notificationsEventHook;
89     HashMap<PlatformUIElement, JSObjectRef> m_notificationListeners;
90 #endif
91
92 #if PLATFORM(MAC)
93     RetainPtr<NotificationHandler> m_globalNotificationHandler;
94 #endif
95
96 #if HAVE(ACCESSIBILITY) && (PLATFORM(GTK) || PLATFORM(EFL))
97     RefPtr<AccessibilityNotificationHandler> m_globalNotificationHandler;
98 #endif
99     
100     void platformResetToConsistentState();
101 };
102
103 #endif // AccessibilityController_h