9e54908b96cec54d04047acb3e7b0d26dc057217
[WebKit-https.git] / Tools / WebKitTestRunner / InjectedBundle / mac / AccessibilityControllerMac.mm
1 /*
2  * Copyright (C) 2011 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 #import "config.h"
32 #import "AccessibilityCommonMac.h"
33 #import "AccessibilityController.h"
34 #import "AccessibilityNotificationHandler.h"
35 #import "InjectedBundle.h"
36 #import "InjectedBundlePage.h"
37
38 #import <JavaScriptCore/JSRetainPtr.h>
39 #import <JavaScriptCore/JSStringRef.h>
40 #import <JavaScriptCore/JSStringRefCF.h>
41 #import <WebKit2/WKBundle.h>
42 #import <WebKit2/WKBundlePage.h>
43 #import <WebKit2/WKBundlePagePrivate.h>
44
45 namespace WTR {
46
47 bool AccessibilityController::addNotificationListener(JSValueRef functionCallback)
48 {
49     if (!functionCallback)
50         return false;
51
52     // Mac programmers should not be adding more than one global notification listener.
53     // Other platforms may be different.
54     if (m_globalNotificationHandler)
55         return false;
56     m_globalNotificationHandler = [[AccessibilityNotificationHandler alloc] init];
57     [m_globalNotificationHandler.get() setCallback:functionCallback];
58     [m_globalNotificationHandler.get() startObserving];
59
60     return true;
61 }
62
63 bool AccessibilityController::removeNotificationListener()
64 {
65     // Mac programmers should not be trying to remove a listener that's already removed.
66     ASSERT(m_globalNotificationHandler);
67     m_globalNotificationHandler.clear();
68
69     return true;
70 }
71
72 static id findAccessibleObjectById(id obj, NSString *idAttribute)
73 {
74     BEGIN_AX_OBJC_EXCEPTIONS
75     id objIdAttribute = [obj accessibilityAttributeValue:@"AXDRTElementIdAttribute"];
76     if ([objIdAttribute isKindOfClass:[NSString class]] && [objIdAttribute isEqualToString:idAttribute])
77         return obj;
78     END_AX_OBJC_EXCEPTIONS
79
80     NSArray *children = [obj accessibilityAttributeValue:NSAccessibilityChildrenAttribute];
81     NSUInteger childrenCount = [children count];
82     for (NSUInteger i = 0; i < childrenCount; ++i) {
83         id result = findAccessibleObjectById([children objectAtIndex:i], idAttribute);
84         if (result)
85             return result;
86     }
87
88     return 0;
89 }
90
91 PassRefPtr<AccessibilityUIElement> AccessibilityController::accessibleElementById(JSStringRef idAttribute)
92 {
93     WKBundlePageRef page = InjectedBundle::shared().page()->page();
94     id root = static_cast<PlatformUIElement>(WKAccessibilityRootObject(page));
95
96     id result = findAccessibleObjectById(root, [NSString stringWithJSStringRef:idAttribute]);
97     if (result)
98         return AccessibilityUIElement::create(result);
99
100     return 0;
101 }
102
103 } // namespace WTR