[reland] Browser Side Text Input State Tracking for OOPIF (Aura Only)

content/browser/renderer_host/render_widget_host_view_base.cc

 // 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.
 
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 
 #include "base/logging.h"
 #include "build/build_config.h"
 #include "content/browser/accessibility/browser_accessibility_manager.h"
 #include "content/browser/gpu/gpu_data_manager_impl.h"
 #include "content/browser/renderer_host/input/synthetic_gesture_target_base.h"
 #include "content/browser/renderer_host/render_process_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_delegate.h"
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_view_base_observer.h"
+#include "content/browser/renderer_host/text_input_manager.h"
 #include "content/common/content_switches_internal.h"
 #include "content/public/browser/render_widget_host_view_frame_subscriber.h"
 #include "ui/display/display.h"
 #include "ui/display/screen.h"
 #include "ui/gfx/geometry/point_conversions.h"
 #include "ui/gfx/geometry/size_conversions.h"
 #include "ui/gfx/geometry/size_f.h"
 
 namespace content {
 
 namespace {
 
 // How many microseconds apart input events should be flushed.
 const int kFlushInputRateInUs = 16666;
 
 }
 
 RenderWidgetHostViewBase::RenderWidgetHostViewBase()
     : popup_type_(blink::WebPopupTypeNone),
       background_color_(SK_ColorWHITE),
       mouse_locked_(false),
       showing_context_menu_(false),
       selection_text_offset_(0),
       selection_range_(gfx::Range::InvalidRange()),
       current_device_scale_factor_(0),
       current_display_rotation_(display::Display::ROTATE_0),
       pinch_zoom_enabled_(content::IsPinchToZoomEnabled()),
+      text_input_manager_(nullptr),
       renderer_frame_number_(0),
       weak_factory_(this) {}
 
 RenderWidgetHostViewBase::~RenderWidgetHostViewBase() {
   DCHECK(!mouse_locked_);
   // We call this here to guarantee that observers are notified before we go
   // away. However, some subclasses may wish to call this earlier in their
   // shutdown process, e.g. to force removal from
   // RenderWidgetHostInputEventRouter's surface map before relinquishing a
   // host pointer, as in RenderWidgetHostViewGuest. There is no harm in calling
@@ skipping 322 matching lines @@
       gfx::ToRoundedPoint(point)));
 }
 
 void RenderWidgetHostViewBase::TransformPointToLocalCoordSpace(
     const gfx::Point& point,
     cc::SurfaceId original_surface,
     gfx::Point* transformed_point) {
   *transformed_point = point;
 }
 
+void RenderWidgetHostViewBase::TextInputStateChanged(
+    const TextInputState& text_input_state) {
+  if (GetTextInputManager())
+    GetTextInputManager()->UpdateTextInputState(this, text_input_state);
+}
+
+TextInputManager* RenderWidgetHostViewBase::GetTextInputManager() {
+  if (text_input_manager_)
+    return text_input_manager_;
+
+  RenderWidgetHostImpl* host =
+      RenderWidgetHostImpl::From(GetRenderWidgetHost());
+  if (!host || !host->delegate())
+    return nullptr;
+
+  // This RWHV needs to be registered with the TextInputManager so that the
+  // TextInputManager starts observing its lifetime.
+  text_input_manager_ = host->delegate()->GetTextInputManager();
+  if (text_input_manager_) {
+    text_input_manager_->Register(this);
+    text_input_manager_->AddObserver(this);

[Charlie Reis, 2016/05/18 20:46:03]

Would it make sense to call TextInputManager::AddObserver from within Register,
or are there cases when we want to register without observing?

[EhsanK, 2016/05/24 20:42:44]

For testing purposes, we just want to observe and not register.

Also, we register to update TextInputManager with state, but we observe it to
get updates about state change, ime stuff, etc. So observing and registering
should be done separately.

Nonetheless, following the comment on line 24 of 'text_input_manager.h', I have
now removed the inheritance of RWHVBase from TextInputManager::Observer. So now
we only call Register here and the observing part is left with RWHVAura.

[Charlie Reis, 2016/05/26 06:22:03]

Acknowledged.

+  }
+
+  return text_input_manager_;
+}
+
 void RenderWidgetHostViewBase::AddObserver(
     RenderWidgetHostViewBaseObserver* observer) {
   observers_.AddObserver(observer);
 }
 
 void RenderWidgetHostViewBase::RemoveObserver(
     RenderWidgetHostViewBaseObserver* observer) {
   observers_.RemoveObserver(observer);
 }
 
 bool RenderWidgetHostViewBase::IsChildFrameForTesting() const {
   return false;
 }
 
 cc::SurfaceId RenderWidgetHostViewBase::SurfaceIdForTesting() const {
   return cc::SurfaceId();
 }
 
+void RenderWidgetHostViewBase::OnDestroyingTextInputManager(
+    TextInputManager* text_input_manager) {
+  DCHECK(text_input_manager && text_input_manager_ == text_input_manager);
+
+  if (text_input_manager_->IsRegisteredView(this))
+    text_input_manager_->Unregister(this);
+  text_input_manager_->RemoveObserver(this);

[Charlie Reis, 2016/05/18 20:46:03]

Seems a bit unusual to have the observer reach back into the TextInputManager to
clear this state, rather than having the TextInputManager handle it directly in
its destructor.  Maybe it would be better to just do clear text_input_manager_
here (with the DCHECK above) and clear the rest in ~TextInputManager?

[EhsanK, 2016/05/24 20:42:44]

Acknowledged. However, I removed this method and added a new method which
basically does the same thing. However, now the RWHVBase does not need to
observer TextInputManager which is good since most of its methods (in future)
will be IME related and only tab's RWHV should observe them (also tests).

The new method is called 'DidUnregisterFromTextInputManager'.

[Charlie Reis, 2016/05/26 06:22:03]

Acknowledged.

+  text_input_manager_ = nullptr;
+}
+
 }  // namespace content