WebCore/page/AXObjectCache.cpp

   1 /*
   2  * Copyright (C) 2008 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  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include "config.h"
  30 #include "AXObjectCache.h"
  31
  32 #include "AccessibilityListBox.h"
  33 #include "AccessibilityListBoxOption.h"
  34 #include "AccessibilityRenderObject.h"
  35 #include "RenderObject.h"
  36
  37 #include <wtf/PassRefPtr.h>
  38
  39 namespace WebCore {
  40
  41 bool AXObjectCache::gAccessibilityEnabled = false;
  42
  43 AXObjectCache::~AXObjectCache()
  44 {
  45     HashMap<AXID, RefPtr<AccessibilityObject> >::iterator end = m_objects.end();
  46     for (HashMap<AXID, RefPtr<AccessibilityObject> >::iterator it = m_objects.begin(); it != end; ++it) {
  47         AccessibilityObject* obj = (*it).second.get();
  48         detachWrapper(obj);
  49         obj->detach();
  50     }
  51 }
  52
  53 AccessibilityObject* AXObjectCache::get(RenderObject* renderer)
  54 {
  55     if (!renderer)
  56         return 0;
  57
  58     RefPtr<AccessibilityObject> obj = 0;
  59     AXID axID = m_renderObjectMapping.get(renderer);
  60     ASSERT(!HashTraits<AXID>::isDeletedValue(axID));
  61
  62     if (axID)
  63         obj = m_objects.get(axID).get();
  64
  65     if (!obj) {
  66         if (renderer->isListBox())
  67             obj = AccessibilityListBox::create(renderer);
  68         else
  69             obj = AccessibilityRenderObject::create(renderer);
  70
  71         getAXID(obj.get());
  72
  73         m_renderObjectMapping.set(renderer, obj.get()->axObjectID());
  74         m_objects.set(obj.get()->axObjectID(), obj);
  75         attachWrapper(obj.get());
  76     }
  77
  78     return obj.get();
  79 }
  80
  81 AccessibilityObject* AXObjectCache::get(AccessibilityRole role)
  82 {
  83     RefPtr<AccessibilityObject> obj = 0;
  84
  85     // will be filled in...
  86     switch (role) {
  87         case ListBoxOptionRole:
  88             obj = AccessibilityListBoxOption::create();
  89             break;
  90         default:
  91             obj = 0;
  92     }
  93
  94     if (obj)
  95         getAXID(obj.get());
  96     else
  97         return 0;
  98
  99     m_objects.set(obj->axObjectID(), obj);
 100     attachWrapper(obj.get());
 101     return obj.get();
 102 }
 103
 104 void AXObjectCache::remove(AXID axID)
 105 {
 106     if (!axID)
 107         return;
 108
 109     // first fetch object to operate some cleanup functions on it
 110     AccessibilityObject* obj = m_objects.get(axID).get();
 111     if (!obj)
 112         return;
 113
 114     detachWrapper(obj);
 115     obj->detach();
 116     removeAXID(obj);
 117
 118     // finally remove the object
 119     if (!m_objects.take(axID)) {
 120         return;
 121     }
 122
 123     ASSERT(m_objects.size() >= m_idsInUse.size());
 124 }
 125
 126 void AXObjectCache::remove(RenderObject* renderer)
 127 {
 128     if (!renderer)
 129         return;
 130
 131     AXID axID = m_renderObjectMapping.get(renderer);
 132     remove(axID);
 133     m_renderObjectMapping.remove(renderer);
 134 }
 135
 136 AXID AXObjectCache::getAXID(AccessibilityObject* obj)
 137 {
 138     // check for already-assigned ID
 139     AXID objID = obj->axObjectID();
 140     if (objID) {
 141         ASSERT(m_idsInUse.contains(objID));
 142         return objID;
 143     }
 144
 145     // generate a new ID
 146     static AXID lastUsedID = 0;
 147     objID = lastUsedID;
 148     do
 149         ++objID;
 150     while (objID == 0 || HashTraits<AXID>::isDeletedValue(objID) || m_idsInUse.contains(objID));
 151     m_idsInUse.add(objID);
 152     lastUsedID = objID;
 153     obj->setAXObjectID(objID);
 154
 155     return objID;
 156 }
 157
 158 void AXObjectCache::removeAXID(AccessibilityObject* obj)
 159 {
 160     AXID objID = obj->axObjectID();
 161     if (objID == 0)
 162         return;
 163     ASSERT(!HashTraits<AXID>::isDeletedValue(objID));
 164     ASSERT(m_idsInUse.contains(objID));
 165     obj->setAXObjectID(0);
 166     m_idsInUse.remove(objID);
 167 }
 168
 169 void AXObjectCache::childrenChanged(RenderObject* renderer)
 170 {
 171     if (!renderer)
 172         return;
 173
 174     AXID axID = m_renderObjectMapping.get(renderer);
 175     if (!axID)
 176         return;
 177
 178     AccessibilityObject* obj = m_objects.get(axID).get();
 179     if (obj)
 180         obj->childrenChanged();
 181 }
 182
 183 void AXObjectCache::selectedChildrenChanged(RenderObject* renderer)
 184 {
 185     postNotificationToElement(renderer, "AXSelectedChildrenChanged");
 186 }
 187
 188 } // namespace WebCore