File: glic_nudge_controller.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (90 lines) | stat: -rw-r--r-- 2,959 bytes parent folder | download | duplicates (2)
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
// Copyright 2025 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_UI_TABS_GLIC_NUDGE_CONTROLLER_H_
#define CHROME_BROWSER_UI_TABS_GLIC_NUDGE_CONTROLLER_H_

#include "base/callback_list.h"
#include "base/observer_list.h"
#include "base/types/pass_key.h"
#include "chrome/browser/ui/tabs/glic_nudge_observer.h"
#include "components/keyed_service/core/keyed_service.h"

class BrowserWindowInterface;
class ScopedWindowCallToAction;

namespace content {
class WebContents;
}  // namespace content

namespace tabs {

// Enumerates the various user action for the Glic nudge.
enum class GlicNudgeActivity {
  kNudgeShown,
  kNudgeClicked,
  kNudgeDismissed,
  kNudgeNotShownWebContents,
  kNudgeIgnoredActiveTabChanged,
  kNudgeIgnoredNavigation,
  kNudgeNotShownWindowCallToActionUI,
};

// Controller that mediates Glic Nudges and ensures that only the active tab is
// targeted.
class GlicNudgeController {
 public:
  using GlicNudgeActivityCallback =
      base::RepeatingCallback<void(GlicNudgeActivity)>;

  explicit GlicNudgeController(
      BrowserWindowInterface* browser_window_interface);
  GlicNudgeController(const GlicNudgeController&) = delete;
  GlicNudgeController& operator=(const GlicNudgeController& other) = delete;
  virtual ~GlicNudgeController();

  void AddObserver(GlicNudgeObserver* observer) {
    observers_.AddObserver(observer);
  }

  void RemoveObserver(GlicNudgeObserver* observer) {
    observers_.RemoveObserver(observer);
  }

  bool HasObserver(GlicNudgeObserver* observer) {
    return observers_.HasObserver(observer);
  }

  // Updates the `nudge_label` for `web_contents`, if the WebContents is active.
  // The nudge will be removed from `web_contents` if `nudge_label` is empty.
  // `activity` must be supplied iff. `nudge_label` is empty, to identify the
  // reason of nudge removal.
  void UpdateNudgeLabel(content::WebContents* web_contents,
                        const std::string& nudge_label,
                        std::optional<GlicNudgeActivity> activity,
                        GlicNudgeActivityCallback callback);

  void OnNudgeActivity(GlicNudgeActivity activity);

  void SetNudgeActivityCallbackForTesting();

 private:
  // Called when the active tab changes, to update the nudge UI appropriate for
  // the tab.
  void OnActiveTabChanged(BrowserWindowInterface* browser_interface);

  // The BrowserWindowInterface that owns `this`.
  const raw_ptr<BrowserWindowInterface> browser_window_interface_;

  base::ObserverList<GlicNudgeObserver> observers_;

  // Callback to invoke for user actions on the nudge.
  GlicNudgeActivityCallback nudge_activity_callback_;

  std::vector<base::CallbackListSubscription> browser_subscriptions_;
  std::unique_ptr<ScopedWindowCallToAction> scoped_window_call_to_action_ptr;
};

}  // namespace tabs

#endif  // CHROME_BROWSER_UI_TABS_GLIC_NUDGE_CONTROLLER_H_