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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
// 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_GLIC_HOST_CONTEXT_GLIC_PINNED_TAB_MANAGER_H_
#define CHROME_BROWSER_GLIC_HOST_CONTEXT_GLIC_PINNED_TAB_MANAGER_H_
#include <vector>
#include "base/callback_list.h"
#include "base/memory/raw_ptr.h"
#include "chrome/browser/glic/host/context/glic_tab_data.h"
#include "chrome/browser/glic/host/glic.mojom.h"
#include "chrome/browser/glic/widget/glic_window_controller.h"
#include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
#include "components/tabs/public/tab_interface.h"
#include "mojo/public/cpp/bindings/remote.h"
class Profile;
class BrowserTabStripTracker;
namespace glic {
// Manages a collection of tabs that have been selected to be shared.
class GlicPinnedTabManager : public TabStripModelObserver {
public:
explicit GlicPinnedTabManager(Profile* profile,
GlicWindowController* window_controller);
~GlicPinnedTabManager() override;
// Registers a callback to be invoked when the collection of pinned tabs
// changes.
using PinnedTabsChangedCallback =
base::RepeatingCallback<void(const std::vector<content::WebContents*>&)>;
base::CallbackListSubscription AddPinnedTabsChangedCallback(
PinnedTabsChangedCallback callback);
// Registers a callback to be invoked when the pinned status of a tab changes.
using TabPinningStatusChangedCallback =
base::RepeatingCallback<void(tabs::TabInterface*, bool)>;
base::CallbackListSubscription AddTabPinningStatusChangedCallback(
TabPinningStatusChangedCallback callback);
// Registers a callback to be invoked when the TabData for a pinned tab is
// changed.
using PinnedTabDataChangedCallback =
base::RepeatingCallback<void(const mojom::TabData*)>;
base::CallbackListSubscription AddPinnedTabDataChangedCallback(
PinnedTabDataChangedCallback callback);
// Pins the specified tabs. If we are only able to pin `n` tabs within the
// limit, the first `n` tabs from this collection will be pinned and we will
// return false (to indicate that it was not fully successful). If any of the
// tab handles correspond to a tab that either doesn't exist or is already
// pinned, it will be skipped and we will similarly return false to indicate
// that the function was not fully successful.
bool PinTabs(base::span<const tabs::TabHandle> tab_handles);
// Unins the specified tabs. If any of the tab handles correspond to a tab
// that either doesn't exist or is not pinned, it will be skipped and we will
// similarly return false to indicate that the function was not fully
// successful.
bool UnpinTabs(base::span<const tabs::TabHandle> tab_handles);
// Unpins all pinned tabs.
void UnpinAllTabs();
// Sets the limit on the number of pinned tabs. Returns the effective number
// of pinned tabs. Can differ due to supporting fewer tabs than requested or
// having more tabs currently pinned than requested.
uint32_t SetMaxPinnedTabs(uint32_t max_pinned_tabs);
// Gets the limit on the number of pinned tabs.
uint32_t GetMaxPinnedTabs() const;
// Gets the current number of pinned tabs.
uint32_t GetNumPinnedTabs() const;
// Returns true if the tab is in the pinned collection.
bool IsTabPinned(tabs::TabHandle tab_handle) const;
// Fetches the current list of pinned tabs.
std::vector<content::WebContents*> GetPinnedTabs() const;
// Subscribes to changes in pin candidates.
void SubscribeToPinCandidates(
mojom::GetPinCandidatesOptionsPtr options,
mojo::PendingRemote<mojom::PinCandidatesObserver> observer);
// Visible for testing.
virtual bool IsBrowserValidForSharing(BrowserWindowInterface* browser_window);
// Visible for testing.
virtual bool IsValidForSharing(content::WebContents* web_contents);
// Visible for testing.
virtual bool IsGlicWindowShowing();
private:
class UpdateThrottler;
// TabStripModelObserver implementation:
void OnTabStripModelChanged(
TabStripModel* tab_strip_model,
const TabStripModelChange& change,
const TabStripSelectionChange& selection) override;
void TabChangedAt(content::WebContents* contents,
int index,
TabChangeType change_type) override;
void OnTabWillBeRemoved(content::WebContents* contents, int index) override;
void OnPinCandidatesObserverDisconnected();
// Sends the current list of pin candidates to the observer.
void SendPinCandidatesUpdate();
// Returns a vector of web contents for potential pin candidates. The vector
// is not sorted or truncated.
std::vector<content::WebContents*> GetUnsortedPinCandidates();
class PinnedTabObserver;
friend PinnedTabObserver;
struct PinnedTabEntry {
PinnedTabEntry(tabs::TabHandle tab_handle,
std::unique_ptr<PinnedTabObserver> tab_observer);
~PinnedTabEntry();
PinnedTabEntry(PinnedTabEntry&& other);
PinnedTabEntry& operator=(PinnedTabEntry&& other);
PinnedTabEntry(const PinnedTabEntry&) = delete;
PinnedTabEntry& operator=(const PinnedTabEntry&) = delete;
tabs::TabHandle tab_handle;
std::unique_ptr<PinnedTabObserver> tab_observer;
};
// Sends an update to the web client with the full set of pinned tabs.
void NotifyPinnedTabsChanged();
// Returns the entry corresponding to the given tab_handle, if it exists.
const PinnedTabEntry* GetPinnedTabEntry(tabs::TabHandle tab_handle) const;
// Returns true if the tab is in the pinned collection.
bool IsTabPinned(int tab_id) const;
// Called by friend PinnedTabObserver.
void OnTabWillClose(tabs::TabHandle tab_handles);
void OnTabDataChanged(tabs::TabHandle tab_handle, mojom::TabDataPtr);
void OnTabChangedOrigin(tabs::TabHandle tab_handle);
// List of callbacks to invoke when the collection of pinned tabs changes
// (including changes to metadata).
base::RepeatingCallbackList<void(const std::vector<content::WebContents*>&)>
pinned_tabs_changed_callback_list_;
// List of callbacks to invoke when the tab data for a pinned tab changes.
base::RepeatingCallbackList<void(const mojom::TabData*)>
pinned_tab_data_changed_callback_list_;
// List of callbacks to invoke when the pinning status for a particular tab
// changes.
base::RepeatingCallbackList<void(tabs::TabInterface*, bool)>
pinning_status_changed_callback_list_;
// Enables searching for pin_candidates.
raw_ptr<Profile> profile_;
raw_ptr<GlicWindowController> window_controller_;
// Using a vector lets us store the pinned tabs in the order that they are
// pinned. Searching for a pinned tab is currently linear.
std::vector<PinnedTabEntry> pinned_tabs_;
uint32_t max_pinned_tabs_;
// The observer for pin candidate changes.
mojo::Remote<mojom::PinCandidatesObserver> pin_candidates_observer_;
// The options for the pin candidate observer.
mojom::GetPinCandidatesOptionsPtr pin_candidates_options_;
// A timer to debounce pin candidate updates.
std::unique_ptr<UpdateThrottler> pin_candidate_updater_;
// Tracks all the browsers for the current profile.
std::unique_ptr<BrowserTabStripTracker> tab_strip_tracker_;
base::WeakPtrFactory<GlicPinnedTabManager> weak_ptr_factory_{this};
};
} // namespace glic
#endif // CHROME_BROWSER_GLIC_HOST_CONTEXT_GLIC_PINNED_TAB_MANAGER_H_
|
