MacViews: Intercept events for Menus (after AppKit has interpreted keystrokes)

ui/base/test/ui_controls_mac.mm

 // Copyright 2013 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.
 
 #include "ui/base/test/ui_controls.h"
 
 #import <Cocoa/Cocoa.h>
-#include <mach/mach_time.h>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/message_loop/message_loop.h"
 #include "ui/events/keycodes/keyboard_code_conversion_mac.h"
-
+#import "ui/events/test/cocoa_test_event_utils.h"
 
 // Implementation details: We use [NSApplication sendEvent:] instead
 // of [NSApplication postEvent:atStart:] so that the event gets sent
 // immediately.  This lets us run the post-event task right
 // immediately as well.  Unfortunately I cannot subclass NSEvent (it's
 // probably a class cluster) to allow other easy answers.  For
 // example, if I could subclass NSEvent, I could run the Task in it's
 // dealloc routine (which necessarily happens after the event is
 // dispatched).  Unlike Linux, Mac does not have message loop
 // observer/notification.  Unlike windows, I cannot post non-events
@@ skipping 10 matching lines @@
 // processed, we setup a task to watch for the event queue time to time and
 // notify the caller as soon as there is no event in the queue.
 //
 // TODO(suzhe):
 // 1. Investigate why using [NSApplication postEvent:atStart:] for keyboard
 //    events causes BrowserKeyEventsTest.CommandKeyEvents to fail.
 //    See http://crbug.com/49270
 // 2. On OSX 10.6, [NSEvent addLocalMonitorForEventsMatchingMask:handler:] may
 //    be used, so that we don't need to poll the event queue time to time.
 
+using cocoa_test_event_utils::SynthesizeKeyEvent;
+using cocoa_test_event_utils::TimeIntervalSinceSystemStartup;
+
 namespace {
 
 // Stores the current mouse location on the screen. So that we can use it
 // when firing keyboard and mouse click events.
 NSPoint g_mouse_location = { 0, 0 };
 
 bool g_ui_controls_enabled = false;
 
-// From
-// http://stackoverflow.com/questions/1597383/cgeventtimestamp-to-nsdate
-// Which credits Apple sample code for this routine.
-uint64_t UpTimeInNanoseconds(void) {
-  uint64_t time;
-  uint64_t timeNano;
-  static mach_timebase_info_data_t sTimebaseInfo;
-
-  time = mach_absolute_time();
-
-  // Convert to nanoseconds.
-
-  // If this is the first time we've run, get the timebase.
-  // We can use denom == 0 to indicate that sTimebaseInfo is
-  // uninitialised because it makes no sense to have a zero
-  // denominator is a fraction.
-  if (sTimebaseInfo.denom == 0) {
-    (void) mach_timebase_info(&sTimebaseInfo);
-  }
-
-  // This could overflow; for testing needs we probably don't care.
-  timeNano = time * sTimebaseInfo.numer / sTimebaseInfo.denom;
-  return timeNano;
-}
-
-NSTimeInterval TimeIntervalSinceSystemStartup() {
-  return UpTimeInNanoseconds() / 1000000000.0;
-}
-
-// Creates and returns an autoreleased key event.
-NSEvent* SynthesizeKeyEvent(NSWindow* window,
-                            bool keyDown,
-                            ui::KeyboardCode keycode,
-                            NSUInteger flags) {
-  unichar character;
-  unichar shifted_character;
-  int macKeycode = ui::MacKeyCodeForWindowsKeyCode(
-      keycode, flags, &shifted_character, &character);
-
-  if (macKeycode < 0)
-    return nil;
-
-  // Note that, in line with AppKit's documentation (and tracing "real" events),
-  // -[NSEvent charactersIngoringModifiers]" are "the characters generated by
-  // the receiving key event as if no modifier key (except for Shift)".
-  // So |charactersIgnoringModifiers| uses |shifted_character|.
-  NSString* charactersIgnoringModifiers =
-      [[[NSString alloc] initWithCharacters:&shifted_character
-                                     length:1] autorelease];
-  NSString* characters;
-  // The following were determined empirically on OSX 10.9.
-  if (flags & NSControlKeyMask) {
-    // If Ctrl is pressed, Cocoa always puts an empty string into |characters|.
-    characters = [NSString string];
-  } else if (flags & NSCommandKeyMask) {
-    // If Cmd is pressed, Cocoa puts a lowercase character into |characters|,
-    // regardless of Shift. If, however, Alt is also pressed then shift *is*
-    // preserved, but re-mappings for Alt are not implemented. Although we still
-    // need to support Alt for things like Alt+Left/Right which don't care.
-    characters =
-        [[[NSString alloc] initWithCharacters:&character length:1] autorelease];
-  } else {
-    // If just Shift or nothing is pressed, |characters| will match
-    // |charactersIgnoringModifiers|. Alt puts a special character into
-    // |characters| (not |charactersIgnoringModifiers|), but they're not mapped
-    // here.
-    characters = charactersIgnoringModifiers;
-  }
-
-  NSEventType type = (keyDown ? NSKeyDown : NSKeyUp);
-
-  // Modifier keys generate NSFlagsChanged event rather than
-  // NSKeyDown/NSKeyUp events.
-  if (keycode == ui::VKEY_CONTROL || keycode == ui::VKEY_SHIFT ||
-      keycode == ui::VKEY_MENU || keycode == ui::VKEY_COMMAND)
-    type = NSFlagsChanged;
-
-  // For events other than mouse moved, [event locationInWindow] is
-  // UNDEFINED if the event is not NSMouseMoved.  Thus, the (0,0)
-  // location should be fine.
-  NSEvent* event = [NSEvent keyEventWithType:type
-                                    location:NSZeroPoint
-                               modifierFlags:flags
-                                   timestamp:TimeIntervalSinceSystemStartup()
-                                windowNumber:[window windowNumber]
-                                     context:nil
-                                  characters:characters
-                 charactersIgnoringModifiers:charactersIgnoringModifiers
-                                   isARepeat:NO
-                                     keyCode:(unsigned short)macKeycode];
-
-  return event;
-}
-
 // Creates the proper sequence of autoreleased key events for a key down + up.
 void SynthesizeKeyEventsSequence(NSWindow* window,
                                  ui::KeyboardCode keycode,
                                  bool control,
                                  bool shift,
                                  bool alt,
                                  bool command,
                                  std::vector<NSEvent*>* events) {
   NSEvent* event = nil;
   NSUInteger flags = 0;
@@ skipping 268 matching lines @@
 void RunClosureAfterAllPendingUIEvents(const base::Closure& closure) {
   base::MessageLoop::current()->PostTask(
       FROM_HERE, base::Bind(&EventQueueWatcher, closure));
 }
 
 bool IsFullKeyboardAccessEnabled() {
   return [NSApp isFullKeyboardAccessEnabled];
 }
 
 }  // namespace ui_controls