[Mac] Convert omnibox keyword hint to decoration.

chrome/browser/cocoa/location_bar/location_bar_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.
 
 #import "chrome/browser/cocoa/location_bar/location_bar_view_mac.h"
 
 #include "app/l10n_util_mac.h"
 #include "app/resource_bundle.h"
 #include "base/i18n/rtl.h"
 #include "base/nsimage_cache_mac.h"
 #include "base/stl_util-inl.h"
 #include "base/string_util.h"
 #include "base/sys_string_conversions.h"
 #include "chrome/app/chrome_dll_resource.h"
 #include "chrome/browser/alternate_nav_url_fetcher.h"
 #import "chrome/browser/app_controller_mac.h"
 #import "chrome/browser/autocomplete/autocomplete_edit_view_mac.h"
 #include "chrome/browser/browser_list.h"
 #import "chrome/browser/cocoa/content_blocked_bubble_controller.h"
 #include "chrome/browser/cocoa/event_utils.h"
 #import "chrome/browser/cocoa/extensions/extension_action_context_menu.h"
 #import "chrome/browser/cocoa/extensions/extension_popup_controller.h"
 #import "chrome/browser/cocoa/first_run_bubble_controller.h"
 #import "chrome/browser/cocoa/location_bar/autocomplete_text_field.h"
 #import "chrome/browser/cocoa/location_bar/autocomplete_text_field_cell.h"
 #import "chrome/browser/cocoa/location_bar/content_setting_decoration.h"
 #import "chrome/browser/cocoa/location_bar/ev_bubble_decoration.h"
+#import "chrome/browser/cocoa/location_bar/keyword_hint_decoration.h"
 #import "chrome/browser/cocoa/location_bar/location_icon_decoration.h"
 #import "chrome/browser/cocoa/location_bar/page_action_decoration.h"
 #import "chrome/browser/cocoa/location_bar/selected_keyword_decoration.h"
 #import "chrome/browser/cocoa/location_bar/star_decoration.h"
 #include "chrome/browser/command_updater.h"
 #include "chrome/browser/content_setting_image_model.h"
 #include "chrome/browser/content_setting_bubble_model.h"
 #include "chrome/browser/extensions/extension_browser_event_router.h"
 #include "chrome/browser/extensions/extensions_service.h"
 #include "chrome/browser/extensions/extension_tabs_module.h"
@@ skipping 28 matching lines @@
       command_updater_(command_updater),
       field_(field),
       disposition_(CURRENT_TAB),
       location_icon_decoration_(new LocationIconDecoration(this)),
       selected_keyword_decoration_(
           new SelectedKeywordDecoration([field_ font])),
       ev_bubble_decoration_(
           new EVBubbleDecoration(location_icon_decoration_.get(),
                                  [field_ font])),
       star_decoration_(new StarDecoration(command_updater)),
+      keyword_hint_decoration_(new KeywordHintDecoration([field_ font])),
       profile_(profile),
       browser_(browser),
       toolbar_model_(toolbar_model),
       transition_(PageTransition::TYPED),
       first_run_bubble_(this) {
   for (size_t i = 0; i < CONTENT_SETTINGS_NUM_TYPES; ++i) {
     DCHECK_EQ(i, content_setting_decorations_.size());
     ContentSettingsType type = static_cast<ContentSettingsType>(i);
     content_setting_decorations_.push_back(
         new ContentSettingDecoration(type, this, profile_));
@@ skipping 284 matching lines @@
 }
 
 NSPoint LocationBarViewMac::GetBookmarkBubblePoint() const {
   AutocompleteTextFieldCell* cell = [field_ cell];
   const NSRect frame = [cell frameForDecoration:star_decoration_.get()
                                         inFrame:[field_ bounds]];
   const NSPoint point = star_decoration_->GetBubblePointInFrame(frame);
   return [field_ convertPoint:point toView:nil];
 }
 
-NSImage* LocationBarViewMac::GetTabButtonImage() {
-  if (!tab_button_image_) {
-    SkBitmap* skiaBitmap = ResourceBundle::GetSharedInstance().
-        GetBitmapNamed(IDR_LOCATION_BAR_KEYWORD_HINT_TAB);
-    if (skiaBitmap) {
-      tab_button_image_.reset([gfx::SkBitmapToNSImage(*skiaBitmap) retain]);
-    }
-  }
-  return tab_button_image_;
-}
-
 NSImage* LocationBarViewMac::GetKeywordImage(const std::wstring& keyword) {
   const TemplateURL* template_url =
       profile_->GetTemplateURLModel()->GetTemplateURLForKeyword(keyword);
   if (template_url && template_url->IsExtensionKeyword()) {
     const SkBitmap& bitmap = profile_->GetExtensionsService()->
         GetOmniboxIcon(template_url->GetExtensionId());
     return gfx::SkBitmapToNSImage(bitmap);
   }
 
   return AutocompleteEditViewMac::ImageForResource(IDR_OMNIBOX_SEARCH);
@@ skipping 96 matching lines @@
   [cell addRightDecoration:star_decoration_.get()];
 
   // Note that display order is right to left.
   for (size_t i = 0; i < page_action_decorations_.size(); ++i) {
     [cell addRightDecoration:page_action_decorations_[i]];
   }
   for (size_t i = 0; i < content_setting_decorations_.size(); ++i) {
     [cell addRightDecoration:content_setting_decorations_[i]];
   }
 
+  [cell addRightDecoration:keyword_hint_decoration_.get()];
+
   // By default only the location icon is visible.
   location_icon_decoration_->SetVisible(true);
   selected_keyword_decoration_->SetVisible(false);
   ev_bubble_decoration_->SetVisible(false);
+  keyword_hint_decoration_->SetVisible(false);
 
   // Get the keyword to use for keyword-search and hinting.
   const std::wstring keyword(edit_view_->model()->keyword());
   std::wstring short_name;
   bool is_extension_keyword = false;
   if (!keyword.empty()) {
     short_name = profile_->GetTemplateURLModel()->
         GetKeywordShortName(keyword, &is_extension_keyword);
   }
 
   const bool is_keyword_hint = edit_view_->model()->is_keyword_hint();
 
   if (!keyword.empty() && !is_keyword_hint) {
     // Switch from location icon to keyword mode.
     location_icon_decoration_->SetVisible(false);
     selected_keyword_decoration_->SetVisible(true);
     selected_keyword_decoration_->SetKeyword(short_name, is_extension_keyword);
     selected_keyword_decoration_->SetImage(GetKeywordImage(keyword));
-
-    // TODO(shess): This goes away once the hints are decorations.
-    [cell clearHint];
   } else if (toolbar_model_->GetSecurityLevel() == ToolbarModel::EV_SECURE) {
     // Switch from location icon to show the EV bubble instead.
     location_icon_decoration_->SetVisible(false);
     ev_bubble_decoration_->SetVisible(true);
 
     std::wstring label(toolbar_model_->GetEVCertName());
     ev_bubble_decoration_->SetLabel(base::SysWideToNSString(label));
-
-    // TODO(shess): This goes away once the hints are decorations.
-    [cell clearHint];
   } else if (!keyword.empty() && is_keyword_hint) {
-    // Keyword is a hint, like "Press [Tab] to search Engine".  [Tab]
-    // is a parameter to be replaced by an image.  "Engine" is a
-    // parameter to be replaced by text based on the keyword.
-    std::vector<size_t> content_param_offsets;
-    int message_id = is_extension_keyword ?
-        IDS_OMNIBOX_EXTENSION_KEYWORD_HINT : IDS_OMNIBOX_KEYWORD_HINT;
-    const std::wstring keyword_hint(
-        l10n_util::GetStringF(message_id,
-                              std::wstring(), short_name,
-                              &content_param_offsets));
-
-    // Should always be 2 offsets, see the comment in
-    // location_bar_view.cc after IDS_OMNIBOX_KEYWORD_HINT fetch.
-    DCHECK_EQ(content_param_offsets.size(), 2U);
-
-    // Where to put the [TAB] image.
-    const size_t split(content_param_offsets.front());
-
-    NSString* prefix = base::SysWideToNSString(keyword_hint.substr(0, split));
-    NSString* suffix = base::SysWideToNSString(keyword_hint.substr(split));
-
-    NSImage* image = GetTabButtonImage();
-    const CGFloat availableWidth([field_ availableDecorationWidth]);
-    [cell setKeywordHintPrefix:prefix image:image suffix:suffix
-                availableWidth:availableWidth];
-  } else {
-    // Nothing interesting to show, plain old text field.
-    [cell clearHint];
+    keyword_hint_decoration_->SetKeyword(short_name, is_extension_keyword);
+    keyword_hint_decoration_->SetVisible(true);
   }
 
   // These need to change anytime the layout changes.
   // TODO(shess): Anytime the field editor might have changed, the
   // cursor rects almost certainly should have changed.  The tooltips
   // might change even when the rects don't change.
   [field_ resetFieldEditorFrameIfNeeded];
   [field_ updateCursorAndToolTipRects];
 
   [field_ setNeedsDisplay:YES];
 }