IME for Mus: Send TextInputClient information to IMEDriver.

services/ui/public/interfaces/ime/ime.mojom

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 module ui.mojom;
 
+import "mojo/common/rtl.mojom";
 import "ui/events/mojo/event.mojom";
 import "ui/gfx/geometry/mojo/geometry.mojom";
 import "ui/gfx/range/mojo/range.mojom";
 
 // Represents an underlined segment of text currently composed by IME.
 // Corresponds to ui::CompositionUnderline.
 struct CompositionUnderline {
   uint32 start_offset;
   uint32 end_offset;
   bool thick;
@@ skipping 46 matching lines @@
   EMAIL,
   URL,
 };
 
 // A service which provides the IMEDriver interface is responsible for doing
 // the composition logic. After starting a session, it receives events from
 // the client via the InputMethod interface, and sends composition events to
 // the client via the TextInputClient.
 interface IMEDriver {
   // session_id is unique and generated by Mus.
-  StartSession(int32 session_id, TextInputClient client,
-               InputMethod& input_method);
+  StartSession(int32 session_id, TextInputClientInformation client_info,
+               TextInputClient client, InputMethod& input_method);
   CancelSession(int32 session_id);
 };
 
 // Clients use IME using the IMEServer interface which is provided by Mus. Mus
 // does minimal processing and mostly just acts as lightweight proxy between
 // the client app and the registered IME driver.
 interface IMEServer {
-  StartSession(TextInputClient client,
+  StartSession(TextInputClientInformation client_info, TextInputClient client,
                InputMethod& input_method);
 };
 
 // An IME driver register should register itself to Mus using the IMERegistrar
 // interface.
 interface IMERegistrar {
   RegisterDriver(IMEDriver driver);
 };
 
 // A client sends updates to the IME driver using the InputMethod interface.
 // This interface is provided by IME drivers, and also by Mus as a lightweight
 // proxy between IME drivers and clients.
 interface InputMethod {
   OnTextInputModeChanged(TextInputMode text_input_mode);
   OnTextInputTypeChanged(TextInputType text_input_type);
 
   // Client sends |caret_bounds| in focused window coordinates,
   // Mus translates it to global coordinates and sends it to IME app.
   OnCaretBoundsChanged(gfx.mojom.Rect caret_bounds);
 
   // Called to process a key event. The callback function will be called to
   // notify the client if the event was handled or not. A handled event may
   // generate zero or more composition events which will be sent to the client
   // using the "input method result" functions of TextInputClient interface.
   ProcessKeyEvent(ui.mojom.Event key_event) => (bool handled);
 
   CancelComposition();
 };
 
+// Contains information about a TextInputClient required by an IMEDriver. Client
+// sends the initial state when starting a session, and can update some of these
+// variables using methods in InputMethod.
+struct TextInputClientInformation {

[sky, 2017/01/13 20:32:41]

Information -> Data or Details?

+  TextInputType text_input_type;
+  TextInputMode text_input_mode;
+  mojo.common.mojom.TextDirection text_direction;
+  int32 text_input_flags;
+  gfx.mojom.Rect caret_bounds;

[sky, 2017/01/13 20:32:41]

Would it make sense to move TextInputClient and InputMethod& into here? That way
StartSession becomes StartSession(int session_id, StartSessionDetails)

[Hadi, 2017/01/13 21:47:52]

Yes, I think it'll make the code simpler. Done.

+};
+
 // IME drivers send updates to clients using the TextInputClient interface.
 interface TextInputClient {
   // Functions corresponding to "input method result" functions of
   // ui::TextInputClient. See comments for InputMethod::ProcessKeyEvent() for
   // when these are called.
 
   // Sets composition text and attributes. See comments for
   // ui::TextInputClient::SetCompositionText() for more details.
   SetCompositionText(CompositionText composition);
   
@@ skipping 12 matching lines @@
   // the character is not processed. See ui::TextInputClient::InsertChar()
   // for more details.
   InsertChar(ui.mojom.Event event);
 
   // TODO(moshayedi): Add functions corresponding to ui::TextInputClient for:
   // - Input context information
   // - Document content operations
   // - Miscellaneous functions
   // crbug.com/631527.
 };