Hitting Tab should always move cursor to end of omnibox text.

chrome/browser/autocomplete/autocomplete_edit_view_mac.mm

 // 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.
 
 #include "chrome/browser/autocomplete/autocomplete_edit_view_mac.h"
 
 #include <Carbon/Carbon.h>  // kVK_Return
 
 #include "app/mac/nsimage_cache.h"
 #include "base/string_util.h"
@@ skipping 198 matching lines @@
   DCHECK(tab);
 
   const bool hasFocus = [field_ currentEditor] ? true : false;
 
   NSRange range;
   if (hasFocus) {
     range = GetSelectedRange();
   } else {
     // If we are not focussed, there is no selection.  Manufacture
     // something reasonable in case it starts to matter in the future.
-    range = NSMakeRange(0, [[field_ stringValue] length]);
+    range = NSMakeRange(0, GetTextLength());
   }
 
   AutocompleteEditViewMacState state(model_->GetStateForTabSwitch(),
                                      hasFocus, range);
   StoreStateToTab(tab, state);
 }
 
 void AutocompleteEditViewMac::Update(
     const TabContents* tab_for_state_restoring) {
   // TODO(shess): It seems like if the tab is non-NULL, then this code
@@ skipping 59 matching lines @@
 
   model_->OpenURL(url, disposition, transition, alternate_nav_url,
                   selected_line, keyword);
 }
 
 string16 AutocompleteEditViewMac::GetText() const {
   return base::SysNSStringToUTF16(GetNonSuggestTextSubstring());
 }
 
 bool AutocompleteEditViewMac::IsEditingOrEmpty() const {
-  return model_->user_input_in_progress() ||
-      ([[field_ stringValue] length] == 0);
+  return model_->user_input_in_progress() || !GetTextLength();
 }
 
 int AutocompleteEditViewMac::GetIcon() const {
   return IsEditingOrEmpty() ?
       AutocompleteMatch::TypeToIcon(model_->CurrentTextType()) :
       toolbar_model_->GetIcon();
 }
 
 void AutocompleteEditViewMac::SetUserText(const string16& text) {
   SetUserText(text, text, true);
 }
 
 void AutocompleteEditViewMac::SetUserText(const string16& text,
                                           const string16& display_text,
                                           bool update_popup) {
   model_->SetUserText(text);
   // TODO(shess): TODO below from gtk.
   // TODO(deanm): something about selection / focus change here.
   SetText(display_text);
   if (update_popup) {
     UpdatePopup();
   }
   controller_->OnChanged();
 }
 
 NSRange AutocompleteEditViewMac::GetSelectedRange() const {
-  DCHECK([field_ currentEditor]);
   return [[field_ currentEditor] selectedRange];
 }
 
 NSRange AutocompleteEditViewMac::GetMarkedRange() const {
   DCHECK([field_ currentEditor]);
   return [(NSTextView*)[field_ currentEditor] markedRange];
 }
 
 void AutocompleteEditViewMac::SetSelectedRange(const NSRange range) {
   // This can be called when we don't have focus.  For instance, when
@@ skipping 29 matching lines @@
     SetUserText(ASCIIToUTF16("?"));
   } else {
     NSRange range = NSMakeRange(start + 1, current_text.size() - start - 1);
     [[field_ currentEditor] setSelectedRange:range];
   }
 }
 
 bool AutocompleteEditViewMac::IsSelectAll() {
   if (![field_ currentEditor])
     return true;
-  const NSRange all_range = NSMakeRange(0, GetText().length());
+  const NSRange all_range = NSMakeRange(0, GetTextLength());
   return NSEqualRanges(all_range, GetSelectedRange());
 }
 
 bool AutocompleteEditViewMac::DeleteAtEndPressed() {
   return delete_at_end_pressed_;
 }
 
 void AutocompleteEditViewMac::GetSelectionBounds(string16::size_type* start,
                                                  string16::size_type* end) {
   if (![field_ currentEditor]) {
     *start = *end = 0;
     return;
   }
 
   const NSRange selected_range = GetSelectedRange();
   *start = static_cast<size_t>(selected_range.location);
   *end = static_cast<size_t>(NSMaxRange(selected_range));
 }
 
 void AutocompleteEditViewMac::SelectAll(bool reversed) {
   // TODO(shess): Figure out what |reversed| implies.  The gtk version
   // has it imply inverting the selection front to back, but I don't
   // even know if that makes sense for Mac.
 
   // TODO(shess): Verify that we should be stealing focus at this
   // point.
-  SetSelectedRange(NSMakeRange(0, GetText().length()));
+  SetSelectedRange(NSMakeRange(0, GetTextLength()));
 }
 
 void AutocompleteEditViewMac::RevertAll() {
   ClosePopup();
   model_->Revert();
   controller_->OnChanged();
   [field_ clearUndoChain];
 }
 
 void AutocompleteEditViewMac::UpdatePopup() {
   model_->SetInputInProgress(true);
   if (!model_->has_focus())
     return;
 
   // Comment copied from AutocompleteEditViewWin::UpdatePopup():
   // Don't inline autocomplete when:
   //   * The user is deleting text
   //   * The caret/selection isn't at the end of the text
   //   * The user has just pasted in something that replaced all the text
   //   * The user is trying to compose something in an IME
-  bool prevent_inline_autocomplete = IsImeComposing();
-  NSTextView* editor = (NSTextView*)[field_ currentEditor];
-  if (editor) {
-    if (NSMaxRange([editor selectedRange]) <
-        [[editor textStorage] length] - suggest_text_length_)
-      prevent_inline_autocomplete = true;
-  }
-
-  model_->StartAutocomplete([editor selectedRange].length != 0,
-                            prevent_inline_autocomplete);
+  model_->StartAutocomplete(GetSelectedRange().length != 0,
+                            IsImeComposing() || !IsCaretAtEnd());
 }
 
 void AutocompleteEditViewMac::ClosePopup() {
   if (popup_view_->GetModel()->IsOpen())
     controller_->OnAutocompleteWillClosePopup();
 
   popup_view_->GetModel()->StopAutocomplete();
 }
 
 void AutocompleteEditViewMac::SetFocus() {
 }
 
-bool AutocompleteEditViewMac::CommitSuggestText() {
-  if (suggest_text_length_ == 0)
-    return false;
-
-  string16 input_text(GetText());
-  suggest_text_length_ = 0;
-  string16 text(GetText());
-  // Call SetText() to force a redraw and move the cursor to the end.
-  SetText(text);
-  model()->FinalizeInstantQuery(input_text, text.substr(input_text.size()));
-  return true;
-}
-
 void AutocompleteEditViewMac::SetText(const string16& display_text) {
   // If we are setting the text directly, there cannot be any suggest text.
   suggest_text_length_ = 0;
   SetTextInternal(display_text);
 }
 
 void AutocompleteEditViewMac::SetTextInternal(
     const string16& display_text) {
   NSString* ss = base::SysUTF16ToNSString(display_text);
   NSMutableAttributedString* as =
@@ skipping 30 matching lines @@
   NSString* text = [field_ stringValue];
   if (suggest_text_length_ > 0) {
     NSUInteger length = [text length];
 
     DCHECK_LE(suggest_text_length_, length);
     text = [text substringToIndex:(length - suggest_text_length_)];
   }
   return text;
 }
 
+NSString* AutocompleteEditViewMac::GetSuggestTextSubstring() const {
+  if (suggest_text_length_ == 0)
+    return nil;
+
+  NSString* text = [field_ stringValue];
+  NSUInteger length = [text length];
+  DCHECK_LE(suggest_text_length_, length);
+  return [text substringFromIndex:(length - suggest_text_length_)];
+}
+
 void AutocompleteEditViewMac::EmphasizeURLComponents() {
   NSTextView* editor = (NSTextView*)[field_ currentEditor];
   // If the autocomplete text field is in editing mode, then we can just change
   // its attributes through its editor. Otherwise, we simply reset its content.
   if (editor) {
     NSTextStorage* storage = [editor textStorage];
     [storage beginEditing];
 
     // Clear the existing attributes from the text storage, then
     // overlay the appropriate Omnibox attributes.
@@ skipping 196 matching lines @@
   if (needs_update) {
     NSRange current_range = GetSelectedRange();
     SetTextInternal(base::SysNSStringToUTF16(text));
     if (NSMaxRange(current_range) <= [text length] - suggest_text_length_)
       SetSelectedRange(current_range);
     else
       SetSelectedRange(NSMakeRange([text length] - suggest_text_length_, 0));
   }
 }
 
+string16 AutocompleteEditViewMac::GetInstantSuggestion() const {
+  return suggest_text_length_ ?
+      base::SysNSStringToUTF16(GetSuggestTextSubstring()) : string16();
+}
+
 int AutocompleteEditViewMac::TextWidth() const {
   // Not used on mac.
   NOTREACHED();
   return 0;
 }
 
 bool AutocompleteEditViewMac::IsImeComposing() const {
   return [(NSTextView*)[field_ currentEditor] hasMarkedText];
 }
 
@@ skipping 42 matching lines @@
 
     if (cmd == @selector(moveUp:)) {
       model_->OnUpOrDownKeyPressed(-1);
       return true;
     }
   }
 
   if (cmd == @selector(moveRight:)) {
     // Only commit suggested text if the cursor is all the way to the right and
     // there is no selection.
-    NSRange range = GetSelectedRange();
-    if (range.length == 0 &&
-        suggest_text_length_ > 0 &&
-        (range.location + suggest_text_length_ ==
-         [[field_ stringValue] length])) {
-      controller_->OnCommitSuggestedText(GetText());
+    if (suggest_text_length_ > 0 && IsCaretAtEnd()) {
+      controller_->OnCommitSuggestedText(true);
       return true;
     }
   }
 
   if (cmd == @selector(scrollPageDown:)) {
     model_->OnUpOrDownKeyPressed(model_->result().size());
     return true;
   }
 
   if (cmd == @selector(scrollPageUp:)) {
     model_->OnUpOrDownKeyPressed(-model_->result().size());
     return true;
   }
 
   if (cmd == @selector(cancelOperation:)) {
     return model_->OnEscapeKeyPressed();
   }
 
   if (cmd == @selector(insertTab:) ||
       cmd == @selector(insertTabIgnoringFieldEditor:)) {
     if (model_->is_keyword_hint())
       return model_->AcceptKeyword();
 
     if (suggest_text_length_ > 0) {
-      controller_->OnCommitSuggestedText(GetText());
+      controller_->OnCommitSuggestedText(true);
       return true;
     }
 
+    if (!IsCaretAtEnd()) {
+      PlaceCaretAt(GetTextLength());
+      // OnDidChange() will not be triggered when setting selected range in this
+      // method, so we need to call it explicitly.
+      OnDidChange();
+      return true;
+    }
+
     if (controller_->AcceptCurrentInstantPreview())
       return true;
   }
 
   // |-noop:| is sent when the user presses Cmd+Return. Override the no-op
   // behavior with the proper WindowOpenDisposition.
   NSEvent* event = [NSApp currentEvent];
   if (cmd == @selector(insertNewline:) ||
      (cmd == @selector(noop:) && [event keyCode] == kVK_Return)) {
     WindowOpenDisposition disposition =
@@ skipping 255 matching lines @@
   }
 
   return string16();
 }
 
 // static
 NSFont* AutocompleteEditViewMac::GetFieldFont() {
   ResourceBundle& rb = ResourceBundle::GetSharedInstance();
   return rb.GetFont(ResourceBundle::BaseFont).GetNativeFont();
 }
+
+NSUInteger AutocompleteEditViewMac::GetTextLength() const {
+  return ([field_ currentEditor] ?
+          [[[field_ currentEditor] string] length] :
+          [[field_ stringValue] length]) - suggest_text_length_;
+}
+
+void AutocompleteEditViewMac::PlaceCaretAt(NSUInteger pos) {
+  DCHECK(pos <= GetTextLength());
+  SetSelectedRange(NSMakeRange(pos, pos));
+}
+
+bool AutocompleteEditViewMac::IsCaretAtEnd() const {
+  const NSRange selection = GetSelectedRange();
+  return selection.length == 0 && selection.location == GetTextLength();
+}