#include <ax_node_position.h>

Inheritance diagram for ui::AXNodePosition:

Public Member Functions
	AXNodePosition ()

	~AXNodePosition () override

	AXNodePosition (const AXNodePosition &other)

AXPositionInstance	Clone () const override

std::u16string	GetText () const override

bool	IsInLineBreak () const override

bool	IsInTextObject () const override

bool	IsInWhiteSpace () const override

int	MaxTextOffset () const override

Public Member Functions inherited from ui::AXPosition< AXNodePosition, AXNode >
virtual	~AXPosition ()=default

AXPosition &	operator= (const AXPosition &other)

SerializedPosition	Serialize ()

std::string	ToString () const

AXTreeID	tree_id () const

AXNode::AXID	anchor_id () const

AXNode *	GetAnchor () const

AXPositionKind	kind () const

int	child_index () const

int	text_offset () const

ax::mojom::TextAffinity	affinity () const

bool	IsIgnored () const

bool	IsNullPosition () const

bool	IsTreePosition () const

bool	IsLeafTreePosition () const

bool	IsTextPosition () const

bool	IsLeafTextPosition () const

bool	IsLeaf () const

bool	IsValid () const

bool	AtStartOfAnchor () const

bool	AtEndOfAnchor () const

bool	AtStartOfWord () const

bool	AtEndOfWord () const

bool	AtStartOfLine () const

bool	AtEndOfLine () const

bool	AtStartOfParagraph () const

bool	AtEndOfParagraph () const

bool	AtStartOfPage () const

bool	AtEndOfPage () const

bool	AtStartOfAXTree () const

bool	AtEndOfAXTree () const

AXBoundaryType	GetFormatStartBoundaryType () const

bool	AtStartOfFormat () const

AXBoundaryType	GetFormatEndBoundaryType () const

bool	AtEndOfFormat () const

bool	AtStartOfInlineBlock () const

bool	AtStartOfDocument () const

bool	AtEndOfDocument () const

bool	AtLastNodeInTree () const

AXNode *	LowestCommonAnchor (const AXPosition &second) const

AXPositionInstance	LowestCommonAncestor (const AXPosition &second) const

AXPositionInstance	CreateAncestorPosition (const AXNode *ancestor_anchor, ax::mojom::MoveDirection move_direction=ax::mojom::MoveDirection::kForward) const

AXPositionInstance	AsValidPosition () const

AXPositionInstance	AsTreePosition () const

AXPositionInstance	AsLeafTreePosition () const

AXPositionInstance	AsTextPosition () const

AXPositionInstance	AsLeafTextPosition () const

AXPositionInstance	AsUnignoredPosition (AXPositionAdjustmentBehavior adjustment_behavior) const

AXRangeType	ExpandToEnclosingTextBoundary (ax::mojom::TextBoundary boundary, AXRangeExpandBehavior expand_behavior) const

AXPositionInstance	CreatePositionAtTextBoundary (ax::mojom::TextBoundary boundary, ax::mojom::MoveDirection direction, AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePositionAtStartOfAnchor () const

AXPositionInstance	CreatePositionAtEndOfAnchor () const

AXPositionInstance	CreatePositionAtStartOfAXTree () const

AXPositionInstance	CreatePositionAtEndOfAXTree () const

AXPositionInstance	CreatePositionAtStartOfDocument () const

AXPositionInstance	CreatePositionAtEndOfDocument () const

AXPositionInstance	CreateChildPositionAt (int child_index) const

AXPositionInstance	CreateParentPosition (ax::mojom::MoveDirection move_direction=ax::mojom::MoveDirection::kForward) const

AXPositionInstance	CreateNextLeafTreePosition () const

AXPositionInstance	CreatePreviousLeafTreePosition () const

AXPositionInstance	CreateNextLeafTextPosition (bool *crossed_line_breaking_object=nullptr) const

AXPositionInstance	CreatePreviousLeafTextPosition () const

AXPositionInstance	AsLeafTextPositionBeforeCharacter () const

AXPositionInstance	AsLeafTextPositionAfterCharacter () const

AXPositionInstance	CreateNextCharacterPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousCharacterPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextWordStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousWordStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextWordEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousWordEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextLineStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousLineStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextLineEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousLineEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousFormatStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextFormatEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextParagraphStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousParagraphStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextParagraphEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousParagraphEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextPageStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousPageStartPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateNextPageEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreatePreviousPageEndPosition (AXBoundaryBehavior boundary_behavior) const

AXPositionInstance	CreateBoundaryStartPosition (AXBoundaryBehavior boundary_behavior, ax::mojom::MoveDirection move_direction, BoundaryConditionPredicate at_start_condition, BoundaryConditionPredicate at_end_condition, BoundaryTextOffsetsFunc get_start_offsets={}) const

AXPositionInstance	CreateBoundaryEndPosition (AXBoundaryBehavior boundary_behavior, ax::mojom::MoveDirection move_direction, BoundaryConditionPredicate at_start_condition, BoundaryConditionPredicate at_end_condition, BoundaryTextOffsetsFunc get_end_offsets={}) const

AXPositionInstance	CreateNextAnchorPosition () const

AXPositionInstance	CreatePreviousAnchorPosition () const

std::optional< int >	CompareTo (const AXPosition &other) const

std::optional< int >	SlowCompareTo (const AXPosition &other) const

void	SnapToMaxTextOffsetIfBeyond ()

bool	IsEmptyObjectReplacedByCharacter () const

bool	IsInDescendantOfEmptyObject () const

AXNode *	GetEmptyObjectAncestorNode () const

void	swap (AXPosition &other)

Static Public Member Functions
static AXPositionInstance	CreatePosition (const AXNode &node, int child_index_or_text_offset, ax::mojom::TextAffinity affinity=ax::mojom::TextAffinity::kDownstream)

Static Public Member Functions inherited from ui::AXPosition< AXNodePosition, AXNode >
static AXPositionInstance	CreateNullPosition ()

static AXPositionInstance	CreateTreePosition (AXTreeID tree_id, AXNode::AXID anchor_id, int child_index)

static AXPositionInstance	CreateTextPosition (AXTreeID tree_id, AXNode::AXID anchor_id, int text_offset, ax::mojom::TextAffinity affinity)

static AXPositionInstance	Unserialize (const SerializedPosition &serialization)

Protected Member Functions
void	AnchorChild (int child_index, AXTreeID tree_id, AXNode::AXID child_id) const override

int	AnchorChildCount () const override

int	AnchorUnignoredChildCount () const override

int	AnchorIndexInParent () const override

int	AnchorSiblingCount () const override

std::stack< AXNode * >	GetAncestorAnchors () const override

AXNode *	GetLowestUnignoredAncestor () const override

void	AnchorParent (AXTreeID tree_id, AXNode::AXID parent_id) const override

AXNode *	GetNodeInTree (AXTreeID tree_id, AXNode::AXID node_id) const override

AXNode::AXID	GetAnchorID (AXNode *node) const override

AXTreeID	GetTreeID (AXNode *node) const override

bool	IsEmbeddedObjectInParent () const override

bool	IsInLineBreakingObject () const override

ax::mojom::Role	GetAnchorRole () const override

ax::mojom::Role	GetRole (AXNode *node) const override

AXNodeTextStyles	GetTextStyles () const override

std::vector< int32_t >	GetWordStartOffsets () const override

std::vector< int32_t >	GetWordEndOffsets () const override

AXNode::AXID	GetNextOnLineID (AXNode::AXID node_id) const override

AXNode::AXID	GetPreviousOnLineID (AXNode::AXID node_id) const override

Protected Member Functions inherited from ui::AXPosition< AXNodePosition, AXNode >
	AXPosition ()

	AXPosition (const AXPosition &other)

int	AnchorTextOffsetInParent () const

void	Initialize (AXPositionKind kind, AXTreeID tree_id, int32_t anchor_id, int child_index, int text_offset, ax::mojom::TextAffinity affinity)

int	MaxTextOffsetInParent () const

Additional Inherited Members
Public Types inherited from ui::AXPosition< AXNodePosition, AXNode >
using	AXPositionInstance = std::unique_ptr< AXPosition< AXNodePosition, AXNode > >

using	AXRangeType = AXRange< AXPosition< AXNodePosition, AXNode > >

typedef bool	BoundaryConditionPredicate(const AXPositionInstance &)

typedef std::vector< int32_t >	BoundaryTextOffsetsFunc(const AXPositionInstance &)

Static Public Attributes inherited from ui::AXPosition< AXNodePosition, AXNode >
static const int	BEFORE_TEXT

static const int	INVALID_INDEX

static const int	INVALID_OFFSET

static constexpr char16_t	kEmbeddedCharacter

Detailed Description

Definition at line 21 of file ax_node_position.h.

Constructor & Destructor Documentation

◆ AXNodePosition() [1/2]

ui::AXNodePosition::AXNodePosition ( )

default

Referenced by Clone().

◆ ~AXNodePosition()

ui::AXNodePosition::~AXNodePosition ( )

overridedefault

◆ AXNodePosition() [2/2]

ui::AXNodePosition::AXNodePosition ( const AXNodePosition & other )

Definition at line 54 of file ax_node_position.cc.

55 : AXPosition<AXNodePosition, AXNode>(other) {}

Member Function Documentation

◆ AnchorChild()

void ui::AXNodePosition::AnchorChild	(	int	child_index,
		AXTreeID *	tree_id,
		AXNode::AXID *	child_id
	)		const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 61 of file ax_node_position.cc.

                                                             {
  BASE_DCHECK(tree_id);
  BASE_DCHECK(child_id);
 
  if (!GetAnchor() || child_index < 0 || child_index >= AnchorChildCount()) {
    *tree_id = AXTreeIDUnknown();
    *child_id = AXNode::kInvalidAXID;
    return;
  }
 
  AXNode* child = nullptr;
  const AXTreeManager* child_tree_manager =
      AXTreeManagerMap::GetInstance().GetManagerForChildTree(*GetAnchor());
  if (child_tree_manager) {
    // The child node exists in a separate tree from its parent.
    child = child_tree_manager->GetRootAsAXNode();
    *tree_id = child_tree_manager->GetTreeID();
  } else {
    child = GetAnchor()->children()[static_cast<size_t>(child_index)];
    *tree_id = this->tree_id();
  }
 
  BASE_DCHECK(child);
  *child_id = child->id();
}

References AnchorChildCount(), ui::AXTreeIDUnknown(), BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::child_index(), ui::AXNode::children(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXTreeManagerMap::GetInstance(), ui::AXTreeManagerMap::GetManagerForChildTree(), ui::AXTreeManager::GetRootAsAXNode(), ui::AXTreeManager::GetTreeID(), ui::AXNode::id(), ui::AXNode::kInvalidAXID, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

◆ AnchorChildCount()

int ui::AXNodePosition::AnchorChildCount ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 89 of file ax_node_position.cc.

                                           {
  if (!GetAnchor())
    return 0;
 
  const AXTreeManager* child_tree_manager =
      AXTreeManagerMap::GetInstance().GetManagerForChildTree(*GetAnchor());
  if (child_tree_manager)
    return 1;
 
  return static_cast<int>(GetAnchor()->children().size());
}

References ui::AXNode::children(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXTreeManagerMap::GetInstance(), and ui::AXTreeManagerMap::GetManagerForChildTree().

Referenced by AnchorChild(), GetText(), and MaxTextOffset().

◆ AnchorIndexInParent()

int ui::AXNodePosition::AnchorIndexInParent ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 108 of file ax_node_position.cc.

                                              {
  return GetAnchor() ? static_cast<int>(GetAnchor()->index_in_parent())
                     : INVALID_INDEX;
}

References ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::index_in_parent(), and ui::AXPosition< AXNodePosition, AXNode >::INVALID_INDEX.

◆ AnchorParent()

void ui::AXNodePosition::AnchorParent	(	AXTreeID *	tree_id,
		AXNode::AXID *	parent_id
	)		const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 150 of file ax_node_position.cc.

                                                               {
  BASE_DCHECK(tree_id);
  BASE_DCHECK(parent_id);
 
  *tree_id = AXTreeIDUnknown();
  *parent_id = AXNode::kInvalidAXID;
 
  if (!GetAnchor())
    return;
 
  AXNode* parent =
      GetParent(GetAnchor() /*child*/, this->tree_id() /*child_tree_id*/,
                tree_id /*parent_tree_id*/, parent_id /*parent_id*/);
 
  if (!parent) {
    *tree_id = AXTreeIDUnknown();
    *parent_id = AXNode::kInvalidAXID;
  }
}

References ui::AXTreeIDUnknown(), BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::kInvalidAXID, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

◆ AnchorSiblingCount()

int ui::AXNodePosition::AnchorSiblingCount ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 113 of file ax_node_position.cc.

                                             {
  AXNode* parent = GetAnchor()->GetUnignoredParent();
  if (parent)
    return static_cast<int>(parent->GetUnignoredChildCount());
 
  return 0;
}

References ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::GetUnignoredChildCount(), and ui::AXNode::GetUnignoredParent().

◆ AnchorUnignoredChildCount()

int ui::AXNodePosition::AnchorUnignoredChildCount ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 101 of file ax_node_position.cc.

                                                    {
  if (!GetAnchor())
    return 0;
 
  return static_cast<int>(GetAnchor()->GetUnignoredChildCount());
}

References ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), and ui::AXNode::GetUnignoredChildCount().

◆ Clone()

AXNodePosition::AXPositionInstance ui::AXNodePosition::Clone ( ) const

overridevirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 57 of file ax_node_position.cc.

                                                             {
  return AXPositionInstance(new AXNodePosition(*this));
}

References AXNodePosition().

◆ CreatePosition()

AXNodePosition::AXPositionInstance ui::AXNodePosition::CreatePosition	(	const AXNode &	node,
		int	child_index_or_text_offset,
		ax::mojom::TextAffinity	affinity = `ax::mojom::TextAffinity::kDownstream`
	)

static

Definition at line 34 of file ax_node_position.cc.

                                  {
  if (!node.tree())
    return CreateNullPosition();
 
  AXTreeID tree_id = node.tree()->GetAXTreeID();
  if (node.IsText()) {
    return CreateTextPosition(tree_id, node.id(), child_index_or_text_offset,
                              affinity);
  }
 
  return CreateTreePosition(tree_id, node.id(), child_index_or_text_offset);
}

References ui::AXPosition< AXNodePosition, AXNode >::affinity(), ui::AXPosition< AXNodePosition, AXNode >::CreateNullPosition(), ui::AXPosition< AXNodePosition, AXNode >::CreateTextPosition(), ui::AXPosition< AXNodePosition, AXNode >::CreateTreePosition(), ui::AXNode::OwnerTree::GetAXTreeID(), ui::AXNode::id(), ui::AXNode::IsText(), ui::AXNode::tree(), and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

Referenced by flutter::FlutterPlatformNodeDelegate::CreateTextPositionAt(), and ui::AXTree::GetUnignoredSelection().

◆ GetAncestorAnchors()

std::stack< AXNode * > ui::AXNodePosition::GetAncestorAnchors ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 121 of file ax_node_position.cc.

                                                           {
  std::stack<AXNode*> anchors;
  AXNode* current_anchor = GetAnchor();
 
  AXNode::AXID current_anchor_id = GetAnchor()->id();
  AXTreeID current_tree_id = tree_id();
 
  AXNode::AXID parent_anchor_id = AXNode::kInvalidAXID;
  AXTreeID parent_tree_id = AXTreeIDUnknown();
 
  while (current_anchor) {
    anchors.push(current_anchor);
    current_anchor = GetParent(
        current_anchor /*child*/, current_tree_id /*child_tree_id*/,
        &parent_tree_id /*parent_tree_id*/, &parent_anchor_id /*parent_id*/);
 
    current_anchor_id = parent_anchor_id;
    current_tree_id = parent_tree_id;
  }
  return anchors;
}

References ui::AXTreeIDUnknown(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::id(), ui::AXNode::kInvalidAXID, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

◆ GetAnchorID()

AXNode::AXID ui::AXNodePosition::GetAnchorID ( AXNode * node ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 182 of file ax_node_position.cc.

                                                         {
  return node->id();
}

References ui::AXNode::id().

◆ GetAnchorRole()

ax::mojom::Role ui::AXNodePosition::GetAnchorRole ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 307 of file ax_node_position.cc.

                                                {
  if (IsNullPosition())
    return ax::mojom::Role::kNone;
  BASE_DCHECK(GetAnchor());
  return GetRole(GetAnchor());
}

References BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), GetRole(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and ax::mojom::kNone.

◆ GetLowestUnignoredAncestor()

AXNode * ui::AXNodePosition::GetLowestUnignoredAncestor ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 143 of file ax_node_position.cc.

                                                         {
  if (!GetAnchor())
    return nullptr;
 
  return GetAnchor()->GetUnignoredParent();
}

References ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), and ui::AXNode::GetUnignoredParent().

◆ GetNextOnLineID()

AXNode::AXID ui::AXNodePosition::GetNextOnLineID ( AXNode::AXID node_id ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 363 of file ax_node_position.cc.

                                                                   {
  if (IsNullPosition())
    return AXNode::kInvalidAXID;
  AXNode* node = GetNodeInTree(tree_id(), node_id);
  int next_on_line_id;
  if (!node || !node->data().GetIntAttribute(
                   ax::mojom::IntAttribute::kNextOnLineId, &next_on_line_id)) {
    return AXNode::kInvalidAXID;
  }
  return static_cast<AXNode::AXID>(next_on_line_id);
}

References ui::AXNode::data(), ui::AXNodeData::GetIntAttribute(), GetNodeInTree(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ui::AXNode::kInvalidAXID, ax::mojom::kNextOnLineId, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

◆ GetNodeInTree()

AXNode * ui::AXNodePosition::GetNodeInTree	(	AXTreeID	tree_id,
		AXNode::AXID	node_id
	)		const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 171 of file ax_node_position.cc.

                                                                {
  if (node_id == AXNode::kInvalidAXID)
    return nullptr;
 
  AXTreeManager* manager = AXTreeManagerMap::GetInstance().GetManager(tree_id);
  if (manager)
    return manager->GetNodeFromTree(tree_id, node_id);
  return nullptr;
}

References ui::AXTreeManagerMap::GetInstance(), ui::AXTreeManagerMap::GetManager(), ui::AXNode::kInvalidAXID, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

Referenced by GetNextOnLineID(), and GetPreviousOnLineID().

◆ GetPreviousOnLineID()

AXNode::AXID ui::AXNodePosition::GetPreviousOnLineID ( AXNode::AXID node_id ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 375 of file ax_node_position.cc.

                                                                       {
  if (IsNullPosition())
    return AXNode::kInvalidAXID;
  AXNode* node = GetNodeInTree(tree_id(), node_id);
  int previous_on_line_id;
  if (!node ||
      !node->data().GetIntAttribute(ax::mojom::IntAttribute::kPreviousOnLineId,
                                    &previous_on_line_id)) {
    return AXNode::kInvalidAXID;
  }
  return static_cast<AXNode::AXID>(previous_on_line_id);
}

References ui::AXNode::data(), ui::AXNodeData::GetIntAttribute(), GetNodeInTree(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ui::AXNode::kInvalidAXID, ax::mojom::kPreviousOnLineId, and ui::AXPosition< AXNodePosition, AXNode >::tree_id().

◆ GetRole()

ax::mojom::Role ui::AXNodePosition::GetRole ( AXNode * node ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 314 of file ax_node_position.cc.

                                                      {
  return node->data().role;
}

References ui::AXNode::data(), and ui::AXNodeData::role.

Referenced by GetAnchorRole().

◆ GetText()

std::u16string ui::AXNodePosition::GetText ( ) const

overridevirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 190 of file ax_node_position.cc.

                                           {
  if (IsNullPosition())
    return {};
 
  std::u16string text;
  if (IsEmptyObjectReplacedByCharacter()) {
    text += kEmbeddedCharacter;
    return text;
  }
 
  const AXNode* anchor = GetAnchor();
  BASE_DCHECK(anchor);
  // TODO(nektar): Replace with PlatformChildCount when AXNodePosition and
  // BrowserAccessibilityPosition are merged into one class.
  if (!AnchorChildCount()) {
    // Special case: Allows us to get text even in non-web content, e.g. in the
    // browser's UI.
    text =
        anchor->data().GetString16Attribute(ax::mojom::StringAttribute::kValue);
    if (!text.empty())
      return text;
  }
 
  if (anchor->IsText()) {
    return anchor->data().GetString16Attribute(
        ax::mojom::StringAttribute::kName);
  }
 
  for (int i = 0; i < AnchorChildCount(); ++i) {
    text += CreateChildPositionAt(i)->GetText();
  }
 
  return text;
}

References AnchorChildCount(), BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::CreateChildPositionAt(), ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNodeData::GetString16Attribute(), i, ui::AXPosition< AXNodePosition, AXNode >::IsEmptyObjectReplacedByCharacter(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ui::AXNode::IsText(), ui::AXPosition< AXNodePosition, AXNode >::kEmbeddedCharacter, ax::mojom::kName, ax::mojom::kValue, and text.

Referenced by IsInWhiteSpace().

◆ GetTextStyles()

AXNodeTextStyles ui::AXNodePosition::GetTextStyles ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 318 of file ax_node_position.cc.

                                                     {
  // Check either the current anchor or its parent for text styles.
  AXNodeTextStyles current_anchor_text_styles =
      !IsNullPosition() ? GetAnchor()->data().GetTextStyles()
                        : AXNodeTextStyles();
  if (current_anchor_text_styles.IsUnset()) {
    AXPositionInstance parent = CreateParentPosition();
    if (!parent->IsNullPosition())
      return parent->GetAnchor()->data().GetTextStyles();
  }
  return current_anchor_text_styles;
}

References ui::AXPosition< AXNodePosition, AXNode >::CreateParentPosition(), ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNodeData::GetTextStyles(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and ui::AXNodeTextStyles::IsUnset().

◆ GetTreeID()

AXTreeID ui::AXNodePosition::GetTreeID ( AXNode * node ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 186 of file ax_node_position.cc.

                                                     {
  return node->tree()->GetAXTreeID();
}

References ui::AXNode::OwnerTree::GetAXTreeID(), and ui::AXNode::tree().

◆ GetWordEndOffsets()

std::vector< int32_t > ui::AXNodePosition::GetWordEndOffsets ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 345 of file ax_node_position.cc.

                                                           {
  if (IsNullPosition())
    return std::vector<int32_t>();
  BASE_DCHECK(GetAnchor());
 
  // Embedded object replacement characters are not represented in |kWordEnds|
  // attribute. Since the whole text exposed inside of an embedded object is of
  // length 1 (the embedded object replacement character), the word end offset
  // is positioned at 1. Because we want to treat the embedded object
  // replacement characters as ordinary characters, it wouldn't be consistent to
  // assume they have no length and return 0 instead of 1.
  if (IsEmptyObjectReplacedByCharacter())
    return {1};
 
  return GetAnchor()->data().GetIntListAttribute(
      ax::mojom::IntListAttribute::kWordEnds);
}

References BASE_DCHECK, ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNodeData::GetIntListAttribute(), ui::AXPosition< AXNodePosition, AXNode >::IsEmptyObjectReplacedByCharacter(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and ax::mojom::kWordEnds.

◆ GetWordStartOffsets()

std::vector< int32_t > ui::AXNodePosition::GetWordStartOffsets ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 331 of file ax_node_position.cc.

                                                             {
  if (IsNullPosition())
    return std::vector<int32_t>();
  BASE_DCHECK(GetAnchor());
 
  // Embedded object replacement characters are not represented in |kWordStarts|
  // attribute.
  if (IsEmptyObjectReplacedByCharacter())
    return {0};
 
  return GetAnchor()->data().GetIntListAttribute(
      ax::mojom::IntListAttribute::kWordStarts);
}

References BASE_DCHECK, ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNodeData::GetIntListAttribute(), ui::AXPosition< AXNodePosition, AXNode >::IsEmptyObjectReplacedByCharacter(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and ax::mojom::kWordStarts.

◆ IsEmbeddedObjectInParent()

bool ui::AXNodePosition::IsEmbeddedObjectInParent ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 284 of file ax_node_position.cc.

                                                    {
  switch (g_ax_embedded_object_behavior) {
    case AXEmbeddedObjectBehavior::kSuppressCharacter:
      return false;
    case AXEmbeddedObjectBehavior::kExposeCharacter:
      // We don't need to expose an "embedded object character" for textual
      // nodes and nodes that are invisible to platform APIs. Textual nodes are
      // represented by their actual text.
      return !IsNullPosition() && !GetAnchor()->IsText() &&
             GetAnchor()->IsChildOfLeaf();
  }
}

References ui::g_ax_embedded_object_behavior, ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::IsChildOfLeaf(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ui::AXNode::IsText(), ui::kExposeCharacter, and ui::kSuppressCharacter.

◆ IsInLineBreak()

bool ui::AXNodePosition::IsInLineBreak ( ) const

overridevirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 225 of file ax_node_position.cc.

                                         {
  if (IsNullPosition())
    return false;
  BASE_DCHECK(GetAnchor());
  return GetAnchor()->IsLineBreak();
}

References BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNode::IsLineBreak(), and ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition().

◆ IsInLineBreakingObject()

bool ui::AXNodePosition::IsInLineBreakingObject ( ) const

overrideprotectedvirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 297 of file ax_node_position.cc.

                                                  {
  if (IsNullPosition())
    return false;
  BASE_DCHECK(GetAnchor());
  return (GetAnchor()->data().GetBoolAttribute(
              ax::mojom::BoolAttribute::kIsLineBreakingObject) &&
          !GetAnchor()->IsInListMarker()) ||
         GetAnchor()->data().role == ax::mojom::Role::kLineBreak;
}

References BASE_DCHECK, data, ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ax::mojom::kIsLineBreakingObject, ax::mojom::kLineBreak, and ui::AXNodeData::role.

◆ IsInTextObject()

bool ui::AXNodePosition::IsInTextObject ( ) const

overridevirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 232 of file ax_node_position.cc.

                                          {
  if (IsNullPosition())
    return false;
  BASE_DCHECK(GetAnchor());
  return GetAnchor()->IsText();
}

References BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and ui::AXNode::IsText().

◆ IsInWhiteSpace()

bool ui::AXNodePosition::IsInWhiteSpace ( ) const

overridevirtual

Implements ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 239 of file ax_node_position.cc.

                                          {
  if (IsNullPosition())
    return false;
  BASE_DCHECK(GetAnchor());
  return GetAnchor()->IsLineBreak() ||
         base::ContainsOnlyChars(GetText(), base::kWhitespaceUTF16);
}

References BASE_DCHECK, base::ContainsOnlyChars(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), GetText(), ui::AXNode::IsLineBreak(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), and base::kWhitespaceUTF16.

◆ MaxTextOffset()

int ui::AXNodePosition::MaxTextOffset ( ) const

overridevirtual

Reimplemented from ui::AXPosition< AXNodePosition, AXNode >.

Definition at line 252 of file ax_node_position.cc.

                                        {
  if (IsNullPosition())
    return INVALID_OFFSET;
 
  if (IsEmptyObjectReplacedByCharacter())
    return 1;
 
  const AXNode* anchor = GetAnchor();
  BASE_DCHECK(anchor);
  // TODO(nektar): Replace with PlatformChildCount when AXNodePosition and
  // BrowserAccessibilityPosition will make one.
  if (!AnchorChildCount()) {
    std::u16string value =
        anchor->data().GetString16Attribute(ax::mojom::StringAttribute::kValue);
    if (!value.empty())
      return value.length();
  }
 
  if (anchor->IsText()) {
    return anchor->data()
        .GetString16Attribute(ax::mojom::StringAttribute::kName)
        .length();
  }
 
  int text_length = 0;
  for (int i = 0; i < AnchorChildCount(); ++i) {
    text_length += CreateChildPositionAt(i)->MaxTextOffset();
  }
 
  return text_length;
}

References AnchorChildCount(), BASE_DCHECK, ui::AXPosition< AXNodePosition, AXNode >::CreateChildPositionAt(), ui::AXNode::data(), ui::AXPosition< AXNodePosition, AXNode >::GetAnchor(), ui::AXNodeData::GetString16Attribute(), i, ui::AXPosition< AXNodePosition, AXNode >::INVALID_OFFSET, ui::AXPosition< AXNodePosition, AXNode >::IsEmptyObjectReplacedByCharacter(), ui::AXPosition< AXNodePosition, AXNode >::IsNullPosition(), ui::AXNode::IsText(), ax::mojom::kName, ax::mojom::kValue, and value.

The documentation for this class was generated from the following files:

third_party/accessibility/ax/ax_node_position.h
third_party/accessibility/ax/ax_node_position.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AXNodePosition() [1/2]

◆ ~AXNodePosition()

◆ AXNodePosition() [2/2]

Member Function Documentation

◆ AnchorChild()

◆ AnchorChildCount()

◆ AnchorIndexInParent()

◆ AnchorParent()

◆ AnchorSiblingCount()

◆ AnchorUnignoredChildCount()

◆ Clone()

◆ CreatePosition()

◆ GetAncestorAnchors()

◆ GetAnchorID()

◆ GetAnchorRole()

◆ GetLowestUnignoredAncestor()

◆ GetNextOnLineID()

◆ GetNodeInTree()

◆ GetPreviousOnLineID()

◆ GetRole()

◆ GetText()

◆ GetTextStyles()

◆ GetTreeID()

◆ GetWordEndOffsets()

◆ GetWordStartOffsets()

◆ IsEmbeddedObjectInParent()

◆ IsInLineBreak()

◆ IsInLineBreakingObject()

◆ IsInTextObject()

◆ IsInWhiteSpace()

◆ MaxTextOffset()