WAI-ARIA: aria-activedescendant doesn't work as intended
[WebKit-https.git] / WebCore / accessibility / win / AXObjectCacheWin.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  * 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
27 #include "config.h"
28 #include "AXObjectCache.h"
29
30 #include "AccessibilityObject.h"
31 #include "Document.h"
32 #include "Page.h"
33 #include "RenderObject.h"
34
35 using namespace std;
36
37 namespace WebCore {
38
39 void AXObjectCache::detachWrapper(AccessibilityObject* obj)
40 {
41     // On Windows, AccessibilityObjects are created when get_accChildCount is
42     // called, but they are not wrapped until get_accChild is called, so this
43     // object may not have a wrapper.
44     if (AccessibilityObjectWrapper* wrapper = obj->wrapper())
45         wrapper->detach();
46 }
47
48 void AXObjectCache::attachWrapper(AccessibilityObject*)
49 {
50     // On Windows, AccessibilityObjects are wrapped when the accessibility
51     // software requests them via get_accChild.
52 }
53
54 void AXObjectCache::handleScrolledToAnchor(const Node* anchorNode)
55 {
56     // The anchor node may not be accessible. Post the notification for the
57     // first accessible object.
58     postPlatformNotification(AccessibilityObject::firstAccessibleObjectFromNode(anchorNode), AXScrolledToAnchor);
59 }
60
61 void AXObjectCache::postPlatformNotification(AccessibilityObject* obj, AXNotification notification)
62 {
63     if (!obj)
64         return;
65
66     Document* document = obj->document();
67     if (!document)
68         return;
69
70     Page* page = document->page();
71     if (!page || !page->chrome()->platformPageClient())
72         return;
73
74     DWORD msaaEvent;
75     switch (notification) {
76         case AXFocusedUIElementChanged:
77         case AXActiveDescendantChanged:
78             msaaEvent = EVENT_OBJECT_FOCUS;
79             break;
80
81         case AXScrolledToAnchor:
82             msaaEvent = EVENT_SYSTEM_SCROLLINGSTART;
83             break;
84
85         default:
86             return;
87     }
88
89     // Windows will end up calling get_accChild() on the root accessible
90     // object for the WebView, passing the child ID that we specify below. We
91     // negate the AXID so we know that the caller is passing the ID of an
92     // element, not the index of a child element.
93
94     ASSERT(obj->axObjectID() >= 1);
95     ASSERT(obj->axObjectID() <= numeric_limits<LONG>::max());
96
97     NotifyWinEvent(msaaEvent, page->chrome()->platformPageClient(), OBJID_CLIENT, -static_cast<LONG>(obj->axObjectID()));
98 }
99
100 AXID AXObjectCache::platformGenerateAXID() const
101 {
102     static AXID lastUsedID = 0;
103
104     // Generate a new ID. Windows accessibility relies on a positive AXID,
105     // ranging from 1 to LONG_MAX.
106     AXID objID = lastUsedID;
107     do {
108         ++objID;
109         objID %= std::numeric_limits<LONG>::max();
110     } while (objID == 0 || HashTraits<AXID>::isDeletedValue(objID) || m_idsInUse.contains(objID));
111
112     ASSERT(objID >= 1 && objID <= std::numeric_limits<LONG>::max());
113
114     lastUsedID = objID;
115
116     return objID;
117 }
118
119 void AXObjectCache::handleFocusedUIElementChanged(RenderObject*, RenderObject* newFocusedRenderer)
120 {
121     if (!newFocusedRenderer)
122         return;
123
124     Page* page = newFocusedRenderer->document()->page();
125     if (!page || !page->chrome()->platformPageClient())
126         return;
127
128     AccessibilityObject* focusedObject = focusedUIElementForPage(page);
129     if (!focusedObject)
130         return;
131
132     ASSERT(!focusedObject->accessibilityIsIgnored());
133
134     postPlatformNotification(focusedObject, AXFocusedUIElementChanged);
135 }
136
137 } // namespace WebCore