chrome/browser/ui/views/tab_search_bubble_host.h

// Copyright 2021 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_VIEWS_TAB_SEARCH_BUBBLE_HOST_H_
#define CHROME_BROWSER_UI_VIEWS_TAB_SEARCH_BUBBLE_HOST_H_

#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "base/time/time.h"
#include "chrome/browser/ui/tabs/organization/tab_organization_observer.h"
#include "chrome/browser/ui/views/bubble/webui_bubble_manager.h"
#include "chrome/browser/ui/views/bubble/webui_bubble_manager_observer.h"
#include "chrome/browser/ui/views/tabs/tab_slot_controller.h"
#include "chrome/browser/ui/webui/tab_search/tab_search.mojom.h"
#include "chrome/browser/ui/webui/tab_search/tab_search_ui.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/views/controls/button/menu_button_controller.h"
#include "ui/views/widget/widget_observer.h"
#include "ui/views/widget/widget_utils.h"

namespace views {
class Widget;
}  // namespace views

class BrowserWindowInterface;
class Profile;
class TabOrganizationService;
class TabSearchBubbleHostObserver;

// TabSearchBubbleHost assumes responsibility for configuring its button,
// showing / hiding the tab search bubble and handling metrics collection.
class TabSearchBubbleHost : public views::WidgetObserver,
                            public TabOrganizationObserver,
                            public WebUIBubbleManagerObserver {
 public:
  TabSearchBubbleHost(views::Button* button,
                      BrowserWindowInterface* browser_window_interface);
  TabSearchBubbleHost(const TabSearchBubbleHost&) = delete;
  TabSearchBubbleHost& operator=(const TabSearchBubbleHost&) = delete;
  ~TabSearchBubbleHost() override;

  // views::WidgetObserver:
  void OnWidgetVisibilityChanged(views::Widget* widget, bool visible) override;
  void OnWidgetDestroying(views::Widget* widget) override;

  // TabOrganizationObserver:
  void OnOrganizationAccepted(Browser* browser) override;
  void OnUserInvokedFeature(const Browser* browser) override;

  // WebUIBubbleManagerObserver:
  void BeforeBubbleWidgetShowed(views::Widget* widget) override;

  void AddObserver(TabSearchBubbleHostObserver* observer);
  void RemoveObserver(TabSearchBubbleHostObserver* observer);

  // When this is called the bubble may already be showing or be loading in.
  // This returns true if the method call results in the creation of a new Tab
  // Search bubble. Optionally use section to force the bubble to open to the
  // given tab, even if the bubble is already showing.
  bool ShowTabSearchBubble(
      bool triggered_by_keyboard_shortcut = false,
      tab_search::mojom::TabSearchSection section =
          tab_search::mojom::TabSearchSection::kSearch,
      tab_search::mojom::TabOrganizationFeature organization_feature =
          tab_search::mojom::TabOrganizationFeature::kNone);
  void CloseTabSearchBubble();

  Browser* GetBrowser();

  views::View* button() { return button_; }

  WebUIBubbleManager* webui_bubble_manager_for_testing() {
    return webui_bubble_manager_.get();
  }

  const std::optional<base::TimeTicks>& bubble_created_time_for_testing()
      const {
    return bubble_created_time_;
  }

 private:
  void ButtonPressed(const ui::Event& event);

  // The anchor button for the tab search bubble.
  const raw_ptr<views::Button> button_;

  const raw_ptr<Profile> profile_;

  std::unique_ptr<WebUIBubbleManager> webui_bubble_manager_;

  views::WidgetOpenTimer widget_open_timer_;

  // Timestamp for when the current bubble was created.
  std::optional<base::TimeTicks> bubble_created_time_;

  base::ObserverList<TabSearchBubbleHostObserver> observers_;

  // A lock to keep its `button_` pressed while |bubble_| is showing or in the
  // process of being shown.
  std::unique_ptr<views::MenuButtonController::PressedLock> pressed_lock_;

  base::ScopedObservation<views::Widget, views::WidgetObserver>
      bubble_widget_observation_{this};

  base::ScopedObservation<TabOrganizationService, TabOrganizationObserver>
      tab_organization_observation_{this};

  base::ScopedObservation<WebUIBubbleManager, WebUIBubbleManagerObserver>
      webui_bubble_manager_observer_{this};
};

#endif  // CHROME_BROWSER_UI_VIEWS_TAB_SEARCH_BUBBLE_HOST_H_