File: text_highlighter_manager.h

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 (74 lines) | stat: -rw-r--r-- 2,848 bytes parent folder | download | duplicates (6)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_COMPANION_TEXT_FINDER_TEXT_HIGHLIGHTER_MANAGER_H_
#define CHROME_BROWSER_COMPANION_TEXT_FINDER_TEXT_HIGHLIGHTER_MANAGER_H_

#include "base/gtest_prod_util.h"
#include "base/memory/weak_ptr.h"
#include "base/unguessable_token.h"
#include "content/public/browser/page_user_data.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "third_party/blink/public/mojom/annotation/annotation.mojom.h"

namespace companion {

namespace internal {
class TextHighlighter;
}

// Manages the creation and deletion of `TextHighlighter` instances.
// There can be at most one instance for the current page at any time, i.e.,
// creating a new one will automatically remove any existing one.
class TextHighlighterManager
    : public content::PageUserData<TextHighlighterManager> {
 public:
  ~TextHighlighterManager() override;

  TextHighlighterManager(const TextHighlighterManager&) = delete;
  TextHighlighterManager& operator=(const TextHighlighterManager&) = delete;

  // Creates a text highlighter and adds it to manager. Removes any existing
  // text hightlighter.
  void CreateTextHighlighterAndRemoveExistingInstance(
      const std::string& text_directive);

  // Creates multiple text finders for a vector of text directives. Calls
  // `all_done_callback` when all text finders finish searching (via
  // `base::BarrierCallback`).
  void CreateTextHighlightersAndRemoveExisting(
      const std::vector<std::string>& text_directives);

  // Returns the text highlighter for testing.
  std::vector<internal::TextHighlighter*> get_text_highlighters_for_testing() {
    std::vector<internal::TextHighlighter*> highlighters;
    highlighters.reserve(highlighters_.size());

    std::transform(highlighters_.begin(), highlighters_.end(),
                   std::back_inserter(highlighters),
                   [](const auto& highlighter) { return highlighter.get(); });
    return highlighters;
  }

 private:
  friend class content::PageUserData<TextHighlighterManager>;
  FRIEND_TEST_ALL_PREFIXES(TextHighlighterManagerTest, TextHighlighterTest);

  explicit TextHighlighterManager(content::Page& page);

  PAGE_USER_DATA_KEY_DECL();

  // List of text highlighters that were attempted to be rendered on the page.
  std::vector<std::unique_ptr<internal::TextHighlighter>> highlighters_;

  // A connection to the annotation agent container on the renderer side to
  // bind a text highlighter instance to its agent counterpart.
  mojo::Remote<blink::mojom::AnnotationAgentContainer> agent_container_;

  base::WeakPtrFactory<TextHighlighterManager> weak_ptr_factory_{this};
};

}  // namespace companion

#endif  // CHROME_BROWSER_COMPANION_TEXT_FINDER_TEXT_HIGHLIGHTER_MANAGER_H_