Source/WebCore: AccessibilityController should support listening to notifications...
[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 "AccessibilityNotificationHandler.h"
31 #import "AccessibilityUIElement.h"
32 #import <AppKit/NSColor.h>
33 #import <Foundation/Foundation.h>
34 #import <WebKit/WebFrame.h>
35 #import <WebKit/WebFramePrivate.h>
36 #import <WebKit/WebHTMLView.h>
37
38 AccessibilityController::AccessibilityController()
39 {
40 }
41
42 AccessibilityController::~AccessibilityController()
43 {
44     // The notification handler should be nil because removeNotificationListener() should have been called in the test.
45     ASSERT(!m_globalNotificationHandler);
46 }
47
48 AccessibilityUIElement AccessibilityController::elementAtPoint(int x, int y)
49 {
50     id accessibilityObject = [[[mainFrame frameView] documentView] accessibilityHitTest:NSMakePoint(x, y)];
51     return AccessibilityUIElement(accessibilityObject);    
52 }
53
54 AccessibilityUIElement AccessibilityController::focusedElement()
55 {
56     id accessibilityObject = [[mainFrame accessibilityRoot] accessibilityFocusedUIElement];
57     return AccessibilityUIElement(accessibilityObject);
58 }
59
60 AccessibilityUIElement AccessibilityController::rootElement()
61 {
62     // FIXME: we could do some caching here.
63     
64     // Layout tests expect that the root element will be the scroll area
65     // containing the web area object. That will be the parent of the accessibilityRoot on WK1.
66     
67     id accessibilityObject = [[mainFrame accessibilityRoot] accessibilityAttributeValue:NSAccessibilityParentAttribute];
68     return AccessibilityUIElement(accessibilityObject);
69 }
70
71 void AccessibilityController::setLogFocusEvents(bool)
72 {
73 }
74
75 void AccessibilityController::setLogScrollingStartEvents(bool)
76 {
77 }
78
79 void AccessibilityController::setLogValueChangeEvents(bool)
80 {
81 }
82
83 void AccessibilityController::setLogAccessibilityEvents(bool)
84 {
85 }
86
87 bool AccessibilityController::addNotificationListener(JSObjectRef functionCallback)
88 {
89     if (!functionCallback)
90         return false;
91  
92     // Mac programmers should not be adding more than one global notification listener.
93     // Other platforms may be different.
94     if (m_globalNotificationHandler)
95         return false;
96     m_globalNotificationHandler = [[AccessibilityNotificationHandler alloc] init];
97     [m_globalNotificationHandler.get() setCallback:functionCallback];
98     [m_globalNotificationHandler.get() startObserving];
99
100     return true;
101 }
102
103 void AccessibilityController::removeNotificationListener()
104 {
105     // Mac programmers should not be trying to remove a listener that's already removed.
106     ASSERT(m_globalNotificationHandler);
107     m_globalNotificationHandler.clear();
108 }