// 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_TABS_TAB_ENUMS_H_
#define CHROME_BROWSER_UI_TABS_TAB_ENUMS_H_

// The Service, UI, or Setting which muted the tab.
enum class TabMutedReason {
  kNone,                  // The tab has never been muted or unmuted.
  kExtension,             // Mute state changed via extension API.
  kAudioIndicator,        // Mute toggled via tab-strip audio icon.
  kContentSetting,        // The sound content setting was set to BLOCK.
  kContentSettingChrome,  // Mute toggled on chrome:// URL.
};

// Source of the call to CloseTab().
enum class CloseTabSource {
  // Tab was closed by a mouse event on the tab or its close button
  kFromMouse,
  // Tab was closed by a touch event on the tab or its close button
  kFromTouch,
  // Tab is closed by some means other than direct tab interaction
  kFromNonUIEvent,
};

// A BitField used to specify what should happen when the tab is closed.
enum TabCloseTypes {
  CLOSE_NONE = 0,

  // Indicates the tab was closed by the user. If true,
  // WebContents::SetClosedByUserGesture(true) is invoked.
  CLOSE_USER_GESTURE = 1 << 0,

  // If true the history is recorded so that the tab can be reopened later. You
  // almost always want to set this.
  CLOSE_CREATE_HISTORICAL_TAB = 1 << 1,

  // If true the side panel is expanded when the tab is closed.
  CLOSE_EXPAND_SIDE_PANEL = 1 << 2,
};

// Constants used when adding tabs.
enum AddTabTypes {
  // Used to indicate nothing special should happen to the newly inserted tab.
  ADD_NONE = 0,

  // The tab should be active.
  ADD_ACTIVE = 1 << 0,

  // The tab should be pinned.
  ADD_PINNED = 1 << 1,

  // If not set the insertion index of the WebContents is left up to the Order
  // Controller associated, so the final insertion index may differ from the
  // specified index. Otherwise the index supplied is used.
  ADD_FORCE_INDEX = 1 << 2,

  // If set the newly inserted tab's opener is set to the active tab. If not
  // set the tab may still inherit the opener under certain situations.
  ADD_INHERIT_OPENER = 1 << 3,
};

// Enumerates different ways to open a new tab. Does not apply to opening
// existing links or searches in a new tab, only to brand new empty tabs.
// KEEP IN SYNC WITH THE NewTabType ENUM IN enums.xml.
// NEW VALUES MUST BE APPENDED AND AVOID CHANGING ANY PRE-EXISTING VALUES.
enum class NewTabTypes {
  // New tab was opened using the new tab button on the tab strip.
  kNewTabButton = 0,

  // New tab was opened using the menu command - either through the keyboard
  // shortcut, or by opening the menu and selecting the command. Applies to
  // both app menu and the menu bar's File menu (on platforms that have one).
  kNewTabCommand = 1,

  // New tab was opened through the context menu on the tab strip.
  kNewTabContextMenu = 2,

  // New tab was opened through the new tab button in the toolbar for the
  // WebUI touch-optimized tab strip.
  kNewTabButtonInToolbarForTouch = 3,

  // New tab was opened through the new tab button inside of the WebUI tab
  // strip.
  kNewTabButtonInWebuiTabStrip = 4,

  // Value for opening tabs without specifying a user action. We may use this
  // in situations where we implicitly make a new tab for the user. For
  // example, when the user deletes a tab group and there are no other tabs
  // in the browser to keep it running.
  kNoUserAction = 5,

  // Number of enum entries, used for UMA histogram reporting macros.
  kNewTabEnumCount = 6,
};

// Enumerates different types of tab activation. Mainly used for
// comparison between classic tab strip and WebUI tab strip.
// KEEP IN SYNC WITH THE TabActivationTypes ENUM IN enums.xml.
// NEW VALUES MUST BE APPENDED AND AVOID CHANGING ANY PRE-EXISTING VALUES.
enum class TabActivationTypes {
  // Switch to a tab.
  kTab = 0,

  // Open the context menu of a tab.
  kContextMenu = 1,

  kMaxValue = kContextMenu,
};

// Enumerates the collapse state of the vertical tab strip.
// KEEP IN SYNC WITH THE VerticalTabStripCollapseState ENUM IN enums.xml.
// LINT.IfChange(VerticalTabStripCollapseState)
enum class VerticalTabStripCollapseState {
  kExpanded = 0,
  kCollapsed = 1,
  kMaxValue = kCollapsed,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/tab/enums.xml:VerticalTabStripCollapseState)

// Enumerates entry points for Tab Groups Focus mode.
// KEEP IN SYNC WITH THE TabGroupFocusEntryPoint ENUM IN enums.xml.
// LINT.IfChange(TabGroupFocusEntryPoint)
enum class TabGroupFocusEntryPoint {
  kEditorBubble = 0,
  kMaxValue = kEditorBubble,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/tab/enums.xml:TabGroupFocusEntryPoint)

// Enumerates exit reasons for Tab Groups Focus mode.
// KEEP IN SYNC WITH THE TabGroupFocusExitReason ENUM IN enums.xml.
// LINT.IfChange(TabGroupFocusExitReason)
enum class TabGroupFocusExitReason {
  kEditorBubble = 0,
  kTabStripButton = 1,
  kGroupClosed = 2,
  kGroupUngrouped = 3,
  kLastTabClosed = 4,
  kUnpinActiveTab = 5,
  kGroupHeaderDraggedIn = 6,
  kActiveTabGroupOperation = 7,
  kTabOutsideGroupClosed = 8,
  kMaxValue = kTabOutsideGroupClosed,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/tab/enums.xml:TabGroupFocusExitReason)

#endif  // CHROME_BROWSER_UI_TABS_TAB_ENUMS_H_