Move some common ime code to ui/base/

ui/base/win/ime_input.h

-// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Copyright (c) 2011 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.
 
-#ifndef CHROME_BROWSER_IME_INPUT_H_
-#define CHROME_BROWSER_IME_INPUT_H_
+#ifndef UI_BASE_WIN_IME_INPUT_H_
+#define UI_BASE_WIN_IME_INPUT_H_
 #pragma once
 
 #include <windows.h>
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
-#include "third_party/WebKit/Source/WebKit/chromium/public/WebCompositionUnderline.h"
+#include "base/i18n/rtl.h"
+#include "base/string16.h"
 #include "ui/gfx/rect.h"
 
+namespace ui {
+
+struct CompositionText;
+
 // This header file defines a struct and a class used for encapsulating IMM32
 // APIs, controls IMEs attached to a window, and enables the 'on-the-spot'
 // input without deep knowledge about the APIs, i.e. knowledge about the
 // language-specific and IME-specific behaviors.
 // The following items enumerates the simplest steps for an (window)
 // application to control its IMEs with the struct and the class defined
 // this file.
 // 1. Add an instance of the ImeInput class to its window class.
 //    (The ImeInput class needs a window handle.)
 // 2. Add messages handlers listed in the following subsections, follow the
@@ skipping 19 matching lines @@
 // 2.4. WM_IME_ENDCOMPOSITION (0x010E)
 //      Call the functions listed below:
 //      - ImeInput::ResetComposition(), and;
 //      - ImeInput::DestroyImeWindow().
 //      An application CAN call ::DefWindowProc().
 // 2.5. WM_INPUTLANGCHANGE (0x0051)
 //      Call the functions listed below:
 //      - ImeInput::SetInputLanguage().
 //      An application CAN call ::DefWindowProc().
 
-// This struct represents the status of an ongoing composition.
-struct ImeComposition {
-  // Represents the start position of the selection range in the IME
-  // composition.
-  int selection_start;
-
-  // Represents the end position of the selection range in the IME composition.
-  // If |selection_start| and |selection_end| are equal, then it represents the
-  // cursor position.
-  int selection_end;
-
-  // Represents the type of the string in the 'ime_string' parameter.
-  // Its possible values and description are listed bwlow:
-  //   Value         Description
-  //   0             The parameter is not used.
-  //   GCS_RESULTSTR The parameter represents a result string.
-  //   GCS_COMPSTR   The parameter represents a composition string.
-  int string_type;
-
-  // Represents the string retrieved from IME (Input Method Editor)
-  std::wstring ime_string;
-
-  // Contains the underline information of the composition string.
-  std::vector<WebKit::WebCompositionUnderline> underlines;
-};
-
 // This class controls the IMM (Input Method Manager) through IMM32 APIs and
 // enables it to retrieve the string being controled by the IMM. (I wrote
 // a note to describe the reason why I do not use 'IME' but 'IMM' below.)
 // NOTE(hbono):
 //   Fortunately or unfortunately, TSF (Text Service Framework) and
 //   CUAS (Cicero Unaware Application Support) allows IMM32 APIs for
 //   retrieving not only the inputs from IMEs (Input Method Editors), used
 //   only for inputting East-Asian language texts, but also the ones from
 //   tablets (on Windows XP Tablet PC Edition and Windows Vista), voice
 //   recognizers (e.g. ViaVoice and Microsoft Office), etc.
@@ skipping 34 matching lines @@
   //     These parameters are used for verifying if this function is called
   //     in a handler function for WM_IME_SETCONTEXT messages because this
   //     function uses ::DefWindowProc() to update the style.
   //     A caller just has to pass the input parameters for the handler
   //     function without modifications.
   //   * handled [out] (BOOL*)
   //     Returns ::DefWindowProc() is really called in this function.
   //     PLEASE DO NOT CALL ::DefWindowProc() IF THIS VALUE IS TRUE!
   //     All the window styles set in this function are over-written when
   //     calling ::DefWindowProc() after returning this function.
-  void SetImeWindowStyle(HWND window_handle, UINT message,
-                         WPARAM wparam, LPARAM lparam, BOOL* handled);
+  // Returns the value returned by DefWindowProc.
+  LRESULT SetImeWindowStyle(HWND window_handle, UINT message,
+                            WPARAM wparam, LPARAM lparam, BOOL* handled);
 
   // Destroys the IME windows and all the resources attached to them.
   // Parameters
   //   * window_handle [in] (HWND)
   //     Represents the window handle of the caller.
   void DestroyImeWindow(HWND window_handle);
 
   // Updates the position of the IME windows.
   // Parameters
   //   * window_handle [in] (HWND)
@@ skipping 17 matching lines @@
 
   // Retrieves a composition result of the ongoing composition if it exists.
   // Parameters
   //   * window_handle [in] (HWND)
   //     Represents the window handle of the caller.
   //   * lparam [in] (LPARAM)
   //     Specifies the updated members of the ongoing composition, and must be
   //     the same parameter of a WM_IME_COMPOSITION message handler.
   //     This parameter is used for checking if the ongoing composition has
   //     its result string,
-  //   * composition [out] (ImeComposition)
-  //     Represents the struct contains the composition result.
+  //   * result [out] (string16)
+  //     Represents the object contains the composition result.
   // Return values
   //   * true
   //     The ongoing composition has a composition result.
   //   * false
   //     The ongoing composition does not have composition results.
   // Remarks
   //   This function is designed for being called from WM_IME_COMPOSITION
   //   message handlers.
-  bool GetResult(HWND window_handle, LPARAM lparam,
-                 ImeComposition* composition);
+  bool GetResult(HWND window_handle, LPARAM lparam, string16* result);
 
   // Retrieves the current composition status of the ongoing composition.
   // Parameters
   //   * window_handle [in] (HWND)
   //     Represents the window handle of the caller.
   //   * lparam [in] (LPARAM)
   //     Specifies the updated members of the ongoing composition, and must be
   //     the same parameter of a WM_IME_COMPOSITION message handler.
   //     This parameter is used for checking if the ongoing composition has
   //     its result string,
-  //   * composition [out] (ImeComposition)
+  //   * composition [out] (Composition)
   //     Represents the struct contains the composition status.
   // Return values
   //   * true
   //     The status of the ongoing composition is updated.
   //   * false
   //     The status of the ongoing composition is not updated.
   // Remarks
   //   This function is designed for being called from WM_IME_COMPOSITION
   //   message handlers.
   bool GetComposition(HWND window_handle, LPARAM lparam,
-                      ImeComposition* composition);
+                      CompositionText* composition);
 
   // Enables the IME attached to the given window, i.e. allows user-input
   // events to be dispatched to the IME.
   // Parameters
   //   * window_handle [in] (HWND)
   //     Represents the window handle of the caller.
   //   * complete [in] (bool)
   //     Represents whether or not to complete the ongoing composition.
   //     + true
   //       After finishing the ongoing composition and close its IME windows,
@@ skipping 21 matching lines @@
 
   // Updates the caret position of the given window.
   // Parameters
   //   * window_handle [in] (HWND)
   //     Represents the window handle of the caller.
   //   * caret_rect [in] (const gfx::Rect&)
   //     Represent the rectangle of the input caret.
   //     This rectangle is used for controlling the positions of IME windows.
   void UpdateCaretRect(HWND window_handle, const gfx::Rect& caret_rect);
 
+  // Returns the current input language id.
+  LANGID input_language_id() const { return input_language_id_; }
+
+  // Returns BCP-47 tag name of the current input language.
+  std::string GetInputLanguageName() const;
+
+  // Returns the text direction of the current input language.
+  base::i18n::TextDirection GetTextDirection() const;
+
+
+  // Helper functions ----------------------------------------------------------
+
+  // Checks if there is any RTL keyboard layout installed in the system.
+  static bool IsRTLKeyboardLayoutInstalled();
+
+  // Checks if the user pressed both Ctrl and right or left Shift keys to
+  // requrest to change the text direction and layout alignment explicitly.
+  // Returns true if only a Ctrl key and a Shift key are down. The desired text
+  // direction will be stored in |*direction|.
+  static bool IsCtrlShiftPressed(base::i18n::TextDirection* direction);
+
  protected:
   // Retrieves the composition information.
   void GetCompositionInfo(HIMC imm_context, LPARAM lparam,
-                          ImeComposition* composition);
+                          CompositionText* composition);
 
   // Updates the position of the IME windows.
   void MoveImeWindow(HWND window_handle, HIMC imm_context);
 
   // Completes the ongoing composition if it exists.
   void CompleteComposition(HWND window_handle, HIMC imm_context);
 
   // Retrieves a string from the IMM.
-  bool GetString(HIMC imm_context, WPARAM lparam, int type,
-                 ImeComposition* composition);
+  bool GetString(HIMC imm_context, WPARAM lparam, int type, string16* result);
 
  private:
   // Represents whether or not there is an ongoing composition in a browser
   // process, i.e. whether or not a browser process is composing a text.
   bool is_composing_;
 
   // This value represents whether or not the current input context has IMEs.
   // The following table shows the list of IME status:
   //   Value  Description
   //   false  The current input language does not have IMEs.
@@ skipping 27 matching lines @@
   //   * true: it creates a system caret.
   //   * false: it does not create a system caret.
   bool system_caret_;
 
   // The rectangle of the input caret retrieved from a renderer process.
   gfx::Rect caret_rect_;
 
   DISALLOW_COPY_AND_ASSIGN(ImeInput);
 };
 
-#endif  // CHROME_BROWSER_IME_INPUT_H_
+}  // namespace ui
+
+#endif  // UI_BASE_WIN_IME_INPUT_H_