Reverse bookmark buttons and menus in RTL

chrome/browser/ui/cocoa/bookmarks/bookmark_button_cell.mm

 // Copyright (c) 2011 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/bookmarks/bookmark_button_cell.h"
 
 #include "base/logging.h"
 #include "base/strings/sys_string_conversions.h"
 #include "chrome/browser/ui/cocoa/bookmarks/bookmark_bar_constants.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_button.h"
 #import "chrome/browser/ui/cocoa/bookmarks/bookmark_context_menu_cocoa_controller.h"
+#include "chrome/browser/ui/cocoa/l10n_util.h"
 #include "chrome/grit/generated_resources.h"
 #import "components/bookmarks/browser/bookmark_model.h"
 #include "content/public/browser/user_metrics.h"
 #import "ui/base/cocoa/nsview_additions.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 #include "ui/base/material_design/material_design_controller.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/resources/grit/ui_resources.h"
 
 using base::UserMetricsAction;
 using bookmarks::BookmarkNode;
 
 namespace {
 
-// Padding on the right side of the arrow icon.
-const int kHierarchyButtonRightPadding = 4;
+// Padding on the trailing side of the arrow icon.
+const int kHierarchyButtonTrailingPadding = 4;
 
-// Padding on the left side of the arrow icon.
-const int kHierarchyButtonLeftPadding = 11;
+// Padding on the leading side of the arrow icon.
+const int kHierarchyButtonLeadingPadding = 11;
 
 const int kIconTextSpacer = 4;
-const int kTextRightPadding = 4;
-const int kIconLeftPadding = 4;
+const int kTextTrailingPadding = 4;
+const int kIconLeadingPadding = 4;
 
 const int kDefaultFontSize = 12;
 
 };  // namespace
 
 @interface OffTheSideButtonCell : BookmarkButtonCell
 
 - (NSString*)accessibilityTitle;
 
 @end
@@ skipping 126 matching lines @@
 
 - (BOOL)isOffTheSideButtonCell {
   return NO;
 }
 
 // Perform all normal init routines specific to the BookmarkButtonCell.
 - (void)configureBookmarkButtonCell {
   [self setButtonType:NSMomentaryPushInButton];
   [self setShowsBorderOnlyWhileMouseInside:YES];
   [self setControlSize:NSSmallControlSize];
-  [self setAlignment:NSLeftTextAlignment];
+  [self setAlignment:NSNaturalTextAlignment];
   [self setFont:[NSFont systemFontOfSize:kDefaultFontSize]];
   [self setBordered:NO];
   [self setBezeled:NO];
   [self setWraps:NO];
   // NSLineBreakByTruncatingMiddle seems more common on OSX but let's
   // try to match Windows for a bit to see what happens.
   [self setLineBreakMode:NSLineBreakByTruncatingTail];
 
   // The overflow button chevron bitmap is not 16 units high, so it'd be scaled
   // at paint time without this.
@@ skipping 21 matching lines @@
 }
 
 - (void)setBookmarkCellText:(NSString*)title
                       image:(NSImage*)image {
   title = [title stringByReplacingOccurrencesOfString:@"\n"
                                            withString:@" "];
   title = [title stringByReplacingOccurrencesOfString:@"\r"
                                            withString:@" "];
 
   if ([title length]) {
-    [self setImagePosition:NSImageLeft];
+    [self setImagePosition:cocoa_l10n_util::LeadingCellImagePosition()];
     [self setTitle:title];
   } else if ([self isFolderButtonCell]) {
     // Left-align icons for bookmarks within folders, regardless of whether
     // there is a title.
-    [self setImagePosition:NSImageLeft];
+    [self setImagePosition:cocoa_l10n_util::LeadingCellImagePosition()];
   } else {
     // For bookmarks without a title that aren't visible directly in the
     // bookmarks bar, squeeze things tighter by displaying only the image.
     // By default, Cocoa leaves extra space in an attempt to display an
     // empty title.
     [self setImagePosition:NSImageOnly];
   }
 
   if (image)
     [self setImage:image];
@@ skipping 57 matching lines @@
 // See comment above mouseEntered:, above.
 - (void)mouseExited:(NSEvent*)event {
   [[self controlView] mouseExited:event];
   [super mouseExited:event];
 }
 
 - (void)setDrawFolderArrow:(BOOL)draw {
   drawFolderArrow_ = draw;
   if (draw && !arrowImage_) {
     ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
-    arrowImage_.reset(
-        [rb.GetNativeImageNamed(IDR_MENU_HIERARCHY_ARROW).ToNSImage() retain]);
+    NSImage* image =
+        rb.GetNativeImageNamed(IDR_MENU_HIERARCHY_ARROW).ToNSImage();
+    if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout())
+      image = cocoa_l10n_util::FlippedImage(image);
+    arrowImage_.reset([image retain]);
   }
 }
 
 - (NSDictionary*)titleTextAttributes {
   base::scoped_nsobject<NSMutableParagraphStyle> style(
       [NSMutableParagraphStyle new]);
   [style setAlignment:NSNaturalTextAlignment];
   [style setLineBreakMode:NSLineBreakByTruncatingTail];
   NSColor* textColor = textColor_.get();
   if (!textColor) {
@@ skipping 18 matching lines @@
 - (NSString*)visibleTitle {
   return [self imagePosition] != NSImageOnly ? [self title] : @"";
 }
 
 // Add extra size for the arrow so it doesn't overlap the text.
 // Does not sanity check to be sure this is actually a folder node.
 - (NSSize)cellSize {
   NSSize cellSize = NSZeroSize;
   // Return the space needed to display the image and title, with a little
   // distance between them.
-  cellSize = NSMakeSize(kIconLeftPadding + [[self image] size].width,
+  cellSize = NSMakeSize(kIconLeadingPadding + [[self image] size].width,
                         bookmarks::kBookmarkButtonHeight);
   NSString* title = [self visibleTitle];
   if ([title length] > 0) {
     CGFloat textWidth =
         [title sizeWithAttributes:[self titleTextAttributes]].width;
     cellSize.width +=
-        kIconTextSpacer + std::ceil(textWidth) + kTextRightPadding;
+        kIconTextSpacer + std::ceil(textWidth) + kTextTrailingPadding;
   } else {
     // Make buttons without visible titles 20pts wide (18 plus padding).
-    cellSize.width += kIconLeftPadding;
+    cellSize.width += kIconLeadingPadding;
   }
 
   if (drawFolderArrow_) {
     cellSize.width += [arrowImage_ size].width +
-                      kHierarchyButtonLeftPadding +
-                      kHierarchyButtonRightPadding;
+                      kHierarchyButtonLeadingPadding +
+                      kHierarchyButtonTrailingPadding;
   }
+  // GradientButtonCell adds a 1px inset.
+  cellSize.width += 2;

[shrike, 2016/12/02 00:28:07]

The inset should be a value returned by an instance method, so that
BookmarkButtonCell can access it without needing to know anything about special
constants being used within in GradientButtonCell.

In GradientButtonCell the -inset method (or whatever you call it) should return
a kBlahBlahBlah - style constant rather than a raw int.

[lgrey, 2016/12/02 18:07:43]

Done. shrike@ PTAL

Turns out it's not actually a constant -- I got thrown by a local with a "k"
prefix in the relevant GradientButtonCell method (also renamed this for
posterity.)

   return cellSize;
 }
 
 - (NSRect)imageRectForBounds:(NSRect)theRect {
   NSRect imageRect = [super imageRectForBounds:theRect];
-  // Add a little space between the image and the button's left edge, but only
-  // if there's a visible title.
+  // Compensate by 1px since |theRect| is inset by 1px
+  // from the size calculated in |cellSize|.
   imageRect.origin.y -= 1;
-  imageRect.origin.x = kIconLeftPadding;
+  imageRect.origin.x =
+      cocoa_l10n_util::ShouldDoExperimentalRTLLayout()
+          ? NSMaxX(theRect) - kIconLeadingPadding - NSWidth(imageRect)
+          // Compensate for the inset
+          : kIconLeadingPadding + 1;
   return imageRect;
 }
 
-- (CGFloat)textStartXOffset {
-  return kIconLeftPadding + [[self image] size].width + kIconTextSpacer;
+- (NSRect)titleRectForBounds:(NSRect)theRect {
+  NSRect textRect = [super titleRectForBounds:theRect];
+  NSRect imageRect = [self imageRectForBounds:theRect];
+  if (cocoa_l10n_util::ShouldDoExperimentalRTLLayout()) {
+    textRect.origin.x = drawFolderArrow_
+                            ? [arrowImage_ size].width +
+                                  kHierarchyButtonTrailingPadding +
+                                  kTextTrailingPadding
+                            : kTextTrailingPadding;
+    // Compensate for the 1px inset
+    textRect.origin.x += 1;
+    textRect.size.width =
+        NSMinX(imageRect) - textRect.origin.x - kIconTextSpacer;
+  } else {
+    textRect.origin.x = NSMaxX(imageRect) + kIconTextSpacer;
+  }
+  return textRect;
 }
 
 - (void)drawFocusRingMaskWithFrame:(NSRect)cellFrame
                             inView:(NSView*)controlView {
   // We have to adjust the focus ring slightly for the chevron and regular
   // bookmark icons.
   if ([self isOffTheSideButtonCell]) {
     cellFrame.origin.y -= 2;
   } else if ([self visibleTitle].length > 0) {
     cellFrame.origin.x += 4;
@@ skipping 11 matching lines @@
 
   // If asked to do so, and if a folder, draw the arrow.
   if (!drawFolderArrow_)
     return;
   BookmarkButton* button = static_cast<BookmarkButton*>([self controlView]);
   DCHECK([button respondsToSelector:@selector(isFolder)]);
   if ([button isFolder]) {
     NSRect imageRect = NSZeroRect;
     imageRect.size = [arrowImage_ size];
     const CGFloat kArrowOffset = 1.0;  // Required for proper centering.
-    CGFloat dX =
-        NSWidth(cellFrame) - NSWidth(imageRect) - kHierarchyButtonRightPadding;
+    CGFloat dX = cocoa_l10n_util::ShouldDoExperimentalRTLLayout()
+                     ? kHierarchyButtonTrailingPadding
+                     : NSWidth(cellFrame) - NSWidth(imageRect) -
+                           kHierarchyButtonTrailingPadding;
     CGFloat dY = (NSHeight(cellFrame) / 2.0) - (NSHeight(imageRect) / 2.0) +
         kArrowOffset;
     NSRect drawRect = NSOffsetRect(imageRect, dX, dY);
     [arrowImage_ drawInRect:drawRect
                     fromRect:imageRect
                    operation:NSCompositeSourceOver
                     fraction:[self isEnabled] ? 1.0 : 0.5
               respectFlipped:YES
                        hints:nil];
   }
 }
 
 - (int)verticalTextOffset {
   return -1;
 }
 
 - (CGFloat)hoverBackgroundVerticalOffsetInControlView:(NSView*)controlView {
   // In Material Design on Retina, and not in a folder menu, nudge the hover
   // background by 1px.
   const CGFloat kLineWidth = [controlView cr_lineWidth];
   if ([self isMaterialDesignButtonType] && ![self isFolderButtonCell] &&
       kLineWidth < 1) {
     return -kLineWidth;
   }
   return 0.0;
 }
 
 
 @end