Introduce WebInputMethodController to blink

third_party/WebKit/Source/web/WebLocalFrameImpl.cpp

 /*
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 178 matching lines @@
 #include "public/web/WebConsoleMessage.h"
 #include "public/web/WebDOMEvent.h"
 #include "public/web/WebDocument.h"
 #include "public/web/WebFindOptions.h"
 #include "public/web/WebFormElement.h"
 #include "public/web/WebFrameClient.h"
 #include "public/web/WebFrameOwnerProperties.h"
 #include "public/web/WebHistoryItem.h"
 #include "public/web/WebIconURL.h"
 #include "public/web/WebInputElement.h"
+#include "public/web/WebInputMethodController.h"
 #include "public/web/WebKit.h"
 #include "public/web/WebNode.h"
 #include "public/web/WebPerformance.h"
 #include "public/web/WebPlugin.h"
 #include "public/web/WebPrintParams.h"
 #include "public/web/WebPrintPresetOptions.h"
 #include "public/web/WebRange.h"
 #include "public/web/WebScriptSource.h"
 #include "public/web/WebSerializedScriptValue.h"
 #include "public/web/WebTreeScopeType.h"
@@ skipping 1033 matching lines @@
 
     // TODO(xiaochengh): The use of updateStyleAndLayoutIgnorePendingStylesheets
     // needs to be audited.  See http://crbug.com/590369 for more details.
     frame()->document()->updateStyleAndLayoutIgnorePendingStylesheets();
 
     inputMethodController.setCompositionFromExistingText(CompositionUnderlineVectorBuilder(underlines), compositionStart, compositionEnd);
 
     return true;
 }
 
 void WebLocalFrameImpl::extendSelectionAndDelete(int before, int after)

[Changwan Ryu, 2016/09/19 02:08:36]

Hmm... Sorry for my ignorance, but how are we plumbing extendSelectionAndDelete
/ setEditableSelectionOffsets / setCompositionFromExistingText for OOPIF now? I
was thinking of merging WebLocalFrameImpl's and WebViewImpl's IMC access at some
point (https://codereview.chromium.org/2323983003/) because they are similar
operations that just ended up in split places.

If so, now I think either all of IMC operations can actually belong to
WebLocalFrameImpl without WebFrameWidget in the first place or we're doing
something incorrectly for extendSelectionAndDelete and other operations (at
least for Android).

Could you check those possibilities? In any case, if we go ahead with this
refactoring I think you need to consider moving these to
WebInputMethodController as well.

[EhsanK, 2016/09/20 15:38:29]

Very good point! I had not considered those methods at all. :P
extendSelectionAndDelete goes from RenderWidgetHostView to RenderFrame which is
a bit weird:
https://cs.chromium.org/chromium/src/content/browser/renderer_host/render_wid...
RWHVAura is the TextInputClient. But it should not be exposed to RFH AFAIK.

Anyway, RenderFrameImpl calls it on |frame_| if RenderWidget agrees with
handling IME.
https://cs.chromium.org/chromium/src/content/renderer/render_frame_impl.cc?rc...

I think what would be nicer is to have is get RWHVAura talk to RenderWidget and
RenderWidget to WebInputMethodController and so on; the same way the other IME
results are being routed: setComposition, finsihComposingText, commitText. WDYT?

SetEditableSelectionOffsets and SetCompositionFromExistingText are similar
except that they Android only now and initiated from ImeAdapterAndroid.
I think if we end up using thie WebInputMethodController (which is owned by
frame), the IME code from WebViewImpl (WebFrameWidgetImpl) and WebLocalFrameImpl
to some extent should be removed. WDYT?
The way it is implemented now, IME is mostly routed through RenderWidgetHost
from tab's RWHV (along with keyboard input). I think for now, the least costly
method could be to route the other (3) IME calls through RenderWidget as well.
From RenderWidget, we could use the WebInputMethodController for focused frame
again. WDYT?
Agreed. I intend to include more WebViewImpl/WebFrameWidgetImpl code in this
class. I was thinking textInputInfo(), selectionBounds(), etc should also be in
the same class since they serve Text* anyway. Not sure if this is the right
class for that too, but I think it is a good place for it to be.


For now, I updated my doc to include the methods you mentioned above in the
list:
https://docs.google.com/document/d/13Nidlg5yIsxQRqXgBPqmb-KcT8q85Z1ds9Z1-Vo1X...

[Changwan Ryu, 2016/09/21 08:42:03]

Hmm... Thanks for adding them. (I noticed that only public version has it for
now. :) ) But does it mean OOPIF input is broken on Android? Or is Android's
OOPIF not implemented yet? If there are any test cases to verify OOPIF case for
Android, could you point me to those?

[EhsanK, 2016/09/21 16:49:10]

Sorry for the public vs private versions of the doc. I should have only had the
public one. I left a comment in the private one that I will be updating the
public, but I guess I will go back and update the private one too.

OOPIF-Android is not complete yet, and neither is IME for it. I am working on
changing text input state tracking for android currently, and plan to implement
the same OOPIF-IME logic for Android soon. I think the methods mentioned above
could be refactored at that time.

[Changwan Ryu, 2016/09/21 23:33:16]

I see. Thanks for the clarification!

 {
     TRACE_EVENT0("blink", "WebLocalFrameImpl::extendSelectionAndDelete");
     if (WebPlugin* plugin = focusedPluginIfInputMethodSupported()) {
         plugin->extendSelectionAndDelete(before, after);
         return;
     }
 
     // TODO(xiaochengh): The use of updateStyleAndLayoutIgnorePendingStylesheets
     // needs to be audited.  See http://crbug.com/590369 for more details.
     frame()->document()->updateStyleAndLayoutIgnorePendingStylesheets();
@@ skipping 196 matching lines @@
 
 WebLocalFrameImpl::WebLocalFrameImpl(WebTreeScopeType scope, WebFrameClient* client)
     : WebLocalFrame(scope)
     , m_frameLoaderClientImpl(FrameLoaderClientImpl::create(this))
     , m_frameWidget(0)
     , m_client(client)
     , m_autofillClient(0)
     , m_contentSettingsClient(0)
     , m_inputEventsScaleFactorForEmulation(1)
     , m_webDevToolsFrontend(0)
+    , m_inputMethodController(new WebInputMethodControllerImpl(this))
     , m_selfKeepAlive(this)
 {
     frameCount++;
 }
 
 WebLocalFrameImpl::WebLocalFrameImpl(WebRemoteFrame* oldWebFrame, WebFrameClient* client)
     : WebLocalFrameImpl(oldWebFrame->inShadowTree() ? WebTreeScopeType::Shadow : WebTreeScopeType::Document, client)
 {
 }
 
@@ skipping 755 matching lines @@
     } else if (metric == "npnNegotiatedProtocol") {
         feature = UseCounter::ChromeLoadTimesNpnNegotiatedProtocol;
     } else if (metric == "wasAlternateProtocolAvailable") {
         feature = UseCounter::ChromeLoadTimesWasAlternateProtocolAvailable;
     } else if (metric == "connectionInfo") {
         feature = UseCounter::ChromeLoadTimesConnectionInfo;
     }
     UseCounter::count(frame(), feature);
 }
 
+WebInputMethodControllerImpl* WebLocalFrameImpl::inputMethodController() const
+{
+    return m_inputMethodController.get();
+}
+
 } // namespace blink