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

chrome/browser/ui/omnibox/omnibox_edit_model.h

 // 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.
 
 #ifndef CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 #define CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "base/time.h"
 #include "chrome/browser/autocomplete/autocomplete_controller_delegate.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
+#include "chrome/browser/ui/omnibox/omnibox_types.h"
 #include "chrome/common/metrics/proto/omnibox_event.pb.h"
 #include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 #include "ui/gfx/native_widget_types.h"
 #include "webkit/glue/window_open_disposition.h"
 
 class AutocompleteController;
 class AutocompleteResult;
 struct InstantSuggestion;
 class OmniboxEditController;
 class OmniboxPopupModel;
 class OmniboxView;
 class Profile;
 
 namespace gfx {
 class Image;
 class Rect;
 }
 
 class OmniboxEditModel : public AutocompleteControllerDelegate {
  public:
   struct State {
     State(bool user_input_in_progress,
           const string16& user_text,
           const string16& keyword,
           bool is_keyword_hint,
-          bool is_caret_visible);
+          OmniboxFocusState focus_state);
     ~State();
 
     bool user_input_in_progress;
     const string16 user_text;
     const string16 keyword;
     const bool is_keyword_hint;
-    const bool is_caret_visible;
+    OmniboxFocusState focus_state;
   };
 
   OmniboxEditModel(OmniboxView* view,
                    OmniboxEditController* controller,
                    Profile* profile);
   virtual ~OmniboxEditModel();
 
   AutocompleteController* autocomplete_controller() const {
     return autocomplete_controller_.get();
   }
@@ skipping 125 matching lines @@
   // URL to be autocompleted).
   void AcceptInput(WindowOpenDisposition disposition,
                    bool for_drop);
 
   // Asks the browser to load the item at |index|, with the given properties.
   void OpenMatch(const AutocompleteMatch& match,
                  WindowOpenDisposition disposition,
                  const GURL& alternate_nav_url,
                  size_t index);
 
-  bool has_focus() const { return has_focus_; }
-  bool is_caret_visible() const { return is_caret_visible_; }
+  OmniboxFocusState focus_state() const { return focus_state_; }
+  bool has_focus() const { return focus_state_ != OMNIBOX_FOCUS_NONE; }
+  bool is_caret_visible() const {
+    return focus_state_ == OMNIBOX_FOCUS_VISIBLE;
+  }

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

Normally I would not provide the has_focus() and is_caret_visible() accessors
given the focus_state() accessor, since callers can cheaply implement these
themselves.

I might be tempted to reverse this, though, if there were lots of callers or
adding them ended up saving a number of lines of code.  Do you know what the
impact would be of removing these?

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

I left these in because I thought it made the call-sites much clearer
(is_focus() rather than focus_state() != OMNIBOX_FOCUS_NONE).

But how about I send you a follow up CL that kills these two and replaces them
with the equivalent, and we can decide if that is better or worse? I think it'll
be easier to decide in context of an actual change.

[Peter Kasting, 2012/12/12 01:21:42]

OK.

 
   // Accessors for keyword-related state (see comments on keyword_ and
   // is_keyword_hint_).
   const string16& keyword() const { return keyword_; }
   bool is_keyword_hint() const { return is_keyword_hint_; }
 
   // Accepts the current keyword hint as a keyword. It always returns true for
   // caller convenience.
   bool AcceptKeyword();
 
   // Clears the current keyword.  |visible_text| is the (non-keyword) text
   // currently visible in the edit.
   void ClearKeyword(const string16& visible_text);
 
   // Returns the current autocomplete result.  This logic should in the future
   // live in AutocompleteController but resides here for now.  This method is
   // used by AutomationProvider::AutocompleteEditGetMatches.
   const AutocompleteResult& result() const;
 
   // Called when the view is gaining focus.  |control_down| is whether the
   // control key is down (at the time we're gaining focus).
   void OnSetFocus(bool control_down);
 
   // Sets the visibility of the caret in the omnibox, if it has focus. The
-  // visibility of the caret is reset to visible if any of the following
-  // happens:
-  // - User starts typing in the omnibox
-  // - User clicks in the omnibox
-  // - Omnibox loses and then regains focus
-  // - SetFocus() is explicitly called again
+  // visibility of the caret is reset to visible if either
+  //   - The user starts typing, or
+  //   - We explicitly focus the omnibox again.
+  // The latter case must be handled in three separate places--OnSetFocus(),
+  // OmniboxView::SetFocus(), and the mouse handlers in OmniboxView. See
+  // accompanying comments for why each of these is necessary.
+  //
   // Caret visibility is tracked per-tab and updates automatically upon
   // switching tabs.
   void SetCaretVisibility(bool visible);
 
   // Sent before |OnKillFocus| and before the popup is closed.
   void OnWillKillFocus(gfx::NativeView view_gaining_focus);
 
   // Called when the view is losing focus.  Resets some state.
   void OnKillFocus();
 
@@ skipping 164 matching lines @@
   // current page is the user's home page.
   metrics::OmniboxEventProto::PageClassification ClassifyPage(
       const GURL& gurl) const;
 
   // Sets |match| and |alternate_nav_url| based on classifying |text|.
   // |alternate_nav_url| may be NULL.
   void ClassifyStringForPasteAndGo(const string16& text,
                                    AutocompleteMatch* match,
                                    GURL* alternate_nav_url) const;
 
+  // If focus_state_ does not match |state|, we update it and notify the
+  // InstantController about the change (passing along the |reason| for the
+  // change). If the caret visibility changes, we call ApplyCaretVisibility() on
+  // the view.
+  void SetFocusState(OmniboxFocusState state, OmniboxFocusChangeReason reason);
+
   scoped_ptr<AutocompleteController> autocomplete_controller_;
 
   OmniboxView* view_;
 
   OmniboxPopupModel* popup_;
 
   OmniboxEditController* controller_;
 
-  // Whether the edit has focus.
-  bool has_focus_;
-
-  // Is the caret visible? Only meaningful if has_focus_ is true.
-  bool is_caret_visible_;
+  OmniboxFocusState focus_state_;
 
   // The URL of the currently displayed page.
   string16 permanent_text_;
 
   // This flag is true when the user has modified the contents of the edit, but
   // not yet accepted them.  We use this to determine when we need to save
   // state (on switching tabs) and whether changes to the page URL should be
   // immediately displayed.
   // This flag will be true in a superset of the cases where the popup is open.
   bool user_input_in_progress_;
@@ skipping 88 matching lines @@
   // an exact keyword match.  If this is true then keyword mode will be
   // triggered automatically if the input is "<keyword> <search string>".  We
   // allow this when CreatedKeywordSearchByInsertingSpaceInMiddle() is true.
   // This has no effect if we're already in keyword mode.
   bool allow_exact_keyword_match_;
 
   DISALLOW_COPY_AND_ASSIGN(OmniboxEditModel);
 };
 
 #endif  // CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_EDIT_MODEL_H_