Source/WebCore: AccessibilityController should support listening to notifications...
[WebKit-https.git] / Tools / DumpRenderTree / chromium / AccessibilityController.cpp
1 /*
2  * Copyright (C) 2010 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 #include "config.h"
32 #include "AccessibilityController.h"
33
34 #include "TestShell.h"
35 #include "WebAccessibilityObject.h"
36 #include "WebFrame.h"
37 #include "platform/WebString.h"
38 #include "WebView.h"
39
40 using namespace WebKit;
41
42 AccessibilityController::AccessibilityController(TestShell* shell)
43     : m_logAccessibilityEvents(false)
44     , m_shell(shell)
45 {
46
47     bindMethod("logAccessibilityEvents", &AccessibilityController::logAccessibilityEventsCallback);
48     bindMethod("addNotificationListener", &AccessibilityController::addNotificationListenerCallback);
49     bindMethod("removeNotificationListener", &AccessibilityController::removeNotificationListenerCallback);
50
51     bindProperty("focusedElement", &AccessibilityController::focusedElementGetterCallback);
52     bindProperty("rootElement", &AccessibilityController::rootElementGetterCallback);
53
54     bindFallbackMethod(&AccessibilityController::fallbackCallback);
55 }
56
57 void AccessibilityController::bindToJavascript(WebFrame* frame, const WebString& classname)
58 {
59     WebAccessibilityObject::enableAccessibility();
60     CppBoundClass::bindToJavascript(frame, classname);
61 }
62
63 void AccessibilityController::reset()
64 {
65     m_rootElement = WebAccessibilityObject();
66     m_focusedElement = WebAccessibilityObject();
67     m_elements.clear();
68
69     m_logAccessibilityEvents = false;
70 }
71
72 void AccessibilityController::setFocusedElement(const WebAccessibilityObject& focusedElement)
73 {
74     m_focusedElement = focusedElement;
75 }
76
77 AccessibilityUIElement* AccessibilityController::getFocusedElement()
78 {
79     if (m_focusedElement.isNull())
80         m_focusedElement = m_shell->webView()->accessibilityObject();
81     return m_elements.getOrCreate(m_focusedElement);
82 }
83
84 AccessibilityUIElement* AccessibilityController::getRootElement()
85 {
86     if (m_rootElement.isNull())
87         m_rootElement = m_shell->webView()->accessibilityObject();
88     return m_elements.createRoot(m_rootElement);
89 }
90
91 bool AccessibilityController::shouldLogAccessibilityEvents()
92 {
93     return m_logAccessibilityEvents;
94 }
95
96 void AccessibilityController::notificationReceived(const WebKit::WebAccessibilityObject& target, const char* notificationName)
97 {
98     // Call notification listeners on the element.
99     AccessibilityUIElement* element = m_elements.getOrCreate(target);
100     element->notificationReceived(notificationName);
101
102     // Call global notification listeners.
103     size_t callbackCount = m_notificationCallbacks.size();
104     for (size_t i = 0; i < callbackCount; i++) {
105         CppVariant arguments[2];
106         arguments[0].set(*element->getAsCppVariant());
107         arguments[1].set(notificationName);
108         CppVariant invokeResult;
109         m_notificationCallbacks[i].invokeDefault(arguments, 2, invokeResult);
110     }
111 }
112
113 void AccessibilityController::logAccessibilityEventsCallback(const CppArgumentList&, CppVariant* result)
114 {
115     m_logAccessibilityEvents = true;
116     result->setNull();
117 }
118
119 void AccessibilityController::addNotificationListenerCallback(const CppArgumentList& arguments, CppVariant* result)
120 {
121     if (arguments.size() < 1 || !arguments[0].isObject()) {
122         result->setNull();
123         return;
124     }
125
126     m_notificationCallbacks.push_back(arguments[0]);
127     result->setNull();
128 }
129
130 void AccessibilityController::removeNotificationListenerCallback(const CppArgumentList&, CppVariant* result)
131 {
132     // FIXME: Implement this.
133     result->setNull();
134 }
135
136 void AccessibilityController::focusedElementGetterCallback(CppVariant* result)
137 {
138     result->set(*(getFocusedElement()->getAsCppVariant()));
139 }
140
141 void AccessibilityController::rootElementGetterCallback(CppVariant* result)
142 {
143     result->set(*(getRootElement()->getAsCppVariant()));
144 }
145
146 void AccessibilityController::fallbackCallback(const CppArgumentList&, CppVariant* result)
147 {
148     printf("CONSOLE MESSAGE: JavaScript ERROR: unknown method called on "
149            "AccessibilityController\n");
150     result->setNull();
151 }