6b544553ffa8866947ff6723b345e118e3ba7c19
[WebKit-https.git] / Tools / DumpRenderTree / mac / AccessibilityControllerMac.mm
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 #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 <AppKit/NSColor.h>
34 #import <Foundation/Foundation.h>
35 #import <JavaScriptCore/JSStringRef.h>
36 #import <JavaScriptCore/JSStringRefCF.h>
37 #import <WebKit/WebFramePrivate.h>
38 #import <WebKit/WebFrameView.h>
39 #import <WebKit/WebHTMLView.h>
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     id accessibilityObject = [[[mainFrame frameView] documentView] accessibilityHitTest:NSMakePoint(x, y)];
54     return AccessibilityUIElement(accessibilityObject);    
55 }
56
57 AccessibilityUIElement AccessibilityController::focusedElement()
58 {
59     id accessibilityObject = [[mainFrame accessibilityRoot] accessibilityFocusedUIElement];
60     return AccessibilityUIElement(accessibilityObject);
61 }
62
63 AccessibilityUIElement AccessibilityController::rootElement()
64 {
65     // FIXME: we could do some caching here.
66     
67     // Layout tests expect that the root element will be the scroll area
68     // containing the web area object. That will be the parent of the accessibilityRoot on WK1.
69     
70     id accessibilityObject = [[mainFrame accessibilityRoot] accessibilityAttributeValue:NSAccessibilityParentAttribute];
71     return AccessibilityUIElement(accessibilityObject);
72 }
73
74 static id findAccessibleObjectById(id obj, NSString *idAttribute)
75 {
76     BEGIN_AX_OBJC_EXCEPTIONS
77     id objIdAttribute = [obj accessibilityAttributeValue:@"AXDRTElementIdAttribute"];
78     if ([objIdAttribute isKindOfClass:[NSString class]] && [objIdAttribute isEqualToString:idAttribute])
79         return obj;
80     END_AX_OBJC_EXCEPTIONS
81
82     BEGIN_AX_OBJC_EXCEPTIONS
83     NSArray *children = [obj accessibilityAttributeValue:NSAccessibilityChildrenAttribute];
84     NSUInteger childrenCount = [children count];
85     for (NSUInteger i = 0; i < childrenCount; ++i) {
86         id result = findAccessibleObjectById([children objectAtIndex:i], idAttribute);
87         if (result)
88             return result;
89     }
90     END_AX_OBJC_EXCEPTIONS
91
92     return nullptr;
93 }
94
95 AccessibilityUIElement AccessibilityController::accessibleElementById(JSStringRef idAttributeRef)
96 {
97     NSString *idAttribute = [NSString stringWithJSStringRef:idAttributeRef];
98     id root = [[mainFrame accessibilityRoot] accessibilityAttributeValue:NSAccessibilityParentAttribute];
99     id result = findAccessibleObjectById(root, idAttribute);
100     if (result)
101         return AccessibilityUIElement(result);
102
103     return nullptr;
104 }
105
106 void AccessibilityController::setLogFocusEvents(bool)
107 {
108 }
109
110 void AccessibilityController::setLogScrollingStartEvents(bool)
111 {
112 }
113
114 void AccessibilityController::setLogValueChangeEvents(bool)
115 {
116 }
117
118 void AccessibilityController::setLogAccessibilityEvents(bool)
119 {
120 }
121
122 void AccessibilityController::platformResetToConsistentState()
123 {
124     [m_globalNotificationHandler stopObserving];
125     m_globalNotificationHandler.clear();
126 }
127
128 bool AccessibilityController::addNotificationListener(JSObjectRef functionCallback)
129 {
130     if (!functionCallback)
131         return false;
132  
133     // Mac programmers should not be adding more than one global notification listener.
134     // Other platforms may be different.
135     if (m_globalNotificationHandler)
136         return false;
137     m_globalNotificationHandler = adoptNS([[AccessibilityNotificationHandler alloc] init]);
138     [m_globalNotificationHandler setCallback:functionCallback];
139     [m_globalNotificationHandler startObserving];
140
141     return true;
142 }
143
144 void AccessibilityController::removeNotificationListener()
145 {
146     // No longer a need to cleanup for tests, since resetToConsistentState will remove the listener.
147 }
148
149 void AccessibilityController::enableEnhancedAccessibility(bool enable)
150 {
151     [mainFrame setEnhancedAccessibility:enable];
152 }
153
154 bool AccessibilityController::enhancedAccessibilityEnabled()
155 {
156     return [mainFrame enhancedAccessibilityEnabled];
157 }
158
159 JSRetainPtr<JSStringRef> AccessibilityController::platformName() const
160 {
161     JSRetainPtr<JSStringRef> platformName(Adopt, JSStringCreateWithUTF8CString("mac"));
162     return platformName;
163 }