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
|
// Copyright 2024 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_BROWSER_WINDOW_PUBLIC_BROWSER_WINDOW_INTERFACE_ITERATOR_H_
#define CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_BROWSER_WINDOW_INTERFACE_ITERATOR_H_
#include <vector>
#include "base/functional/function_ref.h"
class BrowserWindowInterface;
// Returns all browser windows.
// This is primarily used for features that need to operate on all browser
// windows at the same time. You should almost never be using this to find
// a specific browser window. There are some very rare exceptions, such as when
// you need to retrieve a browser window from an identifier or criteria when the
// caller is unassociated with that browser window (for instance, extensions
// modifying browser windows).
// Note that this doesn't account for any BrowserWindowInterfaces that are added
// or removed after the vector is returned.
std::vector<BrowserWindowInterface*> GetAllBrowserWindowInterfaces();
// For these 2 functions, we chose not to simply return
// std::vector<BrowserWindowInterface*> because doing so would open up the
// possibility that a browser could be created or destroyed during iteration,
// resulting in potential use-after-frees (example: crbug.com/405910169).
//
// The return value in the passed-in function indicates whether or not we should
// continue iterating - true means continue, false means terminate.
//
// Example usage:
//
// ForEachCurrentBrowserWindowInterfaceOrderedByActivation(
// [](BrowserWindowInterface* browser_window) {
// // do something with |browser_window|
// return true;
// });
void ForEachCurrentBrowserWindowInterfaceOrderedByActivation(
base::FunctionRef<bool(BrowserWindowInterface*)> on_browser);
// Note here that any windows added during iteration may not remain in
// activation order.
void ForEachCurrentAndNewBrowserWindowInterfaceOrderedByActivation(
base::FunctionRef<bool(BrowserWindowInterface*)> on_browser);
// Returns the last active browser window interface. This can be nullptr if
// there are no browser windows.
// CAUTION: This can return a browser window with *any* profile. Please verify
// the profile.
// If you only care whether a *particular* browser is active, prefer checking
// that with `browser->GetWindow()->IsActive()`, or similar.
BrowserWindowInterface* GetLastActiveBrowserWindowInterfaceWithAnyProfile();
#endif // CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_BROWSER_WINDOW_INTERFACE_ITERATOR_H_
|
