1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
|
/*
* Copyright (C) 2019 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
#include "AXCoreObject.h"
#include "AXIsolatedTree.h"
#include "AXObjectCache.h"
#include "IntPoint.h"
#include "LayoutRect.h"
#include "Path.h"
#include "RenderStyleConstants.h"
#include <variant>
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/RefPtr.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/Vector.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class AXIsolatedTree;
#if ENABLE(AX_THREAD_TEXT_APIS)
struct AXTextRuns;
#endif
class AXIsolatedObject final : public AXCoreObject {
friend class AXIsolatedTree;
public:
static Ref<AXIsolatedObject> create(const Ref<AccessibilityObject>&, AXIsolatedTree*);
~AXIsolatedObject();
std::optional<AXID> treeID() const final { return tree()->treeID(); }
String dbgInternal(bool, OptionSet<AXDebugStringOption>) const final;
void attachPlatformWrapper(AccessibilityObjectWrapper*);
bool isDetached() const final;
bool isTable() const final { return boolAttributeValue(AXProperty::IsTable); }
bool isExposable() const final { return boolAttributeValue(AXProperty::IsExposable); }
bool hasClickHandler() const final { return boolAttributeValue(AXProperty::HasClickHandler); }
FloatRect relativeFrame() const final;
bool hasAttachmentTag() const final { return propertyValue<TagName>(AXProperty::TagName) == TagName::attachment; }
bool hasBodyTag() const final { return propertyValue<TagName>(AXProperty::TagName) == TagName::body; }
bool hasMarkTag() const final { return propertyValue<TagName>(AXProperty::TagName) == TagName::mark; }
const AccessibilityChildrenVector& children(bool updateChildrenIfNeeded = true) final;
#if ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
AXIsolatedObject* parentObject() const final { return tree()->objectForID(parent()); }
AXIsolatedObject* parentObjectUnignored() const final { return downcast<AXIsolatedObject>(AXCoreObject::parentObjectUnignored()); }
#else
AXIsolatedObject* parentObject() const final { return parentObjectUnignored(); }
AXIsolatedObject* parentObjectUnignored() const final { return tree()->objectForID(parent()); }
#endif // ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
AXIsolatedObject* clickableSelfOrAncestor(ClickHandlerFilter filter = ClickHandlerFilter::ExcludeBody) const final { return Accessibility::clickableSelfOrAncestor(*this, filter); };
AXIsolatedObject* editableAncestor() const final { return Accessibility::editableAncestor(*this); };
bool canSetFocusAttribute() const final { return boolAttributeValue(AXProperty::CanSetFocusAttribute); }
AttributedStringStyle stylesForAttributedString() const final;
#if ENABLE(AX_THREAD_TEXT_APIS)
const AXTextRuns* textRuns() const;
bool hasTextRuns() final
{
const auto* runs = textRuns();
return runs && runs->size();
}
TextEmissionBehavior emitTextAfterBehavior() const final { return propertyValue<TextEmissionBehavior>(AXProperty::EmitTextAfterBehavior); }
AXTextRunLineID listMarkerLineID() const final { return propertyValue<AXTextRunLineID>(AXProperty::ListMarkerLineID); };
String listMarkerText() const final { return stringAttributeValue(AXProperty::ListMarkerText); }
#endif // ENABLE(AX_THREAD_TEXT_APIS)
#if ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
bool isIgnored() const final { return boolAttributeValue(AXProperty::IsIgnored); }
#else
// When not including ignored objects in the core tree, we should never create an isolated object from
// an ignored live object, so we can hardcode this to false.
bool isIgnored() const final { return false; }
#endif // ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
AXTextMarkerRange textMarkerRange() const final;
private:
constexpr ProcessID processID() const final { return tree()->processID(); }
void detachRemoteParts(AccessibilityDetachmentType) final;
void detachPlatformWrapper(AccessibilityDetachmentType) final;
std::optional<AXID> parent() const { return m_parentID; }
void setParent(std::optional<AXID> axID) { m_parentID = axID; }
AXIsolatedTree* tree() const { return m_cachedTree.get(); }
AXIsolatedObject(const Ref<AccessibilityObject>&, AXIsolatedTree*);
bool isAXIsolatedObjectInstance() const final { return true; }
AccessibilityObject* associatedAXObject() const;
void initializeProperties(const Ref<AccessibilityObject>&);
void initializePlatformProperties(const Ref<const AccessibilityObject>&);
void setProperty(AXProperty, AXPropertyValueVariant&&);
void setObjectProperty(AXProperty, AXCoreObject*);
void setObjectVectorProperty(AXProperty, const AccessibilityChildrenVector&);
void setPropertyFlag(AXPropertyFlag, bool);
bool hasPropertyFlag(AXPropertyFlag) const;
static bool canBeMultilineTextField(AccessibilityObject&);
// FIXME: consolidate all AttributeValue retrieval in a single template method.
bool boolAttributeValue(AXProperty) const;
String stringAttributeValue(AXProperty) const;
String stringAttributeValueNullIfMissing(AXProperty) const;
int intAttributeValue(AXProperty) const;
unsigned unsignedAttributeValue(AXProperty) const;
double doubleAttributeValue(AXProperty) const;
float floatAttributeValue(AXProperty) const;
AXIsolatedObject* objectAttributeValue(AXProperty) const;
IntPoint intPointAttributeValue(AXProperty) const;
Color colorAttributeValue(AXProperty) const;
URL urlAttributeValue(AXProperty) const;
uint64_t uint64AttributeValue(AXProperty) const;
Path pathAttributeValue(AXProperty) const;
std::pair<unsigned, unsigned> indexRangePairAttributeValue(AXProperty) const;
template<typename T> T rectAttributeValue(AXProperty) const;
template<typename T> Vector<T> vectorAttributeValue(AXProperty) const;
template<typename T> OptionSet<T> optionSetAttributeValue(AXProperty) const;
template<typename T> std::optional<T> optionalAttributeValue(AXProperty) const;
template<typename T> T propertyValue(AXProperty) const;
// The following method performs a lazy caching of the given property.
// If the property is already in m_propertyMap, returns the existing value.
// If not, retrieves the property from the main thread and cache it for later use.
template<typename T> T getOrRetrievePropertyValue(AXProperty);
void fillChildrenVectorForProperty(AXProperty, AccessibilityChildrenVector&) const;
void setMathscripts(AXProperty, AccessibilityObject&);
void insertMathPairs(Vector<std::pair<Markable<AXID>, Markable<AXID>>>&, AccessibilityMathMultiscriptPairs&);
template<typename U> void performFunctionOnMainThreadAndWait(U&& lambda) const
{
Accessibility::performFunctionOnMainThreadAndWait([&lambda, this] {
if (RefPtr object = associatedAXObject())
lambda(object.get());
});
}
template<typename U> void performFunctionOnMainThread(U&& lambda) const
{
Accessibility::performFunctionOnMainThread([lambda = WTFMove(lambda), protectedThis = Ref { *this }] () mutable {
if (RefPtr object = protectedThis->associatedAXObject())
lambda(object.get());
});
}
// Attribute retrieval overrides.
bool isSecureField() const final { return boolAttributeValue(AXProperty::IsSecureField); }
bool isAttachment() const final { return boolAttributeValue(AXProperty::IsAttachment); }
bool isInputImage() const final { return boolAttributeValue(AXProperty::IsInputImage); }
bool isRadioInput() const final { return boolAttributeValue(AXProperty::IsRadioInput); }
bool isKeyboardFocusable() const final { return boolAttributeValue(AXProperty::IsKeyboardFocusable); }
// Table support.
AXIsolatedObject* exposedTableAncestor(bool includeSelf = false) const final { return Accessibility::exposedTableAncestor(*this, includeSelf); }
AccessibilityChildrenVector columns() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::Columns)); }
AccessibilityChildrenVector rows() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::Rows)); }
unsigned columnCount() final { return static_cast<unsigned>(columns().size()); }
unsigned rowCount() final { return static_cast<unsigned>(rows().size()); }
AccessibilityChildrenVector cells() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::Cells)); }
AXIsolatedObject* cellForColumnAndRow(unsigned, unsigned) final;
AccessibilityChildrenVector rowHeaders() final;
AccessibilityChildrenVector visibleRows() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::VisibleRows)); }
AXIsolatedObject* headerContainer() final;
int axColumnCount() const final { return intAttributeValue(AXProperty::AXColumnCount); }
int axRowCount() const final { return intAttributeValue(AXProperty::AXRowCount); }
// Table cell support.
bool isTableCell() const final;
bool isExposedTableCell() const final { return boolAttributeValue(AXProperty::IsExposedTableCell); }
// Returns the start location and row span of the cell.
std::pair<unsigned, unsigned> rowIndexRange() const final { return indexRangePairAttributeValue(AXProperty::RowIndexRange); }
// Returns the start location and column span of the cell.
std::pair<unsigned, unsigned> columnIndexRange() const final { return indexRangePairAttributeValue(AXProperty::ColumnIndexRange); }
int axColumnIndex() const final { return intAttributeValue(AXProperty::AXColumnIndex); }
int axRowIndex() const final { return intAttributeValue(AXProperty::AXRowIndex); }
bool isColumnHeader() const final { return boolAttributeValue(AXProperty::IsColumnHeader); }
bool isRowHeader() const final { return boolAttributeValue(AXProperty::IsRowHeader); }
String cellScope() const final { return stringAttributeValue(AXProperty::CellScope); }
std::optional<AXID> rowGroupAncestorID() const final { return propertyValue<Markable<AXID>>(AXProperty::RowGroupAncestorID); }
// Table column support.
unsigned columnIndex() const final { return unsignedAttributeValue(AXProperty::ColumnIndex); }
// Table row support.
bool isTableRow() const final { return boolAttributeValue(AXProperty::IsTableRow); }
unsigned rowIndex() const final { return unsignedAttributeValue(AXProperty::RowIndex); }
AXIsolatedObject* rowHeader() final { return objectAttributeValue(AXProperty::RowHeader); };
// ARIA tree/grid row support.
bool isARIATreeGridRow() const final { return boolAttributeValue(AXProperty::IsARIATreeGridRow); }
AccessibilityChildrenVector disclosedRows() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::DisclosedRows)); }
AXIsolatedObject* disclosedByRow() const final { return objectAttributeValue(AXProperty::DisclosedByRow); }
bool isFieldset() const final { return boolAttributeValue(AXProperty::IsFieldset); }
bool isChecked() const final { return boolAttributeValue(AXProperty::IsChecked); }
bool isEnabled() const final { return boolAttributeValue(AXProperty::IsEnabled); }
bool isSelected() const final { return boolAttributeValue(AXProperty::IsSelected); }
bool isFocused() const final { return tree()->focusedNodeID() == objectID(); }
bool isMultiSelectable() const final { return boolAttributeValue(AXProperty::IsMultiSelectable); }
InsideLink insideLink() const final { return propertyValue<InsideLink>(AXProperty::InsideLink); }
bool isRequired() const final { return boolAttributeValue(AXProperty::IsRequired); }
bool isExpanded() const final { return boolAttributeValue(AXProperty::IsExpanded); }
bool isFileUploadButton() const final { return boolAttributeValue(AXProperty::IsFileUploadButton); }
FloatPoint screenRelativePosition() const final;
IntPoint remoteFrameOffset() const final;
std::optional<IntRect> cachedRelativeFrame() const { return optionalAttributeValue<IntRect>(AXProperty::RelativeFrame); }
#if PLATFORM(MAC)
FloatRect primaryScreenRect() const final;
#endif
IntSize size() const final { return snappedIntRect(LayoutRect(relativeFrame())).size(); }
FloatRect relativeFrameFromChildren() const;
WallTime dateTimeValue() const final { return propertyValue<WallTime>(AXProperty::DateTimeValue); }
DateComponentsType dateTimeComponentsType() const final { return propertyValue<DateComponentsType>(AXProperty::DateTimeComponentsType); }
bool supportsDatetimeAttribute() const final { return boolAttributeValue(AXProperty::SupportsDatetimeAttribute); }
String datetimeAttributeValue() const final { return stringAttributeValue(AXProperty::DatetimeAttributeValue); }
bool canSetValueAttribute() const final { return boolAttributeValue(AXProperty::CanSetValueAttribute); }
bool canSetSelectedAttribute() const final { return boolAttributeValue(AXProperty::CanSetSelectedAttribute); }
unsigned blockquoteLevel() const final { return unsignedAttributeValue(AXProperty::BlockquoteLevel); }
unsigned headingLevel() const final { return unsignedAttributeValue(AXProperty::HeadingLevel); }
AccessibilityButtonState checkboxOrRadioValue() const final { return propertyValue<AccessibilityButtonState>(AXProperty::ButtonState); }
String valueDescription() const final { return stringAttributeValue(AXProperty::ValueDescription); }
float valueForRange() const final { return floatAttributeValue(AXProperty::ValueForRange); }
float maxValueForRange() const final { return floatAttributeValue(AXProperty::MaxValueForRange); }
float minValueForRange() const final { return floatAttributeValue(AXProperty::MinValueForRange); }
int layoutCount() const final;
double loadingProgress() const final { return tree()->loadingProgress(); }
bool supportsARIAOwns() const final { return boolAttributeValue(AXProperty::SupportsARIAOwns); }
String popupValue() const final { return stringAttributeValue(AXProperty::PopupValue); }
bool pressedIsPresent() const final;
String invalidStatus() const final { return stringAttributeValue(AXProperty::InvalidStatus); }
bool supportsExpanded() const final { return boolAttributeValue(AXProperty::SupportsExpanded); }
AccessibilitySortDirection sortDirection() const final { return static_cast<AccessibilitySortDirection>(intAttributeValue(AXProperty::SortDirection)); }
bool supportsRangeValue() const final { return boolAttributeValue(AXProperty::SupportsRangeValue); }
String identifierAttribute() const final;
String linkRelValue() const final;
Vector<String> classList() const final;
AccessibilityCurrentState currentState() const final { return static_cast<AccessibilityCurrentState>(intAttributeValue(AXProperty::CurrentState)); }
bool supportsCurrent() const final { return boolAttributeValue(AXProperty::SupportsCurrent); }
bool supportsKeyShortcuts() const final { return boolAttributeValue(AXProperty::SupportsKeyShortcuts); }
String keyShortcuts() const final { return stringAttributeValue(AXProperty::KeyShortcuts); }
bool supportsSetSize() const final { return boolAttributeValue(AXProperty::SupportsSetSize); }
bool supportsPosInSet() const final { return boolAttributeValue(AXProperty::SupportsPosInSet); }
int setSize() const final { return intAttributeValue(AXProperty::SetSize); }
int posInSet() const final { return intAttributeValue(AXProperty::PosInSet); }
bool supportsDropping() const final { return boolAttributeValue(AXProperty::SupportsDropping); }
bool supportsDragging() const final { return boolAttributeValue(AXProperty::SupportsDragging); }
bool isGrabbed() final { return boolAttributeValue(AXProperty::IsGrabbed); }
Vector<String> determineDropEffects() const final;
AXIsolatedObject* accessibilityHitTest(const IntPoint&) const final;
AXIsolatedObject* focusedUIElement() const final;
AXIsolatedObject* internalLinkElement() const final { return objectAttributeValue(AXProperty::InternalLinkElement); }
AccessibilityChildrenVector radioButtonGroup() const final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::RadioButtonGroup)); }
AXIsolatedObject* scrollBar(AccessibilityOrientation) final;
const String placeholderValue() const final { return stringAttributeValue(AXProperty::PlaceholderValue); }
String expandedTextValue() const final { return stringAttributeValue(AXProperty::ExpandedTextValue); }
bool supportsExpandedTextValue() const final { return boolAttributeValue(AXProperty::SupportsExpandedTextValue); }
SRGBA<uint8_t> colorValue() const final;
String rolePlatformString() const final { return stringAttributeValue(AXProperty::RolePlatformString); }
String roleDescription() const final { return stringAttributeValue(AXProperty::RoleDescription); }
String subrolePlatformString() const final { return stringAttributeValue(AXProperty::SubrolePlatformString); }
LayoutRect elementRect() const final;
IntPoint clickPoint() final;
void accessibilityText(Vector<AccessibilityText>& texts) const final;
String brailleLabel() const final { return stringAttributeValue(AXProperty::BrailleLabel); }
String brailleRoleDescription() const final { return stringAttributeValue(AXProperty::BrailleRoleDescription); }
String embeddedImageDescription() const final { return stringAttributeValue(AXProperty::EmbeddedImageDescription); }
std::optional<AccessibilityChildrenVector> imageOverlayElements() final { return std::nullopt; }
String extendedDescription() const final { return stringAttributeValue(AXProperty::ExtendedDescription); }
String computedRoleString() const final;
bool isValueAutofillAvailable() const final { return boolAttributeValue(AXProperty::IsValueAutofillAvailable); }
AutoFillButtonType valueAutofillButtonType() const final { return static_cast<AutoFillButtonType>(intAttributeValue(AXProperty::ValueAutofillButtonType)); }
URL url() const final { return urlAttributeValue(AXProperty::URL); }
String accessKey() const final { return stringAttributeValueNullIfMissing(AXProperty::AccessKey); }
String localizedActionVerb() const final { return stringAttributeValue(AXProperty::LocalizedActionVerb); }
String actionVerb() const final { return stringAttributeValue(AXProperty::ActionVerb); }
String autoCompleteValue() const final { return stringAttributeValue(AXProperty::AutoCompleteValue); }
bool isMathElement() const final { return boolAttributeValue(AXProperty::IsMathElement); }
bool isMathFraction() const final { return boolAttributeValue(AXProperty::IsMathFraction); }
bool isMathFenced() const final { return boolAttributeValue(AXProperty::IsMathFenced); }
bool isMathSubscriptSuperscript() const final { return boolAttributeValue(AXProperty::IsMathSubscriptSuperscript); }
bool isMathRow() const final { return boolAttributeValue(AXProperty::IsMathRow); }
bool isMathUnderOver() const final { return boolAttributeValue(AXProperty::IsMathUnderOver); }
bool isMathRoot() const final { return boolAttributeValue(AXProperty::IsMathRoot); }
bool isMathSquareRoot() const final { return boolAttributeValue(AXProperty::IsMathSquareRoot); }
bool isMathTable() const final { return boolAttributeValue(AXProperty::IsMathTable); }
bool isMathTableRow() const final { return boolAttributeValue(AXProperty::IsMathTableRow); }
bool isMathTableCell() const final { return boolAttributeValue(AXProperty::IsMathTableCell); }
bool isMathMultiscript() const final { return boolAttributeValue(AXProperty::IsMathMultiscript); }
bool isMathToken() const final { return boolAttributeValue(AXProperty::IsMathToken); }
std::optional<AccessibilityChildrenVector> mathRadicand() final;
AXIsolatedObject* mathRootIndexObject() final { return objectAttributeValue(AXProperty::MathRootIndexObject); }
AXIsolatedObject* mathUnderObject() final { return objectAttributeValue(AXProperty::MathUnderObject); }
AXIsolatedObject* mathOverObject() final { return objectAttributeValue(AXProperty::MathOverObject); }
AXIsolatedObject* mathNumeratorObject() final { return objectAttributeValue(AXProperty::MathNumeratorObject); }
AXIsolatedObject* mathDenominatorObject() final { return objectAttributeValue(AXProperty::MathDenominatorObject); }
AXIsolatedObject* mathBaseObject() final { return objectAttributeValue(AXProperty::MathBaseObject); }
AXIsolatedObject* mathSubscriptObject() final { return objectAttributeValue(AXProperty::MathSubscriptObject); }
AXIsolatedObject* mathSuperscriptObject() final { return objectAttributeValue(AXProperty::MathSuperscriptObject); }
String mathFencedOpenString() const final { return stringAttributeValue(AXProperty::MathFencedOpenString); }
String mathFencedCloseString() const final { return stringAttributeValue(AXProperty::MathFencedCloseString); }
int mathLineThickness() const final { return intAttributeValue(AXProperty::MathLineThickness); }
void mathPrescripts(AccessibilityMathMultiscriptPairs&) final;
void mathPostscripts(AccessibilityMathMultiscriptPairs&) final;
#if PLATFORM(COCOA)
String speechHintAttributeValue() const final { return stringAttributeValue(AXProperty::SpeechHint); }
#endif
bool fileUploadButtonReturnsValueInTitle() const final;
#if PLATFORM(MAC)
bool caretBrowsingEnabled() const final { return boolAttributeValue(AXProperty::CaretBrowsingEnabled); }
#endif
AXIsolatedObject* focusableAncestor() final { return Accessibility::focusableAncestor(*this); }
AXIsolatedObject* highestEditableAncestor() final { return Accessibility::highestEditableAncestor(*this); }
AccessibilityOrientation orientation() const final { return static_cast<AccessibilityOrientation>(intAttributeValue(AXProperty::Orientation)); }
unsigned hierarchicalLevel() const final { return unsignedAttributeValue(AXProperty::HierarchicalLevel); }
String language() const final { return stringAttributeValue(AXProperty::Language); }
void setSelectedChildren(const AccessibilityChildrenVector&) final;
AccessibilityChildrenVector visibleChildren() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::VisibleChildren)); }
void setChildrenIDs(Vector<AXID>&&);
bool isDetachedFromParent() final;
AXIsolatedObject* liveRegionAncestor(bool excludeIfOff = true) const final { return Accessibility::liveRegionAncestor(*this, excludeIfOff); }
const String liveRegionStatus() const final { return stringAttributeValue(AXProperty::LiveRegionStatus); }
const String liveRegionRelevant() const final { return stringAttributeValue(AXProperty::LiveRegionRelevant); }
bool liveRegionAtomic() const final { return boolAttributeValue(AXProperty::LiveRegionAtomic); }
bool isBusy() const final { return boolAttributeValue(AXProperty::IsBusy); }
bool isInlineText() const final { return boolAttributeValue(AXProperty::IsInlineText); }
// Spin button support.
AXIsolatedObject* incrementButton() final { return objectAttributeValue(AXProperty::IncrementButton); }
AXIsolatedObject* decrementButton() final { return objectAttributeValue(AXProperty::DecrementButton); }
AccessibilityChildrenVector documentLinks() final { return tree()->objectsForIDs(vectorAttributeValue<AXID>(AXProperty::DocumentLinks)); }
bool supportsCheckedState() const final { return boolAttributeValue(AXProperty::SupportsCheckedState); }
String stringValue() const final;
std::optional<String> platformStringValue() const;
// Parameterized attribute retrieval.
Vector<SimpleRange> findTextRanges(const AccessibilitySearchTextCriteria&) const final;
Vector<String> performTextOperation(const AccessibilityTextOperation&) final;
AccessibilityChildrenVector findMatchingObjects(AccessibilitySearchCriteria&&) final;
#if PLATFORM(COCOA)
bool preventKeyboardDOMEventDispatch() const final { return boolAttributeValue(AXProperty::PreventKeyboardDOMEventDispatch); }
#endif
// CharacterRange support.
CharacterRange selectedTextRange() const final { return propertyValue<CharacterRange>(AXProperty::SelectedTextRange); }
int insertionPointLineNumber() const final;
CharacterRange doAXRangeForLine(unsigned) const final;
String doAXStringForRange(const CharacterRange&) const final;
CharacterRange characterRangeForPoint(const IntPoint&) const final;
CharacterRange doAXRangeForIndex(unsigned) const final;
CharacterRange doAXStyleRangeForIndex(unsigned) const final;
IntRect doAXBoundsForRangeUsingCharacterOffset(const CharacterRange&) const final;
IntRect doAXBoundsForRange(const CharacterRange&) const final;
unsigned doAXLineForIndex(unsigned) final;
VisibleSelection selection() const final;
void setSelectedVisiblePositionRange(const VisiblePositionRange&) const final;
std::optional<SimpleRange> simpleRange() const final;
VisiblePositionRange visiblePositionRange() const final;
String selectedText() const final;
VisiblePositionRange visiblePositionRangeForLine(unsigned) const final;
VisiblePositionRange visiblePositionRangeForUnorderedPositions(const VisiblePosition&, const VisiblePosition&) const final;
VisiblePositionRange leftLineVisiblePositionRange(const VisiblePosition&) const final;
VisiblePositionRange rightLineVisiblePositionRange(const VisiblePosition&) const final;
VisiblePositionRange styleRangeForPosition(const VisiblePosition&) const final;
VisiblePositionRange lineRangeForPosition(const VisiblePosition&) const final;
std::optional<SimpleRange> rangeForCharacterRange(const CharacterRange&) const final;
#if PLATFORM(COCOA)
AXTextMarkerRange textMarkerRangeForNSRange(const NSRange&) const final;
#endif
#if PLATFORM(MAC)
AXTextMarkerRange selectedTextMarkerRange() const final;
#endif
String stringForRange(const SimpleRange&) const final;
IntRect boundsForRange(const SimpleRange&) const final;
VisiblePosition visiblePositionForPoint(const IntPoint&) const final;
VisiblePosition nextLineEndPosition(const VisiblePosition&) const final;
VisiblePosition previousLineStartPosition(const VisiblePosition&) const final;
VisiblePosition visiblePositionForIndex(unsigned, bool lastIndexOK) const final;
VisiblePosition visiblePositionForIndex(int) const final;
int indexForVisiblePosition(const VisiblePosition&) const final;
int lineForPosition(const VisiblePosition&) const final;
std::optional<SimpleRange> visibleCharacterRange() const final;
// Attribute setters.
void setARIAGrabbed(bool) final;
void setIsExpanded(bool) final;
bool setValue(float) final;
void setValueIgnoringResult(float) final;
void setSelected(bool) final;
void setSelectedRows(AccessibilityChildrenVector&&) final;
void setFocused(bool) final;
void setSelectedText(const String&) final;
void setSelectedTextRange(CharacterRange&&) final;
bool setValue(const String&) final;
void setValueIgnoringResult(const String&) final;
#if PLATFORM(MAC)
void setCaretBrowsingEnabled(bool) final;
#endif
#if PLATFORM(COCOA)
void setPreventKeyboardDOMEventDispatch(bool) final;
#endif
String textUnderElement(TextUnderElementMode = { }) const final;
std::optional<SimpleRange> misspellingRange(const SimpleRange&, AccessibilitySearchDirection) const final;
FloatRect convertFrameToSpace(const FloatRect&, AccessibilityConversionSpace) const final;
void increment() final;
void decrement() final;
bool performDismissAction() final;
void performDismissActionIgnoringResult() final;
void scrollToMakeVisible() const final;
void scrollToMakeVisibleWithSubFocus(IntRect&&) const final;
void scrollToGlobalPoint(IntPoint&&) const final;
bool replaceTextInRange(const String&, const CharacterRange&) final;
bool insertText(const String&) final;
bool press() final;
bool isAccessibilityObject() const final { return false; }
// Functions that should never be called on an isolated tree object. ASSERT that these are not reached;
bool isAccessibilityRenderObject() const final;
bool isAccessibilityTableInstance() const final;
bool isAccessibilityARIAGridRowInstance() const final { return false; }
bool isAccessibilityARIAGridCellInstance() const final { return false; }
bool isAXRemoteFrame() const final { return false; }
bool isNativeTextControl() const final;
bool isMockObject() const final;
bool isNonNativeTextControl() const final;
bool isIndeterminate() const final { return boolAttributeValue(AXProperty::IsIndeterminate); }
bool isLoaded() const final { return loadingProgress() >= 1; }
bool isOnScreen() const final;
bool isOffScreen() const final;
bool isPressed() const final;
bool isNonLayerSVGObject() const { return boolAttributeValue(AXProperty::IsNonLayerSVGObject); }
// FIXME: isVisible should be accurate for all objects, not just widgets, on COCOA.
bool isVisible() const final { return boolAttributeValue(AXProperty::IsVisible); }
bool isSelectedOptionActive() const final;
bool hasBoldFont() const final { return boolAttributeValue(AXProperty::HasBoldFont); }
bool hasItalicFont() const final { return boolAttributeValue(AXProperty::HasItalicFont); }
Vector<AXTextMarkerRange> misspellingRanges() const final;
bool hasPlainText() const final { return boolAttributeValue(AXProperty::HasPlainText); }
bool hasSameFont(AXCoreObject&) final;
bool hasSameFontColor(AXCoreObject&) final;
bool hasSameStyle(AXCoreObject&) final;
bool hasUnderline() const final { return boolAttributeValue(AXProperty::HasUnderline); }
bool hasHighlighting() const final { return boolAttributeValue(AXProperty::HasHighlighting); }
AXTextMarkerRange textInputMarkedTextMarkerRange() const final;
Element* element() const final;
Node* node() const final;
RenderObject* renderer() const final;
AccessibilityChildrenVector relatedObjects(AXRelationType) const final;
bool supportsHasPopup() const final;
bool supportsChecked() const final;
bool isModalNode() const final;
bool isDescendantOfRole(AccessibilityRole) const final;
bool inheritsPresentationalRole() const final;
void setAccessibleName(const AtomString&) final;
String textContentPrefixFromListMarker() const final;
String titleAttributeValue() const final;
String title() const final { return stringAttributeValue(AXProperty::Title); }
String description() const final { return stringAttributeValue(AXProperty::Description); }
std::optional<String> textContent() const final;
String text() const final;
unsigned textLength() const final;
#if PLATFORM(COCOA)
RetainPtr<NSAttributedString> attributedStringForTextMarkerRange(AXTextMarkerRange&&, SpellCheck) const final;
RetainPtr<CTFontRef> font() const final { return propertyValue<RetainPtr<CTFontRef>>(AXProperty::Font); }
#endif
AXObjectCache* axObjectCache() const final;
Element* actionElement() const final;
Path elementPath() const final { return pathAttributeValue(AXProperty::Path); };
bool supportsPath() const final { return boolAttributeValue(AXProperty::SupportsPath); }
bool isWidget() const final
{
// Plugins are a widget subclass.
return boolAttributeValue(AXProperty::IsPlugin) || boolAttributeValue(AXProperty::IsWidget);
}
Widget* widget() const final;
PlatformWidget platformWidget() const final;
Widget* widgetForAttachmentView() const final;
bool isPlugin() const final { return boolAttributeValue(AXProperty::IsPlugin); }
#if PLATFORM(COCOA)
RemoteAXObjectRef remoteParentObject() const final;
FloatRect convertRectToPlatformSpace(const FloatRect&, AccessibilityConversionSpace) const final;
#endif
Page* page() const final;
Document* document() const final;
LocalFrameView* documentFrameView() const final;
ScrollView* scrollView() const final;
void detachFromParent() final;
OptionSet<AXAncestorFlag> ancestorFlags() const;
bool hasDocumentRoleAncestor() const final { return ancestorFlags().contains(AXAncestorFlag::HasDocumentRoleAncestor); }
bool hasWebApplicationAncestor() const final { return ancestorFlags().contains(AXAncestorFlag::HasWebApplicationAncestor); }
bool isInDescriptionListDetail() const final { return ancestorFlags().contains(AXAncestorFlag::IsInDescriptionListDetail); }
bool isInDescriptionListTerm() const final { return ancestorFlags().contains(AXAncestorFlag::IsInDescriptionListTerm); }
bool isInCell() const final { return ancestorFlags().contains(AXAncestorFlag::IsInCell); }
String nameAttribute() const final { return stringAttributeValue(AXProperty::NameAttribute); }
#if PLATFORM(COCOA)
bool hasApplePDFAnnotationAttribute() const final { return boolAttributeValue(AXProperty::HasApplePDFAnnotationAttribute); }
RetainPtr<id> remoteFramePlatformElement() const final;
#endif
bool hasRemoteFrameChild() const final { return boolAttributeValue(AXProperty::HasRemoteFrameChild); }
#if PLATFORM(COCOA) && ENABLE(MODEL_ELEMENT)
Vector<RetainPtr<id>> modelElementChildren() final;
#endif
void updateBackingStore() final;
String innerHTML() const final;
String outerHTML() const final;
// FIXME: Make this a ThreadSafeWeakPtr<AXIsolatedTree>.
RefPtr<AXIsolatedTree> m_cachedTree;
Markable<AXID> m_parentID;
bool m_childrenDirty { true };
Vector<AXID> m_childrenIDs;
Vector<Ref<AXCoreObject>> m_children;
AXPropertyMap m_propertyMap;
OptionSet<AXPropertyFlag> m_propertyFlags;
// Some objects (e.g. display:contents) form their geometry through their children.
bool m_getsGeometryFromChildren { false };
#if PLATFORM(COCOA)
RetainPtr<NSView> m_platformWidget;
RetainPtr<RemoteAXObjectRef> m_remoteParent;
#else
PlatformWidget m_platformWidget;
#endif
};
template<typename T>
inline T AXIsolatedObject::propertyValue(AXProperty propertyName) const
{
auto it = m_propertyMap.find(propertyName);
if (it == m_propertyMap.end())
return { };
auto value = it->value;
return WTF::switchOn(value,
[] (T& typedValue) { return typedValue; },
[] (auto&) { ASSERT_NOT_REACHED();
return T(); }
);
}
inline void AXIsolatedObject::setPropertyFlag(AXPropertyFlag flag, bool set)
{
if (set)
m_propertyFlags.add(flag);
else
m_propertyFlags.remove(flag);
}
inline bool AXIsolatedObject::hasPropertyFlag(AXPropertyFlag flag) const
{
return m_propertyFlags.contains(flag);
}
} // namespace WebCore
SPECIALIZE_TYPE_TRAITS_ACCESSIBILITY(AXIsolatedObject, isAXIsolatedObjectInstance())
#endif // ENABLE((ACCESSIBILITY_ISOLATED_TREE))
|