Add onfocuschange to the Extended Search API, with associated isFocused attribute.

chrome/renderer/searchbox/searchbox.cc

 // Copyright 2012 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/renderer/searchbox/searchbox.h"
 
 #include "base/string_number_conversions.h"
 #include "base/utf_string_conversions.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/omnibox_focus_state.h"
@@ skipping 46 matching lines @@
 }  // namespace
 
 SearchBox::SearchBox(content::RenderView* render_view)
     : content::RenderViewObserver(render_view),
       content::RenderViewObserverTracker<SearchBox>(render_view),
       verbatim_(false),
       query_is_restricted_(false),
       selection_start_(0),
       selection_end_(0),
       start_margin_(0),
+      is_focused_(false),
       is_key_capture_enabled_(false),
       display_instant_results_(false),
       omnibox_font_size_(0),
       autocomplete_results_cache_(kMaxInstantAutocompleteResultItemCacheSize),
       most_visited_items_cache_(kMaxInstantMostVisitedItemCacheSize) {
 }
 
 SearchBox::~SearchBox() {
 }
 
@@ skipping 117 matching lines @@
                         OnDetermineIfPageSupportsInstant)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxAutocompleteResults,
                         OnAutocompleteResults)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxUpOrDownKeyPressed,
                         OnUpOrDownKeyPressed)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxEscKeyPressed, OnEscKeyPressed)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxCancelSelection,
                         OnCancelSelection)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxSetDisplayInstantResults,
                         OnSetDisplayInstantResults)
-    IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxKeyCaptureChanged,
-                        OnKeyCaptureChange)
+    IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxFocusChanged,

[samarth, 2013/05/22 04:40:56]

nit: fits on one line?

[Donn Denman, 2013/05/22 17:37:36]

Done.

+                        OnFocusChanged)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxThemeChanged,
                         OnThemeChanged)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxFontInformation,
                         OnFontInformationReceived)
     IPC_MESSAGE_HANDLER(ChromeViewMsg_SearchBoxMostVisitedItemsChanged,
                         OnMostVisitedChanged)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
@@ skipping 130 matching lines @@
   SetQuery(query, verbatim);
   selection_start_ = selection_start;
   selection_end_ = selection_end;
   if (render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
     DVLOG(1) << render_view() << " OnKeyPress ESC";
     extensions_v8::SearchBoxExtension::DispatchEscKeyPress(
         render_view()->GetWebView()->mainFrame());
   }
 }
 
-void SearchBox::OnKeyCaptureChange(bool is_key_capture_enabled) {
-  if (is_key_capture_enabled != is_key_capture_enabled_ &&
-      render_view()->GetWebView() && render_view()->GetWebView()->mainFrame()) {
-    is_key_capture_enabled_ = is_key_capture_enabled;
-    DVLOG(1) << render_view() << " OnKeyCaptureChange";
-    extensions_v8::SearchBoxExtension::DispatchKeyCaptureChange(
+void SearchBox::OnFocusChanged(OmniboxFocusState new_focus_state,
+                               OmniboxFocusChangeReason reason) {
+  bool key_capture_enabled = new_focus_state == OMNIBOX_FOCUS_INVISIBLE;
+  if (key_capture_enabled != is_key_capture_enabled_) {
+    is_key_capture_enabled_ = key_capture_enabled;

[samarth, 2013/05/22 04:40:56]

Put this inside the if below, or otherwise the state visible to the page will
change without a corresponding onkeycapturechange event.

[Donn Denman, 2013/05/22 17:37:36]

Done.

[Donn Denman, 2013/05/22 17:37:36]

I was wondering about this (and should have put in a TODO to make sure you
caught it)!  This means that when typing implicitly changes the focus, the
capture change won't be visible to a script polling the isKeyCaptureEnabled
property, which didn't seem right to me.  But if that's the way it's supposed to
work then that's certainly correct.  I tested this as best I could with the
change and it all seems fine, so in practice I guess the problem I was worried
about never happens.  Great catch!

Done.

+    // Tell the page if the key capture mode changed unless the focus state
+    // changed because of TYPING. This is because in that case, the browser
+    // hasn't really stopped capturing key strokes.
+    //
+    // (More practically, if we don't do this check, the page would receive
+    // onkeycapturechange before the corresponding onchange, and the page would
+    // have no way of telling whether the keycapturechange happened because of
+    // some actual user action or just because they started typing.)
+    if (reason != OMNIBOX_FOCUS_CHANGE_TYPING &&
+        render_view()->GetWebView() &&
+        render_view()->GetWebView()->mainFrame()) {
+      DVLOG(1) << render_view() << " OnKeyCaptureChange";
+      extensions_v8::SearchBoxExtension::DispatchKeyCaptureChange(
+          render_view()->GetWebView()->mainFrame());
+    }
+  }
+  bool is_focused = new_focus_state == OMNIBOX_FOCUS_VISIBLE;
+  if (is_focused != is_focused_) {
+    is_focused_ = is_focused;
+    DVLOG(1) << render_view() << " OnFocusChange";
+    extensions_v8::SearchBoxExtension::DispatchFocusChange(
         render_view()->GetWebView()->mainFrame());
   }
 }
 
 void SearchBox::OnSetDisplayInstantResults(bool display_instant_results) {
   display_instant_results_ = display_instant_results;
 }
 
 void SearchBox::OnThemeChanged(const ThemeBackgroundInfo& theme_info) {
   if (IsThemeInfoEqual(theme_info, theme_info_))
@@ skipping 22 matching lines @@
 }
 
 void SearchBox::Reset() {
   query_.clear();
   verbatim_ = false;
   query_is_restricted_ = false;
   selection_start_ = 0;
   selection_end_ = 0;
   popup_bounds_ = gfx::Rect();
   start_margin_ = 0;
+  is_focused_ = false;
   is_key_capture_enabled_ = false;
   theme_info_ = ThemeBackgroundInfo();
   // Don't reset display_instant_results_ to prevent clearing it on committed
   // results pages in extended mode. Otherwise resetting it is a no-op because
   // a new loader is created when it changes; see crbug.com/164662.
   // Also don't reset omnibox_font_ or omnibox_font_size_ since it never
   // changes.
 }
 
 void SearchBox::SetQuery(const string16& query, bool verbatim) {
@@ skipping 21 matching lines @@
     std::vector<InstantMostVisitedItemIDPair>* items) const {
   return most_visited_items_cache_.GetCurrentItems(items);
 }
 
 bool SearchBox::GetMostVisitedItemWithID(
     InstantRestrictedID most_visited_item_id,
     InstantMostVisitedItem* item) const {
   return most_visited_items_cache_.GetItemWithRestrictedID(most_visited_item_id,
                                                            item);
 }