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 23 matching lines @@
 #include "ui/gfx/display.h"
 #include "ui/gfx/geometry/rect.h"
 #include "ui/gfx/native_widget_types.h"
 #include "ui/gfx/range/range.h"
 #include "ui/surface/transport_dib.h"
 
 class SkBitmap;
 
 struct AccessibilityHostMsg_EventParams;
 struct ViewHostMsg_SelectionBounds_Params;
-struct ViewHostMsg_TextInputState_Params;
+struct TextInputState;
 
 namespace media {
 class VideoFrame;
 }
 
 namespace blink {
 struct WebScreenInfo;
 class WebMouseEvent;
 class WebMouseWheelEvent;
 }
 
 namespace cc {
 class SurfaceHittestDelegate;
 }
 
 namespace ui {
 class LatencyInfo;
 }
 
 namespace content {
 class BrowserAccessibilityDelegate;
 class BrowserAccessibilityManager;
 class RenderWidgetHostViewBaseObserver;
 class SyntheticGesture;
 class SyntheticGestureTarget;
 class WebCursor;
 struct DidOverscrollParams;
 struct NativeWebKeyboardEvent;
+struct TextInputState;
 struct WebPluginGeometry;
 
 // 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 37 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);
 
+  // The current text input state for the corresponding widget. This is used by
+  // the WebContents in determining the top level text input state, which is
+  // in turn used by the IME.
+  const TextInputState* text_input_state() const {
+    return text_input_state_.get();
+  }
+
   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 89 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);
 
+  // This method is exclusively called by the owner RenderWidgetHost to inform
+  // the view about a change in the input state which originated in the
+  // corresponding RenderWidget. This state is stored at the RWHV.
+  // Also, this change does not necessarily reflect the current state of the
+  // input since the text input could be due to a change in the focused
+  // child-frame's (in OOPIF) or the out of process content managed by
+  // BrowserPlugin.
+  // TODO(ekaramad): This method should not stay virtual.
+  virtual void TextInputStateChanged(const TextInputState& params);
+
+  // This method is used by the WebContents owning this view to notify the view
+  // of a text input change in the tab. This method is called by the
+  // WebContentsImp if the RenderWidgetHostView is a top-level view. The

[Charlie Reis, 2016/03/16 16:55:13]

nit: WebContentsImpl

[EhsanK, 2016/03/30 20:46:03]

Done.

+  // implementation is platform-specific.
+  virtual void UpdateInputMethodIfNecessary(bool text_input_state_changed) {}
+
   //----------------------------------------------------------------------------
   // 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 118 matching lines @@
 
   // Exposed for testing.
   virtual cc::SurfaceId SurfaceIdForTesting() const;
 
  protected:
   // Interface class only, do not construct.
   RenderWidgetHostViewBase();
 
   void NotifyObserversAboutShutdown();
 
+  // This method should be called by RWHV during destruction or after a crash
+  // to make sure WebContents does not hold invalid text input state.
+  // TODO(ekaramad): Do we need to call this for top-level RWHV as well?
+  void NotifyHostDelegateAboutShutdown();
+
 #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();
 
   gfx::Rect current_display_area_;
 
   uint32_t renderer_frame_number_;
 
   base::OneShotTimer flush_input_timer_;
 
   base::ObserverList<RenderWidgetHostViewBaseObserver> observers_;
 
+  // The last reported input state by the RenderWidget.
+  scoped_ptr<TextInputState> text_input_state_;
+
   base::WeakPtrFactory<RenderWidgetHostViewBase> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderWidgetHostViewBase);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_RENDER_WIDGET_HOST_VIEW_BASE_H_