[AiS] changing mac omnibox suggestions form NSMatrix to NSTableView

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

 // Copyright 2013 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/ui/cocoa/omnibox/omnibox_popup_cell.h"
 
 #include <algorithm>
 #include <cmath>
 
 #include "base/i18n/rtl.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/ui/cocoa/omnibox/omnibox_popup_view_mac.h"
 #include "chrome/browser/ui/cocoa/omnibox/omnibox_view_mac.h"
 #include "chrome/browser/ui/omnibox/omnibox_popup_model.h"
 #include "chrome/grit/generated_resources.h"
 #include "components/omnibox/suggestion_answer.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/gfx/font.h"
 
 namespace {
 
+// How much to adjust the cell sizing up from the default determined
+// by the font.
+const CGFloat kCellHeightAdjust = 6.0;
+
 // How far to offset image column from the left.
 const CGFloat kImageXOffset = 5.0;
 
 // How far to offset the text column from the left.
 const CGFloat kTextStartOffset = 28.0;
 
 // Rounding radius of selection and hover background on popup items.
 const CGFloat kCellRoundingRadius = 2.0;
 
 // Flips the given |rect| in context of the given |frame|.
@@ skipping 112 matching lines @@
                  value:DimTextColor()
                  range:range];
     }
   }
 
   return as;
 }
 
 }  // namespace
 
-@implementation OmniboxPopupCell
+@interface OmniboxPopupCell ()
+- (CGFloat)drawMatchPart:(NSAttributedString*)attributedString
+               withFrame:(NSRect)cellFrame
+                atOffset:(CGFloat)offset
+            withMaxWidth:(int)maxWidth
+                  inView:(NSView*)controlView;
+@end
 
-- (id)init {
-  self = [super init];
-  if (self) {
-    [self setImagePosition:NSImageLeft];
-    [self setBordered:NO];
-    [self setButtonType:NSRadioButton];
+@implementation OmniboxPopupCellData
 
-    // Without this highlighting messes up white areas of images.
-    [self setHighlightsBy:NSNoCellMask];
+- (id)initWithMatch:(const AutocompleteMatch&)match image:(NSImage*)image {
+  if ((self = [super init])) {
+    image_.reset([image retain]);
 
     const base::string16& raw_separator =
         l10n_util::GetStringUTF16(IDS_AUTOCOMPLETE_MATCH_DESCRIPTION_SEPARATOR);
     separator_.reset(
         [CreateAttributedString(raw_separator, DimTextColor()) retain]);
+
+    isContentsRTL_ =
+        (base::i18n::RIGHT_TO_LEFT ==
+         base::i18n::GetFirstStrongCharacterDirection(match.contents));
+    matchType_ = match.type;
+
+    // Prefix may not have any characters with strong directionality, and may
+    // take
+    // the UI directionality. But prefix needs to appear in continuation of the
+    // contents so we force the directionality.

[Scott Hess - ex-Googler, 2015/05/21 20:40:26]

Reformat comment.

[dschuyler, 2015/05/26 18:40:20]

Done.

+    NSTextAlignment textAlignment =
+        isContentsRTL_ ? NSRightTextAlignment : NSLeftTextAlignment;
+    prefix_.reset(
+        [CreateAttributedString(base::UTF8ToUTF16(match.GetAdditionalInfo(
+                                    kACMatchPropertyContentsPrefix)),
+                                ContentTextColor(), textAlignment) retain]);
+
+    contents_.reset([CreateClassifiedAttributedString(
+        match.contents, ContentTextColor(), match.contents_class) retain]);
+
+    if (match.answer) {
+      base::string16 answerString;
+      DCHECK(!match.answer->second_line().text_fields().empty());
+      for (const SuggestionAnswer::TextField& textField :
+           match.answer->second_line().text_fields())
+        answerString.append(textField.text());
+      const base::string16 space(base::ASCIIToUTF16(" "));
+      const SuggestionAnswer::TextField* textField =
+          match.answer->second_line().additional_text();
+      if (textField)
+        answerString.append(space).append(textField->text());
+      textField = match.answer->second_line().status_text();
+      if (textField)
+        answerString.append(space).append(textField->text());
+      description_.reset([CreateClassifiedAttributedString(
+          answerString, DimTextColor(), match.description_class) retain]);
+    } else if (match.description.empty()) {
+      description_.reset();
+    } else {
+      description_.reset([CreateClassifiedAttributedString(
+          match.description, DimTextColor(), match.description_class) retain]);
+    }
   }
   return self;
 }
 
-- (void)setMatch:(const AutocompleteMatch&)match {
-  match_ = match;
-  NSAttributedString *contents = CreateClassifiedAttributedString(
-      match_.contents, ContentTextColor(), match_.contents_class);
-  [self setAttributedTitle:contents];
+- (void)setContents:(NSAttributedString*)contents {
+  contents_.reset([contents retain]);
+}
 
-  if (match_.answer) {
-    base::string16 answerString;
-    DCHECK(!match_.answer->second_line().text_fields().empty());
-    for (const SuggestionAnswer::TextField& textField :
-         match_.answer->second_line().text_fields())
-      answerString += textField.text();
-    const base::char16 space(' ');
-    const SuggestionAnswer::TextField* textField =
-        match_.answer->second_line().additional_text();
-    if (textField)
-      answerString += space + textField->text();
-    textField = match_.answer->second_line().status_text();
-    if (textField)
-      answerString += space + textField->text();
-    description_.reset([CreateClassifiedAttributedString(
-        answerString, DimTextColor(), match_.description_class) retain]);
-  } else if (match_.description.empty()) {
-    description_.reset();
-  } else {
-    description_.reset([CreateClassifiedAttributedString(
-        match_.description, DimTextColor(), match_.description_class) retain]);
-  }
+- (void)setImage:(NSImage*)image {
+  image_.reset([image retain]);
 }
 
 - (void)setMaxMatchContentsWidth:(CGFloat)maxMatchContentsWidth {
   maxMatchContentsWidth_ = maxMatchContentsWidth;
 }
 
 - (void)setContentsOffset:(CGFloat)contentsOffset {
   contentsOffset_ = contentsOffset;
 }
 
-// The default NSButtonCell drawing leaves the image flush left and
-// the title next to the image.  This spaces things out to line up
-// with the star button and autocomplete field.
-- (void)drawInteriorWithFrame:(NSRect)cellFrame inView:(NSView *)controlView {
-  if ([self state] == NSOnState || [self isHighlighted]) {
-    if ([self state] == NSOnState)
-      [SelectedBackgroundColor() set];
-    else
-      [HoveredBackgroundColor() set];
-    NSBezierPath* path =
-        [NSBezierPath bezierPathWithRoundedRect:cellFrame
-                                        xRadius:kCellRoundingRadius
-                                        yRadius:kCellRoundingRadius];
-    [path fill];
-  }
+- (CGFloat)getMatchContentsWidth {
+  return [contents_ size].width;
+}
+
+- (CGFloat)rowHeight {
+  return [image_ size].height + kCellHeightAdjust;

[Scott Hess - ex-Googler, 2015/05/21 20:40:26]

I realize that the current version doesn't have the part which will do variable
height, but this seems dubious.  I think the closest to the previous version
would be [super cellSize].height + kCellHeightAdjust, though that may differ due
to the reparenting.

Is the image size constant?  I'd be happy with a constant.  It's arbitrary, but
that's one less bit of arbitrary.

[dschuyler, 2015/05/26 18:40:20]

Done.

+}
+
+- (void)drawMatchWithFrame:(NSRect)cellFrame
+                    inCell:(OmniboxPopupCell*)cell
+                    inView:(NSView*)controlView {
+  CGFloat remainingWidth = GetContentAreaWidth(cellFrame);
+  CGFloat contentsWidth = [self getMatchContentsWidth];
+  CGFloat separatorWidth = [separator_ size].width;
+  CGFloat descriptionWidth = [description_ size].width;
+  int contentsMaxWidth, descriptionMaxWidth;
+  OmniboxPopupModel::ComputeMatchMaxWidths(
+      ceilf(contentsWidth), ceilf(separatorWidth), ceilf(descriptionWidth),
+      ceilf(remainingWidth), !AutocompleteMatch::IsSearchType(matchType_),
+      &contentsMaxWidth, &descriptionMaxWidth);
 
   // Put the image centered vertically but in a fixed column.
-  NSImage* image = [self image];
-  if (image) {
+  if (image_) {
     NSRect imageRect = cellFrame;
-    imageRect.size = [image size];
+    imageRect.size = [image_ size];
     imageRect.origin.y +=
         std::floor((NSHeight(cellFrame) - NSHeight(imageRect)) / 2.0);
     imageRect.origin.x += kImageXOffset;
-    [image drawInRect:FlipIfRTL(imageRect, cellFrame)
-             fromRect:NSZeroRect  // Entire image
-            operation:NSCompositeSourceOver
-             fraction:1.0
-       respectFlipped:YES
-                hints:nil];
+    [image_ drawInRect:FlipIfRTL(imageRect, cellFrame)
+              fromRect:NSZeroRect
+             operation:NSCompositeSourceOver
+              fraction:1.0
+        respectFlipped:YES
+                 hints:nil];
   }
 
-  [self drawMatchWithFrame:cellFrame inView:controlView];
-}
-
-- (void)drawMatchWithFrame:(NSRect)cellFrame inView:(NSView*)controlView {
-  NSAttributedString* contents = [self attributedTitle];
-
-  CGFloat remainingWidth = GetContentAreaWidth(cellFrame);
-  CGFloat contentsWidth = [self getMatchContentsWidth];
-  CGFloat separatorWidth = [separator_ size].width;
-  CGFloat descriptionWidth = description_.get() ? [description_ size].width : 0;
-  int contentsMaxWidth, descriptionMaxWidth;
-  OmniboxPopupModel::ComputeMatchMaxWidths(
-      ceilf(contentsWidth),
-      ceilf(separatorWidth),
-      ceilf(descriptionWidth),
-      ceilf(remainingWidth),
-      !AutocompleteMatch::IsSearchType(match_.type),
-      &contentsMaxWidth,
-      &descriptionMaxWidth);
-
   CGFloat offset = kTextStartOffset;
-  if (match_.type == AutocompleteMatchType::SEARCH_SUGGEST_TAIL) {
+  if (matchType_ == AutocompleteMatchType::SEARCH_SUGGEST_TAIL) {
     // Infinite suggestions are rendered with a prefix (usually ellipsis), which
     // appear vertically stacked.
     offset += [self drawMatchPrefixWithFrame:cellFrame
+                                      inCell:cell
                                       inView:controlView
                         withContentsMaxWidth:&contentsMaxWidth];
   }
-  offset += [self drawMatchPart:contents
+  offset += [cell drawMatchPart:contents_
                       withFrame:cellFrame
                        atOffset:offset
                    withMaxWidth:contentsMaxWidth
                          inView:controlView];
 
   if (descriptionMaxWidth != 0) {
-    offset += [self drawMatchPart:separator_
+    offset += [cell drawMatchPart:separator_
                         withFrame:cellFrame
                          atOffset:offset
                      withMaxWidth:separatorWidth
                            inView:controlView];
-    offset += [self drawMatchPart:description_
+    offset += [cell drawMatchPart:description_
                         withFrame:cellFrame
                          atOffset:offset
                      withMaxWidth:descriptionMaxWidth
                            inView:controlView];
   }
 }
 
 - (CGFloat)drawMatchPrefixWithFrame:(NSRect)cellFrame
+                             inCell:(OmniboxPopupCell*)cell
                              inView:(NSView*)controlView
                withContentsMaxWidth:(int*)contentsMaxWidth {
   CGFloat offset = 0.0f;
   CGFloat remainingWidth = GetContentAreaWidth(cellFrame);
-  bool isRTL = base::i18n::IsRTL();
-  bool isContentsRTL = (base::i18n::RIGHT_TO_LEFT ==
-      base::i18n::GetFirstStrongCharacterDirection(match_.contents));
-  // Prefix may not have any characters with strong directionality, and may take
-  // the UI directionality. But prefix needs to appear in continuation of the
-  // contents so we force the directionality.
-  NSTextAlignment textAlignment = isContentsRTL ?
-      NSRightTextAlignment : NSLeftTextAlignment;
-  prefix_.reset([CreateAttributedString(base::UTF8ToUTF16(
-      match_.GetAdditionalInfo(kACMatchPropertyContentsPrefix)),
-      ContentTextColor(), textAlignment) retain]);
   CGFloat prefixWidth = [prefix_ size].width;
 
   CGFloat prefixOffset = 0.0f;
-  if (isRTL != isContentsRTL) {
+  if (base::i18n::IsRTL() != isContentsRTL_) {
     // The contents is rendered between the contents offset extending towards
     // the start edge, while prefix is rendered in opposite direction. Ideally
     // the prefix should be rendered at |contentsOffset_|. If that is not
     // sufficient to render the widest suggestion, we increase it to
     // |maxMatchContentsWidth_|.  If |remainingWidth| is not sufficient to
     // accommodate that, we reduce the offset so that the prefix gets rendered.
     prefixOffset = std::min(
         remainingWidth - prefixWidth, std::max(contentsOffset_,
                                                maxMatchContentsWidth_));
     offset = std::max<CGFloat>(0.0, prefixOffset - *contentsMaxWidth);
   } else { // The direction of contents is same as UI direction.
     // Ideally the offset should be |contentsOffset_|. If the max total width
     // (|prefixWidth| + |maxMatchContentsWidth_|) from offset will exceed the
     // |remainingWidth|, then we shift the offset to the left , so that all
     // postfix suggestions are visible.
     // We have to render the prefix, so offset has to be at least |prefixWidth|.
-    offset = std::max(prefixWidth,
+    offset = std::max(
+        prefixWidth,
         std::min(remainingWidth - maxMatchContentsWidth_, contentsOffset_));
     prefixOffset = offset - prefixWidth;
   }
   *contentsMaxWidth = std::min((int)ceilf(remainingWidth - prefixWidth),
                                *contentsMaxWidth);
-  [self drawMatchPart:prefix_
+  [cell drawMatchPart:prefix_
             withFrame:cellFrame
              atOffset:prefixOffset + kTextStartOffset
          withMaxWidth:prefixWidth
                inView:controlView];
   return offset;
 }
 
-- (CGFloat)drawMatchPart:(NSAttributedString*)as
+@end
+
+@implementation OmniboxPopupCell
+
+- (id)copyWithZone:(NSZone*)zone {
+  OmniboxPopupCell* copy = [super copyWithZone:zone];
+  // The representedObject is set to nil in the copy.

[Scott Hess - ex-Googler, 2015/05/21 20:40:27]

What did they do, put _all_ of the special edge cases in NSCell?

[groby-ooo-7-16, 2015/05/22 05:03:07]

Hey, at least this one is documented. (Under representedObject, not copyWithZone
- but beggars can't be choosers :)

Either way, objectValue all the way, and this isn't a problem any more. If you
do insist on keeping representedObject, you'll want to copyWithZone it though,
not just retain it.

[dschuyler, 2015/05/26 18:40:19]

Acknowledged.

[dschuyler, 2015/05/26 18:40:19]

I'm looking into the objectValue vs representedObject stuff (still a wip).

+  [copy setRepresentedObject:[self representedObject]];
+  return copy;
+}
+
+// The default NSButtonCell drawing leaves the image flush left and

[groby-ooo-7-16, 2015/05/21 03:01:48]

Comment doesn't apply any more - it's just an NSCell now. (Also - star button
and autocomplete field didn't apply.) 

If I may make a suggestion, you might want to clean up comments when you copied
code, so this doesn't bit in reviews :)

[dschuyler, 2015/05/26 18:40:19]

Done.

+// the title next to the image.  This spaces things out to line up
+// with the star button and autocomplete field.
+- (void)drawInteriorWithFrame:(NSRect)cellFrame inView:(NSView*)controlView {
+  if ([self state] == NSOnState || [self isHighlighted]) {
+    if ([self state] == NSOnState)
+      [SelectedBackgroundColor() set];
+    else
+      [HoveredBackgroundColor() set];
+    NSBezierPath* path =
+        [NSBezierPath bezierPathWithRoundedRect:cellFrame
+                                        xRadius:kCellRoundingRadius
+                                        yRadius:kCellRoundingRadius];
+    [path fill];
+  }
+
+  base::scoped_nsobject<OmniboxPopupCellData> cellData(
+      [self representedObject]);

[groby-ooo-7-16, 2015/05/21 03:01:48]

No need to scope - representedObject (and objectValue) retain their data. Just
pass [self objectValue] to drawMatchWithFrame:inCell:inView

[Scott Hess - ex-Googler, 2015/05/21 20:40:26]

Scoping is wrong, because -representedObject is not adding an additional
reference for scoped_nsobject<> to own.

[dschuyler, 2015/05/26 18:40:20]

Done.

[dschuyler, 2015/05/26 18:40:20]

Acknowledged.

+  [cellData drawMatchWithFrame:cellFrame inCell:self inView:controlView];
+}
+
+- (CGFloat)drawMatchPart:(NSAttributedString*)attributedString
                withFrame:(NSRect)cellFrame
                 atOffset:(CGFloat)offset
             withMaxWidth:(int)maxWidth
                   inView:(NSView*)controlView {
   if (offset > NSWidth(cellFrame))
     return 0.0f;
   NSRect renderRect = ShiftRect(cellFrame, offset);
   renderRect.size.width =
       std::min(NSWidth(renderRect), static_cast<CGFloat>(maxWidth));
-  if (renderRect.size.width != 0) {
-    [self drawTitle:as
-          withFrame:FlipIfRTL(renderRect, cellFrame)
-             inView:controlView];
-  }
+  NSRect textRect =
+      [attributedString boundingRectWithSize:renderRect.size options:nil];
+  renderRect.origin.y +=
+      std::floor((NSHeight(cellFrame) - NSHeight(textRect)) / 2.0);
+  if (NSWidth(renderRect) != 0)

[Scott Hess - ex-Googler, 2015/05/21 20:40:26]

I'd say > 0.0.  Just because I'm that paranoid.

[groby-ooo-7-16, 2015/05/22 05:03:07]

Let's be properly paranoid and say !NSIsEmptyRect(renderRect))

[dschuyler, 2015/05/26 18:40:20]

Done.

+    [attributedString drawInRect:FlipIfRTL(renderRect, cellFrame)];
   return NSWidth(renderRect);
 }
 
-- (CGFloat)getMatchContentsWidth {
-  NSAttributedString* contents = [self attributedTitle];
-  return contents ? [contents size].width : 0;
-}
-
-
 + (CGFloat)computeContentsOffset:(const AutocompleteMatch&)match {
   const base::string16& inputText = base::UTF8ToUTF16(
       match.GetAdditionalInfo(kACMatchPropertyInputText));
   int contentsStartIndex = 0;
   base::StringToInt(
       match.GetAdditionalInfo(kACMatchPropertyContentsStartIndex),
       &contentsStartIndex);
   // Ignore invalid state.
   if (!StartsWith(match.fill_into_edit, inputText, true)
       || !EndsWith(match.fill_into_edit, match.contents, true)
       || ((size_t)contentsStartIndex >= inputText.length())) {
     return 0;
   }
   bool isRTL = base::i18n::IsRTL();
   bool isContentsRTL = (base::i18n::RIGHT_TO_LEFT ==
       base::i18n::GetFirstStrongCharacterDirection(match.contents));
 
   // Color does not matter.
-  NSAttributedString* as = CreateAttributedString(inputText, DimTextColor());
-  base::scoped_nsobject<NSTextStorage> textStorage([[NSTextStorage alloc]
-      initWithAttributedString:as]);
+  NSAttributedString* attributedString =
+      CreateAttributedString(inputText, DimTextColor());
+  base::scoped_nsobject<NSTextStorage> textStorage(
+      [[NSTextStorage alloc] initWithAttributedString:attributedString]);
   base::scoped_nsobject<NSLayoutManager> layoutManager(
       [[NSLayoutManager alloc] init]);
   base::scoped_nsobject<NSTextContainer> textContainer(
       [[NSTextContainer alloc] init]);
   [layoutManager addTextContainer:textContainer];
   [textStorage addLayoutManager:layoutManager];
 
   NSUInteger charIndex = static_cast<NSUInteger>(contentsStartIndex);
   NSUInteger glyphIndex =
       [layoutManager glyphIndexForCharacterAtIndex:charIndex];
 
   // This offset is computed from the left edge of the glyph always from the
   // left edge of the string, irrespective of the directionality of UI or text.
   CGFloat glyphOffset = [layoutManager locationForGlyphAtIndex:glyphIndex].x;
 
-  CGFloat inputWidth = [as size].width;
+  CGFloat inputWidth = [attributedString size].width;
 
   // The offset obtained above may need to be corrected because the left-most
   // glyph may not have 0 offset. So we find the offset of left-most glyph, and
   // subtract it from the offset of the glyph we obtained above.
   CGFloat minOffset = glyphOffset;
 
   // If content is RTL, we are interested in the right-edge of the glyph.
   // Unfortunately the bounding rect computation methods from NSLayoutManager or
   // NSFont don't work correctly with bidirectional text. So we compute the
   // glyph width by finding the closest glyph offset to the right of the glyph
   // we are looking for.
   CGFloat glyphWidth = inputWidth;
 
-  for (NSUInteger i = 0; i < [as length]; i++) {
+  for (NSUInteger i = 0; i < [attributedString length]; i++) {
     if (i == charIndex) continue;
     glyphIndex = [layoutManager glyphIndexForCharacterAtIndex:i];
     CGFloat offset = [layoutManager locationForGlyphAtIndex:glyphIndex].x;
     minOffset = std::min(minOffset, offset);
     if (offset > glyphOffset)
       glyphWidth = std::min(glyphWidth, offset - glyphOffset);
   }
   glyphOffset -= minOffset;
   if (glyphWidth == 0)
     glyphWidth = inputWidth - glyphOffset;
   if (isContentsRTL)
     glyphOffset += glyphWidth;
   return isRTL ? (inputWidth - glyphOffset) : glyphOffset;
 }
 
 @end