Implement the NSTextInput protocol....

chrome/browser/renderer_host/render_widget_host_view_mac.h

 // Copyright (c) 2006-2008 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.
 
 #ifndef CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_
 #define CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_
 
 #import <Cocoa/Cocoa.h>
 
 #include "base/scoped_nsobject.h"
@@ skipping 11 matching lines @@
 
 @protocol RenderWidgetHostViewMacOwner
 - (RenderWidgetHostViewMac*)renderWidgetHostViewMac;
 @end
 
 // This is the view that lives in the Cocoa view hierarchy. In Windows-land,
 // RenderWidgetHostViewWin is both the view and the delegate. We split the roles
 // but that means that the view needs to own the delegate and will dispose of it
 // when it's removed from the view system.
 
-@interface RenderWidgetHostViewCocoa : BaseView <RenderWidgetHostViewMacOwner> {
+@interface RenderWidgetHostViewCocoa
+    : BaseView <RenderWidgetHostViewMacOwner, NSTextInput> {
  @private
   RenderWidgetHostViewMac* renderWidgetHostView_;
   BOOL canBeKeyView_;
   BOOL closeOnDeactivate_;
   scoped_ptr<RWHVMEditCommandHelper> editCommand_helper_;
 
   // These are part of the magic tooltip code from WebKit's WebHTMLView:
   id trackingRectOwner_;              // (not retained)
   void *trackingRectUserData_;
   NSTrackingRectTag lastToolTipTag_;
@@ skipping 80 matching lines @@
   bool about_to_validate_and_paint_;
 
   // This is the rectangle which we'll paint.
   NSRect invalid_rect_;
 
   // The time at which this view started displaying white pixels as a result of
   // not having anything to paint (empty backing store from renderer). This
   // value returns true for is_null() if we are not recording whiteout times.
   base::TimeTicks whiteout_start_time_;
 
+  // Variables used by our implementaion of the NSTextInput protocol.
+  // An input method of Mac calls the methods of this protocol not only to
+  // notify an application of its status, but also to retrieve the status of
+  // the application. That is, an application cannot control an input method
+  // directly.
+  // This object keeps the status of a composition of the renderer and returns
+  // it when an input method asks for it.
+  // We need to implement Objective-C methods for the NSTextInput protocol. On
+  // the other hand, we need to implement a C++ method for an IPC-message
+  // handler which receives input-method events from the renderer.
+  // To avoid fragmentation of variables used by our input-method
+  // implementation, we define all variables as public member variables of
+  // this C++ class so both the C++ methods and the Objective-C methods can
+  // access them.
+
+  // Represents the input-method attributes supported by this object.
+  NSArray* im_attributes_;
+
+  // Represents whether or not an input method is composing a text.
+  bool im_composing_;
+
+  // Represents the range of the composition string (i.e. a text being
+  // composed by an input method), and the range of the selected text of the
+  // composition string.
+  // TODO(hbono): need to save the composition string itself for the
+  // attributedSubstringFromRange method?
+  NSRange im_marked_range_;
+  NSRange im_selected_range_;
+
+  // Represents the state of modifier keys.
+  // An input method doesn't notify the state of modifier keys. On the other
+  // hand, the state of modifier keys are required by Char events because they
+  // are dispatched to onkeypress() event handlers of JavaScript.
+  // To create a Char event in NSTextInput methods, we save the latest state
+  // of modifier keys when we receive it.
+  int im_modifiers_;
+
+  // Represents the cursor position in this view coordinate.
+  // The renderer sends the cursor position through an IPC message.
+  // We save the latest cursor position here and return it when an input
+  // methods needs it.
+  NSRect im_caret_rect_;
+
  private:
   // Updates the display cursor to the current cursor if the cursor is over this
   // render view.
   void UpdateCursorIfOverSelf();
 
   // Shuts down the render_widget_host_.  This is a separate function so we can
   // invoke it from the message loop.
   void ShutdownHost();
 
   // The associated view.
@@ skipping 14 matching lines @@
   // Factory used to safely scope delayed calls to ShutdownHost().
   ScopedRunnableMethodFactory<RenderWidgetHostViewMac> shutdown_factory_;
 
   // Used for positioning a popup menu.
   BaseView* parent_view_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewMac);
 };
 
 #endif  // CHROME_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_MAC_H_