Cleanup: Add "current tab disposition" argument to DispositionFromXXX() funcs.

Many callers want to do things like "if the link would open in the current tab,
open in a new foreground tab instead".  This provides a simple way to do that.

Bug: none
Change-Id: Ia49088031543905ad4d1d0122a8656c675a33e14
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1986122
Commit-Queue: Avi Drissman <avi@chromium.org>
Reviewed-by: Avi Drissman <avi@chromium.org>
Auto-Submit: Peter Kasting <pkasting@chromium.org>
Cr-Commit-Position: refs/heads/master@{#728583}

chrome/browser/renderer_context_menu/render_view_context_menu.cc

@@ -473,18 +473,6 @@ bool IsCommandForOpenLink(int id) {
           id <= IDC_OPEN_LINK_IN_PROFILE_LAST);
 }
 
-// Usually a new tab is expected where this function is used,
-// however users should be able to open a tab in background
-// or in a new window.
-WindowOpenDisposition ForceNewTabDispositionFromEventFlags(
-    int event_flags) {
-  WindowOpenDisposition disposition =
-      ui::DispositionFromEventFlags(event_flags);
-  return disposition == WindowOpenDisposition::CURRENT_TAB
-             ? WindowOpenDisposition::NEW_FOREGROUND_TAB
-             : disposition;
-}
-
 // Returns the preference of the profile represented by the |context|.
 PrefService* GetPrefs(content::BrowserContext* context) {
   return user_prefs::UserPrefs::Get(context);
@@ -2400,7 +2388,8 @@ void RenderViewContextMenu::ExecuteCommand(int id, int event_flags) {
     case IDC_CONTENT_CONTEXT_SEARCHWEBFOR:
     case IDC_CONTENT_CONTEXT_GOTOURL:
       OpenURL(selection_navigation_url_, GURL(),
-              ForceNewTabDispositionFromEventFlags(event_flags),
+              ui::DispositionFromEventFlags(
+                  event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB),
               ui::PAGE_TRANSITION_LINK);
       break;
 
@@ -2724,8 +2713,8 @@ void RenderViewContextMenu::ExecProtocolHandler(int event_flags,
 
   base::RecordAction(
       UserMetricsAction("RegisterProtocolHandler.ContextMenu_Open"));
-  WindowOpenDisposition disposition =
-      ForceNewTabDispositionFromEventFlags(event_flags);
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
   OpenURL(handlers[handler_index].TranslateUrl(params_.link_url),
           GetDocumentURL(params_),
           disposition,
@@ -3027,8 +3016,8 @@ void RenderViewContextMenu::ExecTranslate() {
 }
 
 void RenderViewContextMenu::ExecLanguageSettings(int event_flags) {
-  WindowOpenDisposition disposition =
-      ForceNewTabDispositionFromEventFlags(event_flags);
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
   GURL url = chrome::GetSettingsUrl(chrome::kLanguageOptionsSubPage);
   OpenURL(url, GURL(), disposition, ui::PAGE_TRANSITION_LINK);
 }
@@ -3036,8 +3025,8 @@ void RenderViewContextMenu::ExecLanguageSettings(int event_flags) {
 void RenderViewContextMenu::ExecProtocolHandlerSettings(int event_flags) {
   base::RecordAction(
       UserMetricsAction("RegisterProtocolHandler.ContextMenu_Settings"));
-  WindowOpenDisposition disposition =
-      ForceNewTabDispositionFromEventFlags(event_flags);
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
   GURL url = chrome::GetSettingsUrl(chrome::kHandlerSettingsSubPage);
   OpenURL(url, GURL(), disposition, ui::PAGE_TRANSITION_LINK);
 }

chrome/browser/ui/search/search_tab_helper.cc

@@ -791,11 +791,10 @@ void SearchTabHelper::OpenExtensionsPage(double button,
                                          bool shift_key) {
   if (!search::DefaultSearchProviderIsGoogle(profile()))
     return;
-  bool middle_button = (button == 1.0);
-  WindowOpenDisposition disposition = ui::DispositionFromClick(
-      middle_button, alt_key, ctrl_key, meta_key, shift_key);
-  if (button > 1)
-    disposition = WindowOpenDisposition::NEW_FOREGROUND_TAB;
+  WindowOpenDisposition disposition =
+      (button > 1) ? WindowOpenDisposition::NEW_FOREGROUND_TAB
+                   : ui::DispositionFromClick((button == 1.0), alt_key,
+                                              ctrl_key, meta_key, shift_key);
   web_contents_->OpenURL(content::OpenURLParams(
       GURL(chrome::kChromeUIExtensionsURL), content::Referrer(), disposition,
       ui::PAGE_TRANSITION_LINK, false));

chrome/browser/ui/toolbar/recent_tabs_sub_menu_model.cc

@@ -259,12 +259,8 @@ void RecentTabsSubMenuModel::ExecuteCommand(int command_id, int event_flags) {
   DCHECK_NE(IDC_RECENT_TABS_NO_DEVICE_TABS, command_id);
   DCHECK(!IsDeviceNameCommandId(command_id));
 
-  WindowOpenDisposition disposition =
-      ui::DispositionFromEventFlags(event_flags);
-  if (disposition == WindowOpenDisposition::CURRENT_TAB) {
-    // Force to open a new foreground tab.
-    disposition = WindowOpenDisposition::NEW_FOREGROUND_TAB;
-  }
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
 
   sessions::TabRestoreService* service =
       TabRestoreServiceFactory::GetForProfile(browser_->profile());

chrome/browser/ui/views/accessibility/invert_bubble_view.cc

@@ -161,14 +161,10 @@ void InvertBubbleView::ButtonPressed(views::Button* sender,
 }
 
 void InvertBubbleView::OpenLink(const std::string& url, int event_flags) {
-  WindowOpenDisposition disposition =
-      ui::DispositionFromEventFlags(event_flags);
-  content::OpenURLParams params(
-      GURL(url), content::Referrer(),
-      disposition == WindowOpenDisposition::CURRENT_TAB
-          ? WindowOpenDisposition::NEW_FOREGROUND_TAB
-          : disposition,
-      ui::PAGE_TRANSITION_LINK, false);
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
+  content::OpenURLParams params(GURL(url), content::Referrer(), disposition,
+                                ui::PAGE_TRANSITION_LINK, false);
   browser_->OpenURL(params);
 }
 

chrome/browser/ui/views/network_profile_bubble_view.cc

@@ -101,15 +101,12 @@ void NetworkProfileBubbleView::LinkClicked(views::Link* source,
                                            int event_flags) {
   NetworkProfileBubble::RecordUmaEvent(
       NetworkProfileBubble::METRIC_LEARN_MORE_CLICKED);
-  WindowOpenDisposition disposition =
-      ui::DispositionFromEventFlags(event_flags);
+  WindowOpenDisposition disposition = ui::DispositionFromEventFlags(
+      event_flags, WindowOpenDisposition::NEW_FOREGROUND_TAB);
   content::OpenURLParams params(
       GURL("https://sites.google.com/a/chromium.org/dev/administrators/"
            "common-problems-and-solutions#network_profile"),
-      content::Referrer(), disposition == WindowOpenDisposition::CURRENT_TAB
-                               ? WindowOpenDisposition::NEW_FOREGROUND_TAB
-                               : disposition,
-      ui::PAGE_TRANSITION_LINK, false);
+      content::Referrer(), disposition, ui::PAGE_TRANSITION_LINK, false);
   navigator_->OpenURL(params);
 
   // If the user interacted with the bubble we don't reduce the number of

chrome/browser/ui/views/toolbar/app_menu.cc

@@ -1000,12 +1000,9 @@ void AppMenu::OnMenuClosed(views::MenuItemView* menu) {
 
 bool AppMenu::ShouldExecuteCommandWithoutClosingMenu(int command_id,
                                                      const ui::Event& event) {
-  if (IsRecentTabsCommand(command_id) && event.IsMouseEvent()) {
-    const auto disposition = ui::DispositionFromEventFlags(event.flags());
-    if (disposition == WindowOpenDisposition::NEW_BACKGROUND_TAB)
-      return true;
-  }
-  return false;
+  return IsRecentTabsCommand(command_id) && event.IsMouseEvent() &&
+         (ui::DispositionFromEventFlags(event.flags()) ==
+          WindowOpenDisposition::NEW_BACKGROUND_TAB);
 }
 
 void AppMenu::BookmarkModelChanged() {

chrome/browser/ui/webui/history/navigation_handler.cc

@@ -46,11 +46,9 @@ void NavigationHandler::HandleNavigateToUrl(const base::ListValue* args) {
   bool middle_button = (button == 1.0);
 
   WindowOpenDisposition disposition = ui::DispositionFromClick(
-      middle_button, alt_key, ctrl_key, meta_key, shift_key);
-  if (disposition == WindowOpenDisposition::CURRENT_TAB &&
-      target_string == "_blank")
-    disposition = WindowOpenDisposition::NEW_FOREGROUND_TAB;
-
+      middle_button, alt_key, ctrl_key, meta_key, shift_key,
+      (target_string == "_blank") ? WindowOpenDisposition::NEW_FOREGROUND_TAB
+                                  : WindowOpenDisposition::CURRENT_TAB);
   web_ui()->GetWebContents()->OpenURL(
       content::OpenURLParams(GURL(url_string), content::Referrer(), disposition,
                              ui::PAGE_TRANSITION_LINK, false));

ui/base/window_open_disposition.cc

@@ -9,11 +9,13 @@
 
 namespace ui {
 
-WindowOpenDisposition DispositionFromClick(bool middle_button,
-                                           bool alt_key,
-                                           bool ctrl_key,
-                                           bool meta_key,
-                                           bool shift_key) {
+WindowOpenDisposition DispositionFromClick(
+    bool middle_button,
+    bool alt_key,
+    bool ctrl_key,
+    bool meta_key,
+    bool shift_key,
+    WindowOpenDisposition disposition_for_current_tab) {
   // MacOS uses meta key (Command key) to spawn new tabs.
 #if defined(OS_MACOSX)
   if (middle_button || meta_key)
@@ -26,16 +28,18 @@ WindowOpenDisposition DispositionFromClick(bool middle_button,
     return WindowOpenDisposition::NEW_WINDOW;
   if (alt_key)
     return WindowOpenDisposition::SAVE_TO_DISK;
-  return WindowOpenDisposition::CURRENT_TAB;
+  return disposition_for_current_tab;
 }
 
-WindowOpenDisposition DispositionFromEventFlags(int event_flags) {
-  return DispositionFromClick(
-      (event_flags & ui::EF_MIDDLE_MOUSE_BUTTON) != 0,
-      (event_flags & ui::EF_ALT_DOWN) != 0,
-      (event_flags & ui::EF_CONTROL_DOWN) != 0,
-      (event_flags & ui::EF_COMMAND_DOWN) != 0,
-      (event_flags & ui::EF_SHIFT_DOWN) != 0);
+WindowOpenDisposition DispositionFromEventFlags(
+    int event_flags,
+    WindowOpenDisposition disposition_for_current_tab) {
+  return DispositionFromClick((event_flags & ui::EF_MIDDLE_MOUSE_BUTTON) != 0,
+                              (event_flags & ui::EF_ALT_DOWN) != 0,
+                              (event_flags & ui::EF_CONTROL_DOWN) != 0,
+                              (event_flags & ui::EF_COMMAND_DOWN) != 0,
+                              (event_flags & ui::EF_SHIFT_DOWN) != 0,
+                              disposition_for_current_tab);
 }
 
 }  // namespace ui

ui/base/window_open_disposition.h

@@ -35,19 +35,26 @@ enum class WindowOpenDisposition {
 
 namespace ui {
 
-// Translates event flags from a click on a link into the user's desired
-// window disposition.  For example, a middle click would mean to open
-// a background tab.
-UI_BASE_EXPORT WindowOpenDisposition DispositionFromClick(bool middle_button,
-                                                          bool alt_key,
-                                                          bool ctrl_key,
-                                                          bool meta_key,
-                                                          bool shift_key);
-
-// Translates event flags into what kind of disposition they represents.
-// For example, a middle click would mean to open a background tab.
-// event_flags are the flags as understood by ui::MouseEvent.
-UI_BASE_EXPORT WindowOpenDisposition DispositionFromEventFlags(int event_flags);
+// Translates event flags from a click on a link into the user's desired window
+// disposition.  For example, a middle click would mean to open a background
+// tab.  |disposition_for_current_tab| is the disposition to return if the flags
+// suggest opening in the current tab; for example, a caller could set this to
+// NEW_FOREGROUND_TAB to prevent a click from overwriting the current tab by
+// default.
+UI_BASE_EXPORT WindowOpenDisposition
+DispositionFromClick(bool middle_button,
+                     bool alt_key,
+                     bool ctrl_key,
+                     bool meta_key,
+                     bool shift_key,
+                     WindowOpenDisposition disposition_for_current_tab =
+                         WindowOpenDisposition::CURRENT_TAB);
+
+// As with DispositionFromClick(), but using |event_flags| as in ui::MouseEvent.
+UI_BASE_EXPORT WindowOpenDisposition
+DispositionFromEventFlags(int event_flags,
+                          WindowOpenDisposition disposition_for_current_tab =
+                              WindowOpenDisposition::CURRENT_TAB);
 
 }  // namespace ui