Tracking composition range on the browser side (Aura)

content/public/test/text_input_test_utils.cc

 // Copyright 2016 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/public/test/text_input_test_utils.h"
 
 #include <unordered_set>
 
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_view_aura.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
 #include "content/browser/renderer_host/render_widget_host_view_base_observer.h"
 #include "content/browser/renderer_host/text_input_manager.h"
 #include "content/browser/web_contents/web_contents_impl.h"
 #include "content/common/text_input_state.h"
 #include "content/common/view_messages.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/test/test_utils.h"
+#include "ui/base/ime/composition_text.h"
 #include "ui/base/ime/input_method.h"
 #include "ui/base/ime/input_method_observer.h"
 
 namespace ui {
+

[Charlie Reis, 2016/07/11 23:56:19]

nit: No blank line needed.

[EhsanK, 2016/07/12 18:31:14]

Acknowledged.

 class TextInputClient;
-}
+}  // namespace ui

[Charlie Reis, 2016/07/11 23:56:19]

nit: No close comment.

[EhsanK, 2016/07/12 18:31:14]

Acknowledged.

 
 namespace content {
 
 // This class is an observer of TextInputManager associated with the provided
 // WebContents. An instance of this class is used in TextInputManagerTester to
 // expose the required API for testing outside of content/.
 class TextInputManagerTester::InternalObserver
     : public TextInputManager::Observer,
       public WebContentsObserver {
  public:
@@ skipping 14 matching lines @@
 
   void set_update_text_input_state_called_callback(
       const base::Closure& callback) {
     update_text_input_state_callback_ = callback;
   }
 
   void set_on_selection_bounds_changed_callback(const base::Closure& callback) {
     on_selection_bounds_changed_callback_ = callback;
   }
 
+  void set_on_ime_composition_range_changed_callback(
+      const base::Closure& callback) {
+    on_ime_composition_range_changed_callback_ = callback;
+  }
+
   const RenderWidgetHostView* GetUpdatedView() const { return updated_view_; }
 
   bool text_input_state_changed() const { return text_input_state_changed_; }
 
   TextInputManager* text_input_manager() const { return text_input_manager_; }
 
   // TextInputManager::Observer implementations.
   void OnUpdateTextInputStateCalled(TextInputManager* text_input_manager,
                                     RenderWidgetHostViewBase* updated_view,
                                     bool did_change_state) override {
     if (text_input_manager_ != text_input_manager)
       return;
     text_input_state_changed_ = did_change_state;
     updated_view_ = updated_view;
     if (!update_text_input_state_callback_.is_null())
       update_text_input_state_callback_.Run();
   }
 
   void OnSelectionBoundsChanged(
       TextInputManager* text_input_manager_,
       RenderWidgetHostViewBase* updated_view) override {
     updated_view_ = updated_view;
     if (!on_selection_bounds_changed_callback_.is_null())
       on_selection_bounds_changed_callback_.Run();
   }
 
+  void OnImeCompositionRangeChanged(
+      TextInputManager* text_input_manager,
+      RenderWidgetHostViewBase* updated_view) override {
+    updated_view_ = updated_view;
+    if (!on_ime_composition_range_changed_callback_.is_null())
+      on_ime_composition_range_changed_callback_.Run();
+  }
+
   // WebContentsObserver implementation.
   void WebContentsDestroyed() override { text_input_manager_ = nullptr; }
 
  private:
   TextInputManager* text_input_manager_;
   RenderWidgetHostViewBase* updated_view_;
   bool text_input_state_changed_;
   base::Closure update_text_input_state_callback_;
   base::Closure on_selection_bounds_changed_callback_;
+  base::Closure on_ime_composition_range_changed_callback_;
 
   DISALLOW_COPY_AND_ASSIGN(InternalObserver);
 };
 
 // This class observes the lifetime of a RenderWidgetHostView. An instance of
 // this class is used in TestRenderWidgetHostViewDestructionObserver to expose
 // the required observer API for testing outside of content/.
 class TestRenderWidgetHostViewDestructionObserver::InternalObserver
     : public RenderWidgetHostViewBaseObserver {
  public:
@@ skipping 103 matching lines @@
   RenderWidgetHostViewBase* view_base =
       static_cast<RenderWidgetHostViewBase*>(view);
   if (!manager || !manager->IsRegistered(view_base))
     return false;
 
   *type = manager->GetTextInputTypeForViewForTesting(view_base);
 
   return true;
 }
 
+void SetCompositionTextForFocusedTextInputClient(
+    WebContents* web_contents,
+    const ui::CompositionText& composition) {
+#if defined(USE_AURA)
+  // We need the tab's view.

[Charlie Reis, 2016/07/11 23:56:19]

Please elaborate why this one needs to care about outer WebContentses when the
other methods in here don't.

[EhsanK, 2016/07/12 18:31:14]

I wanted to make sure the cast to RenderWidgetHostViewAura which follows on line
243 is valid (i.e., it is not a RenderWidgetHostViewChildFrame).

But anyhow, I changed the method to the new version which takes a
RenderWidgetHost and sends the IPC. This is more useful since it is not platform
specific anymore.

+  WebContentsImpl* contents = static_cast<WebContentsImpl*>(web_contents);
+  while (contents->GetOuterWebContents())
+    contents = contents->GetOuterWebContents();
+  static_cast<RenderWidgetHostViewAura*>(contents->GetRenderWidgetHostView())
+      ->SetCompositionText(composition);
+  return;
+#endif
+}
+
 size_t GetRegisteredViewsCountFromTextInputManager(WebContents* web_contents) {
   std::unordered_set<RenderWidgetHostView*> views;
   TextInputManager* manager =
       static_cast<WebContentsImpl*>(web_contents)->GetTextInputManager();
   return !!manager ? manager->GetRegisteredViewsCountForTesting() : 0;
 }
 
 RenderWidgetHostView* GetActiveViewFromWebContents(WebContents* web_contents) {
   return static_cast<WebContentsImpl*>(web_contents)
       ->GetTextInputManager()
       ->active_view_for_testing();
 }
 
 TextInputManagerTester::TextInputManagerTester(WebContents* web_contents)
     : observer_(new InternalObserver(web_contents, this)) {}
 
 TextInputManagerTester::~TextInputManagerTester() {}
 
 void TextInputManagerTester::SetUpdateTextInputStateCalledCallback(
     const base::Closure& callback) {
   observer_->set_update_text_input_state_called_callback(callback);
 }
 
 void TextInputManagerTester::SetOnSelectionBoundsChangedCallback(
     const base::Closure& callback) {
   observer_->set_on_selection_bounds_changed_callback(callback);
 }
 
+void TextInputManagerTester::SetOnImeCompositionRangeChangedCallback(
+    const base::Closure& callback) {
+  observer_->set_on_ime_composition_range_changed_callback(callback);
+}
+
 bool TextInputManagerTester::GetTextInputType(ui::TextInputType* type) {
   DCHECK(observer_->text_input_manager());
   const TextInputState* state =
       observer_->text_input_manager()->GetTextInputState();
   if (!state)
     return false;
   *type = state->type;
   return true;
 }
 
@@ skipping 88 matching lines @@
 
 #ifdef USE_AURA
   RenderWidgetHostViewAura* view = static_cast<RenderWidgetHostViewAura*>(
       web_contents->GetRenderWidgetHostView());
   observer.reset(new InputMethodObserverAura(view->GetInputMethod()));
 #endif
   return observer;
 }
 
 }  // namespace content