File: read_aloud_traversal_utils.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (165 lines) | stat: -rw-r--r-- 5,725 bytes parent folder | download | duplicates (5)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/renderer/accessibility/read_anything/read_aloud_traversal_utils.h"

#include "ui/accessibility/ax_text_utils.h"

namespace a11y {

ReadAloudCurrentGranularity::ReadAloudCurrentGranularity() = default;

ReadAloudCurrentGranularity::ReadAloudCurrentGranularity(
    const ReadAloudCurrentGranularity& other) = default;

ReadAloudCurrentGranularity::~ReadAloudCurrentGranularity() = default;

void ReadAloudCurrentGranularity::AddText(ui::AXNodeID id,
                                          int text_start,
                                          int text_end,
                                          const std::u16string& text_to_add) {
  DCHECK((text_end - text_start) == (int)text_to_add.size());

  ReadAloudTextSegment segment{id, text_start, text_end};
  segments[segment.id] = segment;
  node_ids.push_back(segment.id);

  int current_text_length = text.length();
  text += text_to_add;
  index_map.insert({{current_text_length, text.length()}, id});
}

std::vector<ReadAloudTextSegment>
ReadAloudCurrentGranularity::GetSegmentsForRange(int start_index,
                                                 int end_index) {
  if (start_index >= end_index) {
    return {};
  }

  auto start = index_map.upper_bound({start_index, INT_MAX});
  if (start == index_map.begin()) {
    // start_index is too low
    return {};
  }
  // Rewind by 1 to find the actual start from the upper_bound
  --start;

  auto end = index_map.upper_bound({end_index, INT_MAX});
  if (end == index_map.begin()) {
    // end_index is too low
    return {};
  }

  std::vector<ReadAloudTextSegment> ret;
  while (start != end) {
    auto range = start->first;
    if ((start_index >= range.second) || (end_index <= range.first)) {
      break;
    }
    ui::AXNodeID node = start->second;
    auto segment = segments[node];

    // For the first and last segments, we need to adjust the appropriate
    // boundary to take start_index and end_index into account. For middle
    // segments, we simply add the entire segment.
    int text_start = (start_index >= range.first)
                         ? (segment.text_start + start_index - range.first)
                         : segment.text_start;
    int text_end = (end_index < range.second)
                       ? (segment.text_start + end_index - range.first)
                       : segment.text_end;

    ret.push_back(ReadAloudTextSegment(node, text_start, text_end));
    ++start;
  }

  return ret;
}

void ReadAloudCurrentGranularity::CalculatePlaceholderPhrases() {
  if (text.size() == 0) {
    phrase_boundaries.clear();
    return;
  }

  // Add a phrase boundary every 3 words. TODO(crbug.com/330749762): replace
  // with the correct phrase calculation.
  std::size_t start = 0;
  int count = 0;
  do {
    if (count % 3 == 0) {
      phrase_boundaries.push_back(start);
    }
    int next_word = GetNextWord(text.substr(start));
    if (next_word == 0) {
      break;
    }
    start += next_word;
    ++count;
    if (start >= text.size()) {
      break;
    }
  } while (start);
  phrase_boundaries.push_back(text.size());
}

}  // namespace a11y

namespace {

// Returns the index of the next granularity of the given text, such that the
// next granularity is equivalent to text.substr(0, <returned_index>).
int GetNextGranularity(const std::u16string& text,
                       ax::mojom::TextBoundary boundary) {
  // TODO(crbug.com/40927698): Investigate providing correct line breaks
  // or alternatively making adjustments to ax_text_utils to return boundaries
  // that minimize choppiness.
  std::vector<int> offsets;
  return ui::FindAccessibleTextBoundary(text, offsets, boundary, 0,
                                        ax::mojom::MoveDirection::kForward,
                                        ax::mojom::TextAffinity::kDefaultValue);
}

}  // namespace

int GetNextSentence(const std::u16string& text) {
  return GetNextGranularity(text, ax::mojom::TextBoundary::kSentenceStart);
}

int GetNextWord(const std::u16string& text) {
  return GetNextGranularity(text, ax::mojom::TextBoundary::kWordStart);
}

bool ArePositionsEqual(const ui::AXNodePosition::AXPositionInstance& position,
                       const ui::AXNodePosition::AXPositionInstance& other) {
  return position->GetAnchor() && other->GetAnchor() &&
         (position->CompareTo(*other).value_or(-1) == 0) &&
         (position->text_offset() == other->text_offset());
}

// Returns either the anchor node or the lowest platform ancestor of the node,
// if it's a leaf.
ui::AXNode* GetAnchorNode(
    const ui::AXNodePosition::AXPositionInstance& position) {
  bool is_leaf = position->GetAnchor()->IsChildOfLeaf();
  // If the node is a leaf, use the parent node instead.
  return is_leaf ? position->GetAnchor()->GetLowestPlatformAncestor()
                 : position->GetAnchor();
}

// TODO(crbug.com/40927698): See if we can use string util here.
// https://source.chromium.org/chromium/chromium/src/+/main:base/strings/string_util.h;l=448?q=string_util%20punctuation&ss=chromium
bool IsOpeningPunctuation(char& c) {
  return (c == '(' || c == '{' || c == '[' || c == '<');
}

// We should split the current utterance at a paragraph boundary if the
// AXPosition is at the start of a paragraph and we already have nodes in
// our current granularity segment.
bool ShouldSplitAtParagraph(
    const ui::AXNodePosition::AXPositionInstance& position,
    const a11y::ReadAloudCurrentGranularity current_granularity) {
  return position->AtStartOfParagraph() &&
         (current_granularity.node_ids.size() > 0);
}