InstantExtended: record initial focus state for omnibox interactions.

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"
@@ skipping 32 matching lines @@
 };
 
 class OmniboxEditModel {
  public:
   struct State {
     State(bool user_input_in_progress,
           const string16& user_text,
           const string16& gray_text,
           const string16& keyword,
           bool is_keyword_hint,
-          OmniboxFocusState focus_state);
+          OmniboxFocusState focus_state,
+          OmniboxFocusState focus_state_for_input);
     ~State();
 
     bool user_input_in_progress;
     const string16 user_text;
     const string16 gray_text;
     const string16 keyword;
     const bool is_keyword_hint;
     OmniboxFocusState focus_state;
+    OmniboxFocusState focus_state_for_input;
   };
 
   OmniboxEditModel(OmniboxView* view,
                    OmniboxEditController* controller,
                    Profile* profile);
   virtual ~OmniboxEditModel();
 
   // TODO(beaudoin): Remove this accessor when the AutocompleteController has
   //     completely moved to OmniboxController.
   AutocompleteController* autocomplete_controller() const {
@@ skipping 332 matching lines @@
   scoped_ptr<OmniboxController> omnibox_controller_;
 
   OmniboxView* view_;
 
   OmniboxEditController* controller_;
 
   scoped_ptr<OmniboxCurrentPageDelegate> delegate_;
 
   OmniboxFocusState focus_state_;
 
+  // The focus state when the user initiated input in the omnibox. Only a valid
+  // value, OMNIBOX_FOCUS_{VISIBLE,INVISIBLE}, while user input is in progress
+  // and the ommnibox has focus.
+  OmniboxFocusState focus_state_for_input_;

[Peter Kasting, 2013/07/26 23:22:34]

The name of this seems unclear, and the type might need changing too.

Seems like the name should be something more like "initial_focus_source_", and
we want something more like:

enum FocusSource {
  INVALID,
  OMNIBOX,
  FAKEBOX,
};

I suppose we could continue to use OmniboxFocusState for this, but it seems less
clear -- it would at least need commentary.  Or perhaps we should just change
OmniboxFocusState to FocusedOmniboxField or some equivalent, with the values I
list above, which would probably still be equivalently clear everywhere else
(didn't look to see).

[samarth, 2013/07/29 18:55:35]

So when I initially wrote the code around invisible focus, I consciously tried
to keep the precise notion of  a "fakebox" out of the omnibox (and the browser
code in general), and everything here talks about the visibility of the cursor.

So my options are:
(1) Keep this is as-is and just add some more comments.
(2) Change the metrics enum to also say visible/invisible focus.
(3) Change the omnibox code to have FocusedOmniboxField or something.

I have a slight preference for (2).  What about you?

+
   // 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 84 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_