Accept keyword by pressing space.

chrome/browser/autocomplete/autocomplete_edit.h

 // Copyright (c) 2010 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_AUTOCOMPLETE_AUTOCOMPLETE_EDIT_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_EDIT_H_
 #pragma once
 
 #include "base/string16.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
@@ skipping 81 matching lines @@
 
   // Called whenever the autocomplete edit gets focused.
   virtual void OnSetFocus() = 0;
 
   // Returns the favicon of the current page.
   virtual SkBitmap GetFavIcon() const = 0;
 
   // Returns the title of the current page.
   virtual std::wstring GetTitle() const = 0;
 
+  // Returns true if the keyword hint UI is visible.
+  virtual bool IsKeywordHintVisible() const = 0;

[Peter Kasting, 2011/01/14 00:43:31]

This addition seems a little odd to me.  The AutocompleteEdit already knows when
there's a hint visible: |is_keyword_hint_| is true.  Right?  Why does it need to
ask the controller?

[James Su, 2011/01/14 01:03:54]

They keyword hint UI may not be visible if the browser window is too small,
accepting keyword in such case may surprise the user.

[Peter Kasting, 2011/01/14 01:20:01]

The hint is just a hint.  It is important that space accept the keyword even
when the hint is not visible, just as tab can accept keywords regardless of
whether the hint is visible.

[James Su, 2011/01/14 02:02:46]

Existing code doesn't accept keyword by Tab key if the hint is not visible. I
can change this behavior, if you think it's not correct.

[Peter Kasting, 2011/01/14 02:30:36]

Yeah, that seems like a bug.

[James Su, 2011/01/14 03:26:22]

According to the original code, it's on purpose rather than a bug. Maybe we need
to confirm it with UX designer.

[Peter Kasting, 2011/01/14 17:31:33]

I am the UX designer.  The original code was wrong.

[James Su, 2011/01/14 18:04:12]

Ok, I'll remove those code. It even makes the code simpler :)

+
  protected:
   virtual ~AutocompleteEditController();
 };
 
 class AutocompleteEditModel : public NotificationObserver {
  public:
-  enum KeywordUIState {
-    // The user is typing normally.
-    NORMAL,
-    // The user is editing in the middle of the input string.  Even if the
-    // input looks like a keyword, don't display the keyword UI, as to not
-    // interfere with the user's editing.
-    NO_KEYWORD,
-    // The user has triggered the keyword UI.  Until it disappears, bias
-    // autocomplete results so that input strings of the keyword alone default
-    // to the keyword provider, not a normal navigation or search.
-    KEYWORD,
-  };
-
   struct State {
     State(bool user_input_in_progress,
           const std::wstring& user_text,
           const std::wstring& keyword,
-          bool is_keyword_hint,
-          KeywordUIState keyword_ui_state);
+          bool is_keyword_hint);
     ~State();
 
     bool user_input_in_progress;
     const std::wstring user_text;
     const std::wstring keyword;
     const bool is_keyword_hint;
-    const KeywordUIState keyword_ui_state;
   };
 
   AutocompleteEditModel(AutocompleteEditView* view,
                         AutocompleteEditController* controller,
                         Profile* profile);
   ~AutocompleteEditModel();
 
   void SetPopupModel(AutocompletePopupModel* popup_model);
 
   // TODO: The edit and popup should be siblings owned by the LocationBarView,
@@ skipping 107 matching lines @@
                WindowOpenDisposition disposition,
                PageTransition::Type transition,
                const GURL& alternate_nav_url,
                size_t index,
                const std::wstring& keyword);
 
   bool has_focus() const { return has_focus_; }
 
   // Accessors for keyword-related state (see comments on keyword_ and
   // is_keyword_hint_).
-  std::wstring keyword() const {
-    return (is_keyword_hint_ || (keyword_ui_state_ != NO_KEYWORD)) ?
-        keyword_ : std::wstring();
-  }
+  const std::wstring& keyword() const { return keyword_; }
   bool is_keyword_hint() const { return is_keyword_hint_; }
 
   // Accepts the current keyword hint as a keyword.
   void AcceptKeyword();
 
   // Clears the current keyword.  |visible_text| is the (non-keyword) text
   // currently visible in the edit.
   void ClearKeyword(const std::wstring& visible_text);
 
   // Returns true if a query to an autocomplete provider is currently
@@ skipping 15 matching lines @@
   void OnKillFocus();
 
   // Called when the user presses the escape key.  Decides what, if anything, to
   // revert about any current edits.  Returns whether the key was handled.
   bool OnEscapeKeyPressed();
 
   // Called when the user presses or releases the control key.  Changes state as
   // necessary.
   void OnControlKeyChanged(bool pressed);
 
-  // Called when the user pastes in text that replaces the entire edit contents.
-  void on_paste_replacing_all() { paste_state_ = REPLACING_ALL; }
+  // Called when the user pastes in text. |replacing_all| should be true if the
+  // entire edit contents is being replaced.
+  void OnPaste(bool replacing_all);
 
   // Called when the user presses up or down.  |count| is a repeat count,
   // negative for moving up, positive for moving down.
   void OnUpOrDownKeyPressed(int count);
 
   // Called when any relevant data changes.  This rolls together several
   // separate pieces of data into one call so we can update all the UI
   // efficiently:
   //   |text| is either the new temporary text from the user manually selecting
   //     a different match, or the inline autocomplete text.  We distinguish by
@@ skipping 34 matching lines @@
   enum PasteState {
     NONE,           // Most recent edit was not a paste that replaced all text.
     REPLACED_ALL,   // Most recent edit was a paste that replaced all text.
     REPLACING_ALL,  // In the middle of doing a paste that replaces all
                     // text.  We need this intermediate state because OnPaste()
                     // does the actual detection of such pastes, but
                     // OnAfterPossibleChange() has to update the paste state
                     // for every edit.  If OnPaste() set the state directly to
                     // REPLACED_ALL, OnAfterPossibleChange() wouldn't know
                     // whether that represented the current edit or a past one.
+    PASTED,         // Most recent edit was a normal paste.
+    PASTING,        // Like REPLACING_ALL, but indicating a normal paste.
   };
 
   enum ControlKeyState {
     UP,                   // The control key is not depressed.
     DOWN_WITHOUT_CHANGE,  // The control key is depressed, and the edit's
                           // contents/selection have not changed since it was
                           // depressed.  This is the only state in which we
                           // do the "ctrl-enter" behavior when the user hits
                           // enter.
     DOWN_WITH_CHANGE,     // The control key is depressed, and the edit's
@@ skipping 30 matching lines @@
   // Subtle note: This ignores the desired_tld_ (unlike GetDataForURLExport()
   // and CurrentTextIsURL()).  The view needs this because it calls this
   // function during copy handling, when the control key is down to trigger the
   // copy.
   bool GetURLForText(const std::wstring& text, GURL* url) const;
 
   // Determines the suggested search text and invokes OnSetSuggestedSearchText
   // on the controller.
   void UpdateSuggestedSearchText();
 
+  // Accepts current keyword if the user only typed a whitespace at the end of
+  // |new_user_text|. Returns true if the current keyword is accepted.
+  bool MaybeAcceptKeywordBySpace(const std::wstring& new_user_text);
+
   AutocompleteEditView* view_;
 
   AutocompletePopupModel* popup_;
 
   AutocompleteEditController* controller_;
 
   NotificationRegistrar registrar_;
 
   // Whether the edit has focus.
   bool has_focus_;
@@ skipping 48 matching lines @@
   // When the user hits <esc>, the edit box reverts to "goog".  Hit <esc> again
   // and the popup is closed and "goog" is replaced by the permanent_text_,
   // which is the URL of the current page.
   //
   // original_url_ is only valid when there is temporary text, and is used as
   // the unique identifier of the originally selected item.  Thus, if the user
   // arrows to a different item with the same text, we can still distinguish
   // them and not revert all the way to the permanent_text_.
   bool has_temporary_text_;
   GURL original_url_;
-  KeywordUIState original_keyword_ui_state_;
 
   // When the user's last action was to paste and replace all the text, we
   // disallow inline autocomplete (on the theory that the user is trying to
   // paste in a new URL or part of one, and in either case inline autocomplete
   // would get in the way).
   PasteState paste_state_;
 
   // Whether the control key is depressed.  We track this to avoid calling
   // UpdatePopup() repeatedly if the user holds down the key, and to know
   // whether to trigger "ctrl-enter" behavior.
   ControlKeyState control_key_state_;
 
   // The keyword associated with the current match.  The user may have an actual
   // selected keyword, or just some input text that looks like a keyword (so we
   // can show a hint to press <tab>).  This is the keyword in either case;
   // is_keyword_hint_ (below) distinguishes the two cases.
   std::wstring keyword_;
 
   // True if the keyword associated with this match is merely a hint, i.e. the
   // user hasn't actually selected a keyword yet.  When this is true, we can use
   // keyword_ to show a "Press <tab> to search" sort of hint.
   bool is_keyword_hint_;
 
-  // See KeywordUIState enum.
-  KeywordUIState keyword_ui_state_;
-
   // Paste And Go-related state.  See CanPasteAndGo().
   mutable GURL paste_and_go_url_;
   mutable PageTransition::Type paste_and_go_transition_;
   mutable GURL paste_and_go_alternate_nav_url_;
 
   Profile* profile_;
 
   DISALLOW_COPY_AND_ASSIGN(AutocompleteEditModel);
 };
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_EDIT_H_