OOPIF IME: Renderer Side Changes

third_party/WebKit/Source/web/WebFrameWidgetImpl.cpp

 /*
  * Copyright (C) 2014 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 12 matching lines @@
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #include "web/WebFrameWidgetImpl.h"
 
+#include "core/InputTypeNames.h"
 #include "core/editing/EditingUtilities.h"
 #include "core/editing/Editor.h"
 #include "core/editing/FrameSelection.h"
 #include "core/editing/InputMethodController.h"
 #include "core/editing/PlainTextRange.h"
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/RemoteFrame.h"
 #include "core/frame/Settings.h"
 #include "core/frame/VisualViewport.h"
+#include "core/html/HTMLInputElement.h"
+#include "core/html/HTMLTextAreaElement.h"
 #include "core/input/EventHandler.h"
 #include "core/layout/LayoutView.h"
 #include "core/layout/api/LayoutViewItem.h"
 #include "core/layout/compositing/PaintLayerCompositor.h"
 #include "core/page/ContextMenuController.h"
 #include "core/page/FocusController.h"
 #include "core/page/Page.h"
 #include "core/page/PointerLockController.h"
 #include "platform/KeyboardCodes.h"
 #include "platform/graphics/CompositorMutatorClient.h"
 #include "public/platform/WebFrameScheduler.h"
+#include "public/web/WebPlugin.h"
+#include "public/web/WebRange.h"
 #include "public/web/WebWidgetClient.h"
+#include "web/CompositionUnderlineVectorBuilder.h"
 #include "web/CompositorMutatorImpl.h"
 #include "web/CompositorProxyClientImpl.h"
 #include "web/ContextMenuAllowedScope.h"
 #include "web/WebDevToolsAgentImpl.h"
 #include "web/WebInputEventConversion.h"
 #include "web/WebLocalFrameImpl.h"
 #include "web/WebPluginContainerImpl.h"
 #include "web/WebRemoteFrameImpl.h"
 #include "web/WebViewFrameWidget.h"
 #include "wtf/PtrUtil.h"
@@ skipping 32 matching lines @@
     , m_localRoot(toWebLocalFrameImpl(localRoot))
     , m_mutator(nullptr)
     , m_layerTreeView(nullptr)
     , m_rootLayer(nullptr)
     , m_rootGraphicsLayer(nullptr)
     , m_isAcceleratedCompositingActive(false)
     , m_layerTreeViewClosed(false)
     , m_suppressNextKeypressEvent(false)
     , m_ignoreInputEvents(false)
     , m_isTransparent(false)
+    , m_imeAcceptEvents(true)

[lfg, 2016/07/07 15:13:31]

Should this be initialized to false?

[EhsanK, 2016/07/07 20:25:08]

WebViewImpl initializes this to true. But I guess more importantly, the question
is could we have a focused frame in a Widget but not a page level focus (i.e.,
m_imeAcceptEvents == false)?

[lfg, 2016/07/07 20:58:27]

Yes, indeed.

     , m_selfKeepAlive(this)
 {
     DCHECK(m_localRoot->frame()->isLocalRoot());
     initializeLayerTreeView();
     m_localRoot->setFrameWidget(this);
     allInstances().add(this);
 
     if (localRoot->parent())
         setIsTransparent(true);
 }
@@ skipping 315 matching lines @@
 }
 
 void WebFrameWidgetImpl::mouseCaptureLost()
 {
     TRACE_EVENT_ASYNC_END0("input", "capturing mouse", this);
     m_mouseCaptureNode = nullptr;
 }
 
 void WebFrameWidgetImpl::setFocus(bool enable)
 {
+    m_imeAcceptEvents = enable;

[lfg, 2016/07/07 15:13:31]

Is it possible for the widget to have focus, but m_imeAcceptEvents be false?

[EhsanK, 2016/07/07 20:25:08]

m_imeAcceptEvents is apparent tracking page level focus. I am not sure, but if a
frame is focused on a page, then the page itself must be focused, right? If that
is the case, then I think we should just remove this variable from both
WebViewImpl and WebFrameWidgetImpl.

[lfg, 2016/07/07 20:58:27]

That's right, can you dig a bit more to see if we can get rid of this entirely?
That would be the best scenario.

[EhsanK, 2016/07/11 20:29:53]

I have explained what might happen in WebViewImpl::setFocus.

     page()->focusController().setFocused(enable);
     if (enable) {
         page()->focusController().setActive(true);
         LocalFrame* focusedFrame = page()->focusController().focusedFrame();
         if (focusedFrame) {
             Element* element = focusedFrame->document()->focusedElement();
             if (element && focusedFrame->selection().selection().isNone()) {
                 // If the selection was cleared while the WebView was not
                 // focused, then the focus element shows with a focus ring but
                 // no caret and does respond to keyboard inputs.
@@ skipping 11 matching lines @@
         }
     }
 }
 
 bool WebFrameWidgetImpl::setComposition(
     const WebString& text,
     const WebVector<WebCompositionUnderline>& underlines,
     int selectionStart,
     int selectionEnd)
 {
-    // FIXME: To be implemented.
-    return false;
+    if (!m_imeAcceptEvents)
+        return false;
+
+    LocalFrame* focused = focusedLocalFrameInWidget();
+
+    if (!focused)
+        return false;
+
+    if (WebPlugin* plugin = focusedPluginIfInputMethodSupported(focused))
+        return plugin->setComposition(text, underlines, selectionStart, selectionEnd);
+
+    // The input focus has been moved to another WebWidget object.
+    // We should use this |editor| object only to complete the ongoing
+    // composition.
+    InputMethodController& inputMethodController = focused->inputMethodController();
+    if (!focused->editor().canEdit() && !inputMethodController.hasComposition())
+        return false;
+
+    // We should verify the parent node of this IME composition node are
+    // editable because JavaScript may delete a parent node of the composition
+    // node. In this case, WebKit crashes while deleting texts from the parent
+    // node, which doesn't exist any longer.
+    const EphemeralRange range = inputMethodController.compositionEphemeralRange();
+    if (range.isNotNull()) {
+        Node* node = range.startPosition().computeContainerNode();
+        if (!node || !node->isContentEditable())
+            return false;
+    }
+
+    // A keypress event is canceled. If an ongoing composition exists, then the
+    // keydown event should have arisen from a handled key (e.g., backspace).
+    // In this case we ignore the cancellation and continue; otherwise (no
+    // ongoing composition) we exit and signal success only for attempts to
+    // clear the composition.
+    if (m_suppressNextKeypressEvent && !inputMethodController.hasComposition())
+        return text.isEmpty();
+
+    UserGestureIndicator gestureIndicator(DefinitelyProcessingNewUserGesture);
+
+    // When the range of composition underlines overlap with the range between
+    // selectionStart and selectionEnd, WebKit somehow won't paint the selection
+    // at all (see InlineTextBox::paint() function in InlineTextBox.cpp).
+    // But the selection range actually takes effect.
+    inputMethodController.setComposition(String(text),
+        CompositionUnderlineVectorBuilder(underlines),
+        selectionStart, selectionEnd);
+
+    return text.isEmpty() || inputMethodController.hasComposition();
 }
 
 bool WebFrameWidgetImpl::confirmComposition()
 {
-    // FIXME: To be implemented.
-    return false;
+    return confirmComposition(DoNotKeepSelection);
 }
 
 bool WebFrameWidgetImpl::confirmComposition(ConfirmCompositionBehavior selectionBehavior)
 {
-    // FIXME: To be implemented.
-    return false;
+    return confirmComposition(WebString(), selectionBehavior);
 }
 
 bool WebFrameWidgetImpl::confirmComposition(const WebString& text)
 {
-    // FIXME: To be implemented.
-    return false;
+    UserGestureIndicator gestureIndicator(DefinitelyProcessingNewUserGesture);
+    return confirmComposition(text, DoNotKeepSelection);
+}
+
+bool WebFrameWidgetImpl::confirmComposition(const WebString& text, ConfirmCompositionBehavior selectionBehavior) const
+{
+    if (!m_imeAcceptEvents)
+        return false;
+
+    LocalFrame* focused = focusedLocalFrameInWidget();
+    if (!focused)
+        return false;
+
+    if (WebPlugin* plugin = focusedPluginIfInputMethodSupported(focused))
+        return plugin->confirmComposition(text, selectionBehavior);
+
+    return focused->inputMethodController().confirmCompositionOrInsertText(text, selectionBehavior == KeepSelection ? InputMethodController::KeepSelection : InputMethodController::DoNotKeepSelection);
 }
 
 bool WebFrameWidgetImpl::compositionRange(size_t* location, size_t* length)
 {
-    // FIXME: To be implemented.
-    return false;
+    if (!m_imeAcceptEvents)
+        return false;
+
+    LocalFrame* focused = focusedLocalFrameInWidget();
+    if (!focused)
+        return false;
+
+    const EphemeralRange range = focused->inputMethodController().compositionEphemeralRange();
+    if (range.isNull())
+        return false;
+
+    Element* editable = focused->selection().rootEditableElementOrDocumentElement();
+    DCHECK(editable);
+    PlainTextRange plainTextRange(PlainTextRange::create(*editable, range));
+    if (plainTextRange.isNull())
+        return false;
+    *location = plainTextRange.start();
+    *length = plainTextRange.length();
+    return true;
 }
 
 WebTextInputInfo WebFrameWidgetImpl::textInputInfo()
 {
-    return view()->textInputInfo();
+    WebTextInputInfo info;
+
+    LocalFrame* focused = focusedLocalFrameInWidget();
+    if (!focused)
+        return info;
+
+    FrameSelection& selection = focused->selection();
+    if (!selection.isAvailable()) {
+        // plugins/mouse-capture-inside-shadow.html reaches here.
+        return info;
+    }
+    Element* element = selection.selection().rootEditableElement();
+    if (!element)
+        return info;
+
+    info.inputMode = inputModeOfFocusedElement();
+
+    info.type = textInputType();
+    info.flags = textInputFlags();
+    if (info.type == WebTextInputTypeNone)
+        return info;
+
+    if (!focused->editor().canEdit())
+        return info;
+
+    // Emits an object replacement character for each replaced element so that
+    // it is exposed to IME and thus could be deleted by IME on android.
+    info.value = plainText(EphemeralRange::rangeOfContents(*element), TextIteratorEmitsObjectReplacementCharacter);
+
+    if (info.value.isEmpty())
+        return info;
+
+    EphemeralRange firstRange = firstEphemeralRangeOf(selection.selection());
+    if (firstRange.isNotNull()) {
+        PlainTextRange plainTextRange(PlainTextRange::create(*element, firstRange));
+        if (plainTextRange.isNotNull()) {
+            info.selectionStart = plainTextRange.start();
+            info.selectionEnd = plainTextRange.end();
+        }
+    }
+
+    EphemeralRange range = focused->inputMethodController().compositionEphemeralRange();
+    if (range.isNotNull()) {
+        PlainTextRange plainTextRange(PlainTextRange::create(*element, range));
+        if (plainTextRange.isNotNull()) {
+            info.compositionStart = plainTextRange.start();
+            info.compositionEnd = plainTextRange.end();
+        }
+    }
+
+    return info;
 }
 
 WebTextInputType WebFrameWidgetImpl::textInputType()
 {
-    return view()->textInputType();
+    LocalFrame* focusedFrame = focusedLocalFrameInWidget();
+    if (!focusedFrame)
+        return WebTextInputTypeNone;
+
+    if (!focusedFrame->selection().isAvailable()) {
+        // "mouse-capture-inside-shadow.html" reaches here.
+        return WebTextInputTypeNone;
+    }
+
+    // It's important to preserve the equivalence of textInputInfo().type and textInputType(),
+    // so perform the same rootEditableElement() existence check here for consistency.
+    if (!focusedFrame->selection().selection().rootEditableElement())
+        return WebTextInputTypeNone;
+
+    Document* document = focusedFrame->document();
+    if (!document)
+        return WebTextInputTypeNone;
+
+    Element* element = document->focusedElement();
+    if (!element)
+        return WebTextInputTypeNone;
+
+    if (isHTMLInputElement(*element)) {
+        HTMLInputElement& input = toHTMLInputElement(*element);
+        const AtomicString& type = input.type();
+
+        if (input.isDisabledOrReadOnly())
+            return WebTextInputTypeNone;
+
+        if (type == InputTypeNames::password)
+            return WebTextInputTypePassword;
+        if (type == InputTypeNames::search)
+            return WebTextInputTypeSearch;
+        if (type == InputTypeNames::email)
+            return WebTextInputTypeEmail;
+        if (type == InputTypeNames::number)
+            return WebTextInputTypeNumber;
+        if (type == InputTypeNames::tel)
+            return WebTextInputTypeTelephone;
+        if (type == InputTypeNames::url)
+            return WebTextInputTypeURL;
+        if (type == InputTypeNames::date)
+            return WebTextInputTypeDate;
+        if (type == InputTypeNames::datetime_local)
+            return WebTextInputTypeDateTimeLocal;
+        if (type == InputTypeNames::month)
+            return WebTextInputTypeMonth;
+        if (type == InputTypeNames::time)
+            return WebTextInputTypeTime;
+        if (type == InputTypeNames::week)
+            return WebTextInputTypeWeek;
+        if (type == InputTypeNames::text)
+            return WebTextInputTypeText;
+
+        return WebTextInputTypeNone;
+    }
+
+    if (isHTMLTextAreaElement(*element)) {
+        if (toHTMLTextAreaElement(*element).isDisabledOrReadOnly())
+            return WebTextInputTypeNone;
+        return WebTextInputTypeTextArea;
+    }
+
+    if (element->isHTMLElement()) {
+        if (toHTMLElement(element)->isDateTimeFieldElement())
+            return WebTextInputTypeDateTimeField;
+    }
+
+    if (element->isContentEditable(Node::UserSelectAllIsAlwaysNonEditable))
+        return WebTextInputTypeContentEditable;
+
+    return WebTextInputTypeNone;
 }
 
 WebColor WebFrameWidgetImpl::backgroundColor() const
 {
     if (isTransparent())
         return Color::transparent;
     if (!m_localRoot->frameView())
         return m_baseBackgroundColor;
     FrameView* view = m_localRoot->frameView();
     return view->documentBackgroundColor().rgb();
@@ skipping 138 matching lines @@
 void WebFrameWidgetImpl::didNotAcquirePointerLock()
 {
     page()->pointerLockController().didNotAcquirePointerLock();
 }
 
 void WebFrameWidgetImpl::didLosePointerLock()
 {
     page()->pointerLockController().didLosePointerLock();
 }
 
+bool WebFrameWidgetImpl::getCompositionCharacterBounds(WebVector<WebRect>& bounds)
+{
+    size_t offset = 0;
+    size_t characterCount = 0;
+    if (!compositionRange(&offset, &characterCount))
+        return false;
+
+    if (characterCount == 0)
+        return false;
+
+    LocalFrame* frame = focusedLocalFrameInWidget();
+    if (!frame)
+        return false;
+
+    WebLocalFrameImpl* webLocalFrame = WebLocalFrameImpl::fromFrame(frame);
+    WebVector<WebRect> result(characterCount);
+    WebRect webrect;
+    for (size_t i = 0; i < characterCount; ++i) {
+        if (!webLocalFrame->firstRectForCharacterRange(offset + i, 1, webrect)) {
+            DLOG(ERROR) << "Could not retrieve character rectangle at " << i;
+            return false;
+        }
+        result[i] = webrect;
+    }
+    bounds.swap(result);
+    return true;
+}
+
+void WebFrameWidgetImpl::applyReplacementRange(int start, int length)
+{
+    if (LocalFrame* frame = focusedLocalFrameInWidget()) {
+        WebLocalFrameImpl* webLocalFrame = WebLocalFrameImpl::fromFrame(frame);
+        WebRange webrange = WebRange::fromDocumentRange(webLocalFrame, start, length);
+        if (!webrange.isNull())
+            webLocalFrame->selectRange(webrange);
+    }
+}
+
 void WebFrameWidgetImpl::handleMouseLeave(LocalFrame& mainFrame, const WebMouseEvent& event)
 {
     // FIXME: WebWidget doesn't have the method below.
     // m_client->setMouseOverURL(WebURL());
     PageWidgetEventHandler::handleMouseLeave(mainFrame, event);
 }
 
 void WebFrameWidgetImpl::handleMouseDown(LocalFrame& mainFrame, const WebMouseEvent& event)
 {
     // Take capture on a mouse down on a plugin so we can send it mouse events.
@@ skipping 440 matching lines @@
 }
 
 HitTestResult WebFrameWidgetImpl::hitTestResultForRootFramePos(const IntPoint& posInRootFrame)
 {
     IntPoint docPoint(m_localRoot->frame()->view()->rootFrameToContents(posInRootFrame));
     HitTestResult result = m_localRoot->frame()->eventHandler().hitTestResultAtPoint(docPoint, HitTestRequest::ReadOnly | HitTestRequest::Active);
     result.setToShadowHostIfInUserAgentShadowRoot();
     return result;
 }
 
+LocalFrame* WebFrameWidgetImpl::focusedLocalFrameInWidget() const
+{
+    LocalFrame* frame = page()->focusController().focusedFrame();
+    return (frame && frame->localFrameRoot() == m_localRoot->frame()) ? frame : nullptr;
+}
+
+WebPlugin* WebFrameWidgetImpl::focusedPluginIfInputMethodSupported(LocalFrame* frame) const
+{
+    WebPluginContainerImpl* container = WebLocalFrameImpl::currentPluginContainer(frame);
+    if (container && container->supportsInputMethod())
+        return container->plugin();
+    return nullptr;
+}
+
+WebString WebFrameWidgetImpl::inputModeOfFocusedElement() const
+{
+    if (!RuntimeEnabledFeatures::inputModeAttributeEnabled())
+        return WebString();
+
+    Element* element = focusedElement();
+    if (!element)
+        return WebString();
+
+    if (isHTMLInputElement(*element)) {
+        const HTMLInputElement& input = toHTMLInputElement(*element);
+        if (input.supportsInputModeAttribute())
+            return input.fastGetAttribute(HTMLNames::inputmodeAttr).lower();
+        return WebString();
+    }
+    if (isHTMLTextAreaElement(*element)) {
+        const HTMLTextAreaElement& textarea = toHTMLTextAreaElement(*element);
+        return textarea.fastGetAttribute(HTMLNames::inputmodeAttr).lower();
+    }
+
+    return WebString();
+}
+
+int WebFrameWidgetImpl::textInputFlags() const
+{
+    Element* element = focusedElement();
+    if (!element)
+        return WebTextInputFlagNone;
+
+    DEFINE_STATIC_LOCAL(AtomicString, autocompleteString, ("autocomplete"));
+    DEFINE_STATIC_LOCAL(AtomicString, autocorrectString, ("autocorrect"));
+    int flags = 0;
+
+    const AtomicString& autocomplete = element->getAttribute(autocompleteString);
+    if (autocomplete == "on")
+        flags |= WebTextInputFlagAutocompleteOn;
+    else if (autocomplete == "off")
+        flags |= WebTextInputFlagAutocompleteOff;
+
+    const AtomicString& autocorrect = element->getAttribute(autocorrectString);
+    if (autocorrect == "on")
+        flags |= WebTextInputFlagAutocorrectOn;
+    else if (autocorrect == "off")
+        flags |= WebTextInputFlagAutocorrectOff;
+
+    SpellcheckAttributeState spellcheck = element->spellcheckAttributeState();
+    if (spellcheck == SpellcheckAttributeTrue)
+        flags |= WebTextInputFlagSpellcheckOn;
+    else if (spellcheck == SpellcheckAttributeFalse)
+        flags |= WebTextInputFlagSpellcheckOff;
+
+    if (isHTMLTextFormControlElement(element)) {
+        HTMLTextFormControlElement* formElement = static_cast<HTMLTextFormControlElement*>(element);
+        if (formElement->supportsAutocapitalize()) {
+            DEFINE_STATIC_LOCAL(const AtomicString, none, ("none"));
+            DEFINE_STATIC_LOCAL(const AtomicString, characters, ("characters"));
+            DEFINE_STATIC_LOCAL(const AtomicString, words, ("words"));
+            DEFINE_STATIC_LOCAL(const AtomicString, sentences, ("sentences"));
+
+            const AtomicString& autocapitalize = formElement->autocapitalize();
+            if (autocapitalize == none)
+                flags |= WebTextInputFlagAutocapitalizeNone;
+            else if (autocapitalize == characters)
+                flags |= WebTextInputFlagAutocapitalizeCharacters;
+            else if (autocapitalize == words)
+                flags |= WebTextInputFlagAutocapitalizeWords;
+            else if (autocapitalize == sentences)
+                flags |= WebTextInputFlagAutocapitalizeSentences;
+            else
+                NOTREACHED();
+        }
+    }
+
+    return flags;
+}
+
 } // namespace blink