AccessibilityARIAGrid does not compile when accessibility is disabled
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityARIAGrid.cpp
1 /*
2  * Copyright (C) 2009 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 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 "AccessibilityARIAGrid.h"
31
32 #include "AXObjectCache.h"
33 #include "AccessibilityARIAGridRow.h"
34 #include "AccessibilityTableCell.h"
35 #include "AccessibilityTableColumn.h"
36 #include "AccessibilityTableHeaderContainer.h"
37 #include "AccessibilityTableRow.h"
38 #include "AccessibleNode.h"
39 #include "RenderObject.h"
40 #include "RenderTableSection.h"
41
42 namespace WebCore {
43
44 AccessibilityARIAGrid::AccessibilityARIAGrid(RenderObject* renderer)
45     : AccessibilityTable(renderer)
46 {
47 }
48
49 AccessibilityARIAGrid::~AccessibilityARIAGrid() = default;
50
51 Ref<AccessibilityARIAGrid> AccessibilityARIAGrid::create(RenderObject* renderer)
52 {
53     return adoptRef(*new AccessibilityARIAGrid(renderer));
54 }
55
56 bool AccessibilityARIAGrid::addTableCellChild(AccessibilityObject* child, HashSet<AccessibilityObject*>& appendedRows, unsigned& columnCount)
57 {
58     if (!child || (!is<AccessibilityTableRow>(*child) && !is<AccessibilityARIAGridRow>(*child)))
59         return false;
60         
61     auto& row = downcast<AccessibilityTableRow>(*child);
62     if (appendedRows.contains(&row))
63         return false;
64         
65     // store the maximum number of columns
66     unsigned rowCellCount = row.children().size();
67     if (rowCellCount > columnCount)
68         columnCount = rowCellCount;
69     
70     row.setRowIndex((int)m_rows.size());
71     m_rows.append(&row);
72
73     // Try adding the row if it's not ignoring accessibility,
74     // otherwise add its children (the cells) as the grid's children.
75     if (!row.accessibilityIsIgnored())
76         m_children.append(&row);
77     else
78         m_children.appendVector(row.children());
79
80     appendedRows.add(&row);
81     return true;
82 }
83
84 bool AccessibilityARIAGrid::isMultiSelectable() const
85 {
86     auto multiSelectable = boolValueForProperty(AXPropertyName::Multiselectable);
87     if (multiSelectable && !multiSelectable.value())
88         return false;
89     return true;
90 }
91
92 void AccessibilityARIAGrid::addRowDescendant(AccessibilityObject* rowChild, HashSet<AccessibilityObject*>& appendedRows, unsigned& columnCount)
93 {
94     if (!rowChild)
95         return;
96
97     if (!rowChild->isTableRow() || !rowChild->node()) {
98         // Although a "grid" should have rows as its direct descendants, if this is not a table row,
99         // or this row is anonymous, dive deeper into the descendants to try to find a valid row.
100         for (const auto& child : rowChild->children())
101             addRowDescendant(child.get(), appendedRows, columnCount);
102     } else
103         addTableCellChild(rowChild, appendedRows, columnCount);
104 }
105
106 void AccessibilityARIAGrid::addChildren()
107 {
108     ASSERT(!m_haveChildren); 
109     
110     if (!isExposableThroughAccessibility()) {
111         AccessibilityRenderObject::addChildren();
112         return;
113     }
114     
115     m_haveChildren = true;
116     if (!m_renderer)
117         return;
118     
119     AXObjectCache* axCache = m_renderer->document().axObjectCache();
120     
121     // Add the children rows but be mindful in case there are footer sections in this table.
122     HashSet<AccessibilityObject*> appendedRows;
123     unsigned columnCount = 0;
124     AccessibilityChildrenVector footerSections;
125     for (RefPtr<AccessibilityObject> child = firstChild(); child; child = child->nextSibling()) {
126         bool footerSection = false;
127         if (RenderObject* childRenderer = child->renderer()) {
128             if (is<RenderTableSection>(*childRenderer)) {
129                 RenderTableSection& childSection = downcast<RenderTableSection>(*childRenderer);
130                 if (&childSection == childSection.table()->footer()) {
131                     footerSections.append(child);
132                     footerSection = true;
133                 }
134             }
135         }
136         if (!footerSection)
137             addRowDescendant(child.get(), appendedRows, columnCount);
138     }
139     
140     for (const auto& footerSection : footerSections)
141         addRowDescendant(footerSection.get(), appendedRows, columnCount);
142     
143     // make the columns based on the number of columns in the first body
144     for (unsigned i = 0; i < columnCount; ++i) {
145         auto& column = downcast<AccessibilityTableColumn>(*axCache->getOrCreate(AccessibilityRole::Column));
146         column.setColumnIndex(static_cast<int>(i));
147         column.setParent(this);
148         m_columns.append(&column);
149         if (!column.accessibilityIsIgnored())
150             m_children.append(&column);
151     }
152     
153     AccessibilityObject* headerContainerObject = headerContainer();
154     if (headerContainerObject && !headerContainerObject->accessibilityIsIgnored())
155         m_children.append(headerContainerObject);
156 }
157     
158 } // namespace WebCore