MacViews: Views accelerators table should match the Cocoa one.

chrome/browser/ui/views/accelerator_table.cc

Index: chrome/browser/ui/views/accelerator_table.cc
diff --git a/chrome/browser/ui/views/accelerator_table.cc b/chrome/browser/ui/views/accelerator_table.cc
index f674d5a8f92abd8abc18a0c07fd5333fe0b799c3..a86abc3e58d9c6a120976a325a50839d24d0594a 100644
--- a/chrome/browser/ui/views/accelerator_table.cc
+++ b/chrome/browser/ui/views/accelerator_table.cc
@@ -6,6 +6,11 @@
 
 #include <stddef.h>
 
+#include <algorithm>
+#include <initializer_list>
+#include <set>
+#include <tuple>
+
 #include "base/macros.h"
 #include "build/build_config.h"
 #include "chrome/app/chrome_command_ids.h"
@@ -22,7 +27,6 @@ namespace {
 // For many commands, the Mac equivalent uses Cmd instead of Ctrl. We only need
 // to list the ones that do not have a key equivalent in the main menu, i.e.
 // only the ones in global_keyboard_shortcuts_mac.mm.
-// TODO(jackhou): If-def out the accelerators that should not be on Mac.
 #if defined(OS_MACOSX)
 const ui::EventFlags kPlatformModifier = ui::EF_COMMAND_DOWN;
 #else
@@ -36,16 +40,16 @@ const ui::EventFlags kPlatformModifier = ui::EF_CONTROL_DOWN;
 const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_LEFT, ui::EF_ALT_DOWN, IDC_BACK },
   { ui::VKEY_BACK, ui::EF_NONE, IDC_BACKSPACE_BACK },
-  { ui::VKEY_D, ui::EF_CONTROL_DOWN, IDC_BOOKMARK_PAGE },
-  { ui::VKEY_D, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
+  { ui::VKEY_D, kPlatformModifier, IDC_BOOKMARK_PAGE },
+  { ui::VKEY_D, ui::EF_SHIFT_DOWN | kPlatformModifier,
     IDC_BOOKMARK_ALL_TABS },
-  { ui::VKEY_W, ui::EF_CONTROL_DOWN, IDC_CLOSE_TAB },
-  { ui::VKEY_W, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_CLOSE_WINDOW },
-  { ui::VKEY_F, ui::EF_CONTROL_DOWN, IDC_FIND },
-  { ui::VKEY_G, ui::EF_CONTROL_DOWN, IDC_FIND_NEXT },
-  { ui::VKEY_G, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_FIND_PREVIOUS },
+  { ui::VKEY_W, kPlatformModifier, IDC_CLOSE_TAB },
+  { ui::VKEY_W, ui::EF_SHIFT_DOWN | kPlatformModifier, IDC_CLOSE_WINDOW },
+  { ui::VKEY_F, kPlatformModifier, IDC_FIND },
+  { ui::VKEY_G, kPlatformModifier, IDC_FIND_NEXT },
+  { ui::VKEY_G, ui::EF_SHIFT_DOWN | kPlatformModifier, IDC_FIND_PREVIOUS },
   { ui::VKEY_D, ui::EF_ALT_DOWN, IDC_FOCUS_LOCATION },
-  { ui::VKEY_L, ui::EF_CONTROL_DOWN, IDC_FOCUS_LOCATION },
+  { ui::VKEY_L, kPlatformModifier, IDC_FOCUS_LOCATION },
   { ui::VKEY_K, ui::EF_CONTROL_DOWN, IDC_FOCUS_SEARCH },
   { ui::VKEY_E, ui::EF_CONTROL_DOWN, IDC_FOCUS_SEARCH },
   { ui::VKEY_T, ui::EF_SHIFT_DOWN | ui::EF_ALT_DOWN, IDC_FOCUS_TOOLBAR },
@@ -59,16 +63,16 @@ const AcceleratorMapping kAcceleratorMap[] = {
     IDC_DEV_TOOLS_CONSOLE },
   { ui::VKEY_C, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
     IDC_DEV_TOOLS_INSPECT },
-  { ui::VKEY_O, ui::EF_CONTROL_DOWN, IDC_OPEN_FILE },
-  { ui::VKEY_P, ui::EF_CONTROL_DOWN, IDC_PRINT},
+  { ui::VKEY_O, kPlatformModifier, IDC_OPEN_FILE },
+  { ui::VKEY_P, kPlatformModifier, IDC_PRINT },
 #if defined(ENABLE_BASIC_PRINTING)
   { ui::VKEY_P, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_BASIC_PRINT},
 #endif  // ENABLE_BASIC_PRINTING
-  { ui::VKEY_R, ui::EF_CONTROL_DOWN, IDC_RELOAD },
-  { ui::VKEY_R, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
+  { ui::VKEY_R, kPlatformModifier, IDC_RELOAD },
+  { ui::VKEY_R, ui::EF_SHIFT_DOWN | kPlatformModifier,
     IDC_RELOAD_BYPASSING_CACHE },
   { ui::VKEY_HOME, ui::EF_ALT_DOWN, IDC_HOME },
-  { ui::VKEY_S, ui::EF_CONTROL_DOWN, IDC_SAVE_PAGE },
+  { ui::VKEY_S, kPlatformModifier, IDC_SAVE_PAGE },
   { ui::VKEY_9, kPlatformModifier, IDC_SELECT_LAST_TAB },
   { ui::VKEY_NUMPAD9, kPlatformModifier, IDC_SELECT_LAST_TAB },
 #if defined(OS_LINUX) && !defined(OS_CHROMEOS)
@@ -118,7 +122,7 @@ const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_NUMPAD8, ui::EF_ALT_DOWN, IDC_SELECT_TAB_7 },
   { ui::VKEY_BROWSER_FAVORITES, ui::EF_NONE, IDC_SHOW_BOOKMARK_BAR },
 #endif
-  { ui::VKEY_B, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
+  { ui::VKEY_B, ui::EF_SHIFT_DOWN | kPlatformModifier,
     IDC_SHOW_BOOKMARK_BAR },
   { ui::VKEY_O, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
     IDC_SHOW_BOOKMARK_MANAGER },
@@ -128,12 +132,14 @@ const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_E, ui::EF_ALT_DOWN, IDC_SHOW_APP_MENU},
   { ui::VKEY_ESCAPE, ui::EF_NONE, IDC_STOP },
   { ui::VKEY_U, ui::EF_CONTROL_DOWN, IDC_VIEW_SOURCE },
-  { ui::VKEY_OEM_MINUS, ui::EF_CONTROL_DOWN, IDC_ZOOM_MINUS },
-  { ui::VKEY_SUBTRACT, ui::EF_CONTROL_DOWN, IDC_ZOOM_MINUS },
-  { ui::VKEY_0, ui::EF_CONTROL_DOWN, IDC_ZOOM_NORMAL },
-  { ui::VKEY_NUMPAD0, ui::EF_CONTROL_DOWN, IDC_ZOOM_NORMAL },
-  { ui::VKEY_OEM_PLUS, ui::EF_CONTROL_DOWN, IDC_ZOOM_PLUS },
-  { ui::VKEY_ADD, ui::EF_CONTROL_DOWN, IDC_ZOOM_PLUS },
+  { ui::VKEY_OEM_MINUS, kPlatformModifier, IDC_ZOOM_MINUS },
+  { ui::VKEY_SUBTRACT, kPlatformModifier, IDC_ZOOM_MINUS },
+  { ui::VKEY_0, kPlatformModifier, IDC_ZOOM_NORMAL },
+  { ui::VKEY_NUMPAD0, kPlatformModifier, IDC_ZOOM_NORMAL },
+  { ui::VKEY_OEM_PLUS, kPlatformModifier, IDC_ZOOM_PLUS },
+  { ui::VKEY_ADD, kPlatformModifier, IDC_ZOOM_PLUS },
+
+#if !defined(OS_MACOSX)  // Function keys aren't mapped on Mac.
   { ui::VKEY_F1, ui::EF_NONE, IDC_HELP_PAGE_VIA_KEYBOARD },
   { ui::VKEY_F3, ui::EF_NONE, IDC_FIND_NEXT },
   { ui::VKEY_F3, ui::EF_SHIFT_DOWN, IDC_FIND_PREVIOUS },
@@ -146,6 +152,7 @@ const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_F6, ui::EF_SHIFT_DOWN, IDC_FOCUS_PREVIOUS_PANE },
   { ui::VKEY_F10, ui::EF_NONE, IDC_FOCUS_MENU_BAR },
   { ui::VKEY_F11, ui::EF_NONE, IDC_FULLSCREEN },
+#endif  // !OS_MACOSX
 
   // Platform-specific key maps.
 #if defined(OS_LINUX)
@@ -168,7 +175,7 @@ const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_BROWSER_STOP, ui::EF_NONE, IDC_STOP },
   { ui::VKEY_P, ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN,
     IDC_TOUCH_HUD_PROJECTION_TOGGLE },
-#else  // OS_CHROMEOS
+#else
   { ui::VKEY_ESCAPE, ui::EF_SHIFT_DOWN, IDC_TASK_MANAGER },
   { ui::VKEY_DELETE, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
     IDC_CLEAR_BROWSING_DATA },
@@ -178,7 +185,7 @@ const AcceleratorMapping kAcceleratorMap[] = {
   // On Windows, all VKEY_BROWSER_* keys except VKEY_BROWSER_SEARCH are handled
   // via WM_APPCOMMAND.
   { ui::VKEY_BROWSER_SEARCH, ui::EF_NONE, IDC_FOCUS_SEARCH },
-  { ui::VKEY_M, ui::EF_SHIFT_DOWN | kPlatformModifier, IDC_SHOW_AVATAR_MENU},
+  { ui::VKEY_M, ui::EF_SHIFT_DOWN | kPlatformModifier, IDC_SHOW_AVATAR_MENU },
   // On Chrome OS, these keys are assigned to change UI scale.
   { ui::VKEY_OEM_PLUS, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_ZOOM_PLUS },
   { ui::VKEY_OEM_MINUS, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
@@ -189,14 +196,58 @@ const AcceleratorMapping kAcceleratorMap[] = {
   { ui::VKEY_I, ui::EF_SHIFT_DOWN | ui::EF_ALT_DOWN, IDC_FEEDBACK },
 #endif
   { ui::VKEY_Q, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_EXIT },
-  { ui::VKEY_N, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN,
+  { ui::VKEY_N, ui::EF_SHIFT_DOWN | kPlatformModifier,
     IDC_NEW_INCOGNITO_WINDOW },
-  { ui::VKEY_T, ui::EF_CONTROL_DOWN, IDC_NEW_TAB },
-  { ui::VKEY_N, ui::EF_CONTROL_DOWN, IDC_NEW_WINDOW },
-  { ui::VKEY_T, ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN, IDC_RESTORE_TAB },
-#endif
+  { ui::VKEY_T, kPlatformModifier, IDC_NEW_TAB },
+  { ui::VKEY_N, kPlatformModifier, IDC_NEW_WINDOW },
+  { ui::VKEY_T, ui::EF_SHIFT_DOWN | kPlatformModifier, IDC_RESTORE_TAB },
+#endif  // !OS_CHROMEOS
+
+#if defined(OS_MACOSX)
+  // VKEY_OEM_4 is Left Brace '[{' key.
+  { ui::VKEY_OEM_4, ui::EF_COMMAND_DOWN, IDC_BACK },
+  { ui::VKEY_LEFT, ui::EF_COMMAND_DOWN, IDC_BACK },
+#if defined(ENABLE_BASIC_PRINTING)
+  { ui::VKEY_P, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_BASIC_PRINT },
+#endif  // ENABLE_BASIC_PRINTING
+  { ui::VKEY_BACK, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN,
+    IDC_CLEAR_BROWSING_DATA },
+  { ui::VKEY_V, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN,
+    IDC_CONTENT_CONTEXT_PASTE_AND_MATCH_STYLE },
+  { ui::VKEY_Z, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN,
+    IDC_CONTENT_CONTEXT_REDO },
+  { ui::VKEY_A, ui::EF_COMMAND_DOWN, IDC_CONTENT_CONTEXT_SELECTALL },
+  { ui::VKEY_Z, ui::EF_COMMAND_DOWN, IDC_CONTENT_CONTEXT_UNDO },
+  { ui::VKEY_I, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_DEV_TOOLS },
+  { ui::VKEY_J, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_DEV_TOOLS_CONSOLE },
+  { ui::VKEY_C, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN, IDC_DEV_TOOLS_INSPECT},
+  { ui::VKEY_I, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN,
+    IDC_EMAIL_PAGE_LOCATION },
+  { ui::VKEY_Q, ui::EF_COMMAND_DOWN, IDC_EXIT },
+  { ui::VKEY_F, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_FOCUS_SEARCH },
+  // VKEY_OEM_6 is Right Brace ']}' key.
+  { ui::VKEY_OEM_6, ui::EF_COMMAND_DOWN, IDC_FORWARD },
+  { ui::VKEY_RIGHT, ui::EF_COMMAND_DOWN, IDC_FORWARD },
+  { ui::VKEY_F, ui::EF_COMMAND_DOWN | ui::EF_CONTROL_DOWN, IDC_FULLSCREEN },
+  // VKEY_OEM_2 is Slash '/?' key.
+  { ui::VKEY_OEM_2, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN,
+    IDC_HELP_PAGE_VIA_MENU },
+  { ui::VKEY_H, ui::EF_COMMAND_DOWN, IDC_HIDE_APP },
+  { ui::VKEY_H, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN, IDC_HOME },
+  { ui::VKEY_M, ui::EF_COMMAND_DOWN, IDC_MINIMIZE_WINDOW },
+  { ui::VKEY_RIGHT, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN,
+    IDC_SELECT_NEXT_TAB },
+  { ui::VKEY_LEFT, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN,
+    IDC_SELECT_PREVIOUS_TAB },
+  { ui::VKEY_B, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN,
+    IDC_SHOW_BOOKMARK_MANAGER },
+  { ui::VKEY_J, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN, IDC_SHOW_DOWNLOADS },
+  { ui::VKEY_L, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_SHOW_DOWNLOADS },
+  { ui::VKEY_Y, ui::EF_COMMAND_DOWN, IDC_SHOW_HISTORY },
+  { ui::VKEY_OEM_PERIOD, ui::EF_COMMAND_DOWN, IDC_STOP },
+  { ui::VKEY_U, ui::EF_COMMAND_DOWN | ui::EF_ALT_DOWN, IDC_VIEW_SOURCE },
+#endif  // OS_MACOSX
 };
-const size_t kAcceleratorMapLength = arraysize(kAcceleratorMap);
 
 const int kRepeatableCommandIds[] = {
   IDC_FIND_NEXT,
@@ -238,9 +289,48 @@ const size_t kChromeCmdId2AshActionIdLength =
 
 } // namespace
 
+std::vector<AcceleratorMapping> GetUnfilteredAcceleratorListForTesting() {
+  return std::vector<AcceleratorMapping>(std::begin(kAcceleratorMap),
+                                         std::end(kAcceleratorMap));
+}
+
 std::vector<AcceleratorMapping> GetAcceleratorList() {
-  return std::vector<AcceleratorMapping>(
-      kAcceleratorMap, kAcceleratorMap + kAcceleratorMapLength);
+  static bool is_accelerator_list_initialized = false;
+  CR_DEFINE_STATIC_LOCAL(std::vector<AcceleratorMapping>, accelerators,
+                         (GetUnfilteredAcceleratorListForTesting()));

[sky, 2016/11/08 18:34:10]

Having a non-testing function call a for-testing function is confusing. How
about create a GetAllAcceleratorMappings in the anonymous namespace that both
call?

[themblsha, 2016/11/09 14:54:02]

Good idea, done.

+  if (is_accelerator_list_initialized)
+    return accelerators;
+
+  is_accelerator_list_initialized = true;
+#if defined(OS_MACOSX)
+  // Control modifier is rarely used on Mac, so we allow it only in several
+  // whitelisted cases.
+  const std::set<int> kControlWhitelist = {

[sky, 2016/11/08 18:34:09]

optional: the style guide says you can optionally name non-POD types with kFoo
style, but generally we don't do this. Please use control_whitelist.

[themblsha, 2016/11/09 14:54:02]

pkasting originally asked me to use the kCamelCase name. Reverted.

[Peter Kasting, 2016/11/09 18:39:12]

Scott, can you point to the relevant style guide text on this?  I found
http://google.github.io/styleguide/cppguide.html#Constant_Names , but that
doesn't seem to distinguish between POD and non-POD types.  Nor does
https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md...
.

I'm not aware that we normally make any distinction.

[sky, 2016/11/09 18:42:43]

I said the style guide allows it. My comment was more that generally I haven't
seem the kFoo style for statics like this. That's why I prefixed the comment
with 'optional'.

[Peter Kasting, 2016/11/09 18:52:56]

OK.

I don't know that we commonly have const non-PODs, so I'm not sure whether there
is any consistent pattern.  I thought the kFoo name made it clearer that this is
a compile-time constant, since that's how we do it for other types, but I don't
feel strongly.

+      IDC_SELECT_NEXT_TAB, IDC_SELECT_PREVIOUS_TAB, IDC_FULLSCREEN,
+  };
+
+  auto remove_accelerators = [&kControlWhitelist](const AcceleratorMapping& m) {

[sky, 2016/11/08 18:34:10]

It seems like you're trying to allow for accelerators to be defined that don't
work on the mac, but pruned here. Is that right? If so, I think all this should
be a DCHECK and the table should be fixed for mac. To do otherwise may result in
odd behavior when accelerators are removed that one wouldn't expect to be
removed.

[themblsha, 2016/11/09 14:54:02]

Originally I was doing this, but it resulted in a lot of #ifdefs, and tapted
wanted a cleaner approach.

Here's how it would look with additional #ifdefs (I've included a diff as well
as complete table):
https://gist.github.com/mblsha/0cf9de8da549e23a3ebd01cf56dbebe5

Do you think that the readability tradeoff is worth it for maintainability?

[Peter Kasting, 2016/11/09 18:39:12]

Personally, I much prefer the current solution if the alternative doesn't
actually git rid of this lambda but merely simplifies it.  I think Scott was
hoping to kill this lambda and erase(remove_if()) call entirely; is that
possible?

[sky, 2016/11/09 18:42:43]

That's right. I'm hoping removing of accelerators can go away completely. I'm ok
with a NDEBUG block that loops over ensuring a bad accelerator doesn't exist.

[themblsha, 2016/11/10 14:18:05]

Ah! Okay, I pruned the accelerator list some more, and removed the checks.
They're still present in the unit_test.

Now it's probably better, but it's a little bit easier to get lost in the
#ifdefs.

+    // Alt by itself (or with just shift) is never used on Mac since it's used
+    // to generate non-ASCII characters. Such commands are given Mac-specific
+    // bindings as well, so remove the mappings with Alt, but not those with
+    // Command or Control.
+    constexpr int kNonShiftMask =
+        ui::EF_COMMAND_DOWN | ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN;
+    if ((m.modifiers & kNonShiftMask) == ui::EF_ALT_DOWN)
+      return true;
+
+    // If command uses Control modifier it has to be whitelisted.
+    if ((m.modifiers & ui::EF_CONTROL_DOWN) != 0 &&
+        kControlWhitelist.count(m.command_id) == 0)
+      return true;
+
+    return false;
+  };
+  accelerators.erase(std::remove_if(accelerators.begin(), accelerators.end(),
+                                    remove_accelerators),
+                     accelerators.end());
+#endif  // OS_MACOSX
+  return accelerators;
 }
 
 bool GetAshAcceleratorForCommandId(int command_id,
@@ -268,13 +358,13 @@ bool GetStandardAcceleratorForCommandId(int command_id,
   // anywhere else.
   switch (command_id) {
     case IDC_CUT:
-      *accelerator = ui::Accelerator(ui::VKEY_X, ui::EF_CONTROL_DOWN);
+      *accelerator = ui::Accelerator(ui::VKEY_X, kPlatformModifier);
       return true;
     case IDC_COPY:
-      *accelerator = ui::Accelerator(ui::VKEY_C, ui::EF_CONTROL_DOWN);
+      *accelerator = ui::Accelerator(ui::VKEY_C, kPlatformModifier);
       return true;
     case IDC_PASTE:
-      *accelerator = ui::Accelerator(ui::VKEY_V, ui::EF_CONTROL_DOWN);
+      *accelerator = ui::Accelerator(ui::VKEY_V, kPlatformModifier);
       return true;
   }
   return false;