Routing IME Result Calls to the Correct RenderWidgetHost (Aura Only)

content/browser/renderer_host/text_input_manager.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__
 #define CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__
 
 #include <unordered_map>
 
 #include "base/observer_list.h"
 #include "content/common/content_export.h"
 #include "content/common/text_input_state.h"
 
 namespace content {
 
+class RenderWidgetHostImpl;
 class RenderWidgetHostView;
 class RenderWidgetHostViewBase;
 class WebContents;
 
 // A class which receives updates of TextInputState from multiple sources and
 // decides what the new TextInputState is. It also notifies the observers when
 // text input state is updated.
 class CONTENT_EXPORT TextInputManager {
  public:
   // The tab's top-level RWHV should be an observer of TextInputManager to get
   // notifications about changes in TextInputState or other IME related state
   // for child frames.
   class CONTENT_EXPORT Observer {
    public:
     // Called when a view has called UpdateTextInputState on TextInputManager.
     // If the call has led to a change in TextInputState, |did_update_state| is
     // true. In some plaforms, we need this update even when the state has not
     // changed (e.g., Aura for updating IME).
     virtual void OnUpdateTextInputStateCalled(
         TextInputManager* text_input_manager,
         RenderWidgetHostViewBase* updated_view,
         bool did_update_state) {}
   };
 
   TextInputManager();
   ~TextInputManager();
 
+  // ---------------------------------------------------------------------------
+  // The following methods give are used to obtain information about IME-related

[kenrb, 2016/06/13 19:37:47]

Nit: 'methods give are used'

[EhsanK, 2016/06/17 22:36:20]

Acknowledged.

+  // state for the active RWHV.
+
   // Returns the currently active view (i.e., the RWHV with a focused <input>
   // element), or nullptr if none exist. The |active_view_| cannot have a
   // |TextInputState.type| of ui::TEXT_INPUT_TYPE_NONE.
   RenderWidgetHostViewBase* GetActiveView() const;

[kenrb, 2016/06/13 19:37:47]

Is GetActiveView() still necessary? Looking at this now, since TextInputClient
messages go to the top RWHV and then are routed straight to the active
RenderWidgetHostImpl, I'm not clear on how GetActiveView() is intended to be
used (or, if only for unusual side cases, it the caller could call
GetActiveWidget()->GetView()).

[EhsanK, 2016/06/17 22:36:20]

It is not. I removed it. We store state for each view and hence I was returning
the active view here. But we do not actually need the view as all the IPC go
through the widget. The way it is now, we store state for each view but we
forward to widget.

 
+  // Returns the currently active widget, i.e., the RWH which is associated with
+  // |active_view_|.
+  RenderWidgetHostImpl* GetActiveWidget() const;
+
   // Returns the TextInputState corresponding to |active_view_|.
   // Users of this method should not hold on to the pointer as it might become
   // dangling if the TextInputManager or |active_view_| might go away.
   const TextInputState* GetTextInputState();
 
+  // ---------------------------------------------------------------------------
+  // The following methods are called by RWHVs on the tab to update their IME-
+  // related state.
+
   // Updates the TextInputState for |view|.
   void UpdateTextInputState(RenderWidgetHostViewBase* view,
                             const TextInputState& state);
 
   // Registers the given |view| for tracking its TextInputState. This is called
   // by any view which has updates in its TextInputState (whether tab's RWHV or
   // that of a child frame). The |view| must unregister itself before being
   // destroyed (i.e., call TextInputManager::Unregister).
   void Register(RenderWidgetHostViewBase* view);
 
@@ skipping 28 matching lines @@
   std::unordered_map<RenderWidgetHostViewBase*, TextInputState>
       text_input_state_map_;
 
   base::ObserverList<Observer> observer_list_;
 
   DISALLOW_COPY_AND_ASSIGN(TextInputManager);
 };
 }
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_TEXT_INPUT_MANAGER_H__