File: tab_alert_controller.h

package info (click to toggle)
chromium 140.0.7339.185-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 6,193,740 kB
  • sloc: cpp: 35,093,945; ansic: 7,161,670; javascript: 4,199,694; python: 1,441,797; asm: 949,904; xml: 747,515; pascal: 187,748; perl: 88,691; sh: 88,248; objc: 79,953; sql: 52,714; cs: 44,599; fortran: 24,137; makefile: 22,114; tcl: 15,277; php: 13,980; yacc: 9,000; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (134 lines) | stat: -rw-r--r-- 5,455 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
// 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_ALERT_TAB_ALERT_CONTROLLER_H_
#define CHROME_BROWSER_UI_TABS_ALERT_TAB_ALERT_CONTROLLER_H_

#include <optional>
#include <vector>

#include "base/callback_list.h"
#include "base/containers/flat_set.h"
#include "base/scoped_observation.h"
#include "chrome/browser/media/webrtc/media_stream_capture_indicator.h"
#include "chrome/browser/ui/tabs/alert/tab_alert.h"
#include "chrome/browser/ui/tabs/contents_observing_tab_feature.h"
#include "chrome/browser/vr/vr_tab_helper.h"
#include "components/tabs/public/tab_interface.h"

namespace content {
enum class WebContentsCapabilityType;
class WebContents;
}  // namespace content

namespace glic {
class FocusedTabData;
class GlicKeyedService;
}  // namespace glic

namespace tabs {
class TabInterface;

// Comparator used to determine which tab alert has a higher priority to be
// shown.
struct CompareAlerts {
  bool operator()(TabAlert first, TabAlert second) const;
};

// Observes the corresponding web contents for the tab to keep track of all
// active alerts. Callers can subscribe and be notified when the tab alert that
// should be shown changes.
class TabAlertController : public tabs::ContentsObservingTabFeature,
                           public MediaStreamCaptureIndicator::Observer,
                           public vr::VrTabHelper::Observer {
 public:
  explicit TabAlertController(TabInterface& tab);

  TabAlertController(TabInterface& tab,
                     glic::GlicKeyedService* glic_keyed_service);
  TabAlertController(const TabAlertController&) = delete;
  TabAlertController& operator=(const TabAlertController&) = delete;
  ~TabAlertController() override;

  using AlertToShowChangedCallback =
      base::RepeatingCallback<void(std::optional<TabAlert>)>;
  base::CallbackListSubscription AddAlertToShowChangedCallback(
      AlertToShowChangedCallback callback);

  std::optional<TabAlert> GetAlertToShow() const;
  // Gets all active tab alerts that is sorted from highest priority
  // to lowest priority to be shown.
  std::vector<TabAlert> GetAllActiveAlerts();

  // Returns true if `alert` is currently active for this tab and false
  // otherwise.
  bool IsAlertActive(TabAlert alert) const;

  // WebContentsObserver:
  void OnDiscardContents(TabInterface* tab_interface,
                         content::WebContents* old_contents,
                         content::WebContents* new_contents) override;
  void OnCapabilityTypesChanged(
      content::WebContentsCapabilityType capability_type,
      bool used) override;
  void MediaPictureInPictureChanged(bool is_picture_in_picture) override;
  void DidUpdateAudioMutingState(bool muted) override;

  // MediaStreamCaptureIndicator::Observer:
  void OnIsCapturingVideoChanged(content::WebContents* contents,
                                 bool is_capturing_video) override;
  void OnIsCapturingAudioChanged(content::WebContents* contents,
                                 bool is_capturing_audio) override;
  void OnIsBeingMirroredChanged(content::WebContents* contents,
                                bool is_being_mirrored) override;
  void OnIsCapturingWindowChanged(content::WebContents* contents,
                                  bool is_capturing_window) override;
  void OnIsCapturingDisplayChanged(content::WebContents* contents,
                                   bool is_capturing_display) override;

  // VrTabHelper::Observer:
  void OnIsContentDisplayedInHeadsetChanged(bool state) override;

 private:
#if BUILDFLAG(ENABLE_GLIC)
  void OnGlicContextAccessIndicatorStatusChanged(bool is_accessing);
  void OnGlicSharingFocusedTabChanged(
      const glic::FocusedTabData& focused_tab_data);
  void OnGlicTabPinningChanged(tabs::TabInterface* tab_interface,
                               bool is_sharing);
#endif  // BUILDFLAG(ENABLE_GLIC)

  void OnRecentlyAudibleStateChanged(bool was_audible);

  // Adds `alert` to the set of already active alerts for this tab if it isn't
  // currently active. Otherwise, removes `alert` from the set and is considered
  // inactive.
  void UpdateAlertState(TabAlert alert, bool is_active);

  using AlertToShowChangedCallbackList =
      base::RepeatingCallbackList<void(std::optional<TabAlert>)>;
  AlertToShowChangedCallbackList alert_to_show_changed_callbacks_;

  // Maintains a sorted collection of all active tab alerts from highest
  // priority to lowest priority to be shown.
  base::flat_set<TabAlert, CompareAlerts> active_alerts_;

  // Observes the MediaStreamCaptureIndicator so the alert controller will be
  // notified when a media stream capture has changed.
  base::ScopedObservation<MediaStreamCaptureIndicator,
                          MediaStreamCaptureIndicator::Observer>
      media_stream_capture_indicator_observation_{this};

  // Observes the VrTabHelper so that the controller will be notified when a tab
  // is displaying content to a headset.
  base::ScopedObservation<vr::VrTabHelper, vr::VrTabHelper::Observer>
      vr_tab_helper_observation_{this};

  // Subscriptions to be notified when an alert status has changed.
  base::CallbackListSubscription recently_audible_subscription_;
  std::vector<base::CallbackListSubscription> callback_subscriptions_;
};
}  // namespace tabs

#endif  // CHROME_BROWSER_UI_TABS_ALERT_TAB_ALERT_CONTROLLER_H_