Omnibox UI Experiments: Port Vertical Layout experiment to Mac Cocoa.

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 <stddef.h>
 
 #include <algorithm>
 #include <cmath>
 
+#include "base/feature_list.h"
 #include "base/i18n/rtl.h"
 #include "base/mac/foundation_util.h"
 #include "base/mac/objc_property_releaser.h"
 #include "base/mac/scoped_nsobject.h"
 #include "base/metrics/field_trial_params.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"
@@ skipping 11 matching lines @@
 
 namespace {
 
 // Extra padding beyond the vertical text padding.
 constexpr CGFloat kMaterialExtraVerticalImagePadding = 2.0;
 
 constexpr CGFloat kMaterialTextStartOffset = 27.0;
 
 constexpr CGFloat kMaterialImageXOffset = 6.0;
 
+constexpr CGFloat kDefaultVerticalMargin = 3.0;
+
+constexpr CGFloat kDefaultTextHeight = 19;
+
 // Returns the margin that should appear at the top and bottom of the result.
 CGFloat GetVerticalMargin() {
-  constexpr CGFloat kDefaultVerticalMargin = 3.0;
-
   return base::GetFieldTrialParamByFeatureAsInt(
       omnibox::kUIExperimentVerticalMargin,
       OmniboxFieldTrial::kUIVerticalMarginParam, kDefaultVerticalMargin);
 }
 
 // Flips the given |rect| in context of the given |frame|.
 NSRect FlipIfRTL(NSRect rect, NSRect frame) {
   DCHECK_LE(NSMinX(frame), NSMinX(rect));
   DCHECK_GE(NSMaxX(frame), NSMaxX(rect));
   if (base::i18n::IsRTL()) {
@@ skipping 360 matching lines @@
           [CreateAnswerLine(match.answer->second_line(), isDarkTheme) retain];
       maxLines_ = match.answer->second_line().num_text_lines();
     } else {
       contents_ = [CreateClassifiedAttributedString(
           match.contents, ContentTextColor(isDarkTheme), match.contents_class,
           isDarkTheme) retain];
       if (!match.description.empty()) {
         description_ = [CreateClassifiedAttributedString(
             match.description, DimTextColor(isDarkTheme),
             match.description_class, isDarkTheme) retain];
+
+        if (base::FeatureList::IsEnabled(
+                omnibox::kUIExperimentVerticalLayout) &&
+            !AutocompleteMatch::IsSearchType(match.type)) {
+          // Somtimes swap the contents and description in vertical layouts.

[groby-ooo-7-16, 2017/05/31 00:14:51]

When is "sometimes"?

[tommycli, 2017/05/31 18:20:40]

Done.

+          // TODO(tommycli): If vertical layouts become permanent, swap these
+          // in the underlying match instead of the UI code.

[groby-ooo-7-16, 2017/05/31 00:14:51]

Rendering order should not really affect anything *but* UI code. 

[tommycli, 2017/05/31 18:20:40]

Done.

+          NSAttributedString* temp = contents_;

[groby-ooo-7-16, 2017/05/31 00:14:51]

std::swap(contents_, description_)

[tommycli, 2017/05/31 18:20:40]

Done. Always forget that ObjC is also C++ ... or is it... i'm not completely
sure.

+          contents_ = description_;
+          description_ = temp;
+        }
       }
-      maxLines_ = 1;
     }
     propertyReleaser_OmniboxPopupCellData_.Init(self,
                                                 [OmniboxPopupCellData class]);
   }
   return self;
 }
 
 - (instancetype)copyWithZone:(NSZone*)zone {
   return [self retain];
 }
@@ skipping 17 matching lines @@
     } else {
       [HoveredBackgroundColor(isDarkTheme) set];
     }
     NSRectFillUsingOperation(cellFrame, NSCompositeSourceOver);
   }
 
   [self drawMatchWithFrame:cellFrame inView:controlView];
 }
 
 - (void)drawMatchWithFrame:(NSRect)cellFrame inView:(NSView*)controlView {
+  bool isVerticalLayout =
+      base::FeatureList::IsEnabled(omnibox::kUIExperimentVerticalLayout);
+
   OmniboxPopupCellData* cellData =
       base::mac::ObjCCastStrict<OmniboxPopupCellData>([self objectValue]);
   OmniboxPopupMatrix* tableView =
       base::mac::ObjCCastStrict<OmniboxPopupMatrix>(controlView);
   CGFloat remainingWidth = [OmniboxPopupCell getContentAreaWidth:cellFrame] -
                            [tableView contentLeftPadding];
   CGFloat contentsWidth = [cellData getMatchContentsWidth];
   CGFloat separatorWidth = [[tableView separator] size].width;
   CGFloat descriptionWidth =
       [cellData description] ? [[cellData description] size].width : 0;
   int contentsMaxWidth, descriptionMaxWidth;
   OmniboxPopupModel::ComputeMatchMaxWidths(
       ceilf(contentsWidth), ceilf(separatorWidth), ceilf(descriptionWidth),
-      ceilf(remainingWidth),
-      [cellData isAnswer],
-      !AutocompleteMatch::IsSearchType([cellData matchType]),
-      &contentsMaxWidth,
+      ceilf(remainingWidth), [cellData isAnswer] || isVerticalLayout,
+      !AutocompleteMatch::IsSearchType([cellData matchType]), &contentsMaxWidth,
       &descriptionMaxWidth);
 
+  CGFloat halfLineHeight = (kDefaultTextHeight + kDefaultVerticalMargin) / 2;
+
   NSWindow* parentWindow = [[controlView window] parentWindow];
   BOOL isDarkTheme = [parentWindow hasDarkTheme];
   NSRect imageRect = cellFrame;
   NSImage* theImage =
       isDarkTheme ? [cellData incognitoImage] : [cellData image];
   imageRect.size = [theImage size];
   imageRect.origin.x += kMaterialImageXOffset + [tableView contentLeftPadding];
   imageRect.origin.y +=
       GetVerticalMargin() + kMaterialExtraVerticalImagePadding;
+  if (isVerticalLayout)
+    imageRect.origin.y += halfLineHeight;
   [theImage drawInRect:FlipIfRTL(imageRect, cellFrame)
               fromRect:NSZeroRect
              operation:NSCompositeSourceOver
               fraction:1.0
         respectFlipped:YES
                  hints:nil];
 
-  NSPoint origin =
-      NSMakePoint(kMaterialTextStartOffset + [tableView contentLeftPadding],
-                  GetVerticalMargin());
+  CGFloat left = kMaterialTextStartOffset + [tableView contentLeftPadding];
+  NSPoint origin = NSMakePoint(left, GetVerticalMargin());
+
+  // For matches lacking description in vertical layout, center vertically.
+  if (isVerticalLayout && descriptionMaxWidth == 0)
+    origin.y += halfLineHeight;
+
   if ([cellData matchType] == AutocompleteMatchType::SEARCH_SUGGEST_TAIL) {
     // Tail suggestions are rendered with a prefix (usually ellipsis), which
     // appear vertically stacked.
     origin.x += [self drawMatchPrefixWithFrame:cellFrame
                                      tableView:tableView
                           withContentsMaxWidth:&contentsMaxWidth
                                   forDarkTheme:isDarkTheme];
   }
   origin.x += [self drawMatchPart:[cellData contents]
                         withFrame:cellFrame
                            origin:origin
                      withMaxWidth:contentsMaxWidth
                      forDarkTheme:isDarkTheme];
 
   if (descriptionMaxWidth > 0) {
     if ([cellData isAnswer]) {
-      origin = NSMakePoint(
-          kMaterialTextStartOffset + [tableView contentLeftPadding],
-          [OmniboxPopupCell getContentTextHeight] - GetVerticalMargin());
+      origin = NSMakePoint(left, [OmniboxPopupCell getContentTextHeight:false] -
+                                     GetVerticalMargin());
       CGFloat imageSize = [tableView answerLineHeight];
       NSRect imageRect =
           NSMakeRect(NSMinX(cellFrame) + origin.x, NSMinY(cellFrame) + origin.y,
                      imageSize, imageSize);
       [[cellData answerImage] drawInRect:FlipIfRTL(imageRect, cellFrame)
                                 fromRect:NSZeroRect
                                operation:NSCompositeSourceOver
                                 fraction:1.0
                           respectFlipped:YES
                                    hints:nil];
       if ([cellData answerImage]) {
         origin.x += imageSize + kMaterialImageXOffset;
 
         // Have to nudge the baseline down 1pt in Material Design for the text
         // that follows, so that it's the same as the bottom of the image.
         origin.y += 1;
       }
     } else {
-      origin.x += [self drawMatchPart:[tableView separator]
-                            withFrame:cellFrame
-                               origin:origin
-                         withMaxWidth:separatorWidth
-                         forDarkTheme:isDarkTheme];
+      if (isVerticalLayout) {
+        origin.x = left;

[groby-ooo-7-16, 2017/05/31 00:14:51]

If you assign the whole point:

origin = NSMakePoint(left, halfLineHeight * 2);

[tommycli, 2017/05/31 18:20:39]

Hey. I actually need to add to the y coordinate, rather than re-assign it.

[groby-ooo-7-16, 2017/05/31 19:24:16]

And so you do. TIL my brain skips characters at color boundaries, sorry :(

+        origin.y += halfLineHeight * 2;
+      } else {
+        origin.x += [self drawMatchPart:[tableView separator]
+                              withFrame:cellFrame
+                                 origin:origin
+                           withMaxWidth:separatorWidth
+                           forDarkTheme:isDarkTheme];
+      }
     }
-    origin.x += [self drawMatchPart:[cellData description]
-                          withFrame:cellFrame
-                             origin:origin
-                       withMaxWidth:descriptionMaxWidth
-                       forDarkTheme:isDarkTheme];
+    [self drawMatchPart:[cellData description]
+              withFrame:cellFrame
+                 origin:origin
+           withMaxWidth:descriptionMaxWidth
+           forDarkTheme:isDarkTheme];
   }
 }
 
 - (CGFloat)drawMatchPrefixWithFrame:(NSRect)cellFrame
                           tableView:(OmniboxPopupMatrix*)tableView
                withContentsMaxWidth:(int*)contentsMaxWidth
                        forDarkTheme:(BOOL)isDarkTheme {
   OmniboxPopupCellData* cellData =
       base::mac::ObjCCastStrict<OmniboxPopupCellData>([self objectValue]);
   CGFloat offset = 0.0f;
@@ skipping 126 matching lines @@
 + (NSAttributedString*)createSeparatorStringForDarkTheme:(BOOL)isDarkTheme {
   base::string16 raw_separator =
       l10n_util::GetStringUTF16(IDS_AUTOCOMPLETE_MATCH_DESCRIPTION_SEPARATOR);
   return CreateAttributedString(raw_separator, DimTextColor(isDarkTheme));
 }
 
 + (CGFloat)getContentAreaWidth:(NSRect)cellFrame {
   return NSWidth(cellFrame) - kMaterialTextStartOffset;
 }
 
-+ (CGFloat)getContentTextHeight {
-  constexpr CGFloat kDefaultTextHeight = 19;
-  return kDefaultTextHeight + 2 * GetVerticalMargin();
++ (CGFloat)getContentTextHeight:(BOOL)isTwoLine {
+  CGFloat height = kDefaultTextHeight + 2 * GetVerticalMargin();
+  if (isTwoLine)
+    height += kDefaultTextHeight + kDefaultVerticalMargin;
+  return height;
 }
 
 @end