MacViews: Implement move and move*AndModifySelection commands.

ui/views/cocoa/bridged_native_widget_unittest.mm

 // Copyright 2014 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 "ui/views/cocoa/bridged_native_widget.h"
 
 #import <Cocoa/Cocoa.h>
 
 #include <memory>
 
 #import "base/mac/foundation_util.h"
 #import "base/mac/mac_util.h"
 #import "base/mac/sdk_forward_declarations.h"
 #include "base/macros.h"
 #include "base/message_loop/message_loop.h"
+#include "base/strings/stringprintf.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #import "testing/gtest_mac.h"
 #import "ui/base/cocoa/window_size_constants.h"
 #include "ui/base/ime/input_method.h"
 #import "ui/gfx/mac/coordinate_conversion.h"
 #import "ui/gfx/test/ui_cocoa_test_helper.h"
 #import "ui/views/cocoa/bridged_content_view.h"
 #import "ui/views/cocoa/native_widget_mac_nswindow.h"
 #import "ui/views/cocoa/views_nswindow_delegate.h"
@@ skipping 179 matching lines @@
   Widget::InitParams init_params_;
 };
 
 class BridgedNativeWidgetTest : public BridgedNativeWidgetTestBase {
  public:
   BridgedNativeWidgetTest();
   ~BridgedNativeWidgetTest() override;
 
   // Install a textfield with input type |text_input_type| in the view hierarchy
   // and make it the text input client. Also initializes |dummy_text_view_|.
-  void InstallTextField(const std::string& text,
+  void InstallTextField(const base::string16& text,
                         ui::TextInputType text_input_type);
 
   // Install a textfield with input type ui::TEXT_INPUT_TYPE_TEXT in the view
   // hierarchy and make it the text input client. Also initializes
   // |dummy_text_view_|.
+  void InstallTextField(const base::string16& text);
+
   void InstallTextField(const std::string& text);
 
   // Returns the actual current text for |ns_view_|.
   NSString* GetActualText();
 
   // Returns the expected current text from |dummy_text_view_|.
   NSString* GetExpectedText();
 
   // Returns the actual selection range for |ns_view_|.
   NSRange GetActualSelectionRange();
 
   // Returns the expected selection range from |dummy_text_view_|.
   NSRange GetExpectedSelectionRange();
 
   // Set the selection range for the installed textfield and |dummy_text_view_|.
   void SetSelectionRange(NSRange range);
 
   // Perform command |sel| on |ns_view_| and |dummy_text_view_|.
   void PerformCommand(SEL sel);
 
+  // Make selection from |start| to |end| on installed views::Textfield and
+  // |dummy_text_view_|. If |start| > |end|, extend selection to left from
+  // |start|.
+  void MakeSelection(int start, int end);
+
   // testing::Test:
   void SetUp() override;
   void TearDown() override;
 
  protected:
   // Test delete to beginning of line or paragraph based on |sel|. |sel| can be
   // either deleteToBeginningOfLine: or deleteToBeginningOfParagraph:.
   void TestDeleteBeginning(SEL sel);
 
   // Test delete to end of line or paragraph based on |sel|. |sel| can be
   // either deleteToEndOfLine: or deleteToEndOfParagraph:.
   void TestDeleteEnd(SEL sel);
 
+  // Test editing commands in |selectors| against the expectations set by
+  // |dummy_text_view_|. This is done by selecting every substring within a set
+  // of test strings (both RTL and non-RTL) and performing every selector on
+  // both the NSTextView and the BridgedContentView hosting a focused
+  // views::TextField to ensure the resulting text and selection ranges match.
+  // |selectors| is an NSArray of NSStrings.
+  void TestEditingCommands(NSArray* selectors);
+
   std::unique_ptr<views::View> view_;
 
   // Weak. Owned by bridge().
   BridgedContentView* ns_view_;
 
   // An NSTextView which helps set the expectations for our tests.
   base::scoped_nsobject<NSTextView> dummy_text_view_;
 
   base::MessageLoopForUI message_loop_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(BridgedNativeWidgetTest);
 };
 
 BridgedNativeWidgetTest::BridgedNativeWidgetTest() {
 }
 
 BridgedNativeWidgetTest::~BridgedNativeWidgetTest() {
 }
 
 void BridgedNativeWidgetTest::InstallTextField(
-    const std::string& text,
+    const base::string16& text,
     ui::TextInputType text_input_type) {
   Textfield* textfield = new Textfield();
-  textfield->SetText(ASCIIToUTF16(text));
+  textfield->SetText(text);
   textfield->SetTextInputType(text_input_type);
   view_->RemoveAllChildViews(true);
   view_->AddChildView(textfield);
   textfield->SetBoundsRect(init_params_.bounds);
 
   // Request focus so the InputMethod can dispatch events to the RootView, and
   // have them delivered to the textfield. Note that focusing a textfield
   // schedules a task to flash the cursor, so this requires |message_loop_|.
   textfield->RequestFocus();
 
   [ns_view_ setTextInputClient:textfield];
 
   // Initialize the dummy text view.
   dummy_text_view_.reset([[NSTextView alloc] initWithFrame:NSZeroRect]);
-  [dummy_text_view_ setString:SysUTF8ToNSString(text)];
+  [dummy_text_view_ setString:SysUTF16ToNSString(text)];
+}
+
+void BridgedNativeWidgetTest::InstallTextField(const base::string16& text) {
+  InstallTextField(text, ui::TEXT_INPUT_TYPE_TEXT);
 }
 
 void BridgedNativeWidgetTest::InstallTextField(const std::string& text) {
-  InstallTextField(text, ui::TEXT_INPUT_TYPE_TEXT);
+  InstallTextField(base::ASCIIToUTF16(text), ui::TEXT_INPUT_TYPE_TEXT);
 }
 
 NSString* BridgedNativeWidgetTest::GetActualText() {
   NSRange range = NSMakeRange(0, NSUIntegerMax);
   return [[ns_view_ attributedSubstringForProposedRange:range
                                             actualRange:nullptr] string];
 }
 
 NSString* BridgedNativeWidgetTest::GetExpectedText() {
   NSRange range = NSMakeRange(0, NSUIntegerMax);
@@ skipping 15 matching lines @@
   client->SetSelectionRange(gfx::Range(range));
 
   [dummy_text_view_ setSelectedRange:range];
 }
 
 void BridgedNativeWidgetTest::PerformCommand(SEL sel) {
   [ns_view_ doCommandBySelector:sel];
   [dummy_text_view_ doCommandBySelector:sel];
 }
 
+void BridgedNativeWidgetTest::MakeSelection(int start, int end) {
+  ui::TextInputClient* client = [ns_view_ textInputClient];
+  client->SetSelectionRange(gfx::Range(start, end));
+
+  // Though NSTextView has a selectionAffinity property, it does not seem to
+  // correspond to the selection direction. Hence we extend the selection from
+  //|start| to |end|.
+  [dummy_text_view_ setSelectedRange:NSMakeRange(start, 0)];
+  SEL sel = start > end ? @selector(moveBackwardAndModifySelection:)
+                        : @selector(moveForwardAndModifySelection:);
+  size_t delta = std::abs(end - start);
+
+  for (size_t i = 0; i < delta; i++)
+    [dummy_text_view_ doCommandBySelector:sel];
+}
+
 void BridgedNativeWidgetTest::SetUp() {
   BridgedNativeWidgetTestBase::SetUp();
 
   view_.reset(new views::internal::RootView(widget_.get()));
   base::scoped_nsobject<NSWindow> window([test_window() retain]);
 
   // BridgedNativeWidget expects to be initialized with a hidden (deferred)
   // window.
   [window orderOut:nil];
   EXPECT_FALSE([window delegate]);
@@ skipping 67 matching lines @@
 
   // Make a selection as- "|foo |bar".
   SetSelectionRange(NSMakeRange(0, 4));
   PerformCommand(sel);
   // Verify only the selection is deleted so that the state is "|bar".
   EXPECT_NSEQ_3(@"bar", GetExpectedText(), GetActualText());
   EXPECT_EQ_RANGE_3(NSMakeRange(0, 0), GetExpectedSelectionRange(),
                     GetActualSelectionRange());
 }
 
+void BridgedNativeWidgetTest::TestEditingCommands(NSArray* selectors) {
+  const base::string16 test_strings[] = {
+      base::WideToUTF16(L"ab c"),
+      base::WideToUTF16(L"\x0634\x0632 \x064A")  // RTL string.
+  };
+
+  for (const base::string16& test_string : test_strings) {
+    for (NSString* selector_string in selectors) {
+      SEL sel = NSSelectorFromString(selector_string);
+      const int len = test_string.length();
+      for (int i = 0; i <= len; i++) {
+        for (int j = 0; j <= len; j++) {
+          SCOPED_TRACE(base::StringPrintf(
+              "Testing range [%d-%d] for case %s and selector %s\n", i, j,
+              base::UTF16ToUTF8(test_string).c_str(),
+              base::SysNSStringToUTF8(selector_string).c_str()));
+
+          InstallTextField(test_string);
+          MakeSelection(i, j);
+          EXPECT_EQ_RANGE_3(NSMakeRange(std::min(i, j), std::abs(i - j)),
+                            GetExpectedSelectionRange(),
+                            GetActualSelectionRange());
+
+          PerformCommand(sel);
+          EXPECT_NSEQ(GetExpectedText(), GetActualText());
+          EXPECT_EQ_RANGE(GetExpectedSelectionRange(),
+                          GetActualSelectionRange());
+        }
+      }
+    }
+  }
+}
+
 // The TEST_VIEW macro expects the view it's testing to have a superview. In
 // these tests, the NSView bridge is a contentView, at the root. These mimic
 // what TEST_VIEW usually does.
 TEST_F(BridgedNativeWidgetTest, BridgedNativeWidgetTest_TestViewAddRemove) {
   base::scoped_nsobject<BridgedContentView> view([bridge()->ns_view() retain]);
   EXPECT_NSEQ([test_window() contentView], view);
   EXPECT_NSEQ(test_window(), [view window]);
 
   // The superview of a contentView is an NSNextStepFrame.
   EXPECT_TRUE([view superview]);
@@ skipping 113 matching lines @@
   PerformInit();
   EXPECT_TRUE([window_ hasShadow]);  // Preserves shadow.
 
   window_.reset();
   widget_.reset();
 }
 
 // Ensure a nil NSTextInputContext is returned when the ui::TextInputClient is
 // not editable, a password field, or unset.
 TEST_F(BridgedNativeWidgetTest, InputContext) {
-  const std::string test_string = "test_str";
+  const base::string16 test_string = base::ASCIIToUTF16("test_str");
   InstallTextField(test_string, ui::TEXT_INPUT_TYPE_PASSWORD);
   EXPECT_FALSE([ns_view_ inputContext]);
   InstallTextField(test_string, ui::TEXT_INPUT_TYPE_TEXT);
   EXPECT_TRUE([ns_view_ inputContext]);
   [ns_view_ setTextInputClient:nil];
   EXPECT_FALSE([ns_view_ inputContext]);
   InstallTextField(test_string, ui::TEXT_INPUT_TYPE_NONE);
   EXPECT_FALSE([ns_view_ inputContext]);
 }
 
@@ skipping 302 matching lines @@
 }
 
 TEST_F(BridgedNativeWidgetTest, TextInput_DeleteToBeginningOfParagraph) {
   TestDeleteBeginning(@selector(deleteToBeginningOfParagraph:));
 }
 
 TEST_F(BridgedNativeWidgetTest, TextInput_DeleteToEndOfParagraph) {
   TestDeleteEnd(@selector(deleteToEndOfParagraph:));
 }
 
+// Test move commands against expectations set by |dummy_text_view_|.
+TEST_F(BridgedNativeWidgetTest, TextInput_MoveEditingCommands) {
+  NSArray* selectors = @[
+    @"moveForward:",
+    @"moveRight:",
+    @"moveBackward:",
+    @"moveLeft:",
+    @"moveUp:",
+    @"moveDown:",
+    @"moveWordForward:",
+    @"moveWordBackward:",
+    @"moveToBeginningOfLine:",
+    @"moveToEndOfLine:",
+    @"moveToBeginningOfParagraph:",
+    @"moveToEndOfParagraph:",
+    @"moveToEndOfDocument:",
+    @"moveToBeginningOfDocument:",
+    @"pageDown:",
+    @"pageUp:",
+    @"moveWordRight:",
+    @"moveWordLeft:",
+    @"moveToLeftEndOfLine:",
+    @"moveToRightEndOfLine:"
+  ];
+  TestEditingCommands(selectors);
+}
+
+// Todo(karandeepb): Enable this test once the behavior of all move and select
+// commands are fixed.
+// Test move and select commands against expectations set by |dummy_text_view_|.
+TEST_F(BridgedNativeWidgetTest,
+       TextInput_MoveAndSelectEditingCommands_DISABLED) {
+  NSArray* selectors = @[
+    @"moveBackwardAndModifySelection:",
+    @"moveForwardAndModifySelection:",
+    @"moveWordForwardAndModifySelection:",
+    @"moveWordBackwardAndModifySelection:",
+    @"moveUpAndModifySelection:",
+    @"moveDownAndModifySelection:",
+    @"moveToBeginningOfLineAndModifySelection:",
+    @"moveToEndOfLineAndModifySelection:",
+    @"moveToBeginningOfParagraphAndModifySelection:",
+    @"moveToEndOfParagraphAndModifySelection:",
+    @"moveToEndOfDocumentAndModifySelection:",
+    @"moveToBeginningOfDocumentAndModifySelection:",
+    @"pageDownAndModifySelection:",
+    @"pageUpAndModifySelection:",
+    @"moveParagraphForwardAndModifySelection:",
+    @"moveParagraphBackwardAndModifySelection:",
+    @"moveRightAndModifySelection:",
+    @"moveLeftAndModifySelection:",
+    @"moveWordRightAndModifySelection:",
+    @"moveWordLeftAndModifySelection:",
+    @"moveToLeftEndOfLineAndModifySelection:",
+    @"moveToRightEndOfLineAndModifySelection:"
+  ];
+  TestEditingCommands(selectors);
+}
+
+// Test delete commands against expectations set by |dummy_text_view_|.
+TEST_F(BridgedNativeWidgetTest, TextInput_DeleteCommands) {
+  NSArray* selectors = @[
+    @"deleteForward:", @"deleteBackward:", @"deleteWordForward:",
+    @"deleteWordBackward:", @"deleteToBeginningOfLine:", @"deleteToEndOfLine:",
+    @"deleteToBeginningOfParagraph:", @"deleteToEndOfParagraph:"
+  ];
+  TestEditingCommands(selectors);
+}
+
 // Test firstRectForCharacterRange:actualRange for cases where query range is
 // empty or outside composition range.
 TEST_F(BridgedNativeWidgetTest, TextInput_FirstRectForCharacterRange_Caret) {
   InstallTextField("");
   ui::TextInputClient* client = [ns_view_ textInputClient];
 
   // No composition. Ensure bounds and range corresponding to the current caret
   // position are returned.
   // Initially selection range will be [0, 0].
   NSRange caret_range = NSMakeRange(0, 0);
@@ skipping 144 matching lines @@
   [center postNotificationName:NSWindowDidExitFullScreenNotification
                         object:window];
   EXPECT_EQ(1, [window ignoredToggleFullScreenCount]);  // No change.
   EXPECT_FALSE(bridge()->target_fullscreen_state());
 
   widget_->CloseNow();
 }
 
 }  // namespace test
 }  // namespace views