WK2: Support Accessibility
[WebKit-https.git] / WebCore / accessibility / AXObjectCache.h
1 /*
2  * Copyright (C) 2003, 2006, 2007, 2008, 2009, 2010, 2011 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 COMPUTER, 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 COMPUTER, 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 #ifndef AXObjectCache_h
27 #define AXObjectCache_h
28
29 #include "AccessibilityObject.h"
30 #include "Timer.h"
31 #include <limits.h>
32 #include <wtf/Forward.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/RefPtr.h>
36
37 #ifdef __OBJC__
38 @class WebCoreTextMarker;
39 #else
40 class WebCoreTextMarker;
41 #endif
42
43 namespace WebCore {
44
45 class Document;
46 class HTMLAreaElement;
47 class Node;
48 class Page;
49 class RenderObject;
50 class ScrollView;
51 class VisiblePosition;
52 class Widget;
53
54 struct TextMarkerData {
55     AXID axID;
56     Node* node;
57     int offset;
58     EAffinity affinity;
59 };
60
61 enum PostType { PostSynchronously, PostAsynchronously };
62
63 class AXObjectCache : public Noncopyable {
64 public:
65     AXObjectCache(const Document*);
66     ~AXObjectCache();
67
68     static AccessibilityObject* focusedUIElementForPage(const Page*);
69
70     AccessibilityObject* rootObject();
71     
72     // For AX objects with elements that back them.
73     AccessibilityObject* getOrCreate(RenderObject*);
74     AccessibilityObject* getOrCreate(Widget*);
75
76     // used for objects without backing elements
77     AccessibilityObject* getOrCreate(AccessibilityRole);
78     
79     // will only return the AccessibilityObject if it already exists
80     AccessibilityObject* get(RenderObject*);
81     
82     void remove(RenderObject*);
83     void remove(Widget*);
84     void remove(AXID);
85
86     void detachWrapper(AccessibilityObject*);
87     void attachWrapper(AccessibilityObject*);
88     void childrenChanged(RenderObject*);
89     void selectedChildrenChanged(RenderObject*);
90     // Called by a node when text or a text equivalent (e.g. alt) attribute is changed.
91     void contentChanged(RenderObject*);
92     
93     void handleActiveDescendantChanged(RenderObject*);
94     void handleAriaRoleChanged(RenderObject*);
95     void handleFocusedUIElementChanged(RenderObject* oldFocusedRenderer, RenderObject* newFocusedRenderer);
96     void handleScrolledToAnchor(const Node* anchorNode);
97     void handleAriaExpandedChange(RenderObject*);
98     void handleScrollbarUpdate(ScrollView*);
99     
100     static void enableAccessibility() { gAccessibilityEnabled = true; }
101     static void enableEnhancedUserInterfaceAccessibility() { gAccessibilityEnhancedUserInterfaceEnabled = true; }
102     
103     static bool accessibilityEnabled() { return gAccessibilityEnabled; }
104     static bool accessibilityEnhancedUserInterfaceEnabled() { return gAccessibilityEnhancedUserInterfaceEnabled; }
105
106     void removeAXID(AccessibilityObject*);
107     bool isIDinUse(AXID id) const { return m_idsInUse.contains(id); }
108     AXID platformGenerateAXID() const;
109     AccessibilityObject* objectFromAXID(AXID id) const { return m_objects.get(id).get(); }
110
111     // This is a weak reference cache for knowing if Nodes used by TextMarkers are valid.
112     void setNodeInUse(Node* n) { m_textMarkerNodes.add(n); }
113     void removeNodeForUse(Node* n) { m_textMarkerNodes.remove(n); }
114     bool isNodeInUse(Node* n) { return m_textMarkerNodes.contains(n); }
115     
116     // Text marker utilities.
117     void textMarkerDataForVisiblePosition(TextMarkerData&, const VisiblePosition&);
118     VisiblePosition visiblePositionForTextMarkerData(TextMarkerData&);
119
120     enum AXNotification {
121         AXActiveDescendantChanged,
122         AXCheckedStateChanged,
123         AXChildrenChanged,
124         AXFocusedUIElementChanged,
125         AXLayoutComplete,
126         AXLoadComplete,
127         AXSelectedChildrenChanged,
128         AXSelectedTextChanged,
129         AXValueChanged,
130         AXScrolledToAnchor,
131         AXLiveRegionChanged,
132         AXMenuListValueChanged,
133         AXRowCountChanged,
134         AXRowCollapsed,
135         AXRowExpanded,
136         AXInvalidStatusChanged,
137     };
138
139     void postNotification(RenderObject*, AXNotification, bool postToElement, PostType = PostAsynchronously);
140     void postNotification(AccessibilityObject*, Document*, AXNotification, bool postToElement, PostType = PostAsynchronously);
141
142     enum AXTextChange {
143         AXTextInserted,
144         AXTextDeleted,
145     };
146
147     void nodeTextChangeNotification(RenderObject*, AXTextChange, unsigned offset, unsigned count);
148
149     bool nodeHasRole(Node*, const AtomicString& role);
150
151 protected:
152     void postPlatformNotification(AccessibilityObject*, AXNotification);
153     void nodeTextChangePlatformNotification(AccessibilityObject*, AXTextChange, unsigned offset, unsigned count);
154
155 private:
156     Document* m_document;
157     HashMap<AXID, RefPtr<AccessibilityObject> > m_objects;
158     HashMap<RenderObject*, AXID> m_renderObjectMapping;
159     HashMap<Widget*, AXID> m_widgetObjectMapping;
160     HashSet<Node*> m_textMarkerNodes;
161     static bool gAccessibilityEnabled;
162     static bool gAccessibilityEnhancedUserInterfaceEnabled;
163     
164     HashSet<AXID> m_idsInUse;
165     
166     Timer<AXObjectCache> m_notificationPostTimer;
167     Vector<pair<RefPtr<AccessibilityObject>, AXNotification> > m_notificationsToPost;
168     void notificationPostTimerFired(Timer<AXObjectCache>*);
169     
170     static AccessibilityObject* focusedImageMapUIElement(HTMLAreaElement*);
171     
172     AXID getAXID(AccessibilityObject*);
173     AccessibilityObject* get(Widget*);
174 };
175
176 bool nodeHasRole(Node*, const String& role);
177
178 #if !HAVE(ACCESSIBILITY)
179 inline void AXObjectCache::handleActiveDescendantChanged(RenderObject*) { }
180 inline void AXObjectCache::handleAriaRoleChanged(RenderObject*) { }
181 inline void AXObjectCache::detachWrapper(AccessibilityObject*) { }
182 inline void AXObjectCache::attachWrapper(AccessibilityObject*) { }
183 inline void AXObjectCache::selectedChildrenChanged(RenderObject*) { }
184 inline void AXObjectCache::postNotification(RenderObject*, AXNotification, bool postToElement, PostType) { }
185 inline void AXObjectCache::postNotification(AccessibilityObject*, Document*, AXNotification, bool postToElement, PostType) { }
186 inline void AXObjectCache::postPlatformNotification(AccessibilityObject*, AXNotification) { }
187 inline void AXObjectCache::nodeTextChangeNotification(RenderObject*, AXTextChange, unsigned, unsigned) { }
188 inline void AXObjectCache::nodeTextChangePlatformNotification(AccessibilityObject*, AXTextChange, unsigned, unsigned) { }
189 inline void AXObjectCache::handleFocusedUIElementChanged(RenderObject*, RenderObject*) { }
190 inline void AXObjectCache::handleScrolledToAnchor(const Node*) { }
191 inline void AXObjectCache::contentChanged(RenderObject*) { }
192 inline void AXObjectCache::handleAriaExpandedChange(RenderObject*) { }
193 inline void AXObjectCache::handleScrollbarUpdate(ScrollView*) { }
194 #endif
195
196 }
197
198 #endif