OmniboxPopupViewMac refactoring Part 3 (truncation)

chrome/browser/ui/cocoa/omnibox/omnibox_popup_view_mac.mm

 // Copyright (c) 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.
 
 #include "chrome/browser/ui/cocoa/omnibox/omnibox_popup_view_mac.h"
 
 #include <cmath>
 
 #include "base/stl_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "chrome/browser/autocomplete/autocomplete_match.h"
 #include "chrome/browser/search/search.h"
 #include "chrome/browser/ui/cocoa/browser_window_controller.h"
 #import "chrome/browser/ui/cocoa/omnibox/omnibox_popup_cell.h"
 #include "chrome/browser/ui/cocoa/omnibox/omnibox_view_mac.h"
 #include "chrome/browser/ui/omnibox/omnibox_edit_model.h"
 #include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
 #include "chrome/browser/ui/omnibox/omnibox_popup_non_view.h"
 #include "grit/theme_resources.h"
 #include "skia/ext/skia_utils_mac.h"
 #import "third_party/GTM/AppKit/GTMNSAnimation+Duration.h"
 #import "ui/base/cocoa/cocoa_event_utils.h"
 #import "ui/base/cocoa/flipped_view.h"
 #include "ui/base/cocoa/window_size_constants.h"
 #include "ui/base/resource/resource_bundle.h"
-#include "ui/base/text/text_elider.h"
 #include "ui/gfx/rect.h"
-#include "ui/gfx/scoped_ns_graphics_context_save_gstate_mac.h"
 
 namespace {
 
 // How much to adjust the cell sizing up from the default determined
 // by the font.
 const CGFloat kCellHeightAdjust = 6.0;
 
 // Padding between matrix and the top and bottom of the popup window.
 const CGFloat kPopupPaddingVertical = 5.0;
 
-// How far to offset the text column from the left.
-const CGFloat kTextXOffset = 28.0;
-
 // Animation duration when animating the popup window smaller.
 const NSTimeInterval kShrinkAnimationDuration = 0.1;
 
-// Maximum fraction of the popup width that can be used to display match
-// contents.
-const CGFloat kMaxContentsFraction = 0.7;
-
 // Background colors for different states of the popup elements.
 NSColor* BackgroundColor() {
   return [NSColor controlBackgroundColor];
 }
 
 NSColor* ContentTextColor() {
   return [NSColor blackColor];
 }
 NSColor* DimContentTextColor() {
   return [NSColor darkGrayColor];
@@ skipping 59 matching lines @@
   DCHECK_GT(matrix_width, 0.0);
 
   // Load the results into the popup's matrix.
   const size_t rows = GetResult().size();
   DCHECK_GT(rows, 0U);
   [matrix_ renewRows:rows columns:1];
   for (size_t ii = 0; ii < rows; ++ii) {
     OmniboxPopupCell* cell = [matrix_ cellAtRow:ii column:0];
     const AutocompleteMatch& match = GetResult().match_at(ii);
     [cell setImage:ImageForMatch(match)];
-    [cell setAttributedTitle:MatchText(match, result_font, matrix_width)];
+    [cell setContentText:DecorateMatchedString(match.contents,
+                                               match.contents_class,
+                                               ContentTextColor(),
+                                               DimContentTextColor(),
+                                               result_font)];
+    if (match.description.empty()) {
+      [cell setDescriptionText:nil];
+    } else {
+      NSMutableAttributedString* description =
+          DecorateMatchedString(match.description,
+                                match.description_class,
+                                DimContentTextColor(),
+                                DimContentTextColor(),
+                                result_font);
+      NSString* rawEnDash = @" \u2013 ";
+      [description replaceCharactersInRange:NSMakeRange(0, 0)
+                                 withString:rawEnDash];

[Scott Hess - ex-Googler, 2013/06/28 01:02:48]

I almost want to have the spc en-dash spc sequence pushed down into the cell
drawing code, rather than doing this.

[sail, 2013/06/28 18:41:16]

Done.

+      [cell setDescriptionText:description];
+    }
   }
 
   // Set the cell size to fit a line of text in the cell's font.  All
   // cells should use the same font and each should layout in one
   // line, so they should all be about the same height.
   const NSSize cell_size = [[matrix_ cellAtRow:0 column:0] cellSize];
   DCHECK_GT(cell_size.height, 0.0);
   const CGFloat cell_height = cell_size.height + kCellHeightAdjust;
   [matrix_ setCellSize:NSMakeSize(matrix_width, cell_height)];
 
@@ skipping 31 matching lines @@
                                              size_t row) {
   OpenURLForRow(row,
                 ui::WindowOpenDispositionFromNSEvent([NSApp currentEvent]));
 }
 
 void OmniboxPopupViewMac::OnMatrixRowMiddleClicked(OmniboxPopupMatrix* matrix,
                                                    size_t row) {
   OpenURLForRow(row, NEW_BACKGROUND_TAB);
 }
 
-// Return the text to show for the match, based on the match's
-// contents and description.  Result will be in |font|, with the
-// boldfaced version used for matches.
-NSAttributedString* OmniboxPopupViewMac::MatchText(
-    const AutocompleteMatch& match,
-    gfx::Font& font,
-    float cell_width) {
-  NSMutableAttributedString *as =
-      DecorateMatchedString(match.contents,
-                            match.contents_class,
-                            ContentTextColor(),
-                            DimContentTextColor(),
-                            font);
-
-  // If there is a description, append it, separated from the contents
-  // with an en dash, and decorated with a distinct color.
-  if (!match.description.empty()) {
-    // Make sure the current string fits w/in kMaxContentsFraction of
-    // the cell to make sure the description will be at least
-    // partially visible.
-    // TODO(shess): Consider revising our NSCell subclass to have two
-    // bits and just draw them right, rather than truncating here.
-    const float text_width = cell_width - kTextXOffset;
-    as = ElideString(as, match.contents, font,
-                     text_width * kMaxContentsFraction);
-
-    NSDictionary* attributes = @{
-        NSFontAttributeName :  font.GetNativeFont(),
-        NSForegroundColorAttributeName : ContentTextColor()
-    };
-    NSString* raw_en_dash = @" \u2013 ";
-    NSAttributedString* en_dash =
-        [[[NSAttributedString alloc] initWithString:raw_en_dash
-                                         attributes:attributes] autorelease];
-
-    // In Windows, a boolean force_dim is passed as true for the
-    // description.  Here, we pass the dim text color for both normal and dim,
-    // to accomplish the same thing.
-    NSAttributedString* description =
-        DecorateMatchedString(match.description, match.description_class,
-                              DimContentTextColor(),
-                              DimContentTextColor(),
-                              font);
-
-    [as appendAttributedString:en_dash];
-    [as appendAttributedString:description];
-  }
-
-  NSMutableParagraphStyle* style =
-      [[[NSMutableParagraphStyle alloc] init] autorelease];
-  [style setLineBreakMode:NSLineBreakByTruncatingTail];
-  [style setTighteningFactorForTruncation:0.0];
-  [as addAttribute:NSParagraphStyleAttributeName value:style
-             range:NSMakeRange(0, [as length])];
-
-  return as;
-}
-
 // static
 NSMutableAttributedString* OmniboxPopupViewMac::DecorateMatchedString(
     const string16& match_string,
     const AutocompleteMatch::ACMatchClassifications& classifications,
     NSColor* text_color,
     NSColor* dim_text_color,
     gfx::Font& font) {
   // Cache for on-demand computation of the bold version of |font|.
   NSFont* bold_font = nil;
 
@@ skipping 45 matching lines @@
     if (0 != (i->style & ACMatchClassification::DIM)) {
       [as addAttribute:NSForegroundColorAttributeName
                  value:dim_text_color
                  range:range];
     }
   }
 
   return as;
 }
 
-NSMutableAttributedString* OmniboxPopupViewMac::ElideString(
-    NSMutableAttributedString* a_string,
-    const string16& original_string,
-    const gfx::Font& font,
-    const float width) {
-  // If it already fits, nothing to be done.
-  if ([a_string size].width <= width) {
-    return a_string;
-  }
-
-  // If ElideText() decides to do nothing, nothing to be done.
-  const string16 elided =
-      ui::ElideText(original_string, font, width, ui::ELIDE_AT_END);
-  if (0 == elided.compare(original_string)) {
-    return a_string;
-  }
-
-  // If everything was elided away, clear the string.
-  if (elided.empty()) {
-    [a_string deleteCharactersInRange:NSMakeRange(0, [a_string length])];
-    return a_string;
-  }
-
-  // The ellipses should be the last character, and everything before
-  // that should match the original string.
-  const size_t i(elided.length() - 1);
-  DCHECK_NE(0, elided.compare(0, i, original_string));
-
-  // Replace the end of |aString| with the ellipses from |elided|.
-  NSString* s = base::SysUTF16ToNSString(elided.substr(i));
-  [a_string replaceCharactersInRange:NSMakeRange(i, [a_string length] - i)
-                          withString:s];
-
-  return a_string;
-}
-
 const AutocompleteResult& OmniboxPopupViewMac::GetResult() const {
   return model_->result();
 }
 
 void OmniboxPopupViewMac::CreatePopupIfNeeded() {
   if (!popup_) {
     popup_.reset(
         [[NSWindow alloc] initWithContentRect:ui::kWindowSizeDeterminedLater
                                     styleMask:NSBorderlessWindowMask
                                       backing:NSBackingStoreBuffered
@@ skipping 98 matching lines @@
 void OmniboxPopupViewMac::OpenURLForRow(size_t row,
                                         WindowOpenDisposition disposition) {
   DCHECK_GE(row, 0u);
 
   // OpenMatch() may close the popup, which will clear the result set and, by
   // extension, |match| and its contents.  So copy the relevant match out to
   // make sure it stays alive until the call completes.
   AutocompleteMatch match = GetResult().match_at(row);
   omnibox_view_->OpenMatch(match, disposition, GURL(), row);
 }