54e4a708286813575c1f1e0a3ab66a4ae0a7cb38
[WebKit-https.git] / Tools / DumpRenderTree / ios / AccessibilityControllerIOS.mm
1 /*
2  * Copyright (C) 2009 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 #import "config.h"
27 #import "DumpRenderTree.h"
28 #import "AccessibilityController.h"
29
30 #import "AccessibilityCommonMac.h"
31 #import "AccessibilityNotificationHandler.h"
32 #import "AccessibilityUIElement.h"
33 #import <Foundation/Foundation.h>
34 #import <WebKit/WebFramePrivate.h>
35 #import <WebKit/WebHTMLViewPrivate.h>
36
37 @interface WebHTMLView (Private)
38 - (id)accessibilityFocusedUIElement;
39 @end
40
41 AccessibilityController::AccessibilityController()
42 {
43 }
44
45 AccessibilityController::~AccessibilityController()
46 {
47     // ResetToConsistentState should have cleared this already.
48     ASSERT(!m_globalNotificationHandler);
49 }
50
51 AccessibilityUIElement AccessibilityController::elementAtPoint(int x, int y)
52 {
53     return rootElement().elementAtPoint(x, y);
54 }
55
56 AccessibilityUIElement AccessibilityController::focusedElement()
57 {
58     id webDocumentView = [[mainFrame frameView] documentView];
59     if ([webDocumentView isKindOfClass:[WebHTMLView class]])
60         return AccessibilityUIElement([(WebHTMLView *)webDocumentView accessibilityFocusedUIElement]);
61     return 0;
62 }
63
64 AccessibilityUIElement AccessibilityController::rootElement()
65 {
66     // FIXME: we could do some caching here.
67     id webDocumentView = [[mainFrame frameView] documentView];
68     if ([webDocumentView isKindOfClass:[WebHTMLView class]])
69         return AccessibilityUIElement([(WebHTMLView *)webDocumentView accessibilityRootElement]);
70     return 0;
71 }
72
73 static id findAccessibleObjectById(id obj, NSString *idAttribute)
74 {
75     id objIdAttribute = [obj accessibilityIdentifier];
76     if ([objIdAttribute isKindOfClass:[NSString class]] && [objIdAttribute isEqualToString:idAttribute])
77         return obj;
78     
79     NSUInteger childrenCount = [obj accessibilityElementCount];
80     for (NSUInteger i = 0; i < childrenCount; ++i) {
81         id result = findAccessibleObjectById([obj accessibilityElementAtIndex:i], idAttribute);
82         if (result)
83             return result;
84     }
85     
86     return 0;
87 }
88
89 AccessibilityUIElement AccessibilityController::accessibleElementById(JSStringRef idAttributeRef)
90 {
91     id webDocumentView = [[mainFrame frameView] documentView];
92     if (![webDocumentView isKindOfClass:[WebHTMLView class]])
93         return 0;
94     
95     id root = [(WebHTMLView *)webDocumentView accessibilityRootElement];
96     NSString *idAttribute = [NSString stringWithJSStringRef:idAttributeRef];
97     id result = findAccessibleObjectById(root, idAttribute);
98     if (result)
99         return AccessibilityUIElement(result);
100     
101     return 0;
102 }
103
104 void AccessibilityController::setLogFocusEvents(bool)
105 {
106 }
107
108 void AccessibilityController::setLogScrollingStartEvents(bool)
109 {
110 }
111
112 void AccessibilityController::setLogValueChangeEvents(bool)
113 {
114 }
115
116 void AccessibilityController::setLogAccessibilityEvents(bool)
117 {
118 }
119
120 bool AccessibilityController::addNotificationListener(JSObjectRef functionCallback)
121 {
122     if (!functionCallback)
123         return false;
124     
125     // Mac programmers should not be adding more than one global notification listener.
126     // Other platforms may be different.
127     if (m_globalNotificationHandler)
128         return false;
129     m_globalNotificationHandler = adoptNS([[AccessibilityNotificationHandler alloc] init]);
130     [m_globalNotificationHandler setCallback:functionCallback];
131     [m_globalNotificationHandler startObserving];
132     
133     return true;
134 }
135
136 void AccessibilityController::platformResetToConsistentState()
137 {
138     [m_globalNotificationHandler stopObserving];
139     m_globalNotificationHandler.clear();
140 }
141
142 void AccessibilityController::removeNotificationListener()
143 {
144 }
145
146 void AccessibilityController::enableEnhancedAccessibility(bool enable)
147 {
148     [mainFrame setEnhancedAccessibility:enable];
149 }
150
151 bool AccessibilityController::enhancedAccessibilityEnabled()
152 {
153     return [mainFrame enhancedAccessibilityEnabled];
154 }
155
156 JSRetainPtr<JSStringRef> AccessibilityController::platformName() const
157 {
158     JSRetainPtr<JSStringRef> platformName(Adopt, JSStringCreateWithUTF8CString("ios"));
159     return platformName;
160 }