/
browser_accessibility.h
689 lines (594 loc) · 29.9 KB
/
browser_accessibility.h
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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_
#define CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_
#include <stdint.h>
#include <map>
#include <memory>
#include <ostream>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/strings/string_split.h"
#include "build/build_config.h"
#include "content/common/content_export.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "third_party/blink/public/web/web_ax_enums.h"
#include "ui/accessibility/ax_enums.mojom-forward.h"
#include "ui/accessibility/ax_node.h"
#include "ui/accessibility/ax_node_data.h"
#include "ui/accessibility/ax_node_position.h"
#include "ui/accessibility/ax_range.h"
#include "ui/accessibility/ax_text_attributes.h"
#include "ui/accessibility/platform/ax_platform_node.h"
#include "ui/accessibility/platform/ax_platform_node_delegate.h"
#include "ui/base/buildflags.h"
#if BUILDFLAG(IS_MAC) && __OBJC__
@class BrowserAccessibilityCocoa;
#endif
namespace content {
class BrowserAccessibilityManager;
// A `BrowserAccessibility` object represents one node in the accessibility tree
// on the browser side. It wraps an `AXNode` and assists in exposing
// web-specific information from the node. It's owned by a
// `BrowserAccessibilityManager`.
//
// There are subclasses of BrowserAccessibility for each platform where we
// implement some of the native accessibility APIs that are only specific to the
// Web.
class CONTENT_EXPORT BrowserAccessibility : public ui::AXPlatformNodeDelegate {
public:
// Creates a platform specific BrowserAccessibility. Ownership passes to the
// caller.
static std::unique_ptr<BrowserAccessibility> Create(
BrowserAccessibilityManager* manager,
ui::AXNode* node);
// Returns |delegate| as a BrowserAccessibility object, if |delegate| is
// non-null and an object in the BrowserAccessibility class hierarchy.
static BrowserAccessibility* FromAXPlatformNodeDelegate(
ui::AXPlatformNodeDelegate* delegate);
~BrowserAccessibility() override;
BrowserAccessibility(const BrowserAccessibility&) = delete;
BrowserAccessibility& operator=(const BrowserAccessibility&) = delete;
// Called after the object is first initialized and again every time
// its data changes.
virtual void OnDataChanged();
// Called when the location changed.
virtual void OnLocationChanged() {}
// This is called when the platform-specific attributes for a node need
// to be recomputed, which may involve firing native events, due to a
// change other than an update from OnAccessibilityEvents.
virtual void UpdatePlatformAttributes() {}
// Return true if this object is equal to or a descendant of |ancestor|.
bool IsDescendantOf(const BrowserAccessibility* ancestor) const;
bool IsIgnoredForTextNavigation() const;
bool IsLineBreakObject() const;
// See `AXNode::IsEmptyLeaf()`.
bool IsEmptyLeaf() const;
// Returns true if this object can fire events.
virtual bool CanFireEvents() const;
// Return the AXPlatformNode corresponding to this node, if applicable
// on this platform.
virtual ui::AXPlatformNode* GetAXPlatformNode() const;
// Returns the number of children of this object, or 0 if PlatformIsLeaf()
// returns true.
virtual size_t PlatformChildCount() const;
// Return a pointer to the child at the given index, or NULL for an
// invalid index. Returns nullptr if PlatformIsLeaf() returns true.
virtual BrowserAccessibility* PlatformGetChild(size_t child_index) const;
BrowserAccessibility* PlatformGetParent() const;
// The following methods are virtual so that they can be overridden on Mac to
// take into account the "extra Mac nodes".
//
// TODO(nektar): Refactor `AXNode` so that it can handle "extra Mac nodes"
// itself when using any of its tree traversal methods.
virtual BrowserAccessibility* PlatformGetFirstChild() const;
virtual BrowserAccessibility* PlatformGetLastChild() const;
virtual BrowserAccessibility* PlatformGetNextSibling() const;
virtual BrowserAccessibility* PlatformGetPreviousSibling() const;
// Iterator over platform children.
class CONTENT_EXPORT PlatformChildIterator : public ChildIterator {
public:
using iterator_category = std::bidirectional_iterator_tag;
using difference_type = int;
using value_type = BrowserAccessibility;
using pointer = BrowserAccessibility*;
using reference = BrowserAccessibility&;
PlatformChildIterator(const BrowserAccessibility* parent,
BrowserAccessibility* child);
PlatformChildIterator(const PlatformChildIterator& it);
~PlatformChildIterator() override;
PlatformChildIterator& operator++() override;
PlatformChildIterator& operator++(int) override;
PlatformChildIterator& operator--() override;
PlatformChildIterator& operator--(int) override;
gfx::NativeViewAccessible GetNativeViewAccessible() const override;
BrowserAccessibility* get() const;
absl::optional<size_t> GetIndexInParent() const override;
BrowserAccessibility& operator*() const override;
BrowserAccessibility* operator->() const override;
private:
raw_ptr<const BrowserAccessibility> parent_;
ui::AXNode::ChildIteratorBase<
BrowserAccessibility,
&BrowserAccessibility::PlatformGetNextSibling,
&BrowserAccessibility::PlatformGetPreviousSibling,
&BrowserAccessibility::PlatformGetFirstChild,
&BrowserAccessibility::PlatformGetLastChild>
platform_iterator;
};
// C++ range implementation for platform children, see PlatformChildren().
class PlatformChildrenRange {
public:
explicit PlatformChildrenRange(const BrowserAccessibility* parent)
: parent_(parent) {}
PlatformChildrenRange(const PlatformChildrenRange&) = default;
PlatformChildIterator begin() { return parent_->PlatformChildrenBegin(); }
PlatformChildIterator end() { return parent_->PlatformChildrenEnd(); }
std::reverse_iterator<PlatformChildIterator> rbegin() {
return std::reverse_iterator(parent_->PlatformChildrenEnd());
}
std::reverse_iterator<PlatformChildIterator> rend() {
return std::reverse_iterator(parent_->PlatformChildrenBegin());
}
private:
const raw_ptr<const BrowserAccessibility> parent_;
};
// Returns a range for platform children which can be used in range-based for
// loops, for example, for (const auto& child : PlatformChildren()) {}.
PlatformChildrenRange PlatformChildren() const {
return PlatformChildrenRange(this);
}
PlatformChildIterator PlatformChildrenBegin() const;
PlatformChildIterator PlatformChildrenEnd() const;
// If this object is exposed to the platform's accessibility layer, returns
// this object. Otherwise, returns the lowest ancestor that is exposed to the
// platform.
virtual BrowserAccessibility* PlatformGetLowestPlatformAncestor() const;
// If this node is within an editable region, such as a content editable,
// returns the node that is at the root of that editable region, otherwise
// returns nullptr. In accessibility, an editable region includes all types of
// text fields, (see `AXNodeData::IsTextField()`).
BrowserAccessibility* PlatformGetTextFieldAncestor() const;
// If this node is within a container (or widget) that supports either single
// or multiple selection, returns the node that represents the container.
BrowserAccessibility* PlatformGetSelectionContainer() const;
// Returns nullptr if there are no children.
BrowserAccessibility* PlatformDeepestFirstChild() const;
// Returns nullptr if there are no children.
BrowserAccessibility* PlatformDeepestLastChild() const;
// Returns nullptr if there are no children.
BrowserAccessibility* InternalDeepestFirstChild() const;
// Returns nullptr if there are no children.
BrowserAccessibility* InternalDeepestLastChild() const;
// Range implementation for all children traversal see AllChildren().
class AllChildrenRange final {
public:
explicit AllChildrenRange(const BrowserAccessibility* parent)
: parent_(parent),
child_tree_root_(parent->PlatformGetRootOfChildTree()) {}
AllChildrenRange(const AllChildrenRange&) = default;
class Iterator final {
public:
using iterator_category = std::input_iterator_tag;
using value_type = BrowserAccessibility*;
using difference_type = std::ptrdiff_t;
using pointer = BrowserAccessibility**;
using reference = BrowserAccessibility*&;
Iterator(const BrowserAccessibility* parent,
const BrowserAccessibility* child_tree_root,
unsigned int index = 0U)
: parent_(parent), child_tree_root_(child_tree_root), index_(index) {}
Iterator(const Iterator&) = default;
~Iterator() = default;
Iterator& operator++() {
++index_;
return *this;
}
Iterator operator++(int) {
Iterator tmp(*this);
operator++();
return tmp;
}
bool operator==(const Iterator& rhs) const {
return parent_ == rhs.parent_ && index_ == rhs.index_;
}
bool operator!=(const Iterator& rhs) const { return !operator==(rhs); }
const BrowserAccessibility* operator*();
private:
const BrowserAccessibility* const parent_;
const BrowserAccessibility* const child_tree_root_;
unsigned int index_;
};
Iterator begin() { return {parent_, child_tree_root_}; }
Iterator end() {
unsigned int count =
child_tree_root_ ? 1U : parent_->node()->children().size();
return {parent_, child_tree_root_, count};
}
private:
const raw_ptr<const BrowserAccessibility> parent_;
const raw_ptr<const BrowserAccessibility> child_tree_root_;
};
// Returns a range for all children including ignored children, which can be
// used in range-based for loops, for example,
// for (const auto& child : AllChildren()) {}.
AllChildrenRange AllChildren() const { return AllChildrenRange(this); }
// Derivative utils for AXPlatformNodeDelegate::GetHypertextRangeBoundsRect
gfx::Rect GetUnclippedRootFrameHypertextRangeBoundsRect(
const int start_offset,
const int end_offset,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
// Derivative utils for AXPlatformNodeDelegate::GetInnerTextRangeBoundsRect
gfx::Rect GetUnclippedScreenInnerTextRangeBoundsRect(
const int start_offset,
const int end_offset,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
gfx::Rect GetUnclippedRootFrameInnerTextRangeBoundsRect(
const int start_offset,
const int end_offset,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
// DEPRECATED: Prefer using the interfaces provided by AXPlatformNodeDelegate
// when writing new code.
gfx::Rect GetScreenHypertextRangeBoundsRect(
int start,
int len,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
// Returns the bounds of the given range in coordinates relative to the
// top-left corner of the overall web area. Only valid when the role is
// WebAXRoleStaticText.
// DEPRECATED (for public use): Prefer using the interfaces provided by
// AXPlatformNodeDelegate when writing new non-private code.
gfx::Rect GetRootFrameHypertextRangeBoundsRect(
int start,
int len,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
// This is an approximate hit test that only uses the information in
// the browser process to compute the correct result. It will not return
// correct results in many cases of z-index, overflow, and absolute
// positioning, so BrowserAccessibilityManager::CachingAsyncHitTest
// should be used instead, which falls back on calling ApproximateHitTest
// automatically.
//
// Note that unlike BrowserAccessibilityManager::CachingAsyncHitTest, this
// method takes a parameter in Blink's definition of screen coordinates.
// This is so that the scale factor is consistent with what we receive from
// Blink and store in the AX tree.
// Blink screen coordinates are 1:1 with physical pixels if use-zoom-for-dsf
// is disabled; they're physical pixels divided by device scale factor if
// use-zoom-for-dsf is disabled. For more information see:
// http://www.chromium.org/developers/design-documents/blink-coordinate-spaces
BrowserAccessibility* ApproximateHitTest(
const gfx::Point& blink_screen_point);
//
// Accessors and simple setters.
//
BrowserAccessibilityManager* manager() const { return manager_; }
// These access the internal unignored accessibility tree, which doesn't
// necessarily reflect the accessibility tree that should be exposed on each
// platform. Use PlatformChildCount and PlatformGetChild to implement platform
// accessibility APIs.
size_t InternalChildCount() const;
BrowserAccessibility* InternalGetChild(size_t child_index) const;
BrowserAccessibility* InternalGetParent() const;
BrowserAccessibility* InternalGetFirstChild() const;
BrowserAccessibility* InternalGetLastChild() const;
BrowserAccessibility* InternalGetNextSibling() const;
BrowserAccessibility* InternalGetPreviousSibling() const;
using InternalChildIterator = ui::AXNode::ChildIteratorBase<
BrowserAccessibility,
&BrowserAccessibility::InternalGetNextSibling,
&BrowserAccessibility::InternalGetPreviousSibling,
&BrowserAccessibility::InternalGetFirstChild,
&BrowserAccessibility::InternalGetLastChild>;
InternalChildIterator InternalChildrenBegin() const;
InternalChildIterator InternalChildrenEnd() const;
ui::AXNodeID GetId() const;
gfx::RectF GetLocation() const;
// See `AXNode::IsRootWebAreaForPresentationalIframe()`.
bool IsRootWebAreaForPresentationalIframe() const override;
// See AXNodeData::IsClickable().
virtual bool IsClickable() const;
// See AXNodeData::IsTextField().
bool IsTextField() const;
// See AXNodeData::IsPasswordField().
bool IsPasswordField() const;
// See AXNodeData::IsAtomicTextField().
bool IsAtomicTextField() const;
// See AXNodeData::IsNonAtomicTextField().
bool IsNonAtomicTextField() const;
// Returns true if the accessible name was explicitly set to "" by the author
bool HasExplicitlyEmptyName() const;
// |offset| could only be a character offset. Depending on the platform, the
// character offset could be either in the object's text content (Android and
// Mac), or an offset in the object's hypertext (Linux ATK and Windows IA2).
// Converts to a leaf text position if you pass a character offset on a
// non-leaf node.
AXPosition CreatePositionForSelectionAt(int offset) const;
std::u16string GetNameAsString16() const;
// `AXPlatformNodeDelegate` implementation.
std::u16string GetAuthorUniqueId() const override;
const ui::AXNodeData& GetData() const override;
const ui::AXTreeData& GetTreeData() const override;
ax::mojom::Role GetRole() const override;
bool HasBoolAttribute(ax::mojom::BoolAttribute attribute) const override;
bool GetBoolAttribute(ax::mojom::BoolAttribute attribute) const override;
bool GetBoolAttribute(ax::mojom::BoolAttribute attribute,
bool* value) const override;
bool HasFloatAttribute(ax::mojom::FloatAttribute attribute) const override;
float GetFloatAttribute(ax::mojom::FloatAttribute attribute) const override;
bool GetFloatAttribute(ax::mojom::FloatAttribute attribute,
float* value) const override;
const std::vector<std::pair<ax::mojom::IntAttribute, int32_t>>&
GetIntAttributes() const override;
bool HasIntAttribute(ax::mojom::IntAttribute attribute) const override;
int GetIntAttribute(ax::mojom::IntAttribute attribute) const override;
bool GetIntAttribute(ax::mojom::IntAttribute attribute,
int* value) const override;
const std::vector<std::pair<ax::mojom::StringAttribute, std::string>>&
GetStringAttributes() const override;
bool HasStringAttribute(ax::mojom::StringAttribute attribute) const override;
const std::string& GetStringAttribute(
ax::mojom::StringAttribute attribute) const override;
bool GetStringAttribute(ax::mojom::StringAttribute attribute,
std::string* value) const override;
std::u16string GetString16Attribute(
ax::mojom::StringAttribute attribute) const override;
bool GetString16Attribute(ax::mojom::StringAttribute attribute,
std::u16string* value) const override;
const std::string& GetInheritedStringAttribute(
ax::mojom::StringAttribute attribute) const override;
std::u16string GetInheritedString16Attribute(
ax::mojom::StringAttribute attribute) const override;
const std::vector<
std::pair<ax::mojom::IntListAttribute, std::vector<int32_t>>>&
GetIntListAttributes() const override;
bool HasIntListAttribute(
ax::mojom::IntListAttribute attribute) const override;
const std::vector<int32_t>& GetIntListAttribute(
ax::mojom::IntListAttribute attribute) const override;
bool GetIntListAttribute(ax::mojom::IntListAttribute attribute,
std::vector<int32_t>* value) const override;
bool HasStringListAttribute(
ax::mojom::StringListAttribute attribute) const override;
const std::vector<std::string>& GetStringListAttribute(
ax::mojom::StringListAttribute attribute) const override;
bool GetStringListAttribute(ax::mojom::StringListAttribute attribute,
std::vector<std::string>* value) const override;
typedef base::StringPairs HtmlAttributes;
bool HasHtmlAttribute(const char* attribute) const override;
const HtmlAttributes& GetHtmlAttributes() const override;
bool GetHtmlAttribute(const char* attribute,
std::string* value) const override;
bool GetHtmlAttribute(const char* attribute,
std::u16string* value) const override;
ui::AXTextAttributes GetTextAttributes() const override;
bool HasState(ax::mojom::State state) const override;
ax::mojom::State GetState() const override;
bool HasAction(ax::mojom::Action action) const override;
bool HasTextStyle(ax::mojom::TextStyle text_style) const override;
ax::mojom::NameFrom GetNameFrom() const override;
ax::mojom::DescriptionFrom GetDescriptionFrom() const override;
const ui::AXTree::Selection GetUnignoredSelection() const override;
AXPosition CreatePositionAt(
int offset,
ax::mojom::TextAffinity affinity =
ax::mojom::TextAffinity::kDownstream) const override;
AXPosition CreateTextPositionAt(
int offset,
ax::mojom::TextAffinity affinity =
ax::mojom::TextAffinity::kDownstream) const override;
gfx::NativeViewAccessible GetNSWindow() override;
gfx::NativeViewAccessible GetNativeViewAccessible() override;
gfx::NativeViewAccessible GetParent() const override;
size_t GetChildCount() const override;
gfx::NativeViewAccessible ChildAtIndex(size_t index) override;
bool HasModalDialog() const override;
gfx::NativeViewAccessible GetFirstChild() override;
gfx::NativeViewAccessible GetLastChild() override;
gfx::NativeViewAccessible GetNextSibling() override;
gfx::NativeViewAccessible GetPreviousSibling() override;
bool IsChildOfLeaf() const override;
bool IsDescendantOfAtomicTextField() const override;
bool IsPlatformDocument() const override;
bool IsLeaf() const override;
bool IsFocused() const override;
bool IsIgnored() const override;
bool IsInvisibleOrIgnored() const override;
bool IsToplevelBrowserWindow() override;
gfx::NativeViewAccessible GetLowestPlatformAncestor() const override;
gfx::NativeViewAccessible GetTextFieldAncestor() const override;
gfx::NativeViewAccessible GetSelectionContainer() const override;
gfx::NativeViewAccessible GetTableAncestor() const override;
std::unique_ptr<ChildIterator> ChildrenBegin() override;
std::unique_ptr<ChildIterator> ChildrenEnd() override;
const std::string& GetName() const override;
const std::string& GetDescription() const override;
std::u16string GetHypertext() const override;
const std::map<int, int>& GetHypertextOffsetToHyperlinkChildIndex()
const override;
bool SetHypertextSelection(int start_offset, int end_offset) override;
std::u16string GetTextContentUTF16() const override;
std::u16string GetValueForControl() const override;
gfx::Rect GetBoundsRect(
const ui::AXCoordinateSystem coordinate_system,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const override;
gfx::Rect GetHypertextRangeBoundsRect(
const int start_offset,
const int end_offset,
const ui::AXCoordinateSystem coordinate_system,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const override;
gfx::Rect GetInnerTextRangeBoundsRect(
const int start_offset,
const int end_offset,
const ui::AXCoordinateSystem coordinate_system,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const override;
gfx::NativeViewAccessible HitTestSync(int physical_pixel_x,
int physical_pixel_y) const override;
gfx::NativeViewAccessible GetFocus() const override;
ui::AXPlatformNode* GetFromNodeID(int32_t id) override;
ui::AXPlatformNode* GetFromTreeIDAndNodeID(const ui::AXTreeID& ax_tree_id,
int32_t id) override;
absl::optional<size_t> GetIndexInParent() override;
gfx::AcceleratedWidget GetTargetForNativeAccessibilityEvent() override;
const std::vector<gfx::NativeViewAccessible> GetUIADirectChildrenInRange(
ui::AXPlatformNodeDelegate* start,
ui::AXPlatformNodeDelegate* end) override;
std::string GetLanguage() const override;
bool IsTable() const override;
absl::optional<int> GetTableColCount() const override;
absl::optional<int> GetTableRowCount() const override;
absl::optional<int> GetTableAriaColCount() const override;
absl::optional<int> GetTableAriaRowCount() const override;
absl::optional<int> GetTableCellCount() const override;
absl::optional<bool> GetTableHasColumnOrRowHeaderNode() const override;
std::vector<ui::AXNodeID> GetColHeaderNodeIds() const override;
std::vector<ui::AXNodeID> GetColHeaderNodeIds(int col_index) const override;
std::vector<ui::AXNodeID> GetRowHeaderNodeIds() const override;
std::vector<ui::AXNodeID> GetRowHeaderNodeIds(int row_index) const override;
ui::AXPlatformNode* GetTableCaption() const override;
bool IsTableRow() const override;
absl::optional<int> GetTableRowRowIndex() const override;
bool IsTableCellOrHeader() const override;
absl::optional<int> GetTableCellIndex() const override;
absl::optional<int> GetTableCellColIndex() const override;
absl::optional<int> GetTableCellRowIndex() const override;
absl::optional<int> GetTableCellColSpan() const override;
absl::optional<int> GetTableCellRowSpan() const override;
absl::optional<int> GetTableCellAriaColIndex() const override;
absl::optional<int> GetTableCellAriaRowIndex() const override;
absl::optional<int32_t> GetCellId(int row_index,
int col_index) const override;
absl::optional<int32_t> CellIndexToId(int cell_index) const override;
bool IsCellOrHeaderOfAriaGrid() const override;
bool AccessibilityPerformAction(const ui::AXActionData& data) override;
std::u16string GetLocalizedStringForImageAnnotationStatus(
ax::mojom::ImageAnnotationStatus status) const override;
std::u16string GetLocalizedRoleDescriptionForUnlabeledImage() const override;
std::u16string GetLocalizedStringForLandmarkType() const override;
std::u16string GetLocalizedStringForRoleDescription() const override;
std::u16string GetStyleNameAttributeAsLocalizedString() const override;
ui::TextAttributeMap ComputeTextAttributeMap(
const ui::TextAttributeList& default_attributes) const override;
std::string GetInheritedFontFamilyName() const override;
bool ShouldIgnoreHoveredStateForTesting() override;
bool IsOffscreen() const override;
bool IsMinimized() const override;
bool IsText() const override;
bool IsWebContent() const override;
bool IsReadOnlySupported() const override;
bool IsReadOnlyOrDisabled() const override;
bool HasVisibleCaretOrSelection() const override;
ui::AXPlatformNode* GetTargetNodeForRelation(
ax::mojom::IntAttribute attr) override;
std::vector<ui::AXPlatformNode*> GetTargetNodesForRelation(
ax::mojom::IntListAttribute attr) override;
std::set<ui::AXPlatformNode*> GetReverseRelations(
ax::mojom::IntAttribute attr) override;
std::set<ui::AXPlatformNode*> GetReverseRelations(
ax::mojom::IntListAttribute attr) override;
bool IsOrderedSetItem() const override;
bool IsOrderedSet() const override;
absl::optional<int> GetPosInSet() const override;
absl::optional<int> GetSetSize() const override;
SkColor GetColor() const override;
SkColor GetBackgroundColor() const override;
// Returns true if this node is a list marker or if it's a descendant
// of a list marker node. Returns false otherwise.
bool IsInListMarker() const;
// Returns true if this node is a collapsed popup button that is parent to a
// menu list popup.
bool IsCollapsedMenuListPopUpButton() const;
// Returns the popup button ancestor of this current node if any. The popup
// button needs to be the parent of a menu list popup and needs to be
// collapsed.
BrowserAccessibility* GetCollapsedMenuListPopUpButtonAncestor() const;
// Returns true if:
// 1. This node is a list, AND
// 2. This node has a list ancestor or a list descendant.
bool IsHierarchicalList() const;
// Returns a string representation of this object for debugging purposes.
std::string ToString() const;
protected:
BrowserAccessibility(BrowserAccessibilityManager* manager, ui::AXNode* node);
virtual ui::TextAttributeList ComputeTextAttributes() const;
// The manager of this tree of accessibility objects. Weak, owns us.
const raw_ptr<BrowserAccessibilityManager> manager_;
// Protected so that it can't be called directly on a BrowserAccessibility
// where it could be confused with an id that comes from the node data,
// which is only unique to the Blink process.
// Does need to be called by subclasses such as BrowserAccessibilityAndroid.
const ui::AXUniqueId& GetUniqueId() const override;
// Returns a text attribute map indicating the offsets in the text of a leaf
// object, such as a text field or static text, where spelling and grammar
// errors are present.
ui::TextAttributeMap GetSpellingAndGrammarAttributes() const;
std::string SubtreeToStringHelper(size_t level) override;
// The UIA tree formatter needs access to GetUniqueId() to identify the
// starting point for tree dumps.
friend class AccessibilityTreeFormatterUia;
private:
// Return the bounds after converting from this node's coordinate system
// (which is relative to its nearest scrollable ancestor) to the coordinate
// system specified. If the clipping behavior is set to clipped, clipping is
// applied to all bounding boxes so that the resulting rect is within the
// window. If the clipping behavior is unclipped, the resulting rect may be
// outside of the window or offscreen. If an offscreen result address is
// provided, it will be populated depending on whether the returned bounding
// box is onscreen or offscreen.
gfx::Rect RelativeToAbsoluteBounds(
gfx::RectF bounds,
const ui::AXCoordinateSystem coordinate_system,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result) const;
// Return a rect for a 1-width character past the end of text. This is what
// ATs expect when getting the character extents past the last character in
// a line, and equals what the caret bounds would be when past the end of
// the text.
gfx::Rect GetRootFrameHypertextBoundsPastEndOfText(
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result = nullptr) const;
// See `AXNode::GetTextContentRangeBoundsUTF16`.
gfx::RectF GetTextContentRangeBoundsUTF16(int start_offset,
int end_offset) const;
// Recursive helper function for GetInnerTextRangeBounds.
gfx::Rect GetInnerTextRangeBoundsRectInSubtree(
const int start_offset,
const int end_offset,
const ui::AXCoordinateSystem coordinate_system,
const ui::AXClippingBehavior clipping_behavior,
ui::AXOffscreenResult* offscreen_result) const;
// Given a set of node ids, return the nodes in this delegate's tree to
// which they correspond.
std::set<ui::AXPlatformNode*> GetNodesForNodeIdSet(
const std::set<int32_t>& ids);
// If the node has a child tree, get the root node.
BrowserAccessibility* PlatformGetRootOfChildTree() const;
// Determines whether this object is valid.
bool IsValid() const;
// Given a set of map of spelling text attributes and a start offset, merge
// them into the given map of existing text attributes. Merges the given
// spelling attributes, i.e. document marker information, into the given
// text attributes starting at the given character offset. This is required
// because document markers that are present on text leaves need to be
// propagated to their parent object for compatibility with Firefox.
static void MergeSpellingAndGrammarIntoTextAttributes(
const ui::TextAttributeMap& spelling_attributes,
int start_offset,
ui::TextAttributeMap* text_attributes);
// Return true is the list of text attributes already includes an invalid
// attribute originating from ARIA.
static bool HasInvalidAttribute(const ui::TextAttributeList& attributes);
// A unique ID, since node IDs are frame-local.
ui::AXUniqueId unique_id_;
};
} // namespace content
#endif // CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_H_