Source/WebCore/accessibility/AccessibilityObject.h

   1 /*
   2  * Copyright (C) 2008, 2009, 2011 Apple Inc. All rights reserved.
   3  * Copyright (C) 2008 Nuanti Ltd.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #pragma once
  31
  32 #include "AccessibilityObjectInterface.h"
  33 #include "FloatQuad.h"
  34 #include "LayoutRect.h"
  35 #include "Path.h"
  36 #include <wtf/Forward.h>
  37 #include <wtf/Function.h>
  38 #include <wtf/RefPtr.h>
  39 #include <wtf/Vector.h>
  40
  41 #if PLATFORM(COCOA)
  42 #include <wtf/RetainPtr.h>
  43 #endif
  44
  45 #if USE(ATK)
  46 #include <wtf/glib/GRefPtr.h>
  47 #endif
  48
  49 #if PLATFORM(COCOA)
  50
  51 OBJC_CLASS NSArray;
  52 OBJC_CLASS NSAttributedString;
  53 OBJC_CLASS NSData;
  54 OBJC_CLASS NSMutableAttributedString;
  55 OBJC_CLASS NSString;
  56 OBJC_CLASS NSValue;
  57 OBJC_CLASS NSView;
  58
  59 #endif
  60
  61 namespace WebCore {
  62
  63 class AccessibilityObject;
  64 class IntPoint;
  65 class IntSize;
  66 class ScrollableArea;
  67
  68 struct AccessibilityText {
  69     String text;
  70     AccessibilityTextSource textSource;
  71
  72     AccessibilityText(const String& t, const AccessibilityTextSource& s)
  73         : text(t)
  74         , textSource(s)
  75     { }
  76 };
  77
  78 bool nodeHasPresentationRole(Node*);
  79
  80 class AccessibilityObject : public AXCoreObject {
  81 public:
  82     virtual ~AccessibilityObject();
  83
  84     // After constructing an AccessibilityObject, it must be given a
  85     // unique ID, then added to AXObjectCache, and finally init() must
  86     // be called last.
  87     void setObjectID(AXID id) override { m_id = id; }
  88     void init() override { }
  89
  90     // Prefer using the dedicated functions over consuming these flag values directly, as the flags can sometimes be uninitialized.
  91     // Also, the dedicated functions traverse for you if the flags aren't yet initialized.
  92     // For example, use `hasDocumentRoleAncestor()` instead of `ancestorFlags().contains(AXAncestorFlag::HasDocumentRoleAncestor)`.
  93     OptionSet<AXAncestorFlag> ancestorFlags() const { return m_ancestorFlags; }
  94
  95     void addAncestorFlags(const OptionSet<AXAncestorFlag>& flags) { m_ancestorFlags.add(flags); }
  96     bool ancestorFlagsAreInitialized() const { return m_ancestorFlags.contains(AXAncestorFlag::FlagsInitialized); }
  97     // Computes the flags that this object matches (no traversal is done).
  98     OptionSet<AXAncestorFlag> computeAncestorFlags() const;
  99     // Computes the flags that this object and all ancestors match, traversing all the way to the root.
 100     OptionSet<AXAncestorFlag> computeAncestorFlagsWithTraversal() const;
 101     void initializeAncestorFlags(const OptionSet<AXAncestorFlag>&);
 102     bool hasAncestorMatchingFlag(AXAncestorFlag) const;
 103     bool matchesAncestorFlag(AXAncestorFlag) const;
 104
 105     bool hasDocumentRoleAncestor() const override;
 106     bool hasWebApplicationAncestor() const override;
 107     bool isInDescriptionListDetail() const override;
 108     bool isInDescriptionListTerm() const override;
 109     bool isInCell() const override;
 110
 111     bool isDetached() const override;
 112
 113     bool isAccessibilityNodeObject() const override { return false; }
 114     bool isAccessibilityRenderObject() const override { return false; }
 115     bool isAccessibilityScrollbar() const override { return false; }
 116     bool isAccessibilityScrollViewInstance() const override { return false; }
 117     bool isAXImageInstance() const override { return false; }
 118     bool isAccessibilitySVGRoot() const override { return false; }
 119     bool isAccessibilitySVGElement() const override { return false; }
 120     bool isAccessibilityTableInstance() const override { return false; }
 121     bool isAccessibilityTableColumnInstance() const override { return false; }
 122     bool isAccessibilityProgressIndicatorInstance() const override { return false; }
 123     bool isAccessibilityListBoxInstance() const override { return false; }
 124     bool isAXIsolatedObjectInstance() const override { return false; }
 125
 126     bool isAttachmentElement() const override { return false; }
 127     bool isHeading() const override { return false; }
 128     bool isLink() const override { return false; }
 129     bool isNativeImage() const override { return false; }
 130     bool isImageButton() const override { return false; }
 131     bool isPasswordField() const override { return false; }
 132     bool isContainedByPasswordField() const override;
 133     AccessibilityObject* passwordFieldOrContainingPasswordField() override { return nullptr; }
 134     bool isNativeTextControl() const override { return false; }
 135     bool isSearchField() const override { return false; }
 136     bool isListBoxOption() const override { return false; }
 137     bool isAttachment() const override { return false; }
 138     bool isMediaTimeline() const override { return false; }
 139     bool isMenuRelated() const override { return false; }
 140     bool isMenu() const override { return false; }
 141     bool isMenuBar() const override { return false; }
 142     bool isMenuButton() const override { return false; }
 143     bool isMenuItem() const override { return false; }
 144     bool isFileUploadButton() const override;
 145     bool isInputImage() const override { return false; }
 146     bool isProgressIndicator() const override { return false; }
 147     bool isSlider() const override { return false; }
 148     bool isSliderThumb() const override { return false; }
 149     bool isInputSlider() const override { return false; }
 150     bool isControl() const override { return false; }
 151     bool isLabel() const override { return false; }
 152
 153     bool isList() const override { return false; }
 154     bool isUnorderedList() const override { return false; }
 155     bool isOrderedList() const override { return false; }
 156     bool isDescriptionList() const override { return false; }
 157
 158     // Table support.
 159     bool isTable() const override { return false; }
 160     bool isExposable() const override { return true; }
 161     bool isDataTable() const override { return false; }
 162     int tableLevel() const override { return 0; }
 163     bool supportsSelectedRows() const override { return false; }
 164     AccessibilityChildrenVector columns() override { return AccessibilityChildrenVector(); }
 165     AccessibilityChildrenVector rows() override { return AccessibilityChildrenVector(); }
 166     unsigned columnCount() override { return 0; }
 167     unsigned rowCount() override { return 0; }
 168     AccessibilityChildrenVector cells() override { return AccessibilityChildrenVector(); }
 169     AXCoreObject* cellForColumnAndRow(unsigned, unsigned) override { return nullptr; }
 170     AccessibilityChildrenVector columnHeaders() override { return AccessibilityChildrenVector(); }
 171     AccessibilityChildrenVector rowHeaders() override { return AccessibilityChildrenVector(); }
 172     AccessibilityChildrenVector visibleRows() override { return AccessibilityChildrenVector(); }
 173     AXCoreObject* headerContainer() override { return nullptr; }
 174     int axColumnCount() const override { return 0; }
 175     int axRowCount() const override { return 0; }
 176
 177     // Table cell support.
 178     bool isTableCell() const override { return false; }
 179     // Returns the start location and row span of the cell.
 180     std::pair<unsigned, unsigned> rowIndexRange() const override { return { 0, 1 }; }
 181     // Returns the start location and column span of the cell.
 182     std::pair<unsigned, unsigned> columnIndexRange() const override { return { 0, 1 }; }
 183     bool isColumnHeaderCell() const override { return false; }
 184     bool isRowHeaderCell() const override { return false; }
 185     int axColumnIndex() const override { return -1; }
 186     int axRowIndex() const override { return -1; }
 187
 188     // Table column support.
 189     bool isTableColumn() const override { return false; }
 190     unsigned columnIndex() const override { return 0; }
 191     AXCoreObject* columnHeader() override { return nullptr; }
 192
 193     // Table row support.
 194     bool isTableRow() const override { return false; }
 195     unsigned rowIndex() const override { return 0; }
 196
 197     // ARIA tree/grid row support.
 198     bool isARIATreeGridRow() const override { return false; }
 199     AccessibilityChildrenVector disclosedRows() override; // ARIATreeItem implementation. AccessibilityARIAGridRow overrides this method.
 200     AXCoreObject* disclosedByRow() const override { return nullptr; }
 201
 202     bool isFieldset() const override { return false; }
 203     bool isGroup() const override { return false; }
 204     bool isImageMapLink() const override { return false; }
 205     bool isMenuList() const override { return false; }
 206     bool isMenuListPopup() const override { return false; }
 207     bool isMenuListOption() const override { return false; }
 208     bool isNativeSpinButton() const override { return false; }
 209     AXCoreObject* incrementButton() override { return nullptr; }
 210     AXCoreObject* decrementButton() override { return nullptr; }
 211     bool isSpinButtonPart() const override { return false; }
 212     bool isIncrementor() const override { return false; }
 213     bool isMockObject() const override { return false; }
 214     virtual bool isMediaControlLabel() const { return false; }
 215     bool isMediaObject() const override { return false; }
 216     bool isTextControl() const override;
 217     bool isARIATextControl() const override;
 218     bool isNonNativeTextControl() const override;
 219     bool isButton() const override;
 220     bool isLandmark() const override;
 221     bool isRangeControl() const override;
 222     bool isMeter() const override;
 223     bool isStyleFormatGroup() const override;
 224     bool isFigureElement() const override;
 225     bool isKeyboardFocusable() const override;
 226     bool isOutput() const override;
 227
 228     bool isChecked() const override { return false; }
 229     bool isEnabled() const override { return false; }
 230     bool isSelected() const override { return false; }
 231     bool isFocused() const override { return false; }
 232     bool isHovered() const override { return false; }
 233     bool isIndeterminate() const override { return false; }
 234     bool isLoaded() const override { return false; }
 235     bool isMultiSelectable() const override { return false; }
 236     bool isOffScreen() const override { return false; }
 237     bool isPressed() const override { return false; }
 238     bool isUnvisited() const override { return false; }
 239     bool isVisited() const override { return false; }
 240     bool isRequired() const override { return false; }
 241     bool supportsRequiredAttribute() const override { return false; }
 242     bool isLinked() const override { return false; }
 243     bool isExpanded() const override;
 244     bool isVisible() const override { return true; }
 245     bool isCollapsed() const override { return false; }
 246     void setIsExpanded(bool) override { }
 247     FloatRect relativeFrame() const override;
 248     FloatRect convertFrameToSpace(const FloatRect&, AccessibilityConversionSpace) const override;
 249     HashMap<String, AXEditingStyleValueVariant> resolvedEditingStyles() const override;
 250
 251     // In a multi-select list, many items can be selected but only one is active at a time.
 252     bool isSelectedOptionActive() const override { return false; }
 253
 254     bool hasBoldFont() const override { return false; }
 255     bool hasItalicFont() const override { return false; }
 256     bool hasMisspelling() const override;
 257     std::optional<SimpleRange> misspellingRange(const SimpleRange& start, AccessibilitySearchDirection) const override;
 258     bool hasPlainText() const override { return false; }
 259     bool hasSameFont(const AXCoreObject&) const override { return false; }
 260     bool hasSameFontColor(const AXCoreObject&) const override { return false; }
 261     bool hasSameStyle(const AXCoreObject&) const override { return false; }
 262     bool hasUnderline() const override { return false; }
 263     bool hasHighlighting() const override;
 264
 265     bool supportsDatetimeAttribute() const override;
 266     String datetimeAttributeValue() const override;
 267
 268     bool canSetFocusAttribute() const override { return false; }
 269     bool canSetTextRangeAttributes() const override { return false; }
 270     bool canSetValueAttribute() const override { return false; }
 271     bool canSetNumericValue() const override { return false; }
 272     bool canSetSelectedAttribute() const override { return false; }
 273     bool canSetSelectedChildren() const override { return false; }
 274     bool canSetExpandedAttribute() const override { return false; }
 275
 276     Element* element() const override;
 277     Node* node() const override { return nullptr; }
 278     RenderObject* renderer() const override { return nullptr; }
 279     bool accessibilityIsIgnored() const override;
 280     AccessibilityObjectInclusion defaultObjectInclusion() const override;
 281     bool accessibilityIsIgnoredByDefault() const override;
 282
 283     bool isShowingValidationMessage() const override;
 284     String validationMessage() const override;
 285
 286     unsigned blockquoteLevel() const override;
 287     unsigned headingLevel() const override { return 0; }
 288     AccessibilityButtonState checkboxOrRadioValue() const override;
 289     String valueDescription() const override { return String(); }
 290     float valueForRange() const override { return 0.0f; }
 291     float maxValueForRange() const override { return 0.0f; }
 292     float minValueForRange() const override { return 0.0f; }
 293     float stepValueForRange() const override { return 0.0f; }
 294     AXCoreObject* selectedRadioButton() override { return nullptr; }
 295     AXCoreObject* selectedTabItem() override { return nullptr; }
 296     AXCoreObject* selectedListItem() override;
 297     int layoutCount() const override { return 0; }
 298     double loadingProgress() const override { return 0; }
 299     WEBCORE_EXPORT static bool isARIAControl(AccessibilityRole);
 300     bool supportsCheckedState() const override;
 301
 302     bool supportsARIAOwns() const override { return false; }
 303     bool isActiveDescendantOfFocusedContainer() const override;
 304     void ariaActiveDescendantReferencingElements(AccessibilityChildrenVector&) const override;
 305     void ariaControlsElements(AccessibilityChildrenVector&) const override;
 306     void ariaControlsReferencingElements(AccessibilityChildrenVector&) const override;
 307     void ariaDescribedByElements(AccessibilityChildrenVector&) const override;
 308     void ariaDescribedByReferencingElements(AccessibilityChildrenVector&) const override;
 309     void ariaDetailsElements(AccessibilityChildrenVector&) const override;
 310     void ariaDetailsReferencingElements(AccessibilityChildrenVector&) const override;
 311     void ariaErrorMessageElements(AccessibilityChildrenVector&) const override;
 312     void ariaErrorMessageReferencingElements(AccessibilityChildrenVector&) const override;
 313     void ariaFlowToElements(AccessibilityChildrenVector&) const override;
 314     void ariaFlowToReferencingElements(AccessibilityChildrenVector&) const override;
 315     void ariaLabelledByElements(AccessibilityChildrenVector&) const override;
 316     void ariaLabelledByReferencingElements(AccessibilityChildrenVector&) const override;
 317     void ariaOwnsElements(AccessibilityChildrenVector&) const override;
 318     void ariaOwnsReferencingElements(AccessibilityChildrenVector&) const override;
 319
 320     bool hasPopup() const override { return false; }
 321     String popupValue() const override;
 322     bool hasDatalist() const override;
 323     bool supportsHasPopup() const override;
 324     bool pressedIsPresent() const override;
 325     bool ariaIsMultiline() const override;
 326     String invalidStatus() const override;
 327     bool supportsPressed() const override;
 328     bool supportsExpanded() const override;
 329     bool supportsChecked() const override;
 330     bool supportsRowCountChange() const override;
 331     AccessibilitySortDirection sortDirection() const override;
 332     bool canvasHasFallbackContent() const override { return false; }
 333     bool supportsRangeValue() const override;
 334     String identifierAttribute() const override;
 335     String linkRelValue() const override;
 336     void classList(Vector<String>&) const override;
 337     AccessibilityCurrentState currentState() const override;
 338     String currentValue() const override;
 339     bool supportsCurrent() const override;
 340     const String keyShortcutsValue() const override;
 341
 342     // This function checks if the object should be ignored when there's a modal dialog displayed.
 343     virtual bool ignoredFromModalPresence() const;
 344     bool isModalDescendant(Node*) const override;
 345     bool isModalNode() const override;
 346
 347     bool supportsSetSize() const override;
 348     bool supportsPosInSet() const override;
 349     int setSize() const override;
 350     int posInSet() const override;
 351
 352     // ARIA drag and drop
 353     bool supportsDropping() const override { return false; }
 354     bool supportsDragging() const override { return false; }
 355     bool isGrabbed() override { return false; }
 356     void setARIAGrabbed(bool) override { }
 357     Vector<String> determineDropEffects() const override { return { }; }
 358
 359     // Called on the root AX object to return the deepest available element.
 360     AXCoreObject* accessibilityHitTest(const IntPoint&) const override { return nullptr; }
 361     // Called on the AX object after the render tree determines which is the right AccessibilityRenderObject.
 362     AXCoreObject* elementAccessibilityHitTest(const IntPoint&) const override;
 363
 364     AXCoreObject* focusedUIElement() const override;
 365
 366     AccessibilityObject* firstChild() const override { return nullptr; }
 367     AccessibilityObject* lastChild() const override { return nullptr; }
 368     AccessibilityObject* previousSibling() const override { return nullptr; }
 369     AccessibilityObject* nextSibling() const override { return nullptr; }
 370     AccessibilityObject* nextSiblingUnignored(int limit) const override;
 371     AccessibilityObject* previousSiblingUnignored(int limit) const override;
 372     AccessibilityObject* parentObject() const override { return nullptr; }
 373     AXCoreObject* parentObjectUnignored() const override;
 374     AccessibilityObject* parentObjectIfExists() const override { return nullptr; }
 375     static AccessibilityObject* firstAccessibleObjectFromNode(const Node*);
 376     void findMatchingObjects(AccessibilitySearchCriteria*, AccessibilityChildrenVector&) override;
 377     bool isDescendantOfBarrenParent() const override { return false; }
 378
 379     bool isDescendantOfRole(AccessibilityRole) const override;
 380
 381     // Text selection
 382     Vector<SimpleRange> findTextRanges(const AccessibilitySearchTextCriteria&) const override;
 383     Vector<String> performTextOperation(AccessibilityTextOperation const&) override;
 384
 385     AccessibilityObject* observableObject() const override { return nullptr; }
 386     void linkedUIElements(AccessibilityChildrenVector&) const override { }
 387     AccessibilityObject* titleUIElement() const override { return nullptr; }
 388     AccessibilityObject* correspondingLabelForControlElement() const override { return nullptr; }
 389     AccessibilityObject* correspondingControlForLabelElement() const override { return nullptr; }
 390     AccessibilityObject* scrollBar(AccessibilityOrientation) override { return nullptr; }
 391
 392     AccessibilityRole ariaRoleAttribute() const override { return AccessibilityRole::Unknown; }
 393     bool isPresentationalChildOfAriaRole() const override { return false; }
 394     bool ariaRoleHasPresentationalChildren() const override { return false; }
 395     bool inheritsPresentationalRole() const override { return false; }
 396
 397     // Accessibility Text
 398     void accessibilityText(Vector<AccessibilityText>&) const override { };
 399     // A single method for getting a computed label for an AXObject. It condenses the nuances of accessibilityText. Used by Inspector.
 400     String computedLabel() override;
 401
 402     // A programmatic way to set a name on an AccessibleObject.
 403     void setAccessibleName(const AtomString&) override { }
 404     bool hasAttributesRequiredForInclusion() const override;
 405
 406     // Accessibility Text - (To be deprecated).
 407     String accessibilityDescription() const override { return String(); }
 408     String title() const override { return String(); }
 409     String helpText() const override { return String(); }
 410
 411     // Methods for determining accessibility text.
 412     bool isARIAStaticText() const override { return ariaRoleAttribute() == AccessibilityRole::StaticText; }
 413     String stringValue() const override { return String(); }
 414     String textUnderElement(AccessibilityTextUnderElementMode = AccessibilityTextUnderElementMode()) const override { return String(); }
 415     String text() const override { return String(); }
 416     int textLength() const override { return 0; }
 417     String ariaLabeledByAttribute() const override { return String(); }
 418     String ariaDescribedByAttribute() const override { return String(); }
 419     const String placeholderValue() const override;
 420     bool accessibleNameDerivesFromContent() const override;
 421     String brailleLabel() const override { return getAttribute(HTMLNames::aria_braillelabelAttr); }
 422     String brailleRoleDescription() const override { return getAttribute(HTMLNames::aria_brailleroledescriptionAttr); }
 423     String embeddedImageDescription() const override;
 424     std::optional<AccessibilityChildrenVector> imageOverlayElements() override { return std::nullopt; }
 425
 426     // Abbreviations
 427     String expandedTextValue() const override { return String(); }
 428     bool supportsExpandedTextValue() const override { return false; }
 429
 430     void elementsFromAttribute(Vector<Element*>&, const QualifiedName&) const override;
 431
 432     // Only if isColorWell()
 433     SRGBA<uint8_t> colorValue() const override { return Color::transparentBlack; }
 434
 435     AccessibilityRole roleValue() const override { return m_role; }
 436     String rolePlatformString() const override;
 437     String roleDescription() const override;
 438     String subrolePlatformString() const override;
 439     String ariaLandmarkRoleDescription() const override;
 440
 441     AXObjectCache* axObjectCache() const override;
 442     AXID objectID() const override { return m_id; }
 443
 444     static AccessibilityObject* anchorElementForNode(Node*);
 445     static AccessibilityObject* headingElementForNode(Node*);
 446     Element* anchorElement() const override { return nullptr; }
 447     bool supportsPressAction() const override;
 448     Element* actionElement() const override { return nullptr; }
 449     LayoutRect boundingBoxRect() const override { return LayoutRect(); }
 450     LayoutRect elementRect() const override = 0;
 451     IntPoint clickPoint() override;
 452     static IntRect boundingBoxForQuads(RenderObject*, const Vector<FloatQuad>&);
 453     Path elementPath() const override { return Path(); }
 454     bool supportsPath() const override { return false; }
 455
 456     TextIteratorBehaviors textIteratorBehaviorForTextRange() const override;
 457     PlainTextRange selectedTextRange() const override { return { }; }
 458     int insertionPointLineNumber() const override { return -1; }
 459
 460     URL url() const override { return URL(); }
 461     VisibleSelection selection() const override { return VisibleSelection(); }
 462     String selectedText() const override { return String(); }
 463     String accessKey() const override { return nullAtom(); }
 464     String localizedActionVerb() const override;
 465     String actionVerb() const override;
 466
 467     bool isWidget() const override { return false; }
 468     Widget* widget() const override { return nullptr; }
 469     PlatformWidget platformWidget() const override { return nullptr; }
 470     Widget* widgetForAttachmentView() const override { return nullptr; }
 471
 472 #if PLATFORM(COCOA)
 473     RemoteAXObjectRef remoteParentObject() const override;
 474     FloatRect convertRectToPlatformSpace(const FloatRect&, AccessibilityConversionSpace) const override;
 475 #endif
 476     Page* page() const override;
 477     Document* document() const override;
 478     FrameView* documentFrameView() const override;
 479     Frame* frame() const override;
 480     Frame* mainFrame() const override;
 481     Document* topDocument() const override;
 482     ScrollView* scrollView() const override { return nullptr; }
 483     ScrollView* scrollViewAncestor() const override;
 484     String language() const override;
 485     // 1-based, to match the aria-level spec.
 486     unsigned hierarchicalLevel() const override { return 0; }
 487     bool isInlineText() const override;
 488
 489     // Ensures that the view is focused and active before attempting to set focus to an AccessibilityObject.
 490     // Subclasses that override setFocused should call this base implementation first.
 491     void setFocused(bool) override;
 492
 493     void setSelectedText(const String&) override { }
 494     void setSelectedTextRange(const PlainTextRange&) override { }
 495     bool setValue(const String&) override { return false; }
 496     bool replaceTextInRange(const String&, const PlainTextRange&) override;
 497     bool insertText(const String&) override;
 498
 499     bool setValue(float) override { return false; }
 500     void setSelected(bool) override { }
 501     void setSelectedRows(AccessibilityChildrenVector&) override { }
 502
 503     void makeRangeVisible(const PlainTextRange&) override { }
 504     bool press() override;
 505     bool performDefaultAction() override { return press(); }
 506
 507     AccessibilityOrientation orientation() const override;
 508     void increment() override { }
 509     void decrement() override { }
 510
 511     virtual void updateAccessibilityRole() { }
 512     const AccessibilityChildrenVector& children(bool updateChildrenIfNeeded = true) override;
 513     void addChildren() override { }
 514     void addChild(AXCoreObject*, DescendIfIgnored = DescendIfIgnored::Yes) override;
 515     void insertChild(AXCoreObject*, unsigned, DescendIfIgnored = DescendIfIgnored::Yes) override;
 516
 517     bool canHaveChildren() const override { return true; }
 518     void updateChildrenIfNecessary() override;
 519     void setNeedsToUpdateChildren() override { }
 520     void setNeedsToUpdateSubtree() override { }
 521     void clearChildren() override;
 522     bool needsToUpdateChildren() const override { return false; }
 523 #if PLATFORM(COCOA)
 524     void detachFromParent() override;
 525 #else
 526     void detachFromParent() override { }
 527 #endif
 528     bool isDetachedFromParent() override { return false; }
 529
 530     bool canHaveSelectedChildren() const override { return false; }
 531     void selectedChildren(AccessibilityChildrenVector&) override { }
 532     void setSelectedChildren(const AccessibilityChildrenVector&) override { }
 533     void visibleChildren(AccessibilityChildrenVector&) override { }
 534     void tabChildren(AccessibilityChildrenVector&) override { }
 535     bool shouldFocusActiveDescendant() const override { return false; }
 536     AccessibilityObject* activeDescendant() const override { return nullptr; }
 537     void handleActiveDescendantChanged() override { }
 538     AccessibilityObject* firstAnonymousBlockChild() const override;
 539
 540     WEBCORE_EXPORT static AccessibilityRole ariaRoleToWebCoreRole(const String&);
 541     virtual bool hasAttribute(const QualifiedName&) const;
 542     virtual const AtomString& getAttribute(const QualifiedName&) const;
 543     std::optional<String> attributeValue(const String&) const override;
 544     int getIntegralAttribute(const QualifiedName&) const;
 545     bool hasTagName(const QualifiedName&) const override;
 546     String tagName() const override;
 547
 548     VisiblePositionRange visiblePositionRange() const override { return VisiblePositionRange(); }
 549     VisiblePositionRange visiblePositionRangeForLine(unsigned) const override { return VisiblePositionRange(); }
 550
 551     std::optional<SimpleRange> elementRange() const override;
 552     static bool replacedNodeNeedsCharacter(Node* replacedNode);
 553
 554     VisiblePositionRange visiblePositionRangeForUnorderedPositions(const VisiblePosition&, const VisiblePosition&) const override;
 555     VisiblePositionRange positionOfLeftWord(const VisiblePosition&) const override;
 556     VisiblePositionRange positionOfRightWord(const VisiblePosition&) const override;
 557     VisiblePositionRange leftLineVisiblePositionRange(const VisiblePosition&) const override;
 558     VisiblePositionRange rightLineVisiblePositionRange(const VisiblePosition&) const override;
 559     VisiblePositionRange sentenceForPosition(const VisiblePosition&) const override;
 560     VisiblePositionRange paragraphForPosition(const VisiblePosition&) const override;
 561     VisiblePositionRange styleRangeForPosition(const VisiblePosition&) const override;
 562     VisiblePositionRange visiblePositionRangeForRange(const PlainTextRange&) const override;
 563     VisiblePositionRange lineRangeForPosition(const VisiblePosition&) const override;
 564     VisiblePositionRange selectedVisiblePositionRange() const override { return { }; }
 565
 566     std::optional<SimpleRange> rangeForPlainTextRange(const PlainTextRange&) const override;
 567 #if PLATFORM(MAC)
 568     AXTextMarkerRangeRef textMarkerRangeForNSRange(const NSRange&) const override;
 569 #endif
 570
 571     static String stringForVisiblePositionRange(const VisiblePositionRange&);
 572     String stringForRange(const SimpleRange&) const override;
 573     IntRect boundsForVisiblePositionRange(const VisiblePositionRange&) const override { return IntRect(); }
 574     IntRect boundsForRange(const SimpleRange&) const override { return IntRect(); }
 575     int lengthForVisiblePositionRange(const VisiblePositionRange&) const override;
 576     void setSelectedVisiblePositionRange(const VisiblePositionRange&) const override { }
 577
 578     VisiblePosition visiblePositionForBounds(const IntRect&, AccessibilityVisiblePositionForBounds) const override;
 579     VisiblePosition visiblePositionForPoint(const IntPoint&) const override { return VisiblePosition(); }
 580     VisiblePosition nextVisiblePosition(const VisiblePosition& visiblePos) const override { return visiblePos.next(); }
 581     VisiblePosition previousVisiblePosition(const VisiblePosition& visiblePos) const override { return visiblePos.previous(); }
 582     VisiblePosition nextWordEnd(const VisiblePosition&) const override;
 583     VisiblePosition previousWordStart(const VisiblePosition&) const override;
 584     VisiblePosition nextLineEndPosition(const VisiblePosition&) const override;
 585     VisiblePosition previousLineStartPosition(const VisiblePosition&) const override;
 586     VisiblePosition nextSentenceEndPosition(const VisiblePosition&) const override;
 587     VisiblePosition previousSentenceStartPosition(const VisiblePosition&) const override;
 588     VisiblePosition nextParagraphEndPosition(const VisiblePosition&) const override;
 589     VisiblePosition previousParagraphStartPosition(const VisiblePosition&) const override;
 590     VisiblePosition visiblePositionForIndex(unsigned, bool /*lastIndexOK */) const override { return VisiblePosition(); }
 591
 592     VisiblePosition visiblePositionForIndex(int) const override { return VisiblePosition(); }
 593     int indexForVisiblePosition(const VisiblePosition&) const override { return 0; }
 594
 595     AccessibilityObject* accessibilityObjectForPosition(const VisiblePosition&) const override;
 596     int lineForPosition(const VisiblePosition&) const override;
 597     PlainTextRange plainTextRangeForVisiblePositionRange(const VisiblePositionRange&) const override;
 598     int index(const VisiblePosition&) const override { return -1; }
 599
 600     void lineBreaks(Vector<int>&) const override { }
 601     PlainTextRange doAXRangeForLine(unsigned) const override { return PlainTextRange(); }
 602     PlainTextRange doAXRangeForPosition(const IntPoint&) const override;
 603     PlainTextRange doAXRangeForIndex(unsigned) const override { return PlainTextRange(); }
 604     PlainTextRange doAXStyleRangeForIndex(unsigned) const override;
 605
 606     String doAXStringForRange(const PlainTextRange&) const override { return String(); }
 607     IntRect doAXBoundsForRange(const PlainTextRange&) const override { return IntRect(); }
 608     IntRect doAXBoundsForRangeUsingCharacterOffset(const PlainTextRange&) const override { return IntRect(); }
 609     static String listMarkerTextForNodeAndPosition(Node*, const VisiblePosition&);
 610
 611     unsigned doAXLineForIndex(unsigned) override;
 612
 613     String computedRoleString() const override;
 614
 615     String stringValueForMSAA() const override { return String(); }
 616     String stringRoleForMSAA() const override { return String(); }
 617     String nameForMSAA() const override { return String(); }
 618     String descriptionForMSAA() const override { return String(); }
 619     AccessibilityRole roleValueForMSAA() const override { return roleValue(); }
 620
 621     String passwordFieldValue() const override { return String(); }
 622     bool isValueAutofilled() const override;
 623     bool isValueAutofillAvailable() const override;
 624     AutoFillButtonType valueAutofillButtonType() const override;
 625
 626     // Used by an ARIA tree to get all its rows.
 627     void ariaTreeRows(AccessibilityChildrenVector&) override;
 628     // Used by an ARIA tree item to get only its content, and not its child tree items and groups.
 629     void ariaTreeItemContent(AccessibilityChildrenVector&) override;
 630
 631     // ARIA live-region features.
 632     bool supportsLiveRegion(bool excludeIfOff = true) const override;
 633     bool isInsideLiveRegion(bool excludeIfOff = true) const override;
 634     AccessibilityObject* liveRegionAncestor(bool excludeIfOff = true) const override;
 635     const String liveRegionStatus() const override { return String(); }
 636     const String liveRegionRelevant() const override { return nullAtom(); }
 637     bool liveRegionAtomic() const override { return false; }
 638     bool isBusy() const override { return false; }
 639     static const String defaultLiveRegionStatusForRole(AccessibilityRole);
 640     static bool liveRegionStatusIsEnabled(const AtomString&);
 641     static bool contentEditableAttributeIsEnabled(Element*);
 642     bool hasContentEditableAttributeSet() const override;
 643
 644     bool supportsReadOnly() const override;
 645     String readOnlyValue() const override;
 646
 647     bool supportsAutoComplete() const override;
 648     String autoCompleteValue() const override;
 649
 650     bool hasARIAValueNow() const override { return hasAttribute(HTMLNames::aria_valuenowAttr); }
 651     bool supportsARIAAttributes() const override;
 652
 653     // CSS3 Speech properties.
 654     OptionSet<SpeakAs> speakAsProperty() const override { return OptionSet<SpeakAs> { }; }
 655
 656     // Make this object visible by scrolling as many nested scrollable views as needed.
 657     void scrollToMakeVisible() const override;
 658     // Same, but if the whole object can't be made visible, try for this subrect, in local coordinates.
 659     void scrollToMakeVisibleWithSubFocus(const IntRect&) const override;
 660     // Scroll this object to a given point in global coordinates of the top-level window.
 661     void scrollToGlobalPoint(const IntPoint&) const override;
 662
 663     bool scrollByPage(ScrollByPageDirection) const override;
 664     IntPoint scrollPosition() const override;
 665     AccessibilityChildrenVector contents() override;
 666     IntSize scrollContentsSize() const override;
 667     IntRect scrollVisibleContentRect() const override;
 668     void scrollToMakeVisible(const ScrollRectToVisibleOptions&) const override;
 669
 670     bool lastKnownIsIgnoredValue();
 671     void setLastKnownIsIgnoredValue(bool);
 672     bool hasIgnoredValueChanged();
 673
 674     // All math elements return true for isMathElement().
 675     bool isMathElement() const override { return false; }
 676     bool isMathFraction() const override { return false; }
 677     bool isMathFenced() const override { return false; }
 678     bool isMathSubscriptSuperscript() const override { return false; }
 679     bool isMathRow() const override { return false; }
 680     bool isMathUnderOver() const override { return false; }
 681     bool isMathRoot() const override { return false; }
 682     bool isMathSquareRoot() const override { return false; }
 683     bool isMathText() const override { return false; }
 684     bool isMathNumber() const override { return false; }
 685     bool isMathOperator() const override { return false; }
 686     bool isMathFenceOperator() const override { return false; }
 687     bool isMathSeparatorOperator() const override { return false; }
 688     bool isMathIdentifier() const override { return false; }
 689     bool isMathTable() const override { return false; }
 690     bool isMathTableRow() const override { return false; }
 691     bool isMathTableCell() const override { return false; }
 692     bool isMathMultiscript() const override { return false; }
 693     bool isMathToken() const override { return false; }
 694     bool isMathScriptObject(AccessibilityMathScriptObjectType) const override { return false; }
 695     bool isMathMultiscriptObject(AccessibilityMathMultiscriptObjectType) const override { return false; }
 696
 697     // Root components.
 698     std::optional<AccessibilityChildrenVector> mathRadicand() override { return std::nullopt; }
 699     AXCoreObject* mathRootIndexObject() override { return nullptr; }
 700
 701     // Under over components.
 702     AXCoreObject* mathUnderObject() override { return nullptr; }
 703     AXCoreObject* mathOverObject() override { return nullptr; }
 704
 705     // Fraction components.
 706     AXCoreObject* mathNumeratorObject() override { return nullptr; }
 707     AXCoreObject* mathDenominatorObject() override { return nullptr; }
 708
 709     // Subscript/superscript components.
 710     AXCoreObject* mathBaseObject() override { return nullptr; }
 711     AXCoreObject* mathSubscriptObject() override { return nullptr; }
 712     AXCoreObject* mathSuperscriptObject() override { return nullptr; }
 713
 714     // Fenced components.
 715     String mathFencedOpenString() const override { return String(); }
 716     String mathFencedCloseString() const override { return String(); }
 717     int mathLineThickness() const override { return 0; }
 718     bool isAnonymousMathOperator() const override { return false; }
 719
 720     // Multiscripts components.
 721     void mathPrescripts(AccessibilityMathMultiscriptPairs&) override { }
 722     void mathPostscripts(AccessibilityMathMultiscriptPairs&) override { }
 723
 724     // Visibility.
 725     bool isAXHidden() const override;
 726     bool isDOMHidden() const override;
 727     bool isHidden() const override { return isAXHidden() || isDOMHidden(); }
 728
 729 #if PLATFORM(COCOA)
 730     void overrideAttachmentParent(AXCoreObject* parent) override;
 731 #else
 732     void overrideAttachmentParent(AXCoreObject*) override { }
 733 #endif
 734
 735 #if ENABLE(ACCESSIBILITY)
 736     // a platform-specific method for determining if an attachment is ignored
 737     bool accessibilityIgnoreAttachment() const override;
 738     // gives platforms the opportunity to indicate if and how an object should be included
 739     AccessibilityObjectInclusion accessibilityPlatformIncludesObject() const override;
 740 #else
 741     bool accessibilityIgnoreAttachment() const override { return true; }
 742     AccessibilityObjectInclusion accessibilityPlatformIncludesObject() const override { return AccessibilityObjectInclusion::DefaultBehavior; }
 743 #endif
 744
 745 #if PLATFORM(IOS_FAMILY)
 746     int accessibilityPasswordFieldLength() override;
 747     bool hasTouchEventListener() const override;
 748     bool isInputTypePopupButton() const override;
 749 #endif
 750
 751     // allows for an AccessibilityObject to update its render tree or perform
 752     // other operations update type operations
 753     void updateBackingStore() override;
 754
 755 #if PLATFORM(COCOA)
 756     bool preventKeyboardDOMEventDispatch() const override;
 757     void setPreventKeyboardDOMEventDispatch(bool) override;
 758     bool fileUploadButtonReturnsValueInTitle() const override;
 759     String speechHintAttributeValue() const override;
 760     String descriptionAttributeValue() const override;
 761     String helpTextAttributeValue() const override;
 762     String titleAttributeValue() const override;
 763     bool hasApplePDFAnnotationAttribute() const override { return hasAttribute(HTMLNames::x_apple_pdf_annotationAttr); }
 764 #endif
 765
 766 #if PLATFORM(MAC)
 767     bool caretBrowsingEnabled() const override;
 768     void setCaretBrowsingEnabled(bool) override;
 769 #endif
 770
 771     AccessibilityObject* focusableAncestor() override;
 772     AccessibilityObject* editableAncestor() override;
 773     AccessibilityObject* highestEditableAncestor() override;
 774
 775     const AccessibilityScrollView* ancestorAccessibilityScrollView(bool includeSelf) const override;
 776     AccessibilityObject* webAreaObject() const override { return nullptr; }
 777
 778     void clearIsIgnoredFromParentData() override { m_isIgnoredFromParentData = { }; }
 779     void setIsIgnoredFromParentDataForChild(AXCoreObject*) override;
 780
 781     PAL::SessionID sessionID() const override;
 782     String documentURI() const override;
 783     String documentEncoding() const override;
 784     AccessibilityChildrenVector documentLinks() override { return AccessibilityChildrenVector(); }
 785
 786 protected:
 787     AccessibilityObject() = default;
 788
 789     // FIXME: Make more of these member functions private.
 790
 791     void detachRemoteParts(AccessibilityDetachmentType) override;
 792     void detachPlatformWrapper(AccessibilityDetachmentType) override;
 793
 794     void setIsIgnoredFromParentData(AccessibilityIsIgnoredFromParentData& data) override { m_isIgnoredFromParentData = data; }
 795
 796     virtual bool computeAccessibilityIsIgnored() const { return true; }
 797     bool isAccessibilityObject() const override { return true; }
 798
 799     // If this object itself scrolls, return its ScrollableArea.
 800     virtual ScrollableArea* getScrollableAreaIfScrollable() const { return nullptr; }
 801     virtual void scrollTo(const IntPoint&) const { }
 802     ScrollableArea* scrollableAreaAncestor() const;
 803     void scrollAreaAndAncestor(std::pair<ScrollableArea*, AccessibilityObject*>&) const;
 804
 805     virtual bool shouldIgnoreAttributeRole() const { return false; }
 806     virtual AccessibilityRole buttonRoleType() const;
 807     String rolePlatformDescription() const;
 808     bool isOnScreen() const override;
 809     bool dispatchTouchEvent();
 810
 811     static bool isARIAInput(AccessibilityRole);
 812     void ariaElementsFromAttribute(AccessibilityChildrenVector&, const QualifiedName&) const;
 813     void ariaElementsReferencedByAttribute(AccessibilityChildrenVector&, const QualifiedName&) const;
 814     virtual bool exposesTitleUIElement() const { return true; }
 815     FloatRect unobscuredContentRect() const override;
 816     AccessibilityObject* radioGroupAncestor() const;
 817
 818     bool allowsTextRanges() const;
 819     unsigned getLengthForTextRange() const;
 820     String innerHTML() const override;
 821     String outerHTML() const override;
 822
 823 private:
 824     bool hasAncestorFlag(AXAncestorFlag flag) const { return ancestorFlagsAreInitialized() && m_ancestorFlags.contains(flag); }
 825     std::optional<SimpleRange> rangeOfStringClosestToRangeInDirection(const SimpleRange&, AccessibilitySearchDirection, const Vector<String>&) const;
 826     std::optional<SimpleRange> selectionRange() const;
 827     std::optional<SimpleRange> findTextRange(const Vector<String>& searchStrings, const SimpleRange& start, AccessibilitySearchTextDirection) const;
 828     std::optional<SimpleRange> visibleCharacterRange() const override;
 829
 830     void ariaTreeRows(AccessibilityChildrenVector& rows, AccessibilityChildrenVector& ancestors);
 831
 832 #if PLATFORM(COCOA) && ENABLE(MODEL_ELEMENT)
 833     Vector<RetainPtr<id>> modelElementChildren() override;
 834 #endif
 835
 836 protected: // FIXME: Make the data members private.
 837     bool childrenInitialized() const { return m_childrenInitialized; }
 838     AccessibilityChildrenVector m_children;
 839     mutable bool m_childrenInitialized { false };
 840     AccessibilityRole m_role { AccessibilityRole::Unknown };
 841 private:
 842     AXID m_id;
 843     OptionSet<AXAncestorFlag> m_ancestorFlags;
 844     AccessibilityObjectInclusion m_lastKnownIsIgnoredValue { AccessibilityObjectInclusion::DefaultBehavior };
 845 protected: // FIXME: Make the data members private.
 846     // FIXME: This can be replaced by AXAncestorFlags.
 847     AccessibilityIsIgnoredFromParentData m_isIgnoredFromParentData;
 848     bool m_childrenDirty { false };
 849     bool m_subtreeDirty { false };
 850 private:
 851 #if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
 852     bool m_isolatedTreeNodeInitialized { false };
 853 #endif
 854 };
 855
 856 #if !ENABLE(ACCESSIBILITY)
 857 inline const AccessibilityObject::AccessibilityChildrenVector& AccessibilityObject::children(bool) { return m_children; }
 858 inline String AccessibilityObject::localizedActionVerb() const { return emptyString(); }
 859 inline String AccessibilityObject::actionVerb() const { return emptyString(); }
 860 inline int AccessibilityObject::lineForPosition(const VisiblePosition&) const { return -1; }
 861 inline void AccessibilityObject::updateBackingStore() { }
 862 inline void AccessibilityObject::detachPlatformWrapper(AccessibilityDetachmentType) { }
 863 #endif
 864
 865 #if !(ENABLE(ACCESSIBILITY) && (USE(ATK) || USE(ATSPI)))
 866 inline bool AccessibilityObject::allowsTextRanges() const { return true; }
 867 inline unsigned AccessibilityObject::getLengthForTextRange() const { return text().length(); }
 868 #endif
 869
 870 AccessibilityObject* firstAccessibleObjectFromNode(const Node*, const Function<bool(const AccessibilityObject&)>& isAccessible);
 871
 872 namespace Accessibility {
 873
 874 using PlatformRoleMap = HashMap<AccessibilityRole, String, DefaultHash<unsigned>, WTF::UnsignedWithZeroKeyHashTraits<unsigned>>;
 875
 876 PlatformRoleMap createPlatformRoleMap();
 877 String roleToPlatformString(AccessibilityRole);
 878
 879 } // namespace Accessibility
 880
 881 } // namespace WebCore
 882
 883 #define SPECIALIZE_TYPE_TRAITS_ACCESSIBILITY(ToValueTypeName, predicate) \
 884 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
 885     static bool isType(const WebCore::AXCoreObject& object) { return object.predicate; } \
 886 SPECIALIZE_TYPE_TRAITS_END()
 887
 888 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::AccessibilityObject)
 889 static bool isType(const WebCore::AXCoreObject& context) { return context.isAccessibilityObject(); }
 890 SPECIALIZE_TYPE_TRAITS_END()