Handle newCursorPosition correctly for Android's commitText()

third_party/WebKit/Source/core/editing/InputMethodController.cpp

 /*
  * Copyright (C) 2006, 2007, 2008, 2011 Apple Inc. All rights reserved.
  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 167 matching lines @@
 
     // The composition can start inside a composed character sequence, so we have to override checks.
     // See <http://bugs.webkit.org/show_bug.cgi?id=15781>
     VisibleSelection selection;
     selection.setWithoutValidation(range.startPosition(), range.endPosition());
     frame().selection().setSelection(selection, 0);
 }
 
 bool InputMethodController::confirmComposition()
 {
-    return confirmComposition(composingText());
+    return replaceComposition(composingText(), KeepSelection);
 }
 
-bool InputMethodController::confirmComposition(const String& text, ConfirmCompositionBehavior confirmBehavior)
+bool InputMethodController::replaceComposition(const String& text, ConfirmCompositionBehavior confirmBehavior)
 {
     if (!hasComposition())
         return false;
 
     Optional<Editor::RevealSelectionScope> revealSelectionScope;
     if (confirmBehavior == KeepSelection)
         revealSelectionScope.emplace(&editor());
 
     // If the composition was set from existing text and didn't change, then
     // there's nothing to do here (and we should avoid doing anything as that
@@ skipping 24 matching lines @@
     // Event handler might destroy document.
     if (!frame().document())
         return false;
 
     // No DOM update after 'compositionend'.
     dispatchCompositionEndEvent(frame(), text);
 
     return true;
 }
 
-bool InputMethodController::confirmCompositionOrInsertText(const String& text, ConfirmCompositionBehavior confirmBehavior)
+bool InputMethodController::replaceCompositionAndMoveCaret(const String& text, int relativeCaretPosition)
 {
-    if (!hasComposition()) {
-        if (!text.length())
-            return false;
+    Element* rootEditableElement = frame().selection().rootEditableElement();
+    if (!rootEditableElement)
+        return false;
+    PlainTextRange compositionRange = PlainTextRange::create(*rootEditableElement, *m_compositionRange);
+    if (compositionRange.isNull())
+        return false;
 
-        if (dispatchBeforeInputInsertText(frame().document()->focusedElement(), text) != DispatchEventResult::NotCanceled)
-            return false;
+    int absoluteCaretPosition = getAbsoluteCaretPosition(compositionRange.start(), text.length(), relativeCaretPosition);
+    return replaceComposition(text, DoNotKeepSelection) && moveCaret(absoluteCaretPosition);
+}
 
-        editor().insertText(text, 0);
+bool InputMethodController::commitComposition(const String& text)
+{
+    if (!hasComposition())
+        return insertText(text);
+
+    if (text.length()) {
+        replaceComposition(text, KeepSelection);
         return true;
     }
 
-    if (text.length()) {
-        confirmComposition(text);
-        return true;
-    }
-
-    if (confirmBehavior == DoNotKeepSelection)
-        return confirmComposition(composingText(), DoNotKeepSelection);
-
     SelectionOffsetsScope selectionOffsetsScope(this);
     return confirmComposition();
 }
 
+bool InputMethodController::commitCompositionAndMoveCaret(const String& text, int relativeCaretPosition)
+{
+    if (!hasComposition())
+        return insertTextAndMoveCaret(text, relativeCaretPosition);
+

[yosin_UTC9, 2016/08/29 07:02:01]

nit: no need to have an extra blank line.

[yabinh, 2016/08/29 08:44:00]

Done.

+    if (text.length())
+        return replaceCompositionAndMoveCaret(text, relativeCaretPosition);
+

[yosin_UTC9, 2016/08/29 07:02:02]

nit: no need to have an extra blank line.

[yabinh, 2016/08/29 08:44:01]

Done.

+    return replaceCompositionAndMoveCaret(composingText(), relativeCaretPosition);
+}
+
+bool InputMethodController::insertText(const String& text)
+{
+    if (!text.length())
+        return false;
+

[yosin_UTC9, 2016/08/29 07:02:02]

nit: no need to have an extra blank line.

[yabinh, 2016/08/29 08:44:01]

Done.

+    if (dispatchBeforeInputInsertText(frame().document()->focusedElement(), text) != DispatchEventResult::NotCanceled)
+        return false;
+

[yosin_UTC9, 2016/08/29 07:02:02]

nit: no need to have an extra blank line.

[yabinh, 2016/08/29 08:44:01]

Done.

+    editor().insertText(text, 0);
+    return true;
+}
+
+bool InputMethodController::insertTextAndMoveCaret(const String& text, int relativeCaretPosition)
+{
+    PlainTextRange selectionRange = getSelectionOffsets();
+    if (selectionRange.isNull())
+        return false;
+

[yosin_UTC9, 2016/08/29 07:02:02]

nit: no need to have an extra blank line.

[yabinh, 2016/08/29 08:44:01]

Done.

+    int absoluteCaretPosition = getAbsoluteCaretPosition(selectionRange.start(), text.length(), relativeCaretPosition);

[yosin_UTC9, 2016/08/29 07:02:01]

s/getAbsoluteCaretPosition/computeAbsoluteCaretPosition/
Blink doesn't prefer function names starting with "get".

[yabinh, 2016/08/29 08:44:01]

Done.

+    return insertText(text) && moveCaret(absoluteCaretPosition);

[yosin_UTC9, 2016/08/29 07:02:02]

We should not compute |absoluteCaretPosition| when |insertText(text)| returns
false.

[yabinh, 2016/08/29 08:44:01]

Done.
BTW, we should restore the selection and composition data before inserting text,
because they will change after insertion.

+}
+
 void InputMethodController::cancelComposition()
 {
     if (!hasComposition())
         return;
 
     Editor::RevealSelectionScope revealSelectionScope(&editor());
 
     if (frame().selection().isNone())
         return;
 
@@ skipping 65 matching lines @@
     //    Sending a compositionupdate event at this time ensures that at least one
     //    compositionupdate event is dispatched.
     // 2. Updating the existing composition node.
     //    Send a compositionupdate event when this function updates the existing composition
     //    node, i.e. hasComposition() && !text.isEmpty().
     // 3. Canceling the ongoing composition.
     //    Send a compositionend event when function deletes the existing composition node, i.e.
     //    !hasComposition() && test.isEmpty().
     if (text.isEmpty()) {
         if (hasComposition()) {
-            confirmComposition(emptyString());
+            replaceComposition(emptyString(), KeepSelection);
         } else {
             // It's weird to call |setComposition()| with empty text outside composition, however some IME
             // (e.g. Japanese IBus-Anthy) did this, so we simply delete selection without sending extra events.
             TypingCommand::deleteSelection(*frame().document(), TypingCommand::PreventSpellChecking);
         }
 
         setEditableSelectionOffsets(selectedRange);
         return;
     }
 
@@ skipping 179 matching lines @@
 
     rightBoundary += textLength;
 
     // In case of exceeding the right boundary.
     start = std::min(start, rightBoundary);
     end = std::min(end, rightBoundary);
 
     return PlainTextRange(start, end);
 }
 
+int InputMethodController::getAbsoluteCaretPosition(size_t textStart, size_t textLength, int relativeCaretPosition) const

[yosin_UTC9, 2016/08/29 07:02:02]

This function should be a local static function instead of a member function of
|InputMethodController|, since this function doesn't use members in
|InputMethodController| class.

[yabinh, 2016/08/29 08:44:00]

Done.

+{
+    // If relativeCaretPosition > 0, it's relative to the end of the text - 1;

[yosin_UTC9, 2016/08/29 07:02:01]

Please put this comment in .h file.

[yabinh, 2016/08/29 08:44:01]

Since this function is not declared in .h file in the latest patch, I'll keep
the comments in .cpp file.

+    // if relativeCaretPosition <= 0, it is relative to the start of the text.
+    // This is to match Android behavior. See
+    // https://developer.android.com/reference/android/view/inputmethod/InputConnection.html#commitText(java.lang.CharSequence, int)
+    if (relativeCaretPosition > 0)
+        relativeCaretPosition += textLength - 1;
+    return textStart + relativeCaretPosition;
+}
+
+bool InputMethodController::moveCaret(int newCaretPosition)
+{
+    frame().document()->updateStyleAndLayoutIgnorePendingStylesheets();
+
+    PlainTextRange selectedRange = createRangeForSelection(newCaretPosition, newCaretPosition, 0);
+    if (selectedRange.isNull())
+        return false;
+    return setEditableSelectionOffsets(selectedRange);
+}
+
 void InputMethodController::extendSelectionAndDelete(int before, int after)
 {
     if (!editor().canEdit())
         return;
     PlainTextRange selectionOffsets(getSelectionOffsets());
     if (selectionOffsets.isNull())
         return;
 
     // A common call of before=1 and after=0 will fail if the last character
     // is multi-code-word UTF-16, including both multi-16bit code-points and
@@ skipping 19 matching lines @@
     TypingCommand::deleteSelection(*frame().document());
 }
 
 DEFINE_TRACE(InputMethodController)
 {
     visitor->trace(m_frame);
     visitor->trace(m_compositionRange);
 }
 
 } // namespace blink