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 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 "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
  39 using namespace std;
  40
  41 namespace WebCore {
  42
  43 AccessibilityARIAGrid::AccessibilityARIAGrid(RenderObject* renderer)
  44     : AccessibilityTable(renderer)
  45 {
  46 #if ACCESSIBILITY_TABLES
  47     m_isAccessibilityTable = true;
  48 #else
  49     m_isAccessibilityTable = false;
  50 #endif
  51 }
  52
  53 AccessibilityARIAGrid::~AccessibilityARIAGrid()
  54 {
  55 }
  56
  57 PassRefPtr<AccessibilityARIAGrid> AccessibilityARIAGrid::create(RenderObject* renderer)
  58 {
  59     return adoptRef(new AccessibilityARIAGrid(renderer));
  60 }
  61
  62 bool AccessibilityARIAGrid::addChild(AccessibilityObject* child, HashSet<AccessibilityObject*>& appendedRows, unsigned& columnCount)
  63 {
  64     if (!child || !child->isTableRow() || child->ariaRoleAttribute() != RowRole)
  65         return false;
  66
  67     AccessibilityTableRow* row = static_cast<AccessibilityTableRow*>(child);
  68     if (appendedRows.contains(row))
  69         return false;
  70
  71     // store the maximum number of columns
  72     unsigned rowCellCount = row->children().size();
  73     if (rowCellCount > columnCount)
  74         columnCount = rowCellCount;
  75
  76     row->setRowIndex((int)m_rows.size());
  77     m_rows.append(row);
  78
  79     // Try adding the row if it's not ignoring accessibility,
  80     // otherwise add its children (the cells) as the grid's children.
  81     if (!row->accessibilityIsIgnored())
  82         m_children.append(row);
  83     else
  84         m_children.append(row->children());
  85
  86     appendedRows.add(row);
  87     return true;
  88 }
  89
  90 void AccessibilityARIAGrid::addChildren()
  91 {
  92     ASSERT(!m_haveChildren);
  93
  94     if (!isAccessibilityTable()) {
  95         AccessibilityRenderObject::addChildren();
  96         return;
  97     }
  98
  99     m_haveChildren = true;
 100     if (!m_renderer)
 101         return;
 102
 103     AXObjectCache* axCache = m_renderer->document()->axObjectCache();
 104
 105     // add only rows that are labeled as aria rows
 106     HashSet<AccessibilityObject*> appendedRows;
 107     unsigned columnCount = 0;
 108     for (RefPtr<AccessibilityObject> child = firstChild(); child; child = child->nextSibling()) {
 109
 110         if (!addChild(child.get(), appendedRows, columnCount)) {
 111
 112             // in case the render tree doesn't match the expected ARIA hierarchy, look at the children
 113             if (!child->hasChildren())
 114                 child->addChildren();
 115
 116             // The children of this non-row will contain all non-ignored elements (recursing to find them).
 117             // This allows the table to dive arbitrarily deep to find the rows.
 118             AccessibilityChildrenVector children = child->children();
 119             size_t length = children.size();
 120             for (size_t i = 0; i < length; ++i)
 121                 addChild(children[i].get(), appendedRows, columnCount);
 122         }
 123     }
 124
 125     // make the columns based on the number of columns in the first body
 126     for (unsigned i = 0; i < columnCount; ++i) {
 127         AccessibilityTableColumn* column = static_cast<AccessibilityTableColumn*>(axCache->getOrCreate(ColumnRole));
 128         column->setColumnIndex((int)i);
 129         column->setParentTable(this);
 130         m_columns.append(column);
 131         if (!column->accessibilityIsIgnored())
 132             m_children.append(column);
 133     }
 134
 135     AccessibilityObject* headerContainerObject = headerContainer();
 136     if (headerContainerObject && !headerContainerObject->accessibilityIsIgnored())
 137         m_children.append(headerContainerObject);
 138 }
 139
 140 AccessibilityTableCell* AccessibilityARIAGrid::cellForColumnAndRow(unsigned column, unsigned row)
 141 {
 142     if (!m_renderer)
 143         return 0;
 144
 145     updateChildrenIfNecessary();
 146
 147     if (column >= columnCount() || row >= rowCount())
 148         return 0;
 149
 150     int intRow = (int)row;
 151     int intColumn = (int)column;
 152
 153     pair<int, int> columnRange;
 154     pair<int, int> rowRange;
 155
 156     // Iterate backwards through the rows in case the desired cell has a rowspan and exists
 157     // in a previous row.
 158     for (; intRow >= 0; --intRow) {
 159         AccessibilityObject* tableRow = m_rows[intRow].get();
 160         if (!tableRow)
 161             continue;
 162
 163         AccessibilityChildrenVector children = tableRow->children();
 164         unsigned childrenLength = children.size();
 165
 166         // Since some cells may have colspans, we have to check the actual range of each
 167         // cell to determine which is the right one.
 168         for (unsigned k = 0; k < childrenLength; ++k) {
 169             AccessibilityObject* child = children[k].get();
 170             if (!child->isTableCell())
 171                 continue;
 172
 173             AccessibilityTableCell* tableCellChild = static_cast<AccessibilityTableCell*>(child);
 174             tableCellChild->columnIndexRange(columnRange);
 175             tableCellChild->rowIndexRange(rowRange);
 176
 177             if ((intColumn >= columnRange.first && intColumn < (columnRange.first + columnRange.second))
 178                 && (intRow >= rowRange.first && intRow < (rowRange.first + rowRange.second)))
 179                 return tableCellChild;
 180         }
 181     }
 182
 183     return 0;
 184 }
 185
 186 } // namespace WebCore