Instant API: tell page whether the browser is capturing key strokes.

chrome/browser/ui/views/omnibox/omnibox_view_win.cc

 // Copyright (c) 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/browser/ui/views/omnibox/omnibox_view_win.h"
 
 #include <algorithm>
 #include <locale>
 #include <string>
 
@@ skipping 16 matching lines @@
 #include "chrome/app/chrome_command_ids.h"
 #include "chrome/browser/autocomplete/autocomplete_input.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/autocomplete/keyword_provider.h"
 #include "chrome/browser/command_updater.h"
 #include "chrome/browser/net/url_fixer_upper.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/omnibox/omnibox_edit_controller.h"
 #include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
+#include "chrome/browser/ui/omnibox/omnibox_types.h"
 #include "chrome/browser/ui/search/search.h"
 #include "chrome/browser/ui/views/location_bar/location_bar_view.h"
 #include "chrome/browser/ui/views/omnibox/omnibox_view_views.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/browser/web_contents.h"
 #include "googleurl/src/url_util.h"
 #include "grit/generated_resources.h"
 #include "net/base/escape.h"
 #include "skia/ext/skia_utils_win.h"
@@ skipping 707 matching lines @@
   //   * The user has just pasted in something that replaced all the text
   //   * The user is trying to compose something in an IME
   CHARRANGE sel;
   GetSel(sel);
   model()->StartAutocomplete(sel.cpMax != sel.cpMin,
                             (sel.cpMax < GetTextLength()) || IsImeComposing());
 }
 
 void OmniboxViewWin::SetFocus() {
   ::SetFocus(m_hWnd);
-  // Restore caret visibility if focused explicitly. We need to do this here
-  // because if we already have invisible focus, the ::SetFocus call above will
-  // short-circuit, preventing us from reaching OmniboxEditModel::OnSetFocus(),
-  // which handles restoring visibility when we didn't previously have focus.
+  // Restore caret visibility if focus is explicitly requested. This is
+  // necessary because if we already have invisible focus, the ::SetFocus()
+  // call above will short-circuit, preventing us from reaching
+  // OmniboxEditModel::OnSetFocus(), which handles restoring visibility when the
+  // omnibox regains focus after losing focus.
   model()->SetCaretVisibility(true);
 }
 
 void OmniboxViewWin::ApplyCaretVisibility() {
   // We hide the caret just before destroying it, since destroying a caret that
   // is in the "solid" phase of its blinking will leave a solid vertical bar.
   // We even hide and destroy the caret if we're going to create it again below.
   // If the caret was already visible on entry to this function, the
   // CreateCaret() call (which first destroys the old caret) might leave a solid
   // vertical bar for the same reason as above.  Unconditionally hiding prevents
@@ skipping 987 matching lines @@
   // First, give other handlers a chance to handle the message to see if we are
   // actually going to activate and gain focus.
   LRESULT result = DefWindowProc(WM_MOUSEACTIVATE,
                                  reinterpret_cast<WPARAM>(window),
                                  MAKELPARAM(hit_test, mouse_message));
   // Check if we're getting focus from a click.  We have to do this here rather
   // than in OnXButtonDown() since in many scenarios OnSetFocus() will be
   // reached before OnXButtonDown(), preventing us from detecting this properly
   // there.  Also in those cases, we need to already know in OnSetFocus() that
   // we should not restore the saved selection.
-  if ((!model()->has_focus() || !model()->is_caret_visible()) &&
+  if ((!model()->has_focus() ||
+       model()->focus_state() == OMNIBOX_FOCUS_INVISIBLE) &&

[Peter Kasting, 2012/12/11 19:20:50]

Nit: Same comment.

[samarth, 2012/12/12 01:11:26]

Done.

       ((mouse_message == WM_LBUTTONDOWN || mouse_message == WM_RBUTTONDOWN)) &&
       (result == MA_ACTIVATE)) {
     if (gaining_focus_) {
       // On Windows 8 in metro mode, we get two WM_MOUSEACTIVATE messages when
       // we click on the omnibox with the mouse.
       DCHECK(win8::IsSingleWindowMetroMode());
       return result;
     }
     gaining_focus_.reset(new ScopedFreeze(this, GetTextObjectModel()));
 
-    // Explicitely set focus visibility in the case of clicking on the omnibox,
-    // which will remove invisible focus if present.
+    // Restore caret visibility whenever the user clicks in the omnibox in a
+    // way that would give it focus.  We must handle this case separately here
+    // because if the omnibox currently has invisible focus, the mouse event
+    // won't trigger either SetFocus() or OmniboxEditModel::OnSetFocus().
     model()->SetCaretVisibility(true);
 
     // NOTE: Despite |mouse_message| being WM_XBUTTONDOWN here, we're not
     // guaranteed to call OnXButtonDown() later!  Specifically, if this is the
     // second click of a double click, we'll reach here but later call
     // OnXButtonDblClk().  Make sure |gaining_focus_| gets reset both places,
     // or we'll have visual glitchiness and then DCHECK failures.
 
     // Don't restore saved selection, it will just screw up our interaction
     // with this edit.
@@ skipping 1004 matching lines @@
   return (rect.left - client_rect.left) + (client_rect.right - rect.right);
 }
 
 int OmniboxViewWin::WidthNeededToDisplay(const string16& text) const {
   // Use font_.GetStringWidth() instead of
   // PosFromChar(location_entry_->GetTextLength()) because PosFromChar() is
   // apparently buggy. In both LTR UI and RTL UI with left-to-right layout,
   // PosFromChar(i) might return 0 when i is greater than 1.
   return font_.GetStringWidth(text) + GetHorizontalMargin();
 }