Optimize hasTagName when called on an HTMLElement
[WebKit-https.git] / Source / WebCore / accessibility / atk / AccessibilityObjectAtk.cpp
1 /*
2  * Copyright (C) 2008 Apple Ltd.
3  * Copyright (C) 2008 Alp Toker <alp@atoker.com>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #include "config.h"
22 #include "AccessibilityObject.h"
23
24 #include "HTMLElement.h"
25 #include "HTMLNames.h"
26 #include "RenderText.h"
27 #include <glib-object.h>
28
29 #if HAVE(ACCESSIBILITY)
30
31 namespace WebCore {
32
33 bool AccessibilityObject::accessibilityIgnoreAttachment() const
34 {
35     return false;
36 }
37
38 AccessibilityObjectInclusion AccessibilityObject::accessibilityPlatformIncludesObject() const
39 {
40     AccessibilityObject* parent = parentObject();
41     if (!parent)
42         return DefaultBehavior;
43
44     AccessibilityRole role = roleValue();
45     if (role == HorizontalRuleRole)
46         return IncludeObject;
47
48     // We expose the slider as a whole but not its value indicator.
49     if (role == SliderThumbRole)
50         return IgnoreObject;
51
52     // When a list item is made up entirely of children (e.g. paragraphs)
53     // the list item gets ignored. We need it.
54     if (isGroup() && parent->isList())
55         return IncludeObject;
56
57     // Entries and password fields have extraneous children which we want to ignore.
58     if (parent->isPasswordField() || parent->isTextControl())
59         return IgnoreObject;
60
61     // Include all tables, even layout tables. The AT can decide what to do with each.
62     if (role == CellRole || role == TableRole)
63         return IncludeObject;
64
65     // The object containing the text should implement AtkText itself.
66     if (role == StaticTextRole)
67         return IgnoreObject;
68
69     // Include all list items, regardless they have or not inline children
70     if (role == ListItemRole)
71         return IncludeObject;
72
73     // Bullets/numbers for list items shouldn't be exposed as AtkObjects.
74     if (role == ListMarkerRole)
75         return IgnoreObject;
76
77     // Never expose an unknown object, since AT's won't know what to
78     // do with them. This is what is done on the Mac as well.
79     if (role == UnknownRole)
80         return IgnoreObject;
81
82     // Lines past this point only make sense for AccessibilityRenderObjects.
83     RenderObject* renderObject = renderer();
84     if (!renderObject)
85         return DefaultBehavior;
86
87     // We don't want <span> elements to show up in the accessibility hierarchy unless
88     // we have good reasons for that (e.g. focusable or visible because of containing
89     // a meaningful accessible name, maybe set through ARIA), so we can use
90     // atk_component_grab_focus() to set the focus to it.
91     Node* node = renderObject->node();
92     if (node && node->hasTagName(HTMLNames::spanTag) && !canSetFocusAttribute() && !hasAttributesRequiredForInclusion())
93         return IgnoreObject;
94
95     // Given a paragraph or div containing a non-nested anonymous block, WebCore
96     // ignores the paragraph or div and includes the block. We want the opposite:
97     // ATs are expecting accessible objects associated with textual elements. They
98     // usually have no need for the anonymous block. And when the wrong objects
99     // get included or ignored, needed accessibility signals do not get emitted.
100     if (role == ParagraphRole || role == DivRole) {
101         // Don't call textUnderElement() here, because it's slow and it can
102         // crash when called while we're in the middle of a subtree being deleted.
103         if (!renderObject->firstChildSlow())
104             return DefaultBehavior;
105
106         if (!parent->renderer() || parent->renderer()->isAnonymousBlock())
107             return DefaultBehavior;
108
109         for (RenderObject* r = renderObject->firstChildSlow(); r; r = r->nextSibling()) {
110             if (r->isAnonymousBlock())
111                 return IncludeObject;
112         }
113     }
114
115     // Block spans result in objects of ATK_ROLE_PANEL which are almost always unwanted.
116     // However, if we ignore block spans whose parent is the body, the child controls
117     // will become immediate children of the ATK_ROLE_DOCUMENT_FRAME and any text will
118     // become text within the document frame itself. This ultimately may be what we want
119     // and would largely be consistent with what we see from Gecko. However, ignoring
120     // spans whose parent is the body changes the current behavior we see from WebCore.
121     // Until we have sufficient time to properly analyze these cases, we will defer to
122     // WebCore. We only check that the parent is not aria because we do not expect
123     // anonymous blocks which are aria-related to themselves have an aria role, nor
124     // have we encountered instances where the parent of an anonymous block also lacked
125     // an aria role but the grandparent had one.
126     if (renderObject && renderObject->isAnonymousBlock() && !parent->renderer()->isBody()
127         && parent->ariaRoleAttribute() == UnknownRole)
128         return IgnoreObject;
129
130     return DefaultBehavior;
131 }
132
133 AccessibilityObjectWrapper* AccessibilityObject::wrapper() const
134 {
135     return m_wrapper;
136 }
137
138 void AccessibilityObject::setWrapper(AccessibilityObjectWrapper* wrapper)
139 {
140     if (wrapper == m_wrapper)
141         return;
142
143     if (m_wrapper)
144         g_object_unref(m_wrapper);
145
146     m_wrapper = wrapper;
147
148     if (m_wrapper)
149         g_object_ref(m_wrapper);
150 }
151
152 bool AccessibilityObject::allowsTextRanges() const
153 {
154     // Check type for the AccessibilityObject.
155     if (isTextControl() || isWebArea() || isGroup() || isLink() || isHeading() || isListItem() || isTableCell())
156         return true;
157
158     // Check roles as the last fallback mechanism.
159     AccessibilityRole role = roleValue();
160     return role == ParagraphRole || role == LabelRole || role == DivRole || role == FormRole;
161 }
162
163 unsigned AccessibilityObject::getLengthForTextRange() const
164 {
165     unsigned textLength = text().length();
166
167     if (textLength)
168         return textLength;
169
170     // Gtk ATs need this for all text objects; not just text controls.
171     Node* node = this->node();
172     RenderObject* renderer = node ? node->renderer() : 0;
173     if (renderer && renderer->isText())
174         textLength = toRenderText(*renderer).textLength();
175
176     // Get the text length from the elements under the
177     // accessibility object if the value is still zero.
178     if (!textLength && allowsTextRanges())
179         textLength = textUnderElement(AccessibilityTextUnderElementMode(AccessibilityTextUnderElementMode::TextUnderElementModeIncludeAllChildren)).length();
180
181     return textLength;
182 }
183
184 } // namespace WebCore
185
186 #endif // HAVE(ACCESSIBILITY)