[Mac] Reverse the omnibox in RTL

chrome/browser/ui/cocoa/location_bar/autocomplete_text_field_unittest.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.
 
 #import <ApplicationServices/ApplicationServices.h>
 #import <Cocoa/Cocoa.h>
 
 #include "base/mac/foundation_util.h"
 #include "base/mac/scoped_nsobject.h"
 #import "chrome/browser/ui/cocoa/location_bar/autocomplete_text_field.h"
@@ skipping 67 matching lines @@
     NSRect frame = NSMakeRect(0, 0, kWidth, 30);
     base::scoped_nsobject<AutocompleteTextField> field(
         [[AutocompleteTextField alloc] initWithFrame:frame]);
     field_ = field.get();
     [field_ setStringValue:@"Test test"];
     [[test_window() contentView] addSubview:field_];
 
     AutocompleteTextFieldCell* cell = [field_ cell];
     [cell clearDecorations];
 
-    mock_left_decoration_.SetVisible(false);
-    [cell addLeftDecoration:&mock_left_decoration_];
+    mock_leading_decoration_.SetVisible(false);
+    [cell addLeadingDecoration:&mock_leading_decoration_];
 
-    mock_right_decoration_.SetVisible(false);
-    [cell addRightDecoration:&mock_right_decoration_];
+    mock_trailing_decoration_.SetVisible(false);
+    [cell addTrailingDecoration:&mock_trailing_decoration_];
 
     window_delegate_.reset(
         [[AutocompleteTextFieldWindowTestDelegate alloc] init]);
     [test_window() setDelegate:window_delegate_.get()];
   }
 
   NSEvent* KeyDownEventWithFlags(NSUInteger flags) {
     return [NSEvent keyEventWithType:NSKeyDown
                             location:NSZeroPoint
                        modifierFlags:flags
@@ skipping 18 matching lines @@
       return NSZeroRect;
     }
   }
 
   AutocompleteTextFieldEditor* FieldEditor() {
     return base::mac::ObjCCastStrict<AutocompleteTextFieldEditor>(
         [field_ currentEditor]);
   }
 
   AutocompleteTextField* field_;
-  MockDecoration mock_left_decoration_;
-  MockDecoration mock_right_decoration_;
+  MockDecoration mock_leading_decoration_;
+  MockDecoration mock_trailing_decoration_;
   base::scoped_nsobject<AutocompleteTextFieldWindowTestDelegate>
       window_delegate_;
 };
 
 TEST_VIEW(AutocompleteTextFieldTest, field_);
 
 // Base class for testing AutocompleteTextFieldObserver messages.
 class AutocompleteTextFieldObserverTest : public AutocompleteTextFieldTest {
  public:
   virtual void SetUp() {
@@ skipping 146 matching lines @@
 // Test that the field editor gets the same bounds when focus is
 // delivered by the standard focusing machinery, or by
 // -resetFieldEditorFrameIfNeeded.
 TEST_F(AutocompleteTextFieldTest, ResetFieldEditorBase) {
   // Capture the editor frame resulting from the standard focus
   // machinery.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   const NSRect baseEditorFrame = EditorFrame();
 
   // A decoration should result in a strictly smaller editor frame.
-  mock_left_decoration_.SetVisible(true);
+  mock_leading_decoration_.SetVisible(true);
   [field_ resetFieldEditorFrameIfNeeded];
   EXPECT_NSNE(baseEditorFrame, EditorFrame());
   EXPECT_TRUE(NSContainsRect(baseEditorFrame, EditorFrame()));
 
   // Removing the decoration and using -resetFieldEditorFrameIfNeeded
   // should result in the same frame as the standard focus machinery.
-  mock_left_decoration_.SetVisible(false);
+  mock_leading_decoration_.SetVisible(false);
   [field_ resetFieldEditorFrameIfNeeded];
   EXPECT_NSEQ(baseEditorFrame, EditorFrame());
 }
 
 // Test that the field editor gets the same bounds when focus is
 // delivered by the standard focusing machinery, or by
 // -resetFieldEditorFrameIfNeeded, this time with a decoration
 // pre-loaded.
 TEST_F(AutocompleteTextFieldTest, ResetFieldEditorWithDecoration) {
   AutocompleteTextFieldCell* cell = [field_ cell];
 
   // Make sure decoration isn't already visible, then make it visible.
-  EXPECT_TRUE(NSIsEmptyRect([cell frameForDecoration:&mock_left_decoration_
+  EXPECT_TRUE(NSIsEmptyRect([cell frameForDecoration:&mock_leading_decoration_
                                              inFrame:[field_ bounds]]));
-  mock_left_decoration_.SetVisible(true);
-  EXPECT_FALSE(NSIsEmptyRect([cell frameForDecoration:&mock_left_decoration_
+  mock_leading_decoration_.SetVisible(true);
+  EXPECT_FALSE(NSIsEmptyRect([cell frameForDecoration:&mock_leading_decoration_
                                               inFrame:[field_ bounds]]));
 
   // Capture the editor frame resulting from the standard focus
   // machinery.
 
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   const NSRect baseEditorFrame = EditorFrame();
 
   // When the decoration is not visible the frame should be strictly larger.
-  mock_left_decoration_.SetVisible(false);
-  EXPECT_TRUE(NSIsEmptyRect([cell frameForDecoration:&mock_left_decoration_
+  mock_leading_decoration_.SetVisible(false);
+  EXPECT_TRUE(NSIsEmptyRect([cell frameForDecoration:&mock_leading_decoration_
                                              inFrame:[field_ bounds]]));
   [field_ resetFieldEditorFrameIfNeeded];
   EXPECT_NSNE(baseEditorFrame, EditorFrame());
   EXPECT_TRUE(NSContainsRect(EditorFrame(), baseEditorFrame));
 
   // When the decoration is visible, -resetFieldEditorFrameIfNeeded
   // should result in the same frame as the standard focus machinery.
-  mock_left_decoration_.SetVisible(true);
-  EXPECT_FALSE(NSIsEmptyRect([cell frameForDecoration:&mock_left_decoration_
+  mock_leading_decoration_.SetVisible(true);
+  EXPECT_FALSE(NSIsEmptyRect([cell frameForDecoration:&mock_leading_decoration_
                                               inFrame:[field_ bounds]]));
 
   [field_ resetFieldEditorFrameIfNeeded];
   EXPECT_NSEQ(baseEditorFrame, EditorFrame());
 }
 
 // Test that resetting the field editor bounds does not cause untoward
 // messages to the field's observer.
 TEST_F(AutocompleteTextFieldObserverTest, ResetFieldEditorContinuesEditing) {
   // Many of these methods try to change the selection.
   EXPECT_CALL(field_observer_, SelectionRangeForProposedRange(A<NSRange>()))
       .WillRepeatedly(ReturnArg<0>());
 
   EXPECT_CALL(field_observer_, OnSetFocus(false));
   // Becoming first responder doesn't begin editing.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   const NSRect baseEditorFrame = EditorFrame();
   NSTextView* editor = static_cast<NSTextView*>([field_ currentEditor]);
   EXPECT_TRUE(nil != editor);
 
   // This should begin editing and indicate a change.
   EXPECT_CALL(field_observer_, OnDidBeginEditing());
   EXPECT_CALL(field_observer_, OnBeforeChange());
   EXPECT_CALL(field_observer_, OnDidChange());
   [editor shouldChangeTextInRange:NSMakeRange(0, 0) replacementString:@""];
   [editor didChangeText];
 
   // No messages to |field_observer_| when the frame actually changes.
-  mock_left_decoration_.SetVisible(true);
+  mock_leading_decoration_.SetVisible(true);
   [field_ resetFieldEditorFrameIfNeeded];
   EXPECT_NSNE(baseEditorFrame, EditorFrame());
 }
 
 // Clicking in a right-hand decoration which does not handle the mouse
 // puts the caret rightmost.
 TEST_F(AutocompleteTextFieldTest, ClickRightDecorationPutsCaretRightmost) {
   // Decoration does not handle the mouse event, so the cell should
   // process it.  Called at least once.
-  EXPECT_CALL(mock_right_decoration_, AcceptsMousePress())
+  EXPECT_CALL(mock_trailing_decoration_, AcceptsMousePress())
       .WillOnce(Return(false))
       .WillRepeatedly(Return(false));
 
   // Set the decoration before becoming responder.
   EXPECT_FALSE([field_ currentEditor]);
-  mock_right_decoration_.SetVisible(true);
+  mock_trailing_decoration_.SetVisible(true);
 
   // Make first responder should select all.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   EXPECT_TRUE([field_ currentEditor]);
   const NSRange allRange = NSMakeRange(0, [[field_ stringValue] length]);
   EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
 
   // Generate a click on the decoration.
   AutocompleteTextFieldCell* cell = [field_ cell];
   const NSRect bounds = [field_ bounds];
   const NSRect iconFrame =
-      [cell frameForDecoration:&mock_right_decoration_ inFrame:bounds];
+      [cell frameForDecoration:&mock_trailing_decoration_ inFrame:bounds];
   const NSPoint point = NSMakePoint(NSMidX(iconFrame), NSMidY(iconFrame));
   NSEvent* downEvent = Event(field_, point, NSLeftMouseDown);
   NSEvent* upEvent = Event(field_, point, NSLeftMouseUp);
   [NSApp postEvent:upEvent atStart:YES];
   [field_ mouseDown:downEvent];
 
   // Selection should be a right-hand-side caret.
   EXPECT_TRUE(NSEqualRanges(NSMakeRange([[field_ stringValue] length], 0),
                             [[field_ currentEditor] selectedRange]));
 }
 
 // Clicking in a left-side decoration which doesn't handle the event
 // puts the selection in the leftmost position.
 TEST_F(AutocompleteTextFieldTest, ClickLeftDecorationPutsCaretLeftmost) {
   // Decoration does not handle the mouse event, so the cell should
   // process it.  Called at least once.
-  EXPECT_CALL(mock_left_decoration_, AcceptsMousePress())
+  EXPECT_CALL(mock_leading_decoration_, AcceptsMousePress())
       .WillOnce(Return(false))
       .WillRepeatedly(Return(false));
 
   // Set the decoration before becoming responder.
   EXPECT_FALSE([field_ currentEditor]);
-  mock_left_decoration_.SetVisible(true);
+  mock_leading_decoration_.SetVisible(true);
 
   // Make first responder should select all.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   EXPECT_TRUE([field_ currentEditor]);
   const NSRange allRange = NSMakeRange(0, [[field_ stringValue] length]);
   EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
 
   // Generate a click on the decoration.
   AutocompleteTextFieldCell* cell = [field_ cell];
   const NSRect bounds = [field_ bounds];
   const NSRect iconFrame =
-      [cell frameForDecoration:&mock_left_decoration_ inFrame:bounds];
+      [cell frameForDecoration:&mock_leading_decoration_ inFrame:bounds];
   const NSPoint point = NSMakePoint(NSMidX(iconFrame), NSMidY(iconFrame));
   NSEvent* downEvent = Event(field_, point, NSLeftMouseDown);
   NSEvent* upEvent = Event(field_, point, NSLeftMouseUp);
   [NSApp postEvent:upEvent atStart:YES];
   [field_ mouseDown:downEvent];
 
   // Selection should be a left-hand-side caret.
   EXPECT_TRUE(NSEqualRanges(NSMakeRange(0, 0),
                             [[field_ currentEditor] selectedRange]));
 }
@@ skipping 108 matching lines @@
   const NSRange selectedRange([[field_ currentEditor] selectedRange]);
   EXPECT_EQ(selectedRange.location, 0U);
   EXPECT_EQ(selectedRange.length, [[field_ stringValue] length]);
 }
 
 // Clicking a decoration should call decoration's OnMousePressed.
 TEST_F(AutocompleteTextFieldTest, LeftDecorationMouseDown) {
   // At this point, not focussed.
   EXPECT_FALSE([field_ currentEditor]);
 
-  mock_left_decoration_.SetVisible(true);
-  EXPECT_CALL(mock_left_decoration_, AcceptsMousePress())
+  mock_leading_decoration_.SetVisible(true);
+  EXPECT_CALL(mock_leading_decoration_, AcceptsMousePress())
       .WillRepeatedly(Return(true));
 
   AutocompleteTextFieldCell* cell = [field_ cell];
   [cell updateMouseTrackingAndToolTipsInRect:[field_ frame] ofView:field_];
 
-  const NSRect iconFrame =
-      [cell frameForDecoration:&mock_left_decoration_ inFrame:[field_ bounds]];
+  const NSRect iconFrame = [cell frameForDecoration:&mock_leading_decoration_
+                                            inFrame:[field_ bounds]];
   const NSPoint location = NSMakePoint(NSMidX(iconFrame), NSMidY(iconFrame));
   NSEvent* downEvent = Event(field_, location, NSLeftMouseDown, 1);
   NSEvent* upEvent = Event(field_, location, NSLeftMouseUp, 1);
 
   // Since decorations can be dragged, the mouse-press is sent on
   // mouse-up.
   [NSApp postEvent:upEvent atStart:YES];
 
-  EXPECT_CALL(mock_left_decoration_, OnMousePressed(_, _))
+  EXPECT_CALL(mock_leading_decoration_, OnMousePressed(_, _))
       .WillOnce(Return(true));
   [field_ mouseDown:downEvent];
 
   // Focus the field and test that handled clicks don't affect selection.
   [test_window() makePretendKeyWindowAndSetFirstResponder:field_];
   EXPECT_TRUE([field_ currentEditor]);
   const NSRange allRange = NSMakeRange(0, [[field_ stringValue] length]);
   EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
 
   // Generate another click on the decoration.
   downEvent = Event(field_, location, NSLeftMouseDown, 1);
   upEvent = Event(field_, location, NSLeftMouseUp, 1);
   [NSApp postEvent:upEvent atStart:YES];
-  EXPECT_CALL(mock_left_decoration_, OnMousePressed(_, _))
+  EXPECT_CALL(mock_leading_decoration_, OnMousePressed(_, _))
       .WillOnce(Return(true));
   [field_ mouseDown:downEvent];
 
   // The selection should not have changed.
   EXPECT_TRUE(NSEqualRanges(allRange, [[field_ currentEditor] selectedRange]));
 
   // TODO(shess): Test that mouse drags are initiated if the next
   // event is a drag, or if the mouse-up takes too long to arrive.
   // IDEA: mock decoration to return a pasteboard which a mock
   // AutocompleteTextField notes in -dragImage:*.
 }
 
 // Clicking a decoration should call decoration's OnMousePressed.
 TEST_F(AutocompleteTextFieldTest, RightDecorationMouseDown) {
   // At this point, not focussed.
   EXPECT_FALSE([field_ currentEditor]);
 
-  mock_right_decoration_.SetVisible(true);
-  EXPECT_CALL(mock_right_decoration_, AcceptsMousePress())
+  mock_trailing_decoration_.SetVisible(true);
+  EXPECT_CALL(mock_trailing_decoration_, AcceptsMousePress())
       .WillRepeatedly(Return(true));
 
   AutocompleteTextFieldCell* cell = [field_ cell];
   [cell updateMouseTrackingAndToolTipsInRect:[field_ frame] ofView:field_];
 
   const NSRect bounds = [field_ bounds];
   const NSRect iconFrame =
-      [cell frameForDecoration:&mock_right_decoration_ inFrame:bounds];
+      [cell frameForDecoration:&mock_trailing_decoration_ inFrame:bounds];
   const NSPoint location = NSMakePoint(NSMidX(iconFrame), NSMidY(iconFrame));
   NSEvent* downEvent = Event(field_, location, NSLeftMouseDown, 1);
   NSEvent* upEvent = Event(field_, location, NSLeftMouseUp, 1);
 
   // Since decorations can be dragged, the mouse-press is sent on
   // mouse-up.
   [NSApp postEvent:upEvent atStart:YES];
 
-  EXPECT_CALL(mock_right_decoration_, OnMousePressed(_, _))
+  EXPECT_CALL(mock_trailing_decoration_, OnMousePressed(_, _))
       .WillOnce(Return(true));
   [field_ mouseDown:downEvent];
 }
 
 // Test that page action menus are properly returned.
 // TODO(shess): Really, this should test that things are forwarded to
 // the cell, and the cell tests should test that the right things are
 // selected.  It's easier to mock the event here, though.  This code's
 // event-mockers might be worth promoting to |cocoa_test_event_utils.h| or
 // |cocoa_test_helper.h|.
 TEST_F(AutocompleteTextFieldTest, DecorationMenu) {
   AutocompleteTextFieldCell* cell = [field_ cell];
   const NSRect bounds([field_ bounds]);
 
   const CGFloat edge = NSHeight(bounds) - 4.0;
   const NSSize size = NSMakeSize(edge, edge);
   base::scoped_nsobject<NSImage> image([[NSImage alloc] initWithSize:size]);
 
   base::scoped_nsobject<NSMenu> menu([[NSMenu alloc] initWithTitle:@"Menu"]);
 
-  mock_left_decoration_.SetVisible(true);
-  mock_right_decoration_.SetVisible(true);
+  mock_leading_decoration_.SetVisible(true);
+  mock_trailing_decoration_.SetVisible(true);
 
   // The item with a menu returns it.
-  NSRect actionFrame = [cell frameForDecoration:&mock_right_decoration_
-                                        inFrame:bounds];
+  NSRect actionFrame =
+      [cell frameForDecoration:&mock_trailing_decoration_ inFrame:bounds];
   NSPoint location = NSMakePoint(NSMidX(actionFrame), NSMidY(actionFrame));
   NSEvent* event = Event(field_, location, NSRightMouseDown, 1);
 
   // Check that the decoration is called, and the field returns the
   // menu.
-  EXPECT_CALL(mock_right_decoration_, GetMenu())
+  EXPECT_CALL(mock_trailing_decoration_, GetMenu())
       .WillOnce(Return(menu.get()));
   NSMenu *decorationMenu = [field_ decorationMenuForEvent:event];
   EXPECT_EQ(decorationMenu, menu);
 
   // The item without a menu returns nil.
-  EXPECT_CALL(mock_left_decoration_, GetMenu())
+  EXPECT_CALL(mock_leading_decoration_, GetMenu())
       .WillOnce(Return(static_cast<NSMenu*>(nil)));
-  actionFrame = [cell frameForDecoration:&mock_left_decoration_
-                                 inFrame:bounds];
+  actionFrame =
+      [cell frameForDecoration:&mock_leading_decoration_ inFrame:bounds];
   location = NSMakePoint(NSMidX(actionFrame), NSMidY(actionFrame));
   event = Event(field_, location, NSRightMouseDown, 1);
   EXPECT_FALSE([field_ decorationMenuForEvent:event]);
 
   // Something not in an action returns nil.
   location = NSMakePoint(NSMidX(bounds), NSMidY(bounds));
   event = Event(field_, location, NSRightMouseDown, 1);
   EXPECT_FALSE([field_ decorationMenuForEvent:event]);
 }
 
@@ skipping 107 matching lines @@
   [[field_ cell] setHideFocusState:NO
                             ofView:field_];
   EXPECT_TRUE([[field_ cell] showsFirstResponder]);
   EXPECT_TRUE([FieldEditor() shouldDrawInsertionPoint]);
 }
 
 // Verify that the tracking areas are added properly.
 TEST_F(AutocompleteTextFieldTest, UpdateTrackingAreas) {
   AutocompleteTextFieldCell* cell = [field_ cell];
 
-  mock_left_decoration_.SetVisible(true);
-  mock_right_decoration_.SetVisible(true);
+  mock_leading_decoration_.SetVisible(true);
+  mock_trailing_decoration_.SetVisible(true);
 
-  EXPECT_CALL(mock_left_decoration_, AcceptsMousePress())
+  EXPECT_CALL(mock_leading_decoration_, AcceptsMousePress())
       .WillOnce(Return(true))
       .WillRepeatedly(Return(true));
-  EXPECT_CALL(mock_right_decoration_, AcceptsMousePress())
+  EXPECT_CALL(mock_trailing_decoration_, AcceptsMousePress())
       .WillOnce(Return(false))
       .WillRepeatedly(Return(false));
   [cell updateMouseTrackingAndToolTipsInRect:[field_ bounds] ofView:field_];
 
   EXPECT_EQ([cell mouseTrackingDecorations].size(), 1.0);
 
   [cell clearTrackingArea];
   EXPECT_TRUE([cell mouseTrackingDecorations].empty());
 
-  EXPECT_CALL(mock_right_decoration_, AcceptsMousePress())
+  EXPECT_CALL(mock_trailing_decoration_, AcceptsMousePress())
       .WillOnce(Return(true))
       .WillRepeatedly(Return(true));
 
   [cell updateMouseTrackingAndToolTipsInRect:[field_ bounds] ofView:field_];
   EXPECT_EQ([cell mouseTrackingDecorations].size(), 2.0);
 }
 
 // Verify that clicking a decoration that accepts mouse clicks does not focus
 // the Omnibox.
 TEST_F(AutocompleteTextFieldObserverTest,
        ClickingDecorationDoesNotFocusOmnibox) {
   AutocompleteTextFieldCell* cell = [field_ cell];
 
   // Set up a non-interactive decoration.
   MockDecoration noninteractive_decoration;
   noninteractive_decoration.SetVisible(true);
   EXPECT_CALL(noninteractive_decoration, AcceptsMousePress())
       .WillRepeatedly(testing::Return(false));
-  [cell addLeftDecoration:&noninteractive_decoration];
+  [cell addLeadingDecoration:&noninteractive_decoration];
 
   // Set up an interactive decoration.
   MockDecoration interactive_decoration;
   EXPECT_CALL(interactive_decoration, AcceptsMousePress())
       .WillRepeatedly(testing::Return(true));
   interactive_decoration.SetVisible(true);
-  [cell addLeftDecoration:&interactive_decoration];
+  [cell addLeadingDecoration:&interactive_decoration];
   [cell updateMouseTrackingAndToolTipsInRect:[field_ frame] ofView:field_];
   EXPECT_CALL(interactive_decoration, OnMousePressed(_, _))
       .WillRepeatedly(testing::Return(true));
 
   // Ignore incidental calls. The exact frequency of these calls doesn't matter
   // as they are auxiliary.
   EXPECT_CALL(field_observer_, SelectionRangeForProposedRange(_))
       .WillRepeatedly(testing::Return(NSMakeRange(0, 0)));
   EXPECT_CALL(field_observer_, OnMouseDown(_)).Times(testing::AnyNumber());
   EXPECT_CALL(field_observer_, OnSetFocus(false)).Times(testing::AnyNumber());
@@ skipping 72 matching lines @@
   base::scoped_nsobject<AutocompleteTextField> pin([field_ retain]);
   [field_ removeFromSuperview];
   [test_window() resignKeyWindow];
 
   [[test_window() contentView] addSubview:field_];
   EXPECT_CALL(field_observer_, ClosePopup());
   [test_window() resignKeyWindow];
 }
 
 }  // namespace