Use is<>() / downcast<>() for Accessibility objects
[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 "AccessibilityTableCell.h"
34 #include "AccessibilityTableColumn.h"
35 #include "AccessibilityTableHeaderContainer.h"
36 #include "AccessibilityTableRow.h"
37 #include "RenderObject.h"
38 #include "RenderTableSection.h"
39
40 namespace WebCore {
41
42 AccessibilityARIAGrid::AccessibilityARIAGrid(RenderObject* renderer)
43     : AccessibilityTable(renderer)
44 {
45 }
46
47 AccessibilityARIAGrid::~AccessibilityARIAGrid()
48 {
49 }
50
51 PassRefPtr<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 void AccessibilityARIAGrid::addRowDescendant(AccessibilityObject* rowChild, HashSet<AccessibilityObject*>& appendedRows, unsigned& columnCount)
85 {
86     if (!rowChild)
87         return;
88
89     if (!rowChild->isTableRow()) {
90         // Although a "grid" should have rows as its direct descendants, if this is not a table row,
91         // dive deeper into the descendants to try to find a valid row.
92         for (const auto& child : rowChild->children())
93             addRowDescendant(child.get(), appendedRows, columnCount);
94     } else
95         addTableCellChild(rowChild, appendedRows, columnCount);
96 }
97
98 void AccessibilityARIAGrid::addChildren()
99 {
100     ASSERT(!m_haveChildren); 
101     
102     if (!isAccessibilityTable()) {
103         AccessibilityRenderObject::addChildren();
104         return;
105     }
106     
107     m_haveChildren = true;
108     if (!m_renderer)
109         return;
110     
111     AXObjectCache* axCache = m_renderer->document().axObjectCache();
112     
113     // Add the children rows but be mindful in case there are footer sections in this table.
114     HashSet<AccessibilityObject*> appendedRows;
115     unsigned columnCount = 0;
116     AccessibilityChildrenVector footerSections;
117     for (RefPtr<AccessibilityObject> child = firstChild(); child; child = child->nextSibling()) {
118         bool footerSection = false;
119         if (RenderObject* childRenderer = child->renderer()) {
120             if (is<RenderTableSection>(*childRenderer)) {
121                 RenderTableSection& childSection = downcast<RenderTableSection>(*childRenderer);
122                 if (&childSection == childSection.table()->footer()) {
123                     footerSections.append(child);
124                     footerSection = true;
125                 }
126             }
127         }
128         if (!footerSection)
129             addRowDescendant(child.get(), appendedRows, columnCount);
130     }
131     
132     for (const auto& footerSection : footerSections)
133         addRowDescendant(footerSection.get(), appendedRows, columnCount);
134     
135     // make the columns based on the number of columns in the first body
136     for (unsigned i = 0; i < columnCount; ++i) {
137         auto& column = downcast<AccessibilityTableColumn>(*axCache->getOrCreate(ColumnRole));
138         column.setColumnIndex(static_cast<int>(i));
139         column.setParent(this);
140         m_columns.append(&column);
141         if (!column.accessibilityIsIgnored())
142             m_children.append(&column);
143     }
144     
145     AccessibilityObject* headerContainerObject = headerContainer();
146     if (headerContainerObject && !headerContainerObject->accessibilityIsIgnored())
147         m_children.append(headerContainerObject);
148 }
149     
150 } // namespace WebCore