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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
|
// 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_FEATURES_H_
#define CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_BROWSER_WINDOW_FEATURES_H_
#include <memory>
#include "base/memory/raw_ptr.h"
#include "chrome/common/buildflags.h"
#include "extensions/buildflags/buildflags.h"
#include "ui/base/unowned_user_data/user_data_factory.h"
#if BUILDFLAG(ENABLE_GLIC)
namespace glic {
class GlicButtonController;
class GlicIphController;
} // namespace glic
#endif
namespace actor::ui {
class ActorOverlayWindowController;
} // namespace actor::ui
class BookmarkBarController;
class BookmarksSidePanelCoordinator;
class BreadcrumbManagerBrowserAgent;
class Browser;
class BrowserActions;
class BrowserContentSettingBubbleModelDelegate;
class BrowserInstantController;
class BrowserLiveTabContext;
class BrowserLocationBarModelDelegate;
class BrowserSyncedWindowDelegate;
class BrowserUserEducationInterface;
class BrowserView;
class BrowserWindowInterface;
class ChromeLabsCoordinator;
class ColorProviderBrowserHelper;
class CommentsSidePanelCoordinator;
class CookieControlsBubbleCoordinator;
class DataSharingBubbleController;
class DesktopBrowserWindowCapabilities;
class ExclusiveAccessManager;
class FindBarController;
class HistoryClustersSidePanelCoordinator;
class HistorySidePanelCoordinator;
class IncognitoClearBrowsingDataDialogCoordinator;
class ImmersiveModeController;
class LocationBarModel;
class MemorySaverOptInIPHController;
class PinnedToolbarActionsController;
class ProfileMenuCoordinator;
class ReadingListSidePanelCoordinator;
class SidePanelCoordinator;
class SidePanelUI;
class SigninViewController;
class TabMenuModelDelegate;
class TabSearchToolbarButtonController;
class TabListBridge;
class TabStripModel;
class TabStripServiceRegister;
class ToastController;
class ToastService;
class TranslateBubbleController;
class UpgradeNotificationController;
#if BUILDFLAG(IS_WIN)
namespace default_browser {
class PinInfoBarController;
} // namespace default_browser
class WindowsTaskbarIconUpdater;
#endif
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
namespace pdf::infobar {
class PdfInfoBarController;
} // namespace pdf::infobar
#endif
#if !BUILDFLAG(IS_CHROMEOS)
class DownloadToolbarUIController;
#endif
#if defined(USE_AURA)
class OverscrollPrefManager;
#endif // defined(USE_AURA)
namespace extensions {
class BrowserExtensionWindowController;
#if BUILDFLAG(ENABLE_EXTENSIONS)
class ExtensionBrowserWindowHelper;
#endif // BUILDFLAG(ENABLE_EXTENSIONS)
class ExtensionSidePanelManager;
class Mv2DisabledDialogController;
} // namespace extensions
namespace tabs {
class TabDeclutterController;
class VerticalTabStripStateController;
} // namespace tabs
namespace chrome {
class BrowserCommandController;
} // namespace chrome
namespace commerce {
class ProductSpecificationsEntryPointController;
} // namespace commerce
namespace tabs {
class GlicNudgeController;
class GlicActorTaskIconController;
}
namespace tab_groups {
class DeletionDialogController;
} // namespace tab_groups
namespace lens {
class LensOverlayEntryPointController;
class LensRegionSearchController;
} // namespace lens
namespace media_router {
class CastBrowserController;
} // namespace media_router
namespace memory_saver {
class MemorySaverBubbleController;
} // namespace memory_saver
namespace new_tab_footer {
class NewTabFooterController;
} // namespace new_tab_footer
namespace tab_groups {
class SessionServiceTabGroupSyncObserver;
class SharedTabGroupFeedbackController;
class MostRecentSharedTabUpdateStore;
} // namespace tab_groups
namespace send_tab_to_self {
class SendTabToSelfToolbarBubbleController;
} // namespace send_tab_to_self
namespace split_tabs {
class SplitTabScrimController;
} // namespace split_tabs
// This class owns the core controllers for features that are scoped to a given
// browser window on desktop.
//
// To inject alternative versions of features or mocks for testing, make your
// feature compatible with `UnownedUserDataHost` and then use
// `GetUserDataFactoryForTesting()` to inject your test-specific feature
// object(s).
class BrowserWindowFeatures {
public:
BrowserWindowFeatures();
~BrowserWindowFeatures();
BrowserWindowFeatures(const BrowserWindowFeatures&) = delete;
BrowserWindowFeatures& operator=(const BrowserWindowFeatures&) = delete;
// Called exactly once to initialize features. This is called prior to
// instantiating BrowserView, to allow the view hierarchy to depend on state
// in this class.
void Init(BrowserWindowInterface* browser);
// Called exactly once to initialize features that depend on the window object
// being created.
void InitPostWindowConstruction(Browser* browser);
// Called exactly once to initialize features that depend on the view
// hierarchy in BrowserView.
void InitPostBrowserViewConstruction(BrowserView* browser_view);
// Called exactly once to tear down state that depends on the window object.
void TearDownPreBrowserWindowDestruction();
// Public accessors for features:
BrowserActions* browser_actions() { return browser_actions_.get(); }
chrome::BrowserCommandController* browser_command_controller() {
return browser_command_controller_.get();
}
extensions::Mv2DisabledDialogController*
mv2_disabled_dialog_controller_for_testing() {
return mv2_disabled_dialog_controller_.get();
}
ChromeLabsCoordinator* chrome_labs_coordinator() {
return chrome_labs_coordinator_.get();
}
media_router::CastBrowserController* cast_browser_controller() {
return cast_browser_controller_.get();
}
HistorySidePanelCoordinator* history_side_panel_coordinator() {
return history_side_panel_coordinator_.get();
}
BookmarksSidePanelCoordinator* bookmarks_side_panel_coordinator() {
return bookmarks_side_panel_coordinator_.get();
}
CommentsSidePanelCoordinator* comments_side_panel_coordinator() {
return comments_side_panel_coordinator_.get();
}
PinnedToolbarActionsController* pinned_toolbar_actions_controller() {
return pinned_toolbar_actions_controller_.get();
}
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
pdf::infobar::PdfInfoBarController* pdf_infobar_controller() {
return pdf_infobar_controller_.get();
}
#endif
#if BUILDFLAG(IS_WIN)
default_browser::PinInfoBarController* pin_infobar_controller() {
return pin_infobar_controller_.get();
}
#endif
// TODO(crbug.com/346158959): For historical reasons, side_panel_ui is an
// abstract base class that contains some, but not all of the public interface
// of SidePanelCoordinator. One of the accessors side_panel_ui() or
// side_panel_coordinator() should be removed. For consistency with the rest
// of this class, we use lowercase_with_underscores even though the
// implementation is not inlined.
SidePanelUI* side_panel_ui();
SidePanelCoordinator* side_panel_coordinator() {
return side_panel_coordinator_.get();
}
lens::LensOverlayEntryPointController* lens_overlay_entry_point_controller() {
return lens_overlay_entry_point_controller_.get();
}
actor::ui::ActorOverlayWindowController* actor_overlay_window_controller() {
return actor_overlay_window_controller_.get();
}
lens::LensRegionSearchController* lens_region_search_controller() {
return lens_region_search_controller_.get();
}
tabs::TabDeclutterController* tab_declutter_controller() {
return tab_declutter_controller_.get();
}
tabs::VerticalTabStripStateController* vertical_tab_strip_state_controller() {
return vertical_tab_strip_state_controller_.get();
}
tabs::GlicNudgeController* glic_nudge_controller() {
return glic_nudge_controller_.get();
}
tabs::GlicActorTaskIconController* glic_actor_task_icon_controller() {
return glic_actor_task_icon_controller_.get();
}
TabStripModel* tab_strip_model() { return tab_strip_model_; }
// Returns a pointer to the ToastController for the browser window. This can
// return nullptr for non-normal browser windows because toasts are not
// supported for those cases.
ToastController* toast_controller();
// Returns a pointer to the ToastService for the browser window. This can
// return nullptr for non-normal browser windows because toasts are not
// supported for those cases.
ToastService* toast_service() { return toast_service_.get(); }
send_tab_to_self::SendTabToSelfToolbarBubbleController*
send_tab_to_self_toolbar_bubble_controller() {
return send_tab_to_self_toolbar_bubble_controller_.get();
}
extensions::ExtensionSidePanelManager* extension_side_panel_manager() {
return extension_side_panel_manager_.get();
}
#if !BUILDFLAG(IS_CHROMEOS)
DownloadToolbarUIController* download_toolbar_ui_controller() {
return download_toolbar_ui_controller_.get();
}
#endif
tab_groups::MostRecentSharedTabUpdateStore*
most_recent_shared_tab_update_store() {
return most_recent_shared_tab_update_store_.get();
}
memory_saver::MemorySaverBubbleController* memory_saver_bubble_controller() {
return memory_saver_bubble_controller_.get();
}
tab_groups::SharedTabGroupFeedbackController*
shared_tab_group_feedback_controller() {
return shared_tab_group_feedback_controller_.get();
}
TranslateBubbleController* translate_bubble_controller() {
return translate_bubble_controller_.get();
}
TabSearchToolbarButtonController* tab_search_toolbar_button_controller() {
return tab_search_toolbar_button_controller_.get();
}
CookieControlsBubbleCoordinator* cookie_controls_bubble_coordinator() {
return cookie_controls_bubble_coordinator_.get();
}
BrowserSyncedWindowDelegate* synced_window_delegate() {
return synced_window_delegate_.get();
}
TabMenuModelDelegate* tab_menu_model_delegate() {
return tab_menu_model_delegate_.get();
}
tab_groups::DeletionDialogController* tab_group_deletion_dialog_controller() {
return tab_group_deletion_dialog_controller_.get();
}
SigninViewController* signin_view_controller() {
return signin_view_controller_.get();
}
// Only fetch the tab_strip_service to register a pending receiver.
TabStripServiceRegister* tab_strip_service() {
return tab_strip_service_.get();
}
LocationBarModel* location_bar_model() { return location_bar_model_.get(); }
const LocationBarModel* location_bar_model() const {
return location_bar_model_.get();
}
#if defined(UNIT_TEST)
void swap_location_bar_models(
std::unique_ptr<LocationBarModel>* location_bar_model) {
location_bar_model->swap(location_bar_model_);
}
#endif
ReadingListSidePanelCoordinator* reading_list_side_panel_coordinator() {
return reading_list_side_panel_coordinator_.get();
}
new_tab_footer::NewTabFooterController* new_tab_footer_controller() {
return new_tab_footer_controller_.get();
}
split_tabs::SplitTabScrimController* split_tab_scrim_controller() {
return split_tab_scrim_controller_.get();
}
ProfileMenuCoordinator* profile_menu_coordinator() {
return profile_menu_coordinator_.get();
}
IncognitoClearBrowsingDataDialogCoordinator*
incognito_clear_browsing_data_dialog_coordinator() {
return incognito_clear_browsing_data_dialog_coordinator_.get();
}
#if defined(USE_AURA)
OverscrollPrefManager* overscroll_pref_manager() {
return overscroll_pref_manager_.get();
}
#endif // defined(USE_AURA)
// Get the FindBarController for this browser window, creating it if it does
// not yet exist.
FindBarController* GetFindBarController();
// Returns true if a FindBarController exists for this browser window.
bool HasFindBarController() const;
DataSharingBubbleController* data_sharing_bubble_controller() {
return data_sharing_bubble_controller_.get();
}
ExclusiveAccessManager* exclusive_access_manager() {
return exclusive_access_manager_.get();
}
HistoryClustersSidePanelCoordinator*
history_clusters_side_panel_coordinator() {
return history_clusters_side_panel_coordinator_.get();
}
ImmersiveModeController* immersive_mode_controller() {
return immersive_mode_controller_.get();
}
const ImmersiveModeController* immersive_mode_controller() const {
return immersive_mode_controller_.get();
}
UpgradeNotificationController* upgrade_notification_controller() {
return upgrade_notification_controller_.get();
}
BrowserContentSettingBubbleModelDelegate*
content_setting_bubble_model_delegate() {
return content_setting_bubble_model_delegate_.get();
}
BrowserLiveTabContext* live_tab_context() { return live_tab_context_.get(); }
static ui::UserDataFactoryWithOwner<BrowserWindowInterface>&
GetUserDataFactoryForTesting();
private:
static ui::UserDataFactoryWithOwner<BrowserWindowInterface>&
GetUserDataFactory();
// A collection of features specific to desktop versions of Chrome.
std::unique_ptr<DesktopBrowserWindowCapabilities>
desktop_browser_window_capabilities_;
// Features that are per-browser window will each have a controller. e.g.
// std::unique_ptr<FooFeature> foo_feature_;
std::unique_ptr<BrowserActions> browser_actions_;
std::unique_ptr<chrome::BrowserCommandController> browser_command_controller_;
std::unique_ptr<BookmarkBarController> bookmark_bar_controller_;
std::unique_ptr<BrowserInstantController> instant_controller_;
std::unique_ptr<send_tab_to_self::SendTabToSelfToolbarBubbleController>
send_tab_to_self_toolbar_bubble_controller_;
std::unique_ptr<ChromeLabsCoordinator> chrome_labs_coordinator_;
std::unique_ptr<commerce::ProductSpecificationsEntryPointController>
product_specifications_entry_point_controller_;
std::unique_ptr<ImmersiveModeController> immersive_mode_controller_;
std::unique_ptr<ExclusiveAccessManager> exclusive_access_manager_;
std::unique_ptr<lens::LensOverlayEntryPointController>
lens_overlay_entry_point_controller_;
std::unique_ptr<lens::LensRegionSearchController>
lens_region_search_controller_;
std::unique_ptr<extensions::Mv2DisabledDialogController>
mv2_disabled_dialog_controller_;
std::unique_ptr<tabs::TabDeclutterController> tab_declutter_controller_;
std::unique_ptr<tabs::VerticalTabStripStateController>
vertical_tab_strip_state_controller_;
std::unique_ptr<MemorySaverOptInIPHController>
memory_saver_opt_in_iph_controller_;
std::unique_ptr<HistorySidePanelCoordinator> history_side_panel_coordinator_;
std::unique_ptr<BookmarksSidePanelCoordinator>
bookmarks_side_panel_coordinator_;
std::unique_ptr<CommentsSidePanelCoordinator>
comments_side_panel_coordinator_;
std::unique_ptr<PinnedToolbarActionsController>
pinned_toolbar_actions_controller_;
#if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
std::unique_ptr<pdf::infobar::PdfInfoBarController> pdf_infobar_controller_;
#endif
#if BUILDFLAG(IS_WIN)
std::unique_ptr<default_browser::PinInfoBarController>
pin_infobar_controller_;
#endif
std::unique_ptr<SidePanelCoordinator> side_panel_coordinator_;
std::unique_ptr<tab_groups::SessionServiceTabGroupSyncObserver>
session_service_tab_group_sync_observer_;
raw_ptr<TabStripModel> tab_strip_model_;
std::unique_ptr<ToastService> toast_service_;
// The window-scoped extension side-panel manager. There is a separate
// tab-scoped extension side-panel manager.
std::unique_ptr<extensions::ExtensionSidePanelManager>
extension_side_panel_manager_;
std::unique_ptr<media_router::CastBrowserController> cast_browser_controller_;
#if !BUILDFLAG(IS_CHROMEOS)
std::unique_ptr<DownloadToolbarUIController> download_toolbar_ui_controller_;
#endif
std::unique_ptr<actor::ui::ActorOverlayWindowController>
actor_overlay_window_controller_;
std::unique_ptr<tabs::GlicNudgeController> glic_nudge_controller_;
std::unique_ptr<tabs::GlicActorTaskIconController>
glic_actor_task_icon_controller_;
#if BUILDFLAG(ENABLE_GLIC)
std::unique_ptr<glic::GlicButtonController> glic_button_controller_;
std::unique_ptr<glic::GlicIphController> glic_iph_controller_;
#endif
std::unique_ptr<tab_groups::MostRecentSharedTabUpdateStore>
most_recent_shared_tab_update_store_;
std::unique_ptr<memory_saver::MemorySaverBubbleController>
memory_saver_bubble_controller_;
std::unique_ptr<tab_groups::SharedTabGroupFeedbackController>
shared_tab_group_feedback_controller_;
std::unique_ptr<TranslateBubbleController> translate_bubble_controller_;
std::unique_ptr<TabSearchToolbarButtonController>
tab_search_toolbar_button_controller_;
std::unique_ptr<CookieControlsBubbleCoordinator>
cookie_controls_bubble_coordinator_;
std::unique_ptr<BrowserSyncedWindowDelegate> synced_window_delegate_;
std::unique_ptr<TabMenuModelDelegate> tab_menu_model_delegate_;
std::unique_ptr<tab_groups::DeletionDialogController>
tab_group_deletion_dialog_controller_;
// Helper which implements the LocationBarModelDelegate interface.
std::unique_ptr<BrowserLocationBarModelDelegate> location_bar_model_delegate_;
// The model for the toolbar view.
std::unique_ptr<LocationBarModel> location_bar_model_;
std::unique_ptr<SigninViewController> signin_view_controller_;
std::unique_ptr<new_tab_footer::NewTabFooterController>
new_tab_footer_controller_;
std::unique_ptr<ReadingListSidePanelCoordinator>
reading_list_side_panel_coordinator_;
std::unique_ptr<ProfileMenuCoordinator> profile_menu_coordinator_;
std::unique_ptr<IncognitoClearBrowsingDataDialogCoordinator>
incognito_clear_browsing_data_dialog_coordinator_;
#if defined(USE_AURA)
std::unique_ptr<OverscrollPrefManager> overscroll_pref_manager_;
#endif // defined(USE_AURA)
std::unique_ptr<ColorProviderBrowserHelper> color_provider_browser_helper_;
// This is an experimental API that interacts with the TabStripModel.
std::unique_ptr<TabStripServiceRegister> tab_strip_service_;
// The Find Bar. This may be NULL if there is no Find Bar, and if it is
// non-NULL, it may or may not be visible.
std::unique_ptr<FindBarController> find_bar_controller_;
std::unique_ptr<DataSharingBubbleController> data_sharing_bubble_controller_;
std::unique_ptr<TabListBridge> tab_list_bridge_;
// Note: Depends on TabListBridge, so should come after it in the member list.
std::unique_ptr<extensions::BrowserExtensionWindowController>
extension_window_controller_;
std::unique_ptr<HistoryClustersSidePanelCoordinator>
history_clusters_side_panel_coordinator_;
std::unique_ptr<UpgradeNotificationController>
upgrade_notification_controller_;
// Helper which implements the ContentSettingBubbleModel interface.
std::unique_ptr<BrowserContentSettingBubbleModelDelegate>
content_setting_bubble_model_delegate_;
// Helper which implements the LiveTabContext interface.
std::unique_ptr<BrowserLiveTabContext> live_tab_context_;
#if BUILDFLAG(ENABLE_EXTENSIONS)
std::unique_ptr<extensions::ExtensionBrowserWindowHelper>
extension_browser_window_helper_;
#endif
// Listens for browser-related breadcrumb events to be added to crash reports.
std::unique_ptr<BreadcrumbManagerBrowserAgent>
breadcrumb_manager_browser_agent_;
// TODO(crbug.com/423956131): Remove this.
raw_ptr<BrowserWindowInterface> browser_ = nullptr;
std::unique_ptr<split_tabs::SplitTabScrimController>
split_tab_scrim_controller_;
#if BUILDFLAG(IS_WIN)
std::unique_ptr<WindowsTaskbarIconUpdater> windows_taskbar_icon_updater_;
#endif
std::unique_ptr<BrowserUserEducationInterface> user_education_;
};
#endif // CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_BROWSER_WINDOW_FEATURES_H_
|