8ea76f54716911d364789194916296d69853a3f1
[WebKit-https.git] / WebCore / accessibility / AXObjectCache.h
1 /*
2  * Copyright (C) 2003, 2006, 2007, 2008, 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 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 "EventHandler.h"
31 #include "Timer.h"
32 #include <limits.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 Node;
46 class Page;
47 class RenderObject;
48 class String;
49 class VisiblePosition;
50
51 struct TextMarkerData {
52     AXID axID;
53     Node* node;
54     int offset;
55     EAffinity affinity;
56 };
57
58 class AXObjectCache : public Noncopyable {
59 public:
60     AXObjectCache();
61     ~AXObjectCache();
62
63     static AccessibilityObject* focusedUIElementForPage(const Page*);
64
65     // to be used with render objects
66     AccessibilityObject* getOrCreate(RenderObject*);
67     
68     // used for objects without backing elements
69     AccessibilityObject* getOrCreate(AccessibilityRole);
70     
71     // will only return the AccessibilityObject if it already exists
72     AccessibilityObject* get(RenderObject*);
73     
74     void remove(RenderObject*);
75     void remove(AXID);
76
77     void detachWrapper(AccessibilityObject*);
78     void attachWrapper(AccessibilityObject*);
79     void childrenChanged(RenderObject*);
80     void selectedChildrenChanged(RenderObject*);
81     void handleActiveDescendantChanged(RenderObject*);
82     void handleAriaRoleChanged(RenderObject*);
83     void handleFocusedUIElementChanged(RenderObject* oldFocusedRenderer, RenderObject* newFocusedRenderer);
84     void handleScrolledToAnchor(const Node* anchorNode);
85
86     static void enableAccessibility() { gAccessibilityEnabled = true; }
87     static void enableEnhancedUserInterfaceAccessibility() { gAccessibilityEnhancedUserInterfaceEnabled = true; }
88     
89     static bool accessibilityEnabled() { return gAccessibilityEnabled; }
90     static bool accessibilityEnhancedUserInterfaceEnabled() { return gAccessibilityEnhancedUserInterfaceEnabled; }
91
92     void removeAXID(AccessibilityObject*);
93     bool isIDinUse(AXID id) const { return m_idsInUse.contains(id); }
94     AXID platformGenerateAXID() const;
95     AccessibilityObject* objectFromAXID(AXID id) const { return m_objects.get(id).get(); }
96
97     // Text marker utilities.
98     static void textMarkerDataForVisiblePosition(TextMarkerData&, const VisiblePosition&);
99     static VisiblePosition visiblePositionForTextMarkerData(TextMarkerData&);
100
101     enum AXNotification {
102         AXCheckedStateChanged,
103         AXFocusedUIElementChanged,
104         AXLayoutComplete,
105         AXLoadComplete,
106         AXSelectedChildrenChanged,
107         AXSelectedTextChanged,
108         AXValueChanged,
109         AXScrolledToAnchor,
110     };
111     
112     void postNotification(RenderObject*, AXNotification, bool postToElement);
113
114 protected:
115     void postPlatformNotification(AccessibilityObject*, AXNotification);
116
117 private:
118     HashMap<AXID, RefPtr<AccessibilityObject> > m_objects;
119     HashMap<RenderObject*, AXID> m_renderObjectMapping;
120     static bool gAccessibilityEnabled;
121     static bool gAccessibilityEnhancedUserInterfaceEnabled;
122     
123     HashSet<AXID> m_idsInUse;
124     
125     Timer<AXObjectCache> m_notificationPostTimer;
126     Vector<pair<RefPtr<AccessibilityObject>, AXNotification> > m_notificationsToPost;
127     void notificationPostTimerFired(Timer<AXObjectCache>*);
128     
129     AXID getAXID(AccessibilityObject*);
130     bool nodeIsAriaType(Node*, String role);
131 };
132
133 #if !HAVE(ACCESSIBILITY)
134 inline void AXObjectCache::handleActiveDescendantChanged(RenderObject*) { }
135 inline void AXObjectCache::handleAriaRoleChanged(RenderObject*) { }
136 inline void AXObjectCache::detachWrapper(AccessibilityObject*) { }
137 inline void AXObjectCache::attachWrapper(AccessibilityObject*) { }
138 inline void AXObjectCache::selectedChildrenChanged(RenderObject*) { }
139 inline void AXObjectCache::postNotification(RenderObject*, AXNotification, bool postToElement) { }
140 inline void AXObjectCache::postPlatformNotification(AccessibilityObject*, AXNotification) { }
141 inline void AXObjectCache::handleFocusedUIElementChanged(RenderObject*, RenderObject*) { }
142 inline void AXObjectCache::handleScrolledToAnchor(const Node*) { }
143 #endif
144
145 }
146
147 #endif