[Mac] Implement the system dictionary popup by implementing NSTextInput methods.

chrome/browser/renderer_host/render_widget_host_view_mac.mm

-// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// 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.
 
 #include <QuartzCore/QuartzCore.h>
 
 #include "chrome/browser/renderer_host/render_widget_host_view_mac.h"
 
 #include "app/app_switches.h"
 #include "app/surface/io_surface_support_mac.h"
 #include "base/command_line.h"
 #include "base/logging.h"
 #include "base/mac/scoped_cftyperef.h"
 #import "base/mac/scoped_nsautorelease_pool.h"
 #include "base/metrics/histogram.h"
 #import "base/scoped_nsobject.h"
 #include "base/string_util.h"
 #include "base/sys_info.h"
 #include "base/sys_string_conversions.h"
 #import "chrome/browser/accessibility/browser_accessibility_cocoa.h"
 #include "chrome/browser/accessibility/browser_accessibility_state.h"
 #include "chrome/browser/browser_thread.h"
 #include "chrome/browser/browser_trial.h"
 #include "chrome/browser/gpu_process_host.h"
 #include "chrome/browser/plugin_process_host.h"
 #include "chrome/browser/renderer_host/backing_store_mac.h"
 #include "chrome/browser/renderer_host/render_process_host.h"
 #include "chrome/browser/renderer_host/render_view_host.h"
 #include "chrome/browser/renderer_host/render_widget_host.h"
+#import "chrome/browser/renderer_host/text_input_client_mac.h"
 #include "chrome/browser/spellchecker_platform_engine.h"
 #import "chrome/browser/ui/cocoa/rwhvm_editcommand_helper.h"
 #import "chrome/browser/ui/cocoa/view_id_util.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/native_web_keyboard_event.h"
 #include "chrome/common/edit_command.h"
 #include "chrome/common/gpu_messages.h"
 #include "chrome/common/plugin_messages.h"
 #include "chrome/common/render_messages.h"
 #include "skia/ext/platform_canvas.h"
 #include "third_party/skia/include/core/SkColor.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/mac/WebInputEventFactory.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
+#include "ui/gfx/point.h"
 #include "webkit/glue/webaccessibility.h"
 #include "webkit/plugins/npapi/webplugin.h"
 #import "third_party/mozilla/ComplexTextInputPanel.h"
 
 using WebKit::WebInputEvent;
 using WebKit::WebInputEventFactory;
 using WebKit::WebMouseEvent;
 using WebKit::WebMouseWheelEvent;
 
 static inline int ToWebKitModifiers(NSUInteger flags) {
   int modifiers = 0;
   if (flags & NSControlKeyMask) modifiers |= WebInputEvent::ControlKey;
   if (flags & NSShiftKeyMask) modifiers |= WebInputEvent::ShiftKey;
   if (flags & NSAlternateKeyMask) modifiers |= WebInputEvent::AltKey;
   if (flags & NSCommandKeyMask) modifiers |= WebInputEvent::MetaKey;
   return modifiers;
 }
 
-@interface RenderWidgetHostViewCocoa (Private)
+// Private methods:
+@interface RenderWidgetHostViewCocoa ()
+@property(nonatomic, assign) NSRange selectedRange;
+@property(nonatomic, assign) NSRange markedRange;
+
 + (BOOL)shouldAutohideCursorForEvent:(NSEvent*)event;
 - (id)initWithRenderWidgetHostViewMac:(RenderWidgetHostViewMac*)r;
-- (void)keyEvent:(NSEvent *)theEvent wasKeyEquivalent:(BOOL)equiv;
+- (void)keyEvent:(NSEvent*)theEvent wasKeyEquivalent:(BOOL)equiv;
 - (void)cancelChildPopups;
 - (void)checkForPluginImeCancellation;
 @end
 
 // This API was published since 10.6. Provide the declaration so it can be
 // // called below when building with the 10.5 SDK.
 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_5
 @class NSTextInputContext;
 @interface NSResponder (AppKitDetails)
 - (NSTextInputContext *)inputContext;
@@ skipping 738 matching lines @@
 }
 
 void RenderWidgetHostViewMac::ImeUpdateTextInputState(
     WebKit::WebTextInputType type,
     const gfx::Rect& caret_rect) {
   if (text_input_type_ != type) {
     text_input_type_ = type;
     if (HasFocus())
       SetTextInputActive(true);
   }
-
-  // We need to convert the coordinate of the cursor rectangle sent from the
-  // renderer and save it. Our input method backend uses a coordinate system
-  // whose origin is the upper-left corner of this view. On the other hand,
-  // Cocoa uses a coordinate system whose origin is the lower-left corner of
-  // this view. So, we convert the cursor rectangle and save it.
-  [cocoa_view_ setCaretRect:[cocoa_view_ flipRectToNSRect:caret_rect]];
 }
 
 void RenderWidgetHostViewMac::ImeCancelComposition() {
   [cocoa_view_ cancelComposition];
 }
 
+void RenderWidgetHostViewMac::ImeCompositionRangeChanged(int start, int end) {

[jeremy, 2011/02/21 09:19:47]

Why are start & end signed?  The arguments to NSMakeRange() are unsigned.

Also, it might be a good idea to do some strict validation of these when they
come over IPC to make sure no funny business is happening on the renderer side.

[Robert Sesek, 2011/02/24 23:26:52]

WebRange uses int rather than uint, so that's why I transport them this way. Can
you advise on some sanity checks? Obviously >0 is a good one, but is <INT_MAX a
good upper bound, too?

+  // The RangeChanged message is only sent with valid values. The current
+  // caret position (start == end) will be sent if there is no IME range.
+  [cocoa_view_ setMarkedRange:NSMakeRange(start, end - start)];
+}
+
 void RenderWidgetHostViewMac::DidUpdateBackingStore(
     const gfx::Rect& scroll_rect, int scroll_dx, int scroll_dy,
     const std::vector<gfx::Rect>& copy_rects) {
   if (!is_hidden_) {
     std::vector<gfx::Rect> rects(copy_rects);
 
     // Because the findbar might be open, we cannot use scrollRect:by: here. For
     // now, simply mark all of scroll rect as dirty.
     if (!scroll_rect.IsEmpty())
       rects.push_back(scroll_rect);
@@ skipping 97 matching lines @@
 
     NSString* tooltip_nsstring = base::SysWideToNSString(display_text);
     [cocoa_view_ setToolTipAtMousePoint:tooltip_nsstring];
   }
 }
 
 //
 // RenderWidgetHostViewCocoa uses the stored selection text,
 // which implements NSServicesRequests protocol.
 //
-void RenderWidgetHostViewMac::SelectionChanged(const std::string& text) {
+void RenderWidgetHostViewMac::SelectionChanged(const std::string& text,
+                                               int range_start,
+                                               int range_end) {
   selected_text_ = text;
+  NSRange range = NSMakeRange(range_start, range_end - range_start);
+  if (range_start == 0 && range_end == 0)
+    range.location = NSNotFound;
+  [cocoa_view_ setSelectedRange:range];
 }
 
 BackingStore* RenderWidgetHostViewMac::AllocBackingStore(
     const gfx::Size& size) {
   return new BackingStoreMac(render_widget_host_, size);
 }
 
 // Sets whether or not to accept first responder status.
 void RenderWidgetHostViewMac::SetTakesFocusOnlyOnMouseDown(bool flag) {
   [cocoa_view_ setTakesFocusOnlyOnMouseDown:flag];
@@ skipping 398 matching lines @@
   } else {
     if (text_input_type_ == WebKit::WebTextInputTypePassword)
       DisablePasswordInput();
   }
 }
 
 // RenderWidgetHostViewCocoa ---------------------------------------------------
 
 @implementation RenderWidgetHostViewCocoa
 
-@synthesize caretRect = caretRect_;
+@synthesize selectedRange = selectedRange_;
+@synthesize markedRange = markedRange_;
 
 - (id)initWithRenderWidgetHostViewMac:(RenderWidgetHostViewMac*)r {
   self = [super initWithFrame:NSZeroRect];
   if (self) {
     editCommand_helper_.reset(new RWHVMEditCommandHelper);
     editCommand_helper_->AddEditingSelectorsToClass([self class]);
 
     renderWidgetHostView_.reset(r);
     canBeKeyView_ = YES;
     takesFocusOnlyOnMouseDown_ = NO;
@@ skipping 1049 matching lines @@
         NSUnderlineStyleAttributeName,
         NSUnderlineColorAttributeName,
         NSMarkedClauseSegmentAttributeName,
         NSTextInputReplacementRangeAttributeName,
         nil]);
   }
   return validAttributesForMarkedText_.get();
 }
 
 - (NSUInteger)characterIndexForPoint:(NSPoint)thePoint {
-  NOTIMPLEMENTED();
-  return NSNotFound;
+  DCHECK([self window]);
+  // |thePoint| is in screen coordinates, but needs to be converted to WebKit
+  // coordinates (upper left origin). Scroll offsets will be taken care of in
+  // the renderer.
+  thePoint = [[self window] convertScreenToBase:thePoint];
+  thePoint = [self convertPoint:thePoint fromView:nil];
+  thePoint.y = NSHeight([self frame]) - thePoint.y;
+
+  NSUInteger point =
+      TextInputClientMac::GetInstance()->GetCharacterIndexAtPoint(
+          renderWidgetHostView_->render_widget_host_,
+          gfx::Point(thePoint.x, thePoint.y));
+  NSLog(@"%s:%@ -> %d", _cmd, NSStringFromPoint(thePoint), point);

[jeremy, 2011/02/21 09:19:47]

Remove NSLog? Also, below

[Robert Sesek, 2011/02/24 23:26:52]

I'll do this for landing, but I'm still working on some things so the debug info
is helpful.

+  return point;
 }
 
 - (NSRect)firstRectForCharacterRange:(NSRange)theRange {
-  // An input method requests a cursor rectangle to display its candidate
-  // window.
-  // Calculate the screen coordinate of the cursor rectangle saved in
-  // RenderWidgetHostViewMac::ImeUpdateTextInputState() and send it to the
-  // input method.
-  // Since this window may be moved since we receive the cursor rectangle last
-  // time we sent the cursor rectangle to the input method, so we should map
-  // from the view coordinate to the screen coordinate every time when an input
-  // method need it.
-  NSRect resultRect = [self convertRect:caretRect_ toView:nil];
-  NSWindow* window = [self window];
-  if (window)
-    resultRect.origin = [window convertBaseToScreen:resultRect.origin];
+  NSRect rect = TextInputClientMac::GetInstance()->GetFirstRectForRange(
+      renderWidgetHostView_->render_widget_host_, theRange);
 
-  return resultRect;
-}
-
-- (NSRange)selectedRange {
-  // Return the selected range saved in the setMarkedText method.
-  return hasMarkedText_ ? selectedRange_ : NSMakeRange(NSNotFound, 0);
+  // The returned rectangle is in WebKit coordinates (upper left origin), so
+  // flip the coordinate system and then convert it into screen coordinates for
+  // return.
+  NSRect viewFrame = [self frame];
+  rect.origin.y = NSHeight(viewFrame) - rect.origin.y;
+  rect.origin.y -= rect.size.height;
+  rect = [self convertRectToBase:rect];
+  rect.origin = [[self window] convertBaseToScreen:rect.origin];
+  NSLog(@"%s:%@ -> %@", _cmd, NSStringFromRange(theRange), NSStringFromRect(rect));
+  return rect;
 }
 
 - (NSRange)markedRange {
   // An input method calls this method to check if an application really has
   // a text being composed when hasMarkedText call returns true.
   // Returns the range saved in the setMarkedText method so the input method
   // calls the setMarkedText method and we can update the composition node
   // there. (When this method returns an empty range, the input method doesn't
   // call the setMarkedText method.)
+  NSLog(@"%s -> %@", _cmd, NSStringFromRange(markedRange_));
   return hasMarkedText_ ? markedRange_ : NSMakeRange(NSNotFound, 0);
 }
 
-- (NSAttributedString *)attributedSubstringFromRange:(NSRange)range {
-  // TODO(hbono): Even though many input method works without implementing
-  // this method, we need to save a copy of the string in the setMarkedText
-  // method and create a NSAttributedString with the given range.
-  // http://crbug.com/37715
-  return nil;
+- (NSAttributedString*)attributedSubstringFromRange:(NSRange)range {
+  NSAttributedString* str =
+      TextInputClientMac::GetInstance()->GetAttributedSubstringFromRange(
+          renderWidgetHostView_->render_widget_host_, range);
+  NSLog(@"%s:%@ -> %@", _cmd, NSStringFromRange(range), [str string]);
+  return str;
 }
 
 - (NSInteger)conversationIdentifier {
   return reinterpret_cast<NSInteger>(self);
 }
 
 // Each RenderWidgetHostViewCocoa has its own input context, but we return
 // nil when the caret is in non-editable content or password box to avoid
 // making input methods do their work.
 - (NSTextInputContext *)inputContext {
@@ skipping 38 matching lines @@
 }
 
 - (void)setMarkedText:(id)string selectedRange:(NSRange)newSelRange {
   // An input method updates the composition string.
   // We send the given text and range to the renderer so it can update the
   // composition node of WebKit.
   BOOL isAttributedString = [string isKindOfClass:[NSAttributedString class]];
   NSString* im_text = isAttributedString ? [string string] : string;
   int length = [im_text length];
 
-  markedRange_ = NSMakeRange(0, length);
+  // |markedRange_| will get set on a callback from ImeSetComposition().
   selectedRange_ = newSelRange;
   markedText_ = base::SysNSStringToUTF16(im_text);
   hasMarkedText_ = (length > 0);
 
   underlines_.clear();
   if (isAttributedString) {
     ExtractUnderlines(string, &underlines_);
   } else {
     // Use a thin black underline by default.
     underlines_.push_back(
@@ skipping 271 matching lines @@
   if (!string) return NO;
 
   // If the user is currently using an IME, confirm the IME input,
   // and then insert the text from the service, the same as TextEdit and Safari.
   [self confirmComposition];
   [self insertText:string];
   return YES;
 }
 
 @end