OOPIF IME: Renderer Side Changes

third_party/WebKit/Source/web/WebViewImpl.cpp

 /*
  * Copyright (C) 2011, 2012 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 2286 matching lines @@
 
         LocalFrame* focusedFrame = m_page->focusController().focusedFrame();
         if (focusedFrame) {
             // Finish an ongoing composition to delete the composition node.
             if (focusedFrame->inputMethodController().hasComposition()) {
                 WebAutofillClient* autofillClient = WebLocalFrameImpl::fromFrame(focusedFrame)->autofillClient();
 
                 if (autofillClient)
                     autofillClient->setIgnoreTextChanges(true);
 
                 focusedFrame->inputMethodController().confirmComposition();

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

Let's say we have an ongoing composition and then suddenly change tabs. If the
IPC for page focus arrives sooner we confirm the composition here. Now if the
IPC from IME to confirm arrives later, and we allow it to be processed (by not
checking the flag m_imeAcceptEvents), the same text is confirmed again and
things will appear twice.

I artificially tested this by post tasking IME methods after some delay.

[lfg, 2016/07/11 20:55:51]

Acknowledged.

 
                 if (autofillClient)
                     autofillClient->setIgnoreTextChanges(false);
             }
             m_imeAcceptEvents = false;
         }
     }
 }
 
 bool WebViewImpl::setComposition(
     const WebString& text,
     const WebVector<WebCompositionUnderline>& underlines,
     int selectionStart,
     int selectionEnd)
 {
     LocalFrame* focused = toLocalFrame(focusedCoreFrame());
     if (!focused || !m_imeAcceptEvents)
         return false;
 
+    // In case the focused frame has changed and IME on browser side has did
+    // not know this when it sent the IPC.
+    if (focused->localFrameRoot() != mainFrameImpl()->frame())
+        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;
 
@@ skipping 44 matching lines @@
     UserGestureIndicator gestureIndicator(DefinitelyProcessingNewUserGesture);
     return confirmComposition(text, DoNotKeepSelection);
 }
 
 bool WebViewImpl::confirmComposition(const WebString& text, ConfirmCompositionBehavior selectionBehavior)
 {
     LocalFrame* focused = toLocalFrame(focusedCoreFrame());
     if (!focused || !m_imeAcceptEvents)
         return false;
 
+    // In case the focused frame has changed and IME on browser side has did
+    // not know this when it sent the IPC.
+    if (focused->localFrameRoot() != mainFrameImpl()->frame())
+        return false;
+
     if (WebPlugin* plugin = focusedPluginIfInputMethodSupported(focused))
         return plugin->confirmComposition(text, selectionBehavior);
 
     return focused->inputMethodController().confirmCompositionOrInsertText(text, selectionBehavior == KeepSelection ? InputMethodController::KeepSelection : InputMethodController::DoNotKeepSelection);
 }
 
 bool WebViewImpl::compositionRange(size_t* location, size_t* length)
 {
     // FIXME: Long term, the focused frame should be a local frame. For now,
     // return early to avoid crashes.
     Frame* frame = focusedCoreFrame();
     if (!frame || frame->isRemoteFrame())
         return false;
 
     LocalFrame* focused = toLocalFrame(frame);
     if (!focused || !m_imeAcceptEvents)
         return false;
 
+    // In case the focused frame has changed and IME on browser side has did
+    // not know this when sent the IPC.
+    if (focused->localFrameRoot() != mainFrameImpl()->frame())
+        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 WebViewImpl::textInputInfo()
 {
     WebTextInputInfo info;
 
+    // When mainFrameImpl() is nullptr/remote, IME is handled at the Widget
+    // belonging to the local root.
+    if (!mainFrameImpl())
+        return info;
+
     Frame* focusedFrame = focusedCoreFrame();
     if (!focusedFrame->isLocalFrame())
         return info;
 
     LocalFrame* focused = toLocalFrame(focusedFrame);
     if (!focused)
         return info;
 
+    // We can only have a text input type when focused frame belongs to this
+    // WebViewImpl, i.e., its local root is the main frame.
+    if (focused->localFrameRoot() != mainFrameImpl()->frame())
+        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();
@@ skipping 29 matching lines @@
             info.compositionStart = plainTextRange.start();
             info.compositionEnd = plainTextRange.end();
         }
     }
 
     return info;
 }
 
 WebTextInputType WebViewImpl::textInputType()
 {
+    // When mainFrameImpl() is nullptr/remote, IME is handled at the Widget
+    // belonging to the local root.
+    if (!mainFrameImpl())
+        return WebTextInputTypeNone;
+
     LocalFrame* focusedFrame = m_page->focusController().focusedFrame();
     if (!focusedFrame)
         return WebTextInputTypeNone;
 
+    if (focusedFrame != mainFrameImpl()->frame()) {
+        // We can only report a text input type when the focused frame belongs
+        // to this WebViewImpl, i.e., its local root is the main frame.
+        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;
 
@@ skipping 319 matching lines @@
     if (page())
         page()->pointerLockController().didLosePointerLock();
 }
 
 void WebViewImpl::didChangeWindowResizerRect()
 {
     if (mainFrameImpl()->frameView())
         mainFrameImpl()->frameView()->windowResizerRectChanged();
 }
 
+bool WebViewImpl::getCompositionCharacterBounds(WebVector<WebRect>& bounds)
+{
+    size_t offset = 0;
+    size_t characterCount = 0;
+    if (!compositionRange(&offset, &characterCount))
+        return false;
+
+    if (characterCount == 0)
+        return false;
+
+    WebLocalFrame* frame = focusedFrame();
+
+    // Only consider frames whose local root is the main frame. For other
+    // local frames which have different local roots, the corresponding
+    // WebFrameWidget will handle this task.
+    if (frame->localRoot() != mainFrameImpl())
+        return false;
+
+    WebVector<WebRect> result(characterCount);
+    WebRect webrect;
+    for (size_t i = 0; i < characterCount; ++i) {
+        if (!frame->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 WebViewImpl::applyReplacementRange(int start, int length)
+{
+    if (WebLocalFrame* frame = focusedFrame()->toWebLocalFrame()) {
+        WebRange webrange = WebRange::fromDocumentRange(frame, start, length);
+        if (!webrange.isNull())
+            frame->selectRange(webrange);
+    }
+}
+
 // WebView --------------------------------------------------------------------
 
 WebSettingsImpl* WebViewImpl::settingsImpl()
 {
     if (!m_webSettings)
         m_webSettings = wrapUnique(new WebSettingsImpl(&m_page->settings(), m_devToolsEmulator.get()));
     DCHECK(m_webSettings);
     return m_webSettings.get();
 }
 
@@ skipping 1732 matching lines @@
 {
     // TODO(oshima): Investigate if this should return the ScreenInfo's scale factor rather than
     // page's scale factor, which can be 1 in use-zoom-for-dsf mode.
     if (!page())
         return 1;
 
     return page()->deviceScaleFactor();
 }
 
 } // namespace blink