Mac: Implement firstRectForCharacterRange:actualRange in BridgedContentView.

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>
 
 #import "base/mac/foundation_util.h"
 #import "base/mac/mac_util.h"
@@ skipping 25 matching lines @@
   EXPECT_EQ(a.location, b.location); \
   EXPECT_EQ(a.length, b.length);
 
 namespace {
 
 // Empty range shortcut for readibility.
 NSRange EmptyRange() {
   return NSMakeRange(NSNotFound, 0);
 }
 
+// Changes NSRect to gfx::Rect and converts it from Apple's coordinate system
+// (origin at bottom left) to coordinate system with origin at top left.
+gfx::Rect ConvertCoordinateSystem(NSRect rect) {

[tapted, 2015/12/17 08:42:20]

gfx::ScreenRectFromNSRect

[karandeepb, 2015/12/18 09:15:06]

Done.

+  NSRect screen_rect = [[NSScreen mainScreen] frame];
+  rect.origin.y = screen_rect.size.height - NSMaxY(rect);
+  return gfx::Rect(NSRectToCGRect(rect));
+}
+
 }  // namespace
 
 // Class to override -[NSWindow toggleFullScreen:] to a no-op. This simulates
 // NSWindow's behavior when attempting to toggle fullscreen state again, when
 // the last attempt failed but Cocoa has not yet sent
 // windowDidFailToEnterFullScreen:.
 @interface BridgedNativeWidgetTestFullScreenWindow : NativeWidgetMacNSWindow {
  @private
   int ignoredToggleFullScreenCount_;
 }
@@ skipping 65 matching lines @@
     // before the tests covering the Init() flow are ready to do that.
     init_params_.type = Widget::InitParams::TYPE_WINDOW_FRAMELESS;
 
     // To control the lifetime without an actual window that must be closed,
     // tests in this file need to use WIDGET_OWNS_NATIVE_WIDGET.
     init_params_.ownership = Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
 
     // Opacity defaults to "infer" which is usually updated by ViewsDelegate.
     init_params_.opacity = Widget::InitParams::OPAQUE_WINDOW;
 
+    init_params_.bounds = gfx::Rect(100, 100, 100, 100);
+
     native_widget_mac_->GetWidget()->Init(init_params_);
   }
 
  protected:
   scoped_ptr<Widget> widget_;
   MockNativeWidgetMac* native_widget_mac_;  // Weak. Owned by |widget_|.
 
   // Make the InitParams available to tests to cover initialization codepaths.
   Widget::InitParams init_params_;
 };
@@ skipping 26 matching lines @@
 
 BridgedNativeWidgetTest::BridgedNativeWidgetTest() {
 }
 
 BridgedNativeWidgetTest::~BridgedNativeWidgetTest() {
 }
 
 void BridgedNativeWidgetTest::InstallTextField(const std::string& text) {
   Textfield* textfield = new Textfield();
   textfield->SetText(ASCIIToUTF16(text));
+  textfield->SetBoundsRect(init_params_.bounds);
   view_->AddChildView(textfield);
 
   // 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];
 }
 
@@ skipping 311 matching lines @@
   EXPECT_EQ("a", GetText());
   EXPECT_EQ_RANGE(NSMakeRange(1, 0), [ns_view_ selectedRange]);
 
   // Should succeed after moving left first.
   [ns_view_ doCommandBySelector:@selector(moveLeft:)];
   [ns_view_ doCommandBySelector:@selector(deleteForward:)];
   EXPECT_EQ("", GetText());
   EXPECT_EQ_RANGE(NSMakeRange(0, 0), [ns_view_ selectedRange]);
 }
 
+TEST_F(BridgedNativeWidgetTest, TextInput_FirstRectForCharacterRange) {
+  InstallTextField("");
+  ui::TextInputClient* textInputClient = [ns_view_ textInputClient];

[tapted, 2015/12/17 08:42:20]

hacker_style (eg. `client` for brevity too)

[karandeepb, 2015/12/18 09:15:06]

Done.

+  NSRange range;
+  NSRange actual_range = NSMakeRange(-1, -1);
+  NSRect rect;
+  gfx::Rect bounds;
+
+  // Empty composition.
+  rect = [ns_view_ firstRectForCharacterRange:NSMakeRange(0, 0)
+                                  actualRange:&actual_range];
+  bounds = textInputClient->GetCaretBounds();
+  bounds.set_width(0);
+  EXPECT_TRUE(ConvertCoordinateSystem(rect) == bounds);
+  EXPECT_TRUE(NSEqualRanges(NSMakeRange(0, 0), actual_range));
+
+  rect = [ns_view_ firstRectForCharacterRange:NSMakeRange(1, 1)
+                                  actualRange:&actual_range];
+  EXPECT_TRUE(ConvertCoordinateSystem(rect) == bounds);
+  EXPECT_TRUE(NSEqualRanges(NSMakeRange(1, 0), actual_range));
+
+  // Set composition with caret before second character('e').
+  ui::CompositionText composition;
+  composition.selection = gfx::Range(1);
+  composition.text = base::UTF8ToUTF16("test_str");
+  size_t count = composition.text.length();
+  textInputClient->SetCompositionText(composition);
+
+  range = NSMakeRange(1, 0);
+  rect = [ns_view_ firstRectForCharacterRange:range actualRange:&actual_range];
+  bounds = textInputClient->GetCaretBounds();
+  bounds.set_width(0);
+  EXPECT_TRUE(ConvertCoordinateSystem(rect) == bounds);
+  EXPECT_TRUE(NSEqualRanges(range, actual_range));
+
+  range = NSMakeRange(2, 0);
+  rect = [ns_view_ firstRectForCharacterRange:range actualRange:&actual_range];
+  EXPECT_FALSE(ConvertCoordinateSystem(rect) == bounds);
+  EXPECT_TRUE(NSEqualRanges(range, actual_range));
+
+  // Query outside composition range.
+  range = NSMakeRange(count + 1, 0);
+  rect = [ns_view_ firstRectForCharacterRange:range actualRange:&actual_range];
+  EXPECT_TRUE(ConvertCoordinateSystem(rect) == bounds);
+  EXPECT_TRUE(NSEqualRanges(range, actual_range));
+
+  std::vector<gfx::Rect> char_bounds, caret_bounds;

[tapted, 2015/12/17 08:42:20]

it's uncommon to declare multiple things on a line like this in chrome.

You can set the size when constructing too, rather than using .resize

[karandeepb, 2015/12/18 09:15:06]

Done.

+  char_bounds.resize(count);
+  caret_bounds.resize(count + 1);
+
+  // Generate caret_bounds between different characters.
+  for (size_t i = 0; i <= count; i++) {
+    composition.selection = gfx::Range(i);
+    textInputClient->SetCompositionText(composition);
+    caret_bounds[i] = textInputClient->GetCaretBounds();
+  }
+
+  // Generate individual character bounds from caret positions.
+  for (size_t i = 0; i < count; i++) {
+    char_bounds[i].set_origin(caret_bounds[i].origin());
+    char_bounds[i].set_width(caret_bounds[i + 1].x() - caret_bounds[i].x());
+    char_bounds[i].set_height(
+        std::max(caret_bounds[i].height(), caret_bounds[i + 1].height()));
+  }
+
+  // Verify bounds for all valid ranges.
+  for (size_t i = 0; i < count; i++) {
+    for (size_t j = i + 1; j <= count; j++) {
+      range = NSMakeRange(i, j - i);
+      rect =
+          [ns_view_ firstRectForCharacterRange:range actualRange:&actual_range];
+
+      bounds = gfx::Rect();
+      for (size_t k = i; k < j; k++)
+        bounds.Union(char_bounds[k]);
+
+      EXPECT_TRUE(ConvertCoordinateSystem(rect) == bounds);
+      EXPECT_TRUE(NSEqualRanges(range, actual_range));
+    }
+  }
+
+  // Check NSZeroRect is returned if bridged_content_view has no textInputClient
+  // available.
+  [ns_view_ setTextInputClient:nil];
+  rect = [ns_view_ firstRectForCharacterRange:NSMakeRange(0, 0)
+                                  actualRange:&actual_range];
+  EXPECT_TRUE(NSEqualRects(rect, NSZeroRect));
+}
+
 typedef BridgedNativeWidgetTestBase BridgedNativeWidgetSimulateFullscreenTest;
 
 // Simulate the notifications that AppKit would send out if a fullscreen
 // operation begins, and then fails and must abort. This notification sequence
 // was determined by posting delayed tasks to toggle fullscreen state and then
 // mashing Ctrl+Left/Right to keep OSX in a transition between Spaces to cause
 // the fullscreen transition to fail.
 TEST_F(BridgedNativeWidgetSimulateFullscreenTest, FailToEnterAndExit) {
   if (base::mac::IsOSSnowLeopard())
     return;
@@ skipping 58 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