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 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
|
/*
* 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. ``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
* 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 "AXTextMarker.h"
#include "AXTextRun.h"
#include "AXTreeStore.h"
#include "ColorHash.h"
#include "PageIdentifier.h"
#include "RenderStyleConstants.h"
#include "TagName.h"
#include <wtf/HashMap.h>
#include <wtf/Lock.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/RuntimeApplicationChecks.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/ThreadSafeWeakPtr.h>
namespace WTF {
class TextStream;
}
namespace WebCore {
class AXIsolatedObject;
class AXGeometryManager;
class AXObjectCache;
class AccessibilityObject;
class Page;
enum class AXStreamOptions : uint8_t;
// The most common boolean properties are stored in a bitfield rather than in a UncheckedKeyHashMap.
// If you edit these, update AXIsolatedObject::boolAttributeValue and AXIsolatedObject::setProperty.
enum class AXPropertyFlag : uint32_t {
CanSetFocusAttribute = 1 << 0,
CanSetSelectedAttribute = 1 << 1,
CanSetValueAttribute = 1 << 2,
HasBoldFont = 1 << 3,
HasItalicFont = 1 << 4,
HasPlainText = 1 << 5,
IsEnabled = 1 << 6,
IsExposedTableCell = 1 << 7,
IsGrabbed = 1 << 8,
IsIgnored = 1 << 9,
IsInlineText = 1 << 10,
IsKeyboardFocusable = 1 << 11,
IsNonLayerSVGObject = 1 << 12,
IsTableRow = 1 << 13,
SupportsCheckedState = 1 << 14,
SupportsDragging = 1 << 15,
SupportsExpanded = 1 << 16,
SupportsPath = 1 << 17,
SupportsPosInSet = 1 << 18,
SupportsSetSize = 1 << 19
};
enum class AXProperty : uint16_t {
#if !ENABLE(AX_THREAD_TEXT_APIS)
// Rather than caching text content as property when ENABLE(AX_THREAD_TEXT_APIS), we should
// synthesize it on-the-fly using AXProperty::TextRuns.
AttributedText,
#endif // !ENABLE(AX_THREAD_TEXT_APIS)
AXColumnCount,
AXColumnIndex,
AXRowCount,
AXRowIndex,
AccessKey,
AccessibilityText,
ActionVerb,
AncestorFlags,
AutoCompleteValue,
BackgroundColor,
BlockquoteLevel,
BrailleLabel,
BrailleRoleDescription,
ButtonState,
CanBeMultilineTextField,
CanSetFocusAttribute,
CanSetSelectedAttribute,
CanSetValueAttribute,
#if PLATFORM(MAC)
CaretBrowsingEnabled,
#endif
Cells,
CellScope,
CellSlots,
ColorValue,
Columns,
ColumnIndex,
ColumnIndexRange,
CurrentState,
DateTimeComponentsType,
DateTimeValue,
DatetimeAttributeValue,
DecrementButton,
Description,
DisclosedByRow,
DisclosedRows,
DocumentEncoding,
DocumentLinks,
DocumentURI,
EmbeddedImageDescription,
EmitTextAfterBehavior,
ExpandedTextValue,
ExtendedDescription,
#if PLATFORM(COCOA)
Font,
#endif
TextColor,
HasApplePDFAnnotationAttribute,
HasBoldFont,
HasClickHandler,
HasHighlighting,
HasItalicFont,
HasLinethrough,
HasPlainText,
HasRemoteFrameChild,
IsSubscript,
IsSuperscript,
HasTextShadow,
HasUnderline,
HeadingLevel,
HierarchicalLevel,
HorizontalScrollBar,
IdentifierAttribute,
IncrementButton,
InitialFrameRect,
InnerHTML,
InternalLinkElement,
InsideLink,
InvalidStatus,
IsGrabbed,
IsARIATreeGridRow,
IsAttachment,
IsBusy,
IsChecked,
IsColumnHeader,
IsEnabled,
IsExpanded,
IsExposable,
IsExposedTableCell,
IsFieldset,
IsFileUploadButton,
IsIgnored,
IsIndeterminate,
IsInlineText,
IsRadioInput,
IsInputImage,
IsKeyboardFocusable,
IsListBox,
IsMathElement,
IsMathFraction,
IsMathFenced,
IsMathSubscriptSuperscript,
IsMathRow,
IsMathUnderOver,
IsMathRoot,
IsMathSquareRoot,
IsMathTable,
IsMathTableRow,
IsMathTableCell,
IsMathMultiscript,
IsMathToken,
IsMultiSelectable,
IsNonLayerSVGObject,
IsPlugin,
IsPressed,
IsRequired,
IsRowHeader,
IsSecureField,
IsSelected,
IsSelectedOptionActive,
IsTable,
IsTableRow,
IsTree,
IsTreeItem,
IsValueAutofillAvailable,
IsVisible,
IsWidget,
KeyShortcuts,
Language,
LinethroughColor,
#if ENABLE(AX_THREAD_TEXT_APIS)
ListMarkerLineID,
ListMarkerText,
#endif // ENABLE(AX_THREAD_TEXT_APIS)
LiveRegionAtomic,
LiveRegionRelevant,
LiveRegionStatus,
LocalizedActionVerb,
MathFencedOpenString,
MathFencedCloseString,
MathLineThickness,
MathPrescripts,
MathPostscripts,
MathRadicand,
MathRootIndexObject,
MathUnderObject,
MathOverObject,
MathNumeratorObject,
MathDenominatorObject,
MathBaseObject,
MathSubscriptObject,
MathSuperscriptObject,
MaxValueForRange,
MinValueForRange,
NameAttribute,
Orientation,
OuterHTML,
Path,
PlaceholderValue,
PopupValue,
PosInSet,
PreventKeyboardDOMEventDispatch,
RadioButtonGroup,
RelativeFrame,
RemoteFrameOffset,
RemoteFramePlatformElement,
RolePlatformString,
RoleDescription,
Rows,
RowGroupAncestorID,
RowHeader,
RowHeaders,
RowIndex,
RowIndexRange,
ScreenRelativePosition,
SelectedTextRange,
SetSize,
SortDirection,
SpeechHint,
StringValue,
SubrolePlatformString,
SupportsDragging,
SupportsDropping,
SupportsARIAOwns,
SupportsCheckedState,
SupportsCurrent,
SupportsDatetimeAttribute,
SupportsExpanded,
SupportsExpandedTextValue,
SupportsKeyShortcuts,
SupportsPath,
SupportsPosInSet,
SupportsRangeValue,
SupportsSetSize,
TagName,
TextContentPrefixFromListMarker,
#if !ENABLE(AX_THREAD_TEXT_APIS)
// Rather than caching text content as property when ENABLE(AX_THREAD_TEXT_APIS), we should
// synthesize it on-the-fly using AXProperty::TextRuns.
TextContent,
#endif // !ENABLE(AX_THREAD_TEXT_APIS)
TextInputMarkedTextMarkerRange,
#if ENABLE(AX_THREAD_TEXT_APIS)
TextRuns,
#endif
Title,
TitleAttributeValue,
URL,
UnderlineColor,
ValueAutofillButtonType,
ValueDescription,
ValueForRange,
VerticalScrollBar,
VisibleChildren,
VisibleRows,
};
WTF::TextStream& operator<<(WTF::TextStream&, AXProperty);
using AXPropertySet = HashSet<AXProperty, IntHash<AXProperty>, WTF::StrongEnumHashTraits<AXProperty>>;
// If this type is modified, the switchOn statment in AXIsolatedObject::setProperty must be updated as well.
using AXPropertyValueVariant = std::variant<std::nullptr_t, Markable<AXID>, String, bool, int, unsigned, double, float, uint64_t, WallTime, DateComponentsType, AccessibilityButtonState, Color, std::shared_ptr<URL>, LayoutRect, FloatPoint, FloatRect, IntPoint, IntRect, std::pair<unsigned, unsigned>, Vector<AccessibilityText>, Vector<AXID>, Vector<std::pair<Markable<AXID>, Markable<AXID>>>, Vector<String>, std::shared_ptr<Path>, OptionSet<AXAncestorFlag>, InsideLink, Vector<Vector<Markable<AXID>>>, CharacterRange, std::pair<Markable<AXID>, CharacterRange>, TagName
#if PLATFORM(COCOA)
, RetainPtr<NSAttributedString>
, RetainPtr<id>
#endif // PLATFORM(COCOA)
#if ENABLE(AX_THREAD_TEXT_APIS)
, RetainPtr<CTFontRef>
, AXTextRuns
, TextEmissionBehavior
, AXTextRunLineID
#endif // ENABLE(AX_THREAD_TEXT_APIS)
>;
using AXPropertyMap = UncheckedKeyHashMap<AXProperty, AXPropertyValueVariant, IntHash<AXProperty>, WTF::StrongEnumHashTraits<AXProperty>>;
WTF::TextStream& operator<<(WTF::TextStream&, const AXPropertyMap&);
struct AXPropertyChange {
AXID axID; // ID of the object whose properties changed.
AXPropertyMap properties; // Changed properties.
};
struct NodeUpdateOptions {
AXPropertySet properties;
bool shouldUpdateNode { false };
bool shouldUpdateChildren { false };
NodeUpdateOptions(const AXPropertySet& propertyNames, bool shouldUpdateNode, bool shouldUpdateChildren)
: properties(propertyNames)
, shouldUpdateNode(shouldUpdateNode)
, shouldUpdateChildren(shouldUpdateChildren)
{ }
NodeUpdateOptions(const AXPropertySet& propertyNames)
: properties(propertyNames)
{ }
NodeUpdateOptions(AXProperty propertyName)
: properties({ propertyName })
{ }
static NodeUpdateOptions nodeUpdate()
{
return { { }, true, false };
}
static NodeUpdateOptions childrenUpdate()
{
return { { }, false, true };
}
};
DECLARE_ALLOCATOR_WITH_HEAP_IDENTIFIER(AXIsolatedTree);
class AXIsolatedTree : public ThreadSafeRefCountedAndCanMakeThreadSafeWeakPtr<AXIsolatedTree>
, public AXTreeStore<AXIsolatedTree> {
WTF_MAKE_NONCOPYABLE(AXIsolatedTree);
WTF_MAKE_TZONE_ALLOCATED(AXIsolatedTree);
friend WTF::TextStream& operator<<(WTF::TextStream&, AXIsolatedTree&);
friend void streamIsolatedSubtreeOnMainThread(TextStream&, const AXIsolatedTree&, AXID, const OptionSet<AXStreamOptions>&);
public:
static RefPtr<AXIsolatedTree> create(AXObjectCache&);
// Creates a tree consisting of only the Scrollview and the WebArea objects. This tree is used as a temporary placeholder while the whole tree is being built.
static Ref<AXIsolatedTree> createEmpty(AXObjectCache&);
constexpr bool isEmptyContentTree() const { return m_isEmptyContentTree; }
virtual ~AXIsolatedTree();
static void removeTreeForPageID(PageIdentifier);
static RefPtr<AXIsolatedTree> treeForPageID(std::optional<PageIdentifier>);
static RefPtr<AXIsolatedTree> treeForPageID(PageIdentifier);
AXObjectCache* axObjectCache() const;
constexpr AXGeometryManager* geometryManager() const { return m_geometryManager.get(); }
AXIsolatedObject* rootNode() { return m_rootNode.get(); }
RefPtr<AXIsolatedObject> rootWebArea();
std::optional<AXID> focusedNodeID();
WEBCORE_EXPORT RefPtr<AXIsolatedObject> focusedNode();
AXIsolatedObject* objectForID(AXID) const;
inline AXIsolatedObject* objectForID(std::optional<AXID> axID) const
{
return axID ? objectForID(*axID) : nullptr;
}
template<typename U> Vector<Ref<AXCoreObject>> objectsForIDs(const U&);
void generateSubtree(AccessibilityObject&);
bool shouldCreateNodeChange(AccessibilityObject&);
void updateNode(AccessibilityObject&);
enum class ResolveNodeChanges : bool { No, Yes };
void updateChildren(AccessibilityObject&, ResolveNodeChanges = ResolveNodeChanges::Yes);
void updateChildrenForObjects(const ListHashSet<Ref<AccessibilityObject>>&);
void updateNodeProperty(AccessibilityObject& object, AXProperty property) { updateNodeProperties(object, { property }); }
void updateNodeProperties(AccessibilityObject&, const AXPropertySet&);
void updateNodeProperties(AccessibilityObject* axObject, const AXPropertySet& properties)
{
if (axObject)
updateNodeProperties(*axObject, properties);
}
void updateDependentProperties(AccessibilityObject&);
void updatePropertiesForSelfAndDescendants(AccessibilityObject&, const AXPropertySet&);
void updateFrame(AXID, IntRect&&);
void updateRootScreenRelativePosition();
void overrideNodeProperties(AXID, AXPropertyMap&&);
double loadingProgress();
void updateLoadingProgress(double);
void addUnconnectedNode(Ref<AccessibilityObject>);
bool isUnconnectedNode(std::optional<AXID> axID) const { return axID && m_unconnectedNodes.contains(*axID); }
// Removes the corresponding isolated object and all descendants from the m_nodeMap and queues their removal from the tree.
void removeNode(AXID, std::optional<AXID> /* parentID */);
// Removes the given node and all its descendants from m_nodeMap.
void removeSubtreeFromNodeMap(std::optional<AXID>, std::optional<AXID> /* parentID */);
void objectBecameIgnored(const AccessibilityObject& object)
{
#if !ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
// When an object becomes ignored, we should immediately remove it from the nodemap.
// This is critical because objects can become ignored at any point, including in the
// middle of AXObjectCache::handleChildrenChanged(). Consider this tree structure:
// <main> (not ignored)
// ++<div> (not ignored)
// Imagine <div> gains new children, and we run handleChildrenChanged() for it. However,
// it becomes ignored in the middle of handleChildrenChanged(). We will still call
// AXIsolatedTree::updateChildren for this <div>, and because it isn't yet removed from
// the nodemap, we will run the children update on the <div> rather than the <main>.
// Eagerly removing <div> from the nodemap when it becomes ignored prevents this by
// allowing us to ascend up the nodemap to the <main>, which can properly scoop up <div>s children.
// Note that this problem is only relevant in a world where !ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE),
// because when that flag is on, is-ignored doesn't matter when building the core-tree.
// Normally, when removing things from the nodemap, we want to use removeSubtreeFromNodeMap because
// it removes both the given object, and all its descendants, as the descendants should not be in the
// tree without some parent. However, when something becomes ignored, those descendants still exist,
// just with a different parent (the next unignored ancestor). So we can safely only remove the given
// object from the nodemap, and rely on the normal updateChildren flow to repair parent relationships
// as needed.
m_nodeMap.remove(object.objectID());
// Any queued parent updates no longer need to happen (and if we do try to process them, we'll crash,
// since this object is no longer in the node map).
m_needsParentUpdate.remove(object.objectID());
#endif // !ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
#if ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
objectChangedIgnoredState(object);
queueNodeUpdate(object.objectID(), { AXProperty::IsIgnored });
#endif // ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
}
void objectBecameUnignored(const AccessibilityObject& object)
{
#if ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
// We only cache minimal properties for ignored objects, so do a full node update to ensure all properties are cached.
queueNodeUpdate(object.objectID(), NodeUpdateOptions::nodeUpdate());
objectChangedIgnoredState(object);
#else
UNUSED_PARAM(object);
#endif // ENABLE(INCLUDE_IGNORED_IN_CORE_AX_TREE)
}
// Both setPendingRootNodeLocked and setFocusedNodeID are called during the generation
// of the IsolatedTree.
// Focused node updates in AXObjectCache use setFocusNodeID.
void setPendingRootNodeLocked(AXIsolatedObject&) WTF_REQUIRES_LOCK(m_changeLogLock);
void setFocusedNodeID(std::optional<AXID>);
void applyPendingRootNode();
// Relationships between objects.
std::optional<ListHashSet<AXID>> relatedObjectIDsFor(const AXIsolatedObject&, AXRelationType);
void relationsNeedUpdate(bool needUpdate) { m_relationsNeedUpdate = needUpdate; }
void updateRelations(const UncheckedKeyHashMap<AXID, AXRelations>&);
// Called on AX thread from WebAccessibilityObjectWrapper methods.
// During layout tests, it is called on the main thread.
void applyPendingChanges();
constexpr AXID treeID() const { return m_id; }
constexpr ProcessID processID() const { return m_processID; }
void setPageActivityState(OptionSet<ActivityState>);
OptionSet<ActivityState> pageActivityState() const;
// Use only if the s_storeLock is already held like in findAXTree.
WEBCORE_EXPORT OptionSet<ActivityState> lockedPageActivityState() const;
AXTextMarkerRange selectedTextMarkerRange();
void setSelectedTextMarkerRange(AXTextMarkerRange&&);
void queueNodeUpdate(AXID, const NodeUpdateOptions&);
void queueNodeRemoval(const AccessibilityObject&);
void processQueuedNodeUpdates();
#if ENABLE(AX_THREAD_TEXT_APIS)
AXTextMarker firstMarker();
AXTextMarker lastMarker();
#endif
private:
AXIsolatedTree(AXObjectCache&);
static void storeTree(AXObjectCache&, const Ref<AXIsolatedTree>&);
void reportLoadingProgress(double);
// Queue this isolated tree up to destroy itself on the secondary thread.
// We can't destroy the tree on the main-thread (by removing all `Ref`s to it)
// because it could be being used by the secondary thread to service an AX request.
void queueForDestruction();
static UncheckedKeyHashMap<PageIdentifier, Ref<AXIsolatedTree>>& treePageCache() WTF_REQUIRES_LOCK(s_storeLock);
void createEmptyContent(AccessibilityObject&);
constexpr bool isUpdatingSubtree() const { return m_rootOfSubtreeBeingUpdated; }
constexpr void updatingSubtree(AccessibilityObject* axObject) { m_rootOfSubtreeBeingUpdated = axObject; }
enum class AttachWrapper : bool { OnMainThread, OnAXThread };
struct NodeChange {
Ref<AXIsolatedObject> isolatedObject;
#if PLATFORM(COCOA)
RetainPtr<AccessibilityObjectWrapper> wrapper;
#elif USE(ATSPI)
RefPtr<AccessibilityObjectWrapper> wrapper;
#endif
AttachWrapper attachWrapper { AttachWrapper::OnMainThread };
};
std::optional<NodeChange> nodeChangeForObject(Ref<AccessibilityObject>, AttachWrapper = AttachWrapper::OnMainThread);
void collectNodeChangesForSubtree(AccessibilityObject&);
bool isCollectingNodeChanges() const { return m_collectingNodeChangesAtTreeLevel > 0; }
void queueChange(const NodeChange&) WTF_REQUIRES_LOCK(m_changeLogLock);
void queueRemovals(Vector<AXID>&&);
void queueRemovalsLocked(Vector<AXID>&&) WTF_REQUIRES_LOCK(m_changeLogLock);
void queueRemovalsAndUnresolvedChanges();
Vector<NodeChange> resolveAppends();
void queueAppendsAndRemovals(Vector<NodeChange>&&, Vector<AXID>&&);
void objectChangedIgnoredState(const AccessibilityObject&);
const ProcessID m_processID { legacyPresentingApplicationPID() };
unsigned m_maxTreeDepth { 0 };
WeakPtr<AXObjectCache> m_axObjectCache;
OptionSet<ActivityState> m_pageActivityState;
RefPtr<AXGeometryManager> m_geometryManager;
bool m_isEmptyContentTree { false };
// Reference to a temporary, empty content tree that this tree will replace. Used for updating the empty content tree while this is built.
RefPtr<AXIsolatedTree> m_replacingTree;
RefPtr<AccessibilityObject> m_rootOfSubtreeBeingUpdated;
// Stores the parent ID and children IDs for a given IsolatedObject.
struct ParentChildrenIDs {
Markable<AXID> parentID;
Vector<AXID> childrenIDs;
};
// Only accessed on the main thread.
// A representation of the tree's parent-child relationships. Each
// IsolatedObject must have one and only one entry in this map, that maps
// its ObjectID to its ParentChildrenIDs struct.
UncheckedKeyHashMap<AXID, ParentChildrenIDs> m_nodeMap;
// Only accessed on the main thread.
// Stores all nodes that are added via addUnconnectedNode, which do not get stored in m_nodeMap.
HashSet<AXID> m_unconnectedNodes;
// Only accessed on the main thread.
// The key is the ID of the object that will be resolved into an m_pendingAppends NodeChange.
// The value is whether the wrapper should be attached on the main thread or the AX thread.
UncheckedKeyHashMap<AXID, AttachWrapper> m_unresolvedPendingAppends;
// Only accessed on the main thread.
// While performing tree updates, we append nodes to this list that are no longer connected
// in the tree and should be removed. This list turns into m_pendingSubtreeRemovals when
// handed off to the secondary thread.
Vector<AXID> m_subtreesToRemove;
// Only accessed on the main thread.
// This is used when updating the isolated tree in response to dynamic children changes.
// It is required to protect objects from being incorrectly deleted when they are re-parented,
// as the original parent will want to queue it for removal, but we need to keep the object around
// for the new parent.
HashSet<AXID> m_protectedFromDeletionIDs;
// Only accessed on the main thread.
// Objects whose parent has changed, and said change needs to be synced to the secondary thread.
HashSet<AXID> m_needsParentUpdate;
// 1-based tree level, 0 = not collecting. Only accessed on the main thread.
unsigned m_collectingNodeChangesAtTreeLevel { 0 };
// Only accessed on AX thread.
UncheckedKeyHashMap<AXID, Ref<AXIsolatedObject>> m_readerThreadNodeMap;
RefPtr<AXIsolatedObject> m_rootNode;
// Written to by main thread under lock, accessed and applied by AX thread.
RefPtr<AXIsolatedObject> m_pendingRootNode WTF_GUARDED_BY_LOCK(m_changeLogLock);
Vector<NodeChange> m_pendingAppends WTF_GUARDED_BY_LOCK(m_changeLogLock); // Nodes to be added to the tree and platform-wrapped.
Vector<AXPropertyChange> m_pendingPropertyChanges WTF_GUARDED_BY_LOCK(m_changeLogLock);
Vector<AXID> m_pendingSubtreeRemovals WTF_GUARDED_BY_LOCK(m_changeLogLock); // Nodes whose subtrees are to be removed from the tree.
Vector<std::pair<AXID, Vector<AXID>>> m_pendingChildrenUpdates WTF_GUARDED_BY_LOCK(m_changeLogLock);
HashSet<AXID> m_pendingProtectedFromDeletionIDs WTF_GUARDED_BY_LOCK(m_changeLogLock);
UncheckedKeyHashMap<AXID, AXID> m_pendingParentUpdates WTF_GUARDED_BY_LOCK(m_changeLogLock);
Markable<AXID> m_pendingFocusedNodeID WTF_GUARDED_BY_LOCK(m_changeLogLock);
bool m_queuedForDestruction WTF_GUARDED_BY_LOCK(m_changeLogLock) { false };
Markable<AXID> m_focusedNodeID;
std::atomic<double> m_loadingProgress { 0 };
std::atomic<double> m_processingProgress { 1 };
// Relationships between objects.
UncheckedKeyHashMap<AXID, AXRelations> m_relations WTF_GUARDED_BY_LOCK(m_changeLogLock);
// Set to true by the AXObjectCache and false by AXIsolatedTree.
bool m_relationsNeedUpdate { true };
Lock m_changeLogLock;
AXTextMarkerRange m_selectedTextMarkerRange WTF_GUARDED_BY_LOCK(m_changeLogLock);
// Queued node updates used for building a new tree snapshot.
ListHashSet<AXID> m_needsUpdateChildren;
ListHashSet<AXID> m_needsUpdateNode;
UncheckedKeyHashMap<AXID, AXPropertySet> m_needsPropertyUpdates;
// The key is the ID of the node being removed. The value is the ID of the parent in the core tree (if it exists).
UncheckedKeyHashMap<AXID, std::optional<AXID>> m_needsNodeRemoval;
};
inline AXObjectCache* AXIsolatedTree::axObjectCache() const
{
ASSERT(isMainThread());
return m_axObjectCache.get();
}
inline RefPtr<AXIsolatedTree> AXIsolatedTree::treeForPageID(std::optional<PageIdentifier> pageID)
{
return pageID ? treeForPageID(*pageID) : nullptr;
}
template<typename U>
inline Vector<Ref<AXCoreObject>> AXIsolatedTree::objectsForIDs(const U& axIDs)
{
ASSERT(!isMainThread());
Vector<Ref<AXCoreObject>> result;
result.reserveInitialCapacity(axIDs.size());
for (const auto& axID : axIDs) {
if (RefPtr object = objectForID(axID))
result.append(object.releaseNonNull());
}
result.shrinkToFit();
return result;
}
} // namespace WebCore
#endif
|