File: editor_system_actuator.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 (95 lines) | stat: -rw-r--r-- 3,432 bytes parent folder | download | duplicates (3)
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
// 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_ASH_INPUT_METHOD_EDITOR_SYSTEM_ACTUATOR_H_
#define CHROME_BROWSER_ASH_INPUT_METHOD_EDITOR_SYSTEM_ACTUATOR_H_

#include <memory>
#include <optional>
#include <string>
#include <string_view>

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/timer/timer.h"
#include "chrome/browser/ash/input_method/editor_consent_enums.h"
#include "chrome/browser/ash/input_method/editor_metrics_recorder.h"
#include "chrome/browser/ash/input_method/editor_text_insertion.h"
#include "chrome/browser/ash/input_method/editor_transition_enums.h"
#include "chrome/browser/profiles/profile.h"
#include "chromeos/ash/services/orca/public/mojom/orca_service.mojom.h"
#include "mojo/public/cpp/bindings/associated_receiver.h"
#include "mojo/public/cpp/bindings/pending_associated_receiver.h"
#include "url/gurl.h"

namespace ash::input_method {

class EditorSystemActuator : public orca::mojom::SystemActuator {
 public:
  class System {
   public:
    virtual ~System() = default;
    virtual void Announce(const std::u16string& message) = 0;
    virtual void ProcessConsentAction(ConsentAction consent_action) = 0;
    virtual void ShowUI() = 0;
    virtual void CloseUI() = 0;
    virtual void HandleTrigger(
        std::optional<std::string_view> preset_query_id,
        std::optional<std::string_view> freeform_text) = 0;
    virtual EditorMetricsRecorder* GetMetricsRecorder() = 0;
    virtual size_t GetSelectedTextLength() = 0;
  };

  EditorSystemActuator(
      Profile* profile,
      mojo::PendingAssociatedReceiver<orca::mojom::SystemActuator> receiver,
      System* system);
  ~EditorSystemActuator() override;

  // orca::mojom::SystemActuator overrides
  void InsertText(const std::string& text) override;
  void ApproveConsent() override;
  void DeclineConsent() override;
  void OpenUrlInNewWindow(const GURL& url) override;
  void ShowUI() override;
  void CloseUI() override;
  void SubmitFeedback(const std::string& description) override;
  void OnTrigger(orca::mojom::TriggerContextPtr trigger_context) override;
  void EmitMetricEvent(orca::mojom::MetricEvent metric_event) override;
  void OnInputContextUpdated(const GURL& url);

  // Relevant input events
  void OnFocus(int context_id);

  void SetNoticeTransitionAction(
      EditorNoticeTransitionAction transition_action);

 private:
  void QueueTextInsertion(const std::string pending_text);

  raw_ptr<Profile> profile_;
  mojo::AssociatedReceiver<orca::mojom::SystemActuator>
      system_actuator_receiver_;

  // Not owned by this class.
  raw_ptr<System> system_;

  // Possibly holds a queued text insertion operation. If a text insertion op
  // has been queued, then it will be inserted in the next focused text field.
  // Only one text insertion can be queued at a time, with new text insertions
  // overwriting previously queued insertions.
  std::unique_ptr<EditorTextInsertion> queued_text_insertion_;

  GURL current_url_;

  EditorNoticeTransitionAction notice_transition_action_ =
      EditorNoticeTransitionAction::kShowEditorPanel;

  base::OneShotTimer announcement_delay_;
  base::WeakPtrFactory<EditorSystemActuator> weak_ptr_factory_{this};
};

}  // namespace ash::input_method

#endif  // CHROME_BROWSER_ASH_INPUT_METHOD_EDITOR_SYSTEM_ACTUATOR_H_