// 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 COMPONENTS_TABS_PUBLIC_MOCK_TAB_INTERFACE_H_
#define COMPONENTS_TABS_PUBLIC_MOCK_TAB_INTERFACE_H_

#include <memory>
#include <optional>

#include "base/callback_list.h"
#include "base/memory/weak_ptr.h"
#include "base/types/pass_key.h"
#include "components/split_tabs/split_tab_id.h"
#include "components/tabs/public/tab_collection.h"
#include "components/tabs/public/tab_interface.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "ui/base/unowned_user_data/unowned_user_data_host.h"

class BrowserWindowInterface;
class Profile;

namespace content {
class WebContents;
}

namespace tabs {
class TabFeatures;

class MockTabInterface : public testing::NiceMock<TabInterface> {
 public:
  MockTabInterface();
  ~MockTabInterface() override;

  MOCK_METHOD(base::WeakPtr<TabInterface>, GetWeakPtr, (), (override));
  MOCK_METHOD(content::WebContents*, GetContents, (), (const, override));
  MOCK_METHOD(void, LoadIfNeeded, (), (override));
  MOCK_METHOD(std::u16string, GetTitle, (), (const, override));
  MOCK_METHOD(GURL, GetURL, (), (const, override));
  MOCK_METHOD(base::Time, GetLastActiveTime, (), (const, override));
  MOCK_METHOD(Profile*, GetProfile, (), (const, override));
  MOCK_METHOD(void, Close, (), (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterWillDiscardContents,
              (WillDiscardContentsCallback),
              (override));
  MOCK_METHOD(bool, IsActivated, (), (const, override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterDidActivate,
              (DidActivateCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterWillDeactivate,
              (WillDeactivateCallback),
              (override));
  MOCK_METHOD(bool, IsVisible, (), (const, override));
  MOCK_METHOD(bool, IsSelected, (), (const, override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterDidBecomeVisible,
              (DidBecomeVisibleCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterWillBecomeHidden,
              (WillBecomeHiddenCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterWillDetach,
              (WillDetach),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterDidInsert,
              (DidInsertCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterPinnedStateChanged,
              (PinnedStateChangedCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterGroupChanged,
              (GroupChangedCallback),
              (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterBlockedStateChanged,
              (BlockedStateChangedCallback),
              (override));
  MOCK_METHOD(bool, CanShowModalUI, (), (const, override));
  MOCK_METHOD(std::unique_ptr<ScopedTabModalUI>, ShowModalUI, (), (override));
  MOCK_METHOD(base::CallbackListSubscription,
              RegisterModalUIChanged,
              (TabInterfaceCallback),
              (override));
  MOCK_METHOD(bool, IsInNormalWindow, (), (const override));
  MOCK_METHOD(BrowserWindowInterface*,
              GetBrowserWindowInterface,
              (),
              (override));
  MOCK_METHOD(const BrowserWindowInterface*,
              GetBrowserWindowInterface,
              (),
              (const override));
  MOCK_METHOD(TabFeatures*, GetTabFeatures, (), (override));
  MOCK_METHOD(const TabFeatures*, GetTabFeatures, (), (const override));
  MOCK_METHOD(bool, IsPinned, (), (const override));
  MOCK_METHOD(bool, IsBlocked, (), (const override));
  MOCK_METHOD(bool, IsSplit, (), (const override));
  MOCK_METHOD(std::optional<tab_groups::TabGroupId>,
              GetGroup,
              (),
              (const override));
  MOCK_METHOD(std::optional<split_tabs::SplitTabId>,
              GetSplit,
              (),
              (const override));
  MOCK_METHOD(TabCollection*,
              GetParentCollection,
              (base::PassKey<TabCollection>),
              (const override));
  MOCK_METHOD(const TabCollection*, GetParentCollection, (), (const override));
  MOCK_METHOD(void,
              OnReparented,
              (TabCollection*, base::PassKey<TabCollection>),
              (override));
  MOCK_METHOD(void,
              OnAncestorChanged,
              (base::PassKey<TabCollection>),
              (override));
  MOCK_METHOD(uint32_t, GetTabHandle, (), (const override));
  MOCK_METHOD(ui::UnownedUserDataHost&, GetUnownedUserDataHost, (), (override));
  MOCK_METHOD(const ui::UnownedUserDataHost&,
              GetUnownedUserDataHost,
              (),
              (const, override));

 private:
  // Returned by GetUnownedUserDataHost() by default so that tests exercising
  // UnownedUserData-based lookups do not need to stub the method themselves.
  ui::UnownedUserDataHost default_unowned_user_data_host_;
};

}  // namespace tabs

#endif  // COMPONENTS_TABS_PUBLIC_MOCK_TAB_INTERFACE_H_