accessible/base/HTMLMarkupMap.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:expandtab:shiftwidth=2:tabstop=2:
   3  */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 MARKUPMAP(
   9     a,
  10     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
  11       // An anchor element without an href attribute and without a click
  12       // listener should be a generic.
  13       if (!aElement->HasAttr(nsGkAtoms::href) &&
  14           !nsCoreUtils::HasClickListener(aElement)) {
  15         return new HyperTextAccessible(aElement, aContext->Document());
  16       }
  17       // Only some roles truly enjoy life as HTMLLinkAccessibles, for
  18       // details see closed bug 494807.
  19       const nsRoleMapEntry* roleMapEntry = aria::GetRoleMap(aElement);
  20       if (roleMapEntry && roleMapEntry->role != roles::NOTHING &&
  21           roleMapEntry->role != roles::LINK) {
  22         return new HyperTextAccessible(aElement, aContext->Document());
  23       }
  24
  25       return new HTMLLinkAccessible(aElement, aContext->Document());
  26     },
  27     0)
  28
  29 MARKUPMAP(abbr, New_HyperText, 0)
  30
  31 MARKUPMAP(acronym, New_HyperText, 0)
  32
  33 MARKUPMAP(address, New_HyperText, roles::GROUPING)
  34
  35 MARKUPMAP(article, New_HyperText, roles::ARTICLE, Attr(xmlroles, article))
  36
  37 MARKUPMAP(
  38     aside,
  39     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
  40       return new HTMLAsideAccessible(aElement, aContext->Document());
  41     },
  42     0)
  43
  44 MARKUPMAP(blockquote, New_HyperText, roles::BLOCKQUOTE)
  45
  46 MARKUPMAP(
  47     button,
  48     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
  49       return new HTMLButtonAccessible(aElement, aContext->Document());
  50     },
  51     0)
  52
  53 MARKUPMAP(
  54     caption,
  55     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
  56       if (aContext->IsTable()) {
  57         dom::HTMLTableElement* tableEl =
  58             dom::HTMLTableElement::FromNode(aContext->GetContent());
  59         if (tableEl && tableEl == aElement->GetParent() &&
  60             tableEl->GetCaption() == aElement) {
  61           return new HTMLCaptionAccessible(aElement, aContext->Document());
  62         }
  63       }
  64       return nullptr;
  65     },
  66     0)
  67
  68 MARKUPMAP(code, New_HyperText, roles::CODE)
  69
  70 MARKUPMAP(dd, New_HTMLDtOrDd<HyperTextAccessible>, roles::DEFINITION)
  71
  72 MARKUPMAP(del, New_HyperText, roles::CONTENT_DELETION)
  73
  74 MARKUPMAP(details, New_HyperText, roles::DETAILS)
  75
  76 MARKUPMAP(dfn, New_HyperText, roles::TERM)
  77
  78 MARKUPMAP(dialog, New_HyperText, roles::DIALOG)
  79
  80 MARKUPMAP(
  81     div,
  82     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
  83       // Never create an accessible if we're part of an anonymous
  84       // subtree.
  85       if (aElement->IsInNativeAnonymousSubtree()) {
  86         return nullptr;
  87       }
  88       // Always create an accessible if the div has an id.
  89       if (aElement->HasAttr(nsGkAtoms::id)) {
  90         return new HyperTextAccessible(aElement, aContext->Document());
  91       }
  92       // Never create an accessible if the div is not display:block; or
  93       // display:inline-block or the like.
  94       nsIFrame* f = aElement->GetPrimaryFrame();
  95       if (!f || !f->IsBlockFrameOrSubclass()) {
  96         return nullptr;
  97       }
  98       // Check for various conditions to determine if this is a block
  99       // break and needs to be rendered.
 100       // If its previous sibling is an inline element, we probably want
 101       // to break, so render.
 102       // FIXME: This looks extremely incorrect in presence of shadow DOM,
 103       // display: contents, and what not.
 104       nsIContent* prevSibling = aElement->GetPreviousSibling();
 105       if (prevSibling) {
 106         nsIFrame* prevSiblingFrame = prevSibling->GetPrimaryFrame();
 107         if (prevSiblingFrame && prevSiblingFrame->IsInlineOutside()) {
 108           return new HyperTextAccessible(aElement, aContext->Document());
 109         }
 110       }
 111       // Now, check the children.
 112       nsIContent* firstChild = aElement->GetFirstChild();
 113       if (firstChild) {
 114         nsIFrame* firstChildFrame = firstChild->GetPrimaryFrame();
 115         if (!firstChildFrame) {
 116           // The first child is invisible, but this might be due to an
 117           // invisible text node. Try the next.
 118           firstChild = firstChild->GetNextSibling();
 119           if (!firstChild) {
 120             // If there's no next sibling, there's only one child, so there's
 121             // nothing more we can do.
 122             return nullptr;
 123           }
 124           firstChildFrame = firstChild->GetPrimaryFrame();
 125         }
 126         // Check to see if first child has an inline frame.
 127         if (firstChildFrame && firstChildFrame->IsInlineOutside()) {
 128           return new HyperTextAccessible(aElement, aContext->Document());
 129         }
 130         nsIContent* lastChild = aElement->GetLastChild();
 131         MOZ_ASSERT(lastChild);
 132         if (lastChild != firstChild) {
 133           nsIFrame* lastChildFrame = lastChild->GetPrimaryFrame();
 134           if (!lastChildFrame) {
 135             // The last child is invisible, but this might be due to an
 136             // invisible text node. Try the next.
 137             lastChild = lastChild->GetPreviousSibling();
 138             MOZ_ASSERT(lastChild);
 139             if (lastChild == firstChild) {
 140               return nullptr;
 141             }
 142             lastChildFrame = lastChild->GetPrimaryFrame();
 143           }
 144           // Check to see if last child has an inline frame.
 145           if (lastChildFrame && lastChildFrame->IsInlineOutside()) {
 146             return new HyperTextAccessible(aElement, aContext->Document());
 147           }
 148         }
 149       }
 150       return nullptr;
 151     },
 152     roles::SECTION)
 153
 154 MARKUPMAP(
 155     dl,
 156     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 157       return new HTMLListAccessible(aElement, aContext->Document());
 158     },
 159     roles::DEFINITION_LIST)
 160
 161 MARKUPMAP(dt, New_HTMLDtOrDd<HTMLLIAccessible>, roles::TERM)
 162
 163 MARKUPMAP(em, New_HyperText, roles::EMPHASIS)
 164
 165 MARKUPMAP(
 166     figcaption,
 167     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 168       return new HTMLFigcaptionAccessible(aElement, aContext->Document());
 169     },
 170     roles::CAPTION)
 171
 172 MARKUPMAP(
 173     figure,
 174     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 175       return new HTMLFigureAccessible(aElement, aContext->Document());
 176     },
 177     roles::FIGURE, Attr(xmlroles, figure))
 178
 179 MARKUPMAP(
 180     fieldset,
 181     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 182       return new HTMLGroupboxAccessible(aElement, aContext->Document());
 183     },
 184     0)
 185
 186 MARKUPMAP(
 187     form,
 188     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 189       return new HTMLFormAccessible(aElement, aContext->Document());
 190     },
 191     0)
 192
 193 MARKUPMAP(
 194     footer,
 195     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 196       return new HTMLHeaderOrFooterAccessible(aElement, aContext->Document());
 197     },
 198     0)
 199
 200 MARKUPMAP(
 201     header,
 202     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 203       return new HTMLHeaderOrFooterAccessible(aElement, aContext->Document());
 204     },
 205     0)
 206
 207 MARKUPMAP(h1, New_HyperText, roles::HEADING)
 208
 209 MARKUPMAP(h2, New_HyperText, roles::HEADING)
 210
 211 MARKUPMAP(h3, New_HyperText, roles::HEADING)
 212
 213 MARKUPMAP(h4, New_HyperText, roles::HEADING)
 214
 215 MARKUPMAP(h5, New_HyperText, roles::HEADING)
 216
 217 MARKUPMAP(h6, New_HyperText, roles::HEADING)
 218
 219 MARKUPMAP(hgroup, New_HyperText, roles::GROUPING)
 220
 221 MARKUPMAP(
 222     hr,
 223     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 224       return new HTMLHRAccessible(aElement, aContext->Document());
 225     },
 226     0)
 227
 228 MARKUPMAP(
 229     input,
 230     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 231       // TODO(emilio): This would be faster if it used
 232       // HTMLInputElement's already-parsed representation.
 233       if (aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 234                                 nsGkAtoms::checkbox, eIgnoreCase)) {
 235         return new CheckboxAccessible(aElement, aContext->Document());
 236       }
 237       if (aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 238                                 nsGkAtoms::image, eIgnoreCase)) {
 239         return new HTMLButtonAccessible(aElement, aContext->Document());
 240       }
 241       if (aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 242                                 nsGkAtoms::radio, eIgnoreCase)) {
 243         return new HTMLRadioButtonAccessible(aElement, aContext->Document());
 244       }
 245       if (aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 246                                 nsGkAtoms::time, eIgnoreCase)) {
 247         return new HTMLDateTimeAccessible<roles::TIME_EDITOR>(
 248             aElement, aContext->Document());
 249       }
 250       if (aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 251                                 nsGkAtoms::date, eIgnoreCase) ||
 252           aElement->AttrValueIs(kNameSpaceID_None, nsGkAtoms::type,
 253                                 nsGkAtoms::datetime_local, eIgnoreCase)) {
 254         return new HTMLDateTimeAccessible<roles::DATE_EDITOR>(
 255             aElement, aContext->Document());
 256       }
 257       return nullptr;
 258     },
 259     0)
 260
 261 MARKUPMAP(ins, New_HyperText, roles::CONTENT_INSERTION)
 262
 263 MARKUPMAP(
 264     label,
 265     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 266       return new HTMLLabelAccessible(aElement, aContext->Document());
 267     },
 268     roles::LABEL)
 269
 270 MARKUPMAP(
 271     legend,
 272     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 273       return new HTMLLegendAccessible(aElement, aContext->Document());
 274     },
 275     roles::LABEL)
 276
 277 MARKUPMAP(
 278     li,
 279     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 280       // If list item is a child of accessible list then create an
 281       // accessible for it unconditionally by tag name. nsBlockFrame
 282       // creates the list item accessible for other elements styled as
 283       // list items.
 284       if (aContext->IsList() &&
 285           aContext->GetContent() == aElement->GetParent()) {
 286         return new HTMLLIAccessible(aElement, aContext->Document());
 287       }
 288
 289       return nullptr;
 290     },
 291     0)
 292
 293 MARKUPMAP(main, New_HyperText, roles::LANDMARK)
 294
 295 MARKUPMAP(map, nullptr, roles::TEXT_CONTAINER)
 296
 297 MARKUPMAP(mark, New_HyperText, roles::MARK, Attr(xmlroles, mark))
 298
 299 MARKUPMAP(
 300     menu,
 301     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 302       return new HTMLListAccessible(aElement, aContext->Document());
 303     },
 304     roles::LIST)
 305
 306 MARKUPMAP(nav, New_HyperText, roles::LANDMARK)
 307
 308 MARKUPMAP(
 309     ol,
 310     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 311       return new HTMLListAccessible(aElement, aContext->Document());
 312     },
 313     roles::LIST)
 314
 315 MARKUPMAP(
 316     option,
 317     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 318       return new HTMLSelectOptionAccessible(aElement, aContext->Document());
 319     },
 320     0)
 321
 322 MARKUPMAP(
 323     optgroup,
 324     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 325       return new HTMLSelectOptGroupAccessible(aElement, aContext->Document());
 326     },
 327     0)
 328
 329 MARKUPMAP(
 330     output,
 331     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 332       return new HTMLOutputAccessible(aElement, aContext->Document());
 333     },
 334     roles::STATUSBAR, Attr(aria_live, polite))
 335
 336 MARKUPMAP(p, nullptr, roles::PARAGRAPH)
 337
 338 MARKUPMAP(
 339     progress,
 340     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 341       return new HTMLProgressAccessible(aElement, aContext->Document());
 342     },
 343     0)
 344
 345 MARKUPMAP(q, New_HyperText, 0)
 346
 347 MARKUPMAP(s, New_HyperText, roles::CONTENT_DELETION)
 348
 349 MARKUPMAP(
 350     section,
 351     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 352       return new HTMLSectionAccessible(aElement, aContext->Document());
 353     },
 354     0)
 355
 356 MARKUPMAP(strong, New_HyperText, roles::STRONG)
 357
 358 MARKUPMAP(sub, New_HyperText, roles::SUBSCRIPT)
 359
 360 MARKUPMAP(
 361     summary,
 362     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 363       return new HTMLSummaryAccessible(aElement, aContext->Document());
 364     },
 365     roles::SUMMARY)
 366
 367 MARKUPMAP(sup, New_HyperText, roles::SUPERSCRIPT)
 368
 369 MARKUPMAP(
 370     table,
 371     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 372       return new HTMLTableAccessible(aElement, aContext->Document());
 373     },
 374     roles::TABLE)
 375
 376 MARKUPMAP(time, New_HyperText, roles::TIME, Attr(xmlroles, time),
 377           AttrFromDOM(datetime, datetime))
 378
 379 MARKUPMAP(tbody, nullptr, roles::ROWGROUP)
 380
 381 MARKUPMAP(
 382     td,
 383     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 384       if (!aContext->IsHTMLTableRow()) {
 385         return nullptr;
 386       }
 387       if (aElement->HasAttr(nsGkAtoms::scope)) {
 388         return new HTMLTableHeaderCellAccessible(aElement,
 389                                                  aContext->Document());
 390       }
 391       return new HTMLTableCellAccessible(aElement, aContext->Document());
 392     },
 393     0)
 394
 395 MARKUPMAP(tfoot, nullptr, roles::ROWGROUP)
 396
 397 MARKUPMAP(
 398     th,
 399     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 400       if (!aContext->IsHTMLTableRow()) {
 401         return nullptr;
 402       }
 403       return new HTMLTableHeaderCellAccessible(aElement, aContext->Document());
 404     },
 405     0)
 406
 407 MARKUPMAP(thead, nullptr, roles::ROWGROUP)
 408
 409 MARKUPMAP(
 410     tr,
 411     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 412       if (aContext->IsTableRow()) {
 413         // A <tr> within a row isn't valid.
 414         return nullptr;
 415       }
 416       const nsRoleMapEntry* roleMapEntry = aria::GetRoleMap(aElement);
 417       if (roleMapEntry && roleMapEntry->role != roles::NOTHING &&
 418           roleMapEntry->role != roles::ROW) {
 419         // There is a valid ARIA role which isn't "row". Don't treat this as an
 420         // HTML table row.
 421         return nullptr;
 422       }
 423       // Check if this <tr> is within a table. We check the grandparent because
 424       // it might be inside a rowgroup. We don't specifically check for an HTML
 425       // table because there are cases where there is a <tr> inside a
 426       // <div role="table"> such as Monorail.
 427       if (aContext->IsTable() ||
 428           (aContext->LocalParent() && aContext->LocalParent()->IsTable())) {
 429         return new HTMLTableRowAccessible(aElement, aContext->Document());
 430       }
 431       return nullptr;
 432     },
 433     roles::ROW)
 434
 435 MARKUPMAP(
 436     ul,
 437     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 438       return new HTMLListAccessible(aElement, aContext->Document());
 439     },
 440     roles::LIST)
 441
 442 MARKUPMAP(
 443     meter,
 444     [](Element* aElement, LocalAccessible* aContext) -> LocalAccessible* {
 445       return new HTMLMeterAccessible(aElement, aContext->Document());
 446     },
 447     roles::METER)
 448
 449 MARKUPMAP(search, New_HyperText, roles::LANDMARK)