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_key_capture_enabled_(false),
+      omnibox_focus_state_(OMNIBOX_FOCUS_NONE),
       display_instant_results_(false),
       omnibox_font_size_(0),
       autocomplete_results_cache_(kMaxInstantAutocompleteResultItemCacheSize),
       most_visited_items_cache_(kMaxInstantMostVisitedItemCacheSize) {
 }
 
 SearchBox::~SearchBox() {
 }
 
 void SearchBox::SetSuggestions(
@@ skipping 72 matching lines @@
 void SearchBox::HideBars() {
   DVLOG(1) << render_view() << " HideBars";
   render_view()->Send(new ChromeViewHostMsg_SearchBoxHideBars(
       render_view()->GetRoutingID(), render_view()->GetPageId()));
 }
 
 int SearchBox::GetStartMargin() const {
   return static_cast<int>(start_margin_ / GetZoom());
 }
 
+bool SearchBox::is_focused() const {
+  return omnibox_focus_state_ == OMNIBOX_FOCUS_VISIBLE;
+}
+
+bool SearchBox::is_key_capture_enabled() const {
+  return omnibox_focus_state_ == OMNIBOX_FOCUS_INVISIBLE;
+}
+
 gfx::Rect SearchBox::GetPopupBounds() const {
   double zoom = GetZoom();
   return gfx::Rect(static_cast<int>(popup_bounds_.x() / zoom),
                    static_cast<int>(popup_bounds_.y() / zoom),
                    static_cast<int>(popup_bounds_.width() / zoom),
                    static_cast<int>(popup_bounds_.height() / zoom));
 }
 
 void SearchBox::GetAutocompleteResults(
     std::vector<InstantAutocompleteResultIDPair>* results) const {
@@ skipping 176 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(
-        render_view()->GetWebView()->mainFrame());
+void SearchBox::OnKeyCaptureChange(OmniboxFocusState new_focus_state,
+                                   OmniboxFocusChangeReason reason) {
+  if (new_focus_state != omnibox_focus_state_) {

[samarth, 2013/05/13 20:56:53]

Sorry, this is all a little confusing so let me give a bit more background. The
invisible focus craziness is a way to have a searchbox on the NTP such that if
you click on it and start typing, your keystrokes appear in the omnibox. We
solve this by creating a dummy searchbox that's not really an input field and
when the user clicks on it, the omnibox is actually focused but without a
blinking cursor.  (This is only way we've been able to implement it that won't
break IMEs.)

However, we don't want to expose the precise implementation of this to the API,
which is why it's referred to as "capturing key strokes" rather than talking
about invisible focus. So, in the chrome implementation today, we have 3 states
(not focused, visible focus, invisible focus). But from the point of view of the
API, there are 2 bools (iskeycaptureenabled and isfocused).

So, with that in mind, I think it makes the most sense to maintain 2bools in
this class corresponding to the 2 api bools. Then in this function, for each of
those, we can convert the OmniboxFocusState to the correct new value, compare to
the old value and send an update to the page if the value changed.

(The only other wrinkle with all of this if state goes from INVISIBLE -> VISIBLE
for reason TYPING, we don't consider iscapturingkeystrokes to have changed. See
comments in InstantController::OmniboxFocusChanged for why that is.)

[Donn Denman, 2013/05/13 23:44:50]

Thanks for explaining this.  Done.

+    OmniboxFocusState previous_focus_state = omnibox_focus_state_;
+    omnibox_focus_state_ = new_focus_state;
+    if (render_view()->GetWebView() &&
+        render_view()->GetWebView()->mainFrame()) {
+      DVLOG(1) << render_view() << " OnKeyCaptureChange";
+      extensions_v8::SearchBoxExtension::DispatchKeyCaptureChange(
+          render_view()->GetWebView()->mainFrame());
+      if (omnibox_focus_state_ == OMNIBOX_FOCUS_VISIBLE ||
+          previous_focus_state == OMNIBOX_FOCUS_VISIBLE) {
+        // Focus moved into, or out of, the real omnibox.
+        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_))
     return;
@@ skipping 21 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_key_capture_enabled_ = false;
+  omnibox_focus_state_ = OMNIBOX_FOCUS_NONE;
   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) {
   query_ = query;
@@ skipping 20 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);
 }