AX: WebKit needs heuristics to differentiate lists used for layout from semantic...
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityList.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 "AccessibilityList.h"
31
32 #include "AXObjectCache.h"
33 #include "HTMLNames.h"
34 #include "RenderListItem.h"
35 #include "RenderObject.h"
36 #include "RenderStyle.h"
37
38 namespace WebCore {
39     
40 using namespace HTMLNames;
41
42 AccessibilityList::AccessibilityList(RenderObject* renderer)
43     : AccessibilityRenderObject(renderer)
44 {
45 }
46
47 AccessibilityList::~AccessibilityList()
48 {
49 }
50
51 PassRefPtr<AccessibilityList> AccessibilityList::create(RenderObject* renderer)
52 {
53     return adoptRef(new AccessibilityList(renderer));
54 }
55
56 bool AccessibilityList::computeAccessibilityIsIgnored() const
57 {
58     return accessibilityIsIgnoredByDefault();
59 }
60     
61 bool AccessibilityList::isUnorderedList() const
62 {
63     if (!m_renderer)
64         return false;
65     
66     Node* node = m_renderer->node();
67
68     // The ARIA spec says the "list" role is supposed to mimic a UL or OL tag.
69     // Since it can't be both, it's probably OK to say that it's an un-ordered list.
70     // On the Mac, there's no distinction to the client.
71     if (ariaRoleAttribute() == ListRole)
72         return true;
73     
74     return node && node->hasTagName(ulTag);
75 }
76
77 bool AccessibilityList::isOrderedList() const
78 {
79     if (!m_renderer)
80         return false;
81
82     // ARIA says a directory is like a static table of contents, which sounds like an ordered list.
83     if (ariaRoleAttribute() == DirectoryRole)
84         return true;
85
86     Node* node = m_renderer->node();
87     return node && node->hasTagName(olTag);    
88 }
89
90 bool AccessibilityList::isDescriptionList() const
91 {
92     if (!m_renderer)
93         return false;
94     
95     Node* node = m_renderer->node();
96     return node && node->hasTagName(dlTag);
97 }
98
99 AccessibilityRole AccessibilityList::determineAccessibilityRole()
100 {
101     m_ariaRole = determineAriaRoleAttribute();
102     
103     // Directory is mapped to list for now, but does not adhere to the same heuristics.
104     if (ariaRoleAttribute() == DirectoryRole)
105         return ListRole;
106     
107     // Heuristic to determine if this list is being used for layout or for content.
108     //   1. If it's a named list, like ol or aria=list, then it's a list.
109     //      1a. Unless the list has no children, then it's not a list.
110     //   2. If it displays visible list markers, it's a list.
111     //   3. If it does not display list markers and has only one child, it's not a list.
112     //   4. If it does not have any listitem children, it's not a list.
113     //   5. Otherwise it's a list (for now).
114     
115     AccessibilityRole role = ListRole;
116     
117     // Temporarily set role so that we can query children (otherwise canHaveChildren returns false).
118     m_role = role;
119     
120     unsigned listItemCount = 0;
121     bool hasVisibleMarkers = false;
122
123     const auto& children = this->children();
124     // DescriptionLists are always semantically a description list, so do not apply heuristics.
125     if (isDescriptionList() && children.size())
126         return DescriptionListRole;
127
128     for (const auto& child : children) {
129         if (child->ariaRoleAttribute() == ListItemRole)
130             listItemCount++;
131         else if (child->roleValue() == ListItemRole) {
132             RenderObject* listItem = child->renderer();
133             if (listItem && listItem->isListItem()) {
134                 if (listItem->style().listStyleType() != NoneListStyle || listItem->style().listStyleImage())
135                     hasVisibleMarkers = true;
136                 listItemCount++;
137             }
138         }
139     }
140     
141     bool unorderedList = isUnorderedList();
142     // Non <ul> lists and ARIA lists only need to have one child.
143     // <ul> lists need to have 1 child, or visible markers.
144     if (!unorderedList || ariaRoleAttribute() != UnknownRole) {
145         if (!listItemCount)
146             role = GroupRole;
147     } else if (unorderedList && listItemCount <= 1 && !hasVisibleMarkers)
148         role = GroupRole;
149
150     return role;
151 }
152     
153 AccessibilityRole AccessibilityList::roleValue() const
154 {
155     ASSERT(m_role != UnknownRole);
156     return m_role;
157 }
158     
159 } // namespace WebCore