2008-04-02 Beth Dakin <bdakin@apple.com>
[WebKit-https.git] / WebCore / page / mac / AXObjectCacheMac.mm
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Computer, 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 #import "config.h"
27 #import "AXObjectCache.h"
28
29 #import "AccessibilityObject.h"
30 #import "AccessibilityObjectWrapper.h"
31 #import "RenderObject.h"
32 #import "WebCoreViewFactory.h"
33
34 #import <wtf/PassRefPtr.h>
35
36 // The simple Cocoa calls in this file don't throw exceptions.
37
38 namespace WebCore {
39
40 bool AXObjectCache::gAccessibilityEnabled = false;
41
42 AXObjectCache::~AXObjectCache()
43 {
44     HashMap<RenderObject*, RefPtr<AccessibilityObject> >::iterator end = m_objects.end();
45     for (HashMap<RenderObject*, RefPtr<AccessibilityObject> >::iterator it = m_objects.begin(); it != end; ++it) {
46         AccessibilityObject* obj = (*it).second.get();
47         [obj->wrapper() detach];
48         obj->detach();
49     }
50 }
51
52 AccessibilityObject* AXObjectCache::get(RenderObject* renderer)
53 {
54     RefPtr<AccessibilityObject> obj = m_objects.get(renderer).get();
55     if (obj)
56         return obj.get();
57     obj = AccessibilityObject::create(renderer);
58     m_objects.set(renderer, obj);    
59     obj->setWrapper([[AccessibilityObjectWrapper alloc] initWithAccessibilityObject:obj.get()]);
60     return obj.get();
61 }
62
63 void AXObjectCache::remove(RenderObject* renderer)
64 {
65     // first fetch object to operate some cleanup functions on it 
66     AccessibilityObject* obj = m_objects.get(renderer).get();
67     if (obj) {
68         [obj->wrapper() detach];
69         obj->detach();
70         
71         // finally remove the object
72         if (!m_objects.take(renderer)) {
73             ASSERT(!renderer->hasAXObject());
74             return;
75         }
76     }
77     ASSERT(m_objects.size() >= m_idsInUse.size());
78 }
79
80 AXID AXObjectCache::getAXID(AccessibilityObject* obj)
81 {
82     // check for already-assigned ID
83     AXID objID = obj->axObjectID();
84     if (objID) {
85         ASSERT(m_idsInUse.contains(objID));
86         return objID;
87     }
88
89     // generate a new ID
90     static AXID lastUsedID = 0;
91     objID = lastUsedID;
92     do
93         ++objID;
94     while (objID == 0 || objID == AXIDHashTraits::deletedValue() || m_idsInUse.contains(objID));
95     m_idsInUse.add(objID);
96     lastUsedID = objID;
97     obj->setAXObjectID(objID);
98
99     return objID;
100 }
101
102 void AXObjectCache::removeAXID(AccessibilityObject* obj)
103 {
104     AXID objID = obj->axObjectID();
105     if (objID == 0)
106         return;
107     ASSERT(objID != AXIDHashTraits::deletedValue());
108     ASSERT(m_idsInUse.contains(objID));
109     obj->setAXObjectID(0);
110     m_idsInUse.remove(objID);
111 }
112
113 void AXObjectCache::childrenChanged(RenderObject* renderer)
114 {
115     AccessibilityObject* obj = m_objects.get(renderer).get();
116     if (obj)
117         obj->childrenChanged();
118 }
119
120 void AXObjectCache::postNotification(RenderObject* renderer, const String& message)
121 {
122     if (!renderer)
123         return;
124     
125     // notifications for text input objects are sent to that object
126     // all others are sent to the top WebArea
127     RefPtr<AccessibilityObject> obj = get(renderer)->observableObject();
128     if (!obj)
129         obj = get(renderer->document()->renderer());
130         
131     if (!obj)
132         return;
133
134     NSAccessibilityPostNotification(obj->wrapper(), message);
135 }
136
137 void AXObjectCache::postNotificationToElement(RenderObject* renderer, const String& message)
138 {
139     // send the notification to the specified element itself, not one of its ancestors
140     if (!renderer)
141         return;
142
143     RefPtr<AccessibilityObject> obj = get(renderer);
144     if (!obj)
145         return;
146
147     NSAccessibilityPostNotification(obj->wrapper(), message);
148 }
149
150 void AXObjectCache::handleFocusedUIElementChanged()
151 {
152     [[WebCoreViewFactory sharedFactory] accessibilityHandleFocusChanged];
153 }
154
155 }