Browser Side Text Input State Tracking for OOPIF.

content/browser/renderer_host/render_widget_host_view_base.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_BASE_H_
 #define CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_BASE_H_
 
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 44 matching lines @@
 class SurfaceHittestDelegate;
 }
 
 namespace ui {
 class LatencyInfo;
 }
 
 namespace content {
 class BrowserAccessibilityDelegate;
 class BrowserAccessibilityManager;
+class RenderFrameHostImpl;
 class SyntheticGesture;
 class SyntheticGestureTarget;
 class WebCursor;
 struct DidOverscrollParams;
 struct NativeWebKeyboardEvent;
 struct WebPluginGeometry;
 
+using TextInputState = ViewHostMsg_TextInputState_Params;
+
 // Basic implementation shared by concrete RenderWidgetHostView subclasses.
 class CONTENT_EXPORT RenderWidgetHostViewBase : public RenderWidgetHostView,
                                                 public IPC::Listener {
  public:
   ~RenderWidgetHostViewBase() override;
 
   float current_device_scale_factor() const {
     return current_device_scale_factor_;
   }
 
@@ skipping 35 matching lines @@
   // the renderer.
   void DidReceiveRendererFrame();
 
   // Notification that a resize or move session ended on the native widget.
   void UpdateScreenInfo(gfx::NativeView view);
 
   // Tells if the display property (work area/scale factor) has
   // changed since the last time.
   bool HasDisplayPropertyChanged(gfx::NativeView view);
 
+  // Notifies the top level page RWHVBase about a change in text input state in

[kenrb, 2016/02/01 20:12:43]

It suffices to say RenderWidgetHostView instead of RWHVBase.

[EhsanK, 2016/02/12 15:46:59]

Done.

+  // RWHVBase corresponding to out of process content represented by
+  // BrowserPlugin.
+  // TODO(ekaramad): Remove this API when BrowserPlugin is removed.
+  void NotifyGuestTextInputStateChanged(RenderWidgetHostViewBase* guest_rwhv);
+
+  // The current cached text input state which might be different from
+  // text_input_state_ if the view is for a main frame.
+  const TextInputState* current_text_input_state() const {
+    return cached_text_input_state_;
+  }
+
   base::WeakPtr<RenderWidgetHostViewBase> GetWeakPtr();
 
   //----------------------------------------------------------------------------
   // The following methods can be overridden by derived classes.
 
   // Notifies the View that the renderer text selection has changed.
   virtual void SelectionChanged(const base::string16& text,
                                 size_t offset,
                                 const gfx::Range& range);
 
@@ skipping 87 matching lines @@
   // embedded within the RenderWidgetHostViewBase's Surface to the
   // coordinate space of the embedding Surface. Typically this means that a
   // point was received from an out-of-process iframe's RenderWidget and needs
   // to be translated to viewport coordinates for the root RWHV, in which case
   // this method is called on the root RWHV with the out-of-process iframe's
   // SurfaceId.
   virtual void TransformPointToLocalCoordSpace(const gfx::Point& point,
                                                cc::SurfaceId original_surface,
                                                gfx::Point* transformed_point);
 
+  // Updates the state of the input method attached to the view.

[kenrb, 2016/02/01 20:12:43]

These comments need to be expanded. It appears that each RenderWidgetHostView
now keeps its own state (which is attached to RenderWidgetHostViewBase), and we
reference the 'current' text input state as being the state attached to the
focused frame. This doesn't really come across from the comments as written.

[EhsanK, 2016/02/12 15:46:59]

Done.

+  // TODO(ekaramad): Make this non-virtual if possible.
+  virtual void TextInputStateChanged(
+      const ViewHostMsg_TextInputState_Params& params);
+
+  // Notifies the top level RenderWidgetHostView or the corresponding
+  // ui::InputMethod of a change in text input state in either this RWHV or one
+  // of the child frame's RWHV.
+  virtual void NotifyTextInputStateChanged();
+
+  // Returns true if this RenderWidgetHostViewBase is for a main frame.
+  virtual bool ShouldObtainTextInputStateFromSubFrameViews() const;
+
   //----------------------------------------------------------------------------
   // The following static methods are implemented by each platform.
 
   static void GetDefaultScreenInfo(blink::WebScreenInfo* results);
 
   //----------------------------------------------------------------------------
   // The following pure virtual methods are implemented by derived classes.
 
   // Perform all the initialization steps necessary for this object to represent
   // a popup (such as a <select> dropdown), then shows the popup at |pos|.
@@ skipping 10 matching lines @@
   // |scroll_offset| is the scroll offset of the render view.
   virtual void MovePluginWindows(
       const std::vector<WebPluginGeometry>& moves) = 0;
 
   // Sets the cursor to the one associated with the specified cursor_type
   virtual void UpdateCursor(const WebCursor& cursor) = 0;
 
   // Indicates whether the page has finished loading.
   virtual void SetIsLoading(bool is_loading) = 0;
 
-  // Updates the state of the input method attached to the view.
-  virtual void TextInputStateChanged(
-      const ViewHostMsg_TextInputState_Params& params) = 0;
-
   // Cancel the ongoing composition of the input method attached to the view.
   virtual void ImeCancelComposition() = 0;
 
   // Notifies the View that the renderer has ceased to exist.
   virtual void RenderProcessGone(base::TerminationStatus status,
                                  int error_code) = 0;
 
   // Tells the View to destroy itself.
   virtual void Destroy() = 0;
 
@@ skipping 107 matching lines @@
 
   // The callback that DetachPluginsHelper calls for each child window. Call
   // this directly if you want to do custom filtering on plugin windows first.
   static void DetachPluginWindowsCallback(HWND window);
 #endif
 
  protected:
   // Interface class only, do not construct.
   RenderWidgetHostViewBase();
 
+  // The frame currently focused in the frame tree containing this.
+  RenderFrameHostImpl* GetFocusedFrame() const;
+
 #if defined(OS_WIN)
   // Shared implementation of MovePluginWindows for use by win and aura/wina.
   static void MovePluginWindowsHelper(
       HWND parent,
       const std::vector<WebPluginGeometry>& moves);
 
   static void PaintPluginWindowsHelper(
       HWND parent,
       const gfx::Rect& damaged_screen_rect);
 
@@ skipping 22 matching lines @@
   // A buffer containing the text inside and around the current selection range.
   base::string16 selection_text_;
 
   // The offset of the text stored in |selection_text_| relative to the start of
   // the web page.
   size_t selection_text_offset_;
 
   // The current selection range relative to the start of the web page.
   gfx::Range selection_range_;
 
- protected:
   // The scale factor of the display the renderer is currently on.
   float current_device_scale_factor_;
 
   // The orientation of the display the renderer is currently on.
   gfx::Display::Rotation current_display_rotation_;
 
   // Whether pinch-to-zoom should be enabled and pinch events forwarded to the
   // renderer.
   bool pinch_zoom_enabled_;
 
  private:
   void FlushInput();
 
+  // Returns the current text input state from all text input elements in this
+  // view or one of the child frame views.
+  const TextInputState* FindCurrentTextInputState();
+
   gfx::Rect current_display_area_;
 
   uint32_t renderer_frame_number_;
 
   base::OneShotTimer flush_input_timer_;
 
+  scoped_ptr<TextInputState> text_input_state_;
+
+  const TextInputState* cached_text_input_state_;
+
+  const RenderWidgetHostViewBase* focused_guest_rwhv_;
+
   base::WeakPtrFactory<RenderWidgetHostViewBase> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewBase);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_BASE_H_