MacViews: Handle Tab properly

ui/views/cocoa/bridged_content_view.mm

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #import "ui/views/cocoa/bridged_content_view.h"
 
 #include "base/logging.h"
 #import "base/mac/scoped_nsobject.h"
 #include "base/strings/sys_string_conversions.h"
 #include "ui/base/ime/text_input_client.h"
@@ skipping 23 matching lines @@
       ? [source_window convertBaseToScreen:point]
       : point;
 
   NSPoint point_in_window = [target_window convertScreenToBase:point_in_screen];
   NSRect content_rect =
       [target_window contentRectForFrameRect:[target_window frame]];
   return gfx::Point(point_in_window.x,
                     NSHeight(content_rect) - point_in_window.y);
 }
 
+// Checks if there's an active MenuController during key event dispatch. If
+// there is one, it gets preference, and it will likely swallow the event.
+bool DispatchEventToMenu(views::Widget* widget, ui::KeyboardCode key_code) {
+  MenuController* menuController = MenuController::GetActiveInstance();
+  if (menuController && menuController->owner() == widget) {
+    if (menuController->OnWillDispatchKeyEvent(0, key_code) ==
+        ui::POST_DISPATCH_NONE)
+      return true;
+  }
+  return false;
 }
 
+}  // namespace
+
 @interface BridgedContentView ()
 
 // Translates the location of |theEvent| to toolkit-views coordinates and passes
 // the event to NativeWidgetMac for handling.
 - (void)handleMouseEvent:(NSEvent*)theEvent;
 
+// Translates keycodes and modifiers on |theEvent| to ui::KeyEvents and passes
+// the event to the InputMethod for dispatch.
+- (void)handleKeyEvent:(NSEvent*)theEvent;
+
 // Handles an NSResponder Action Message by mapping it to a corresponding text
 // editing command from ui_strings.grd and, when not being sent to a
 // TextInputClient, the keyCode that toolkit-views expects internally.
 // For example, moveToLeftEndOfLine: would pass ui::VKEY_HOME in non-RTL locales
 // even though the Home key on Mac defaults to moveToBeginningOfDocument:.
 // This approach also allows action messages a user
 // may have remapped in ~/Library/KeyBindings/DefaultKeyBinding.dict to be
 // catered for.
 // Note: default key bindings in Mac can be read from StandardKeyBinding.dict
 // which lives in /System/Library/Frameworks/AppKit.framework/Resources. Do
@@ skipping 71 matching lines @@
 // BridgedContentView private implementation.
 
 - (void)handleMouseEvent:(NSEvent*)theEvent {
   if (!hostedView_)
     return;
 
   ui::MouseEvent event(theEvent);
   hostedView_->GetWidget()->OnMouseEvent(&event);
 }
 
+- (void)handleKeyEvent:(NSEvent*)theEvent {
+  if (!hostedView_)
+    return;
+
+  DCHECK(theEvent);
+  ui::KeyEvent event(theEvent);
+  if (DispatchEventToMenu(hostedView_->GetWidget(), event.key_code()))
+    return;
+
+  hostedView_->GetWidget()->GetInputMethod()->DispatchKeyEvent(event);
+}
+
 - (void)handleAction:(int)commandId
              keyCode:(ui::KeyboardCode)keyCode
              domCode:(ui::DomCode)domCode
           eventFlags:(int)eventFlags {
   if (!hostedView_)
     return;
 
-  // If there's an active MenuController it gets preference, and it will likely
-  // swallow the event.
-  MenuController* menuController = MenuController::GetActiveInstance();
-  if (menuController && menuController->owner() == hostedView_->GetWidget()) {
-    if (menuController->OnWillDispatchKeyEvent(0, keyCode) ==
-        ui::POST_DISPATCH_NONE)
-      return;
-  }
+  if (DispatchEventToMenu(hostedView_->GetWidget(), keyCode))
+    return;
 
   // If there's an active TextInputClient, schedule the editing command to be
   // performed.
   if (commandId && textInputClient_ &&
       textInputClient_->IsEditCommandEnabled(commandId))
     textInputClient_->SetEditCommandForNextKeyEvent(commandId);
 
   // Generate a synthetic event with the keycode toolkit-views expects.
   ui::KeyEvent event(ui::ET_KEY_PRESSED, keyCode, domCode, eventFlags);
   hostedView_->GetWidget()->GetInputMethod()->DispatchKeyEvent(event);
@@ skipping 151 matching lines @@
     return;
 
   ui::MouseWheelEvent event(theEvent);
   hostedView_->GetWidget()->OnMouseEvent(&event);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // NSResponder Action Messages. Keep sorted according NSResponder.h (from the
 // 10.9 SDK). The list should eventually be complete. Anything not defined will
 // beep when interpretKeyEvents: would otherwise call it.
-// TODO(tapted): Make this list complete.
+// TODO(tapted): Make this list complete, except for insert* methods which are
+// dispatched as regular key events in doCommandBySelector:.
 
 // The insertText action message forwards to the TextInputClient unless a menu
-// is active.
+// is active. Note that NSResponder's interpretKeyEvents: implementation doesn't
+// direct insertText: through doCommandBySelector:, so this is still needed to
+// handle the case when inputContext: is nil. When inputContext: returns non-nil
+// text goes directly to insertText:replacementRange:.
 - (void)insertText:(id)text {

[tapted, 2015/02/26 00:46:34]

Ah, my macviews trybot picked up a regression here in interactive_ui_tests (menu
mnemonic stuff) . Turns out insertText: is still needed because NSResponder's
interpretKeyEvents:implementation doesn't direct insertText: through
doCommandBySelector:, so the insertText: method is still needed (as well as
insertText:replacementRange:)

I've restored the old method and added a comment for the unwary.

   [self insertText:text replacementRange:NSMakeRange(NSNotFound, 0)];
 }
 
 // Selection movement and scrolling.
 
 - (void)moveRight:(id)sender {
   [self handleAction:IDS_MOVE_RIGHT
              keyCode:ui::VKEY_RIGHT
              domCode:ui::DomCode::ARROW_RIGHT
           eventFlags:0];
@@ skipping 83 matching lines @@
           eventFlags:ui::EF_SHIFT_DOWN];
 }
 
 - (void)moveToRightEndOfLineAndModifySelection:(id)sender {
   [self handleAction:IDS_MOVE_TO_END_OF_LINE_AND_MODIFY_SELECTION
              keyCode:ui::VKEY_END
              domCode:ui::DomCode::END
           eventFlags:ui::EF_SHIFT_DOWN];
 }
 
-// Insertions and Indentations.
-
-- (void)insertNewline:(id)sender {
-  [self handleAction:0
-             keyCode:ui::VKEY_RETURN
-             domCode:ui::DomCode::ENTER
-          eventFlags:0];
-}
-
 // Deletions.
 
 - (void)deleteForward:(id)sender {
   [self handleAction:IDS_DELETE_FORWARD
              keyCode:ui::VKEY_DELETE
              domCode:ui::DomCode::DEL
           eventFlags:0];
 }
 
 - (void)deleteBackward:(id)sender {
@@ skipping 82 matching lines @@
   return [[[NSAttributedString alloc]
       initWithString:base::SysUTF16ToNSString(substring)] autorelease];
 }
 
 - (NSUInteger)characterIndexForPoint:(NSPoint)aPoint {
   NOTIMPLEMENTED();
   return 0;
 }
 
 - (void)doCommandBySelector:(SEL)selector {
+  // Like the renderer, handle insert action messages as a regular key dispatch.
+  // This ensures, e.g., insertTab correctly changes focus between fields.
+  if (inKeyDown_ && [NSStringFromSelector(selector) hasPrefix:@"insert"]) {
+    [self handleKeyEvent:[NSApp currentEvent]];
+    return;
+  }
+
   if ([self respondsToSelector:selector])
     [self performSelector:selector withObject:nil];
   else
     [[self nextResponder] doCommandBySelector:selector];
 }
 
 - (NSRect)firstRectForCharacterRange:(NSRange)range
                          actualRange:(NSRangePointer)actualRange {
   NOTIMPLEMENTED();
   return NSZeroRect;
@@ skipping 121 matching lines @@
   }
 
   return [super accessibilityAttributeValue:attribute];
 }
 
 - (id)accessibilityHitTest:(NSPoint)point {
   return [hostedView_->GetNativeViewAccessible() accessibilityHitTest:point];
 }
 
 @end