Introduce WebInputMethodController to blink

third_party/WebKit/public/web/WebInputMethodController.h

 /*
  * Copyright (C) 2016 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 10 matching lines @@
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * 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.
  */
 
-#ifndef DOMVisualViewport_h
-#define DOMVisualViewport_h
+#ifndef WebInputMethodController_h
+#define WebInputMethodController_h
 
-#include "bindings/core/v8/ScriptWrappable.h"
-#include "core/dom/ExecutionContext.h"
-#include "core/events/EventTarget.h"
-#include "platform/heap/Handle.h"
+#include "WebCompositionUnderline.h"
+#include "WebWidget.h"
 
 namespace blink {
 
-class LocalDOMWindow;
-class ExecutionContext;
+class WebString;
+template <typename T>
+class WebVector;
 
-class DOMVisualViewport final : public EventTargetWithInlineData {
-    DEFINE_WRAPPERTYPEINFO();
+class WebInputMethodController {
+
 public:
-    static DOMVisualViewport* create(LocalDOMWindow* window)
-    {
-        return new DOMVisualViewport(window);
-    }
+    enum ConfirmCompositionBehavior {
+        DoNotKeepSelection,
+        KeepSelection,
+    };
 
-    ~DOMVisualViewport() override;
+    virtual ~WebInputMethodController() {};
+    // Called to inform the WebInputMethodController of a new composition text.
+    // If selectionStart and selectionEnd has the same value, then it indicates
+    // the input caret position. If the text is empty, then the existing
+    // composition text will be canceled.
+    // Returns true if the composition text was set successfully.
+    virtual bool setComposition(
+        const WebString& text,
+        const WebVector<WebCompositionUnderline>& underlines,
+        int selectionStart,
+        int selectionEnd)
+        = 0;
 
-    DECLARE_VIRTUAL_TRACE();
+    // Called to inform the WebWidget that deleting the ongoing composition if
+    // any, inserting the specified text, and moving the caret according to
+    // relativeCaretPosition.
+    virtual bool commitText(const WebString& text, int relativeCaretPosition) = 0;
 
-    // EventTarget overrides:
-    const AtomicString& interfaceName() const override;
-    ExecutionContext* getExecutionContext() const override;
-
-    double scrollLeft();
-    double scrollTop();
-    double pageX();
-    double pageY();
-    double clientWidth();
-    double clientHeight();
-    double scale();
-
-private:
-    explicit DOMVisualViewport(LocalDOMWindow*);
-
-    Member<LocalDOMWindow> m_window;
+    // Called to inform the WebWidget to confirm an ongoing composition.
+    virtual bool finishComposingText(ConfirmCompositionBehavior selectionBehavior) = 0;
 };
 
 } // namespace blink
-
-#endif // DOMVisualViewport_h
+#endif