0e78b36b4f4ab63ca9c054a7545cb33b9ae59f41
[WebKit-https.git] / Source / WebCore / accessibility / AccessibilityTableCell.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 "AccessibilityTableCell.h"
31
32 #include "AXObjectCache.h"
33 #include "HTMLNames.h"
34 #include "RenderObject.h"
35 #include "RenderTableCell.h"
36
37 using namespace std;
38
39 namespace WebCore {
40     
41 using namespace HTMLNames;
42
43 AccessibilityTableCell::AccessibilityTableCell(RenderObject* renderer)
44     : AccessibilityRenderObject(renderer)
45 {
46 }
47
48 AccessibilityTableCell::~AccessibilityTableCell()
49 {
50 }
51
52 PassRefPtr<AccessibilityTableCell> AccessibilityTableCell::create(RenderObject* renderer)
53 {
54     return adoptRef(new AccessibilityTableCell(renderer));
55 }
56
57 bool AccessibilityTableCell::computeAccessibilityIsIgnored() const
58 {
59     AccessibilityObjectInclusion decision = accessibilityIsIgnoredBase();
60     if (decision == IncludeObject)
61         return false;
62     if (decision == IgnoreObject)
63         return true;
64     
65     if (!isTableCell())
66         return AccessibilityRenderObject::computeAccessibilityIsIgnored();
67     
68     return false;
69 }
70    
71 AccessibilityObject* AccessibilityTableCell::parentTable() const
72 {
73     if (!m_renderer || !m_renderer->isTableCell())
74         return 0;
75
76     // If the document no longer exists, we might not have an axObjectCache.
77     if (!axObjectCache())
78         return 0;
79     
80     // Do not use getOrCreate. parentTable() can be called while the render tree is being modified 
81     // by javascript, and creating a table element may try to access the render tree while in a bad state.
82     // By using only get() implies that the AXTable must be created before AXTableCells. This should
83     // always be the case when AT clients access a table.
84     // https://bugs.webkit.org/show_bug.cgi?id=42652    
85     return axObjectCache()->get(toRenderTableCell(m_renderer)->table());
86 }
87     
88 bool AccessibilityTableCell::isTableCell() const
89 {
90     AccessibilityObject* parent = parentObjectUnignored();
91     if (!parent || !parent->isTableRow())
92         return false;
93     
94     return true;
95 }
96     
97 AccessibilityRole AccessibilityTableCell::determineAccessibilityRole()
98 {
99     if (!isTableCell())
100         return AccessibilityRenderObject::determineAccessibilityRole();
101     
102     return CellRole;
103 }
104     
105 void AccessibilityTableCell::rowIndexRange(pair<unsigned, unsigned>& rowRange)
106 {
107     if (!m_renderer || !m_renderer->isTableCell())
108         return;
109     
110     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
111     rowRange.first = renderCell->rowIndex();
112     rowRange.second = renderCell->rowSpan();
113     
114     // since our table might have multiple sections, we have to offset our row appropriately
115     RenderTableSection* section = renderCell->section();
116     RenderTable* table = renderCell->table();
117     if (!table || !section)
118         return;
119
120     RenderTableSection* tableSection = table->topSection();    
121     unsigned rowOffset = 0;
122     while (tableSection) {
123         if (tableSection == section)
124             break;
125         rowOffset += tableSection->numRows();
126         tableSection = table->sectionBelow(tableSection, SkipEmptySections);
127     }
128
129     rowRange.first += rowOffset;
130 }
131     
132 void AccessibilityTableCell::columnIndexRange(pair<unsigned, unsigned>& columnRange)
133 {
134     if (!m_renderer || !m_renderer->isTableCell())
135         return;
136     
137     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
138     columnRange.first = renderCell->col();
139     columnRange.second = renderCell->colSpan();    
140 }
141     
142 AccessibilityObject* AccessibilityTableCell::titleUIElement() const
143 {
144     // Try to find if the first cell in this row is a <th>. If it is,
145     // then it can act as the title ui element. (This is only in the
146     // case when the table is not appearing as an AXTable.)
147     if (isTableCell() || !m_renderer || !m_renderer->isTableCell())
148         return 0;
149
150     // Table cells that are th cannot have title ui elements, since by definition
151     // they are title ui elements
152     Node* node = m_renderer->node();
153     if (node && node->hasTagName(thTag))
154         return 0;
155     
156     RenderTableCell* renderCell = toRenderTableCell(m_renderer);
157
158     // If this cell is in the first column, there is no need to continue.
159     int col = renderCell->col();
160     if (!col)
161         return 0;
162
163     int row = renderCell->rowIndex();
164
165     RenderTableSection* section = renderCell->section();
166     if (!section)
167         return 0;
168     
169     RenderTableCell* headerCell = section->primaryCellAt(row, 0);
170     if (!headerCell || headerCell == renderCell)
171         return 0;
172
173     Node* cellElement = headerCell->node();
174     if (!cellElement || !cellElement->hasTagName(thTag))
175         return 0;
176     
177     return axObjectCache()->getOrCreate(headerCell);
178 }
179     
180 } // namespace WebCore