Allow webdriver users to choose between sending the key events when...

chrome/browser/automation/testing_automation_provider.cc

 // Copyright (c) 2011 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 "chrome/browser/automation/testing_automation_provider.h"
 
 #include <map>
 #include <string>
 #include <vector>
 
@@ skipping 4637 matching lines @@
   if (modifiers & automation::kControlKeyMask)
     event.modifiers |= WebKit::WebInputEvent::ControlKey;
   if (modifiers & automation::kAltKeyMask)
     event.modifiers |= WebKit::WebInputEvent::AltKey;
   if (modifiers & automation::kMetaKeyMask)
     event.modifiers |= WebKit::WebInputEvent::MetaKey;
 
   event.isSystemKey = is_system_key;
   event.timeStampSeconds = base::Time::Now().ToDoubleT();
   event.skip_in_browser = true;
-  new InputEventAckNotificationObserver(this, reply_message, event.type);
-  browser->GetSelectedTabContents()->render_view_host()->
-    ForwardKeyboardEvent(event);
+  bool use_native_events = false;
+  // If useNativeEvents is true, this funciton will call
+  // ui_controls::endKeyPress to the native window handle of the browser,
+  // allowing events to be catched higher up; if false it will send an
+  // event directly to webkit.
+  if (args->GetBoolean("useNativeEvents", &use_native_events)
+      && use_native_events) {

[Hironori Bono, 2011/03/04 06:25:17]

nit: This operator should be the end of the previous line.
<http://dev.chromium.org/developers/coding-style>

[timothe faudot, 2011/03/04 06:47:35]

Done.

+    // The ui_controls::SendKeyPress function will generate up and down events
+    // from one keycode for us so we only need to send one event to it.
+    // Filtering is done via the RawKeyDown type because it is the one sent by
+    // the current webdriver implementation of WebElement.SendKeys(...).
+    if (event.type == WebKit::WebInputEvent::RawKeyDown) {
+      BrowserWindow* browser_window = browser->window();
+      if (browser_window == NULL) {

[Hironori Bono, 2011/03/04 06:25:17]

nit: browser_window == NULL -> !browser_window

[timothe faudot, 2011/03/04 06:47:35]

Done.

+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not get the browser window");
+        return;
+      }
+      gfx::NativeWindow window = browser_window->GetNativeHandle();
+      if (window == NULL) {

[Hironori Bono, 2011/03/04 06:25:17]

nit: window == NULL -> !window

[timothe faudot, 2011/03/04 06:47:35]

Done.

+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not get the browser window handle");
+        return;
+      }
+      if (!ui_controls::SendKeyPress(
+              window, static_cast<ui::KeyboardCode>(event.nativeKeyCode),
+              ((event.modifiers & WebKit::WebInputEvent::ControlKey) ==
+              WebKit::WebInputEvent::ControlKey),

[Hironori Bono, 2011/03/04 06:25:17]

nit: I prefer using a local variable as listed in the following snippet.
  bool control = !!(modifiers & automation::kControlKeyMask);
  bool shift = !!(modifiers & automation::kShiftKeyMask);
  bool alt = !!(modifiers & automation::kShiftKeyMask);
  bool meta = !!(modifiers & automation::kShiftKeyMask);
  if (!ui_controls::SendKeyPress(window, event.nativeKeyCode, control,
                                 shift, alt, meta)) {
    ...
  }

[timothe faudot, 2011/03/04 06:47:35]

Done.

+              ((event.modifiers & WebKit::WebInputEvent::ShiftKey) ==
+              WebKit::WebInputEvent::ShiftKey),
+              ((event.modifiers & WebKit::WebInputEvent::AltKey) ==
+              WebKit::WebInputEvent::AltKey),
+              ((event.modifiers & WebKit::WebInputEvent::MetaKey) ==
+              WebKit::WebInputEvent::MetaKey))) {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendError("Could not send the native key event");
+        return;
+      } else {
+        AutomationJSONReply reply(this, reply_message);
+        reply.SendSuccess(NULL);
+      }
+    } else {
+      // Skip this event by acknowledging it without doing nothing.
+      AutomationJSONReply reply(this, reply_message);
+      reply.SendSuccess(NULL);
+    }
+  } else {
+    new InputEventAckNotificationObserver(this, reply_message, event.type);
+    browser->GetSelectedTabContents()->render_view_host()->
+      ForwardKeyboardEvent(event);

[Hironori Bono, 2011/03/04 06:25:17]

nit: I prefer using an early exit as listed in the following snippet.
  if (!args->GetBoolean("useNativeEvents", &use_native_events) ||
      !use_native_events) {
    new InputEventAckNotificationObserver(this, reply_message, event.type);
    browser->GetSelectedTabContents()->render_view_host()->
    ForwardKeyboardEvent(event);
    return;
  }

[timothe faudot, 2011/03/04 06:47:35]

Down, also added an early return statement up.

+  }
 }
 
 // Sample JSON input: { "command": "GetNTPThumbnailMode" }
 // For output, refer to GetNTPThumbnailMode() in
 // chrome/test/pyautolib/pyauto.py.
 void TestingAutomationProvider::GetNTPThumbnailMode(
     Browser* browser,
     DictionaryValue* args,
     IPC::Message* reply_message) {
   const int shown_sections = ShownSectionsHandler::GetShownSections(
@@ skipping 94 matching lines @@
   }
 
   PrefService* prefs = browser->profile()->GetPrefs();
   Section section;
   if (section_name.compare("apps") == 0) {
     section = MENU_APPS;
   } else if (section_name.compare("most_visited") == 0) {
     section = MENU_THUMB;
   } else if (section_name.compare("recently_closed") == 0) {
     section = MENU_RECENT;
-  }
-  else {
+  } else {
     reply.SendError(StringPrintf("Unexpected section name: '%s'",
                                  section_name.c_str()));
     return;
   }
 
   int shown_sections = ShownSectionsHandler::GetShownSections(prefs);
   if (turn_on) {
     // Change the bit for the relevant section in the bitmask to 1.
     shown_sections |= section;
   } else {
@@ skipping 236 matching lines @@
     // If you change this, update Observer for NotificationType::SESSION_END
     // below.
     MessageLoop::current()->PostTask(FROM_HERE,
         NewRunnableMethod(this, &TestingAutomationProvider::OnRemoveProvider));
   }
 }
 
 void TestingAutomationProvider::OnRemoveProvider() {
   AutomationProviderList::GetInstance()->RemoveProvider(this);
 }