358 lines
13 KiB
C++
358 lines
13 KiB
C++
/* SPDX-FileCopyrightText: 2010 The Chromium Authors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup GHOST
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef WITH_INPUT_IME
|
|
|
|
# include <windows.h>
|
|
|
|
# include <string>
|
|
|
|
# include "GHOST_Event.hh"
|
|
# include "GHOST_Rect.hh"
|
|
# include <vector>
|
|
|
|
/* MSDN LOCALE_SISO639LANGNAME states maximum length of 9, including terminating null. */
|
|
# define W32_ISO639_LEN 9
|
|
|
|
class GHOST_EventIME : public GHOST_Event {
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
* \param msec: The time this event was generated.
|
|
* \param type: The type of key event.
|
|
* \param customdata: custom-data, typically #GHOST_TEventImeData.
|
|
*/
|
|
GHOST_EventIME(uint64_t msec,
|
|
GHOST_TEventType type,
|
|
GHOST_IWindow *window,
|
|
const void *customdata)
|
|
: GHOST_Event(msec, type, window)
|
|
{
|
|
this->data_ = customdata;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* 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 GHOST_ImeWin32 class to its window class.
|
|
* (The GHOST_ImeWin32 class needs a window handle.)
|
|
* 2. Add messages handlers listed in the following subsections, follow the
|
|
* instructions written in each subsection, and use the GHOST_ImeWin32 class.
|
|
* 2.1. WM_IME_SETCONTEXT (0x0281)
|
|
* Call the functions listed below:
|
|
* - GHOST_ImeWin32::CreateImeWindow();
|
|
* - GHOST_ImeWin32::CleanupComposition(), and;
|
|
* - GHOST_ImeWin32::SetImeWindowStyle().
|
|
* An application MUST prevent from calling ::DefWindowProc().
|
|
* 2.2. WM_IME_STARTCOMPOSITION (0x010D)
|
|
* Call the functions listed below:
|
|
* - GHOST_ImeWin32::CreateImeWindow(), and;
|
|
* - GHOST_ImeWin32::ResetComposition().
|
|
* An application MUST prevent from calling ::DefWindowProc().
|
|
* 2.3. WM_IME_COMPOSITION (0x010F)
|
|
* Call the functions listed below:
|
|
* - GHOST_ImeWin32::UpdateImeWindow();
|
|
* - GHOST_ImeWin32::GetResult();
|
|
* - GHOST_ImeWin32::GetComposition(), and;
|
|
* - GHOST_ImeWin32::ResetComposition() (optional).
|
|
* An application MUST prevent from calling ::DefWindowProc().
|
|
* 2.4. WM_IME_ENDCOMPOSITION (0x010E)
|
|
* Call the functions listed below:
|
|
* - GHOST_ImeWin32::ResetComposition(), and;
|
|
* - GHOST_ImeWin32::DestroyImeWindow().
|
|
* An application CAN call ::DefWindowProc().
|
|
* 2.5. WM_INPUTLANGCHANGE (0x0051)
|
|
* Call the functions listed below:
|
|
* - GHOST_ImeWin32::UpdateInputLanguage().
|
|
* An application CAN call ::DefWindowProc().
|
|
*/
|
|
|
|
/* This struct represents the status of an ongoing composition. */
|
|
struct ImeComposition {
|
|
/* Represents the cursor position in the IME composition. */
|
|
int cursor_position;
|
|
|
|
/* Represents the position of the beginning of the selection */
|
|
int target_start;
|
|
|
|
/* Represents the position of the end of the selection */
|
|
int target_end;
|
|
|
|
/**
|
|
* Represents the type of the string in the 'ime_string' parameter.
|
|
* Its possible values and description are listed below:
|
|
* 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;
|
|
std::vector<char> utf8_buf;
|
|
std::vector<unsigned char> format;
|
|
};
|
|
|
|
/**
|
|
* This class controls the IMM (Input Method Manager) through IMM32 APIs and
|
|
* enables it to retrieve the string being controlled 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.
|
|
* We can disable TSF and CUAS in Windows XP Tablet PC Edition. On the other
|
|
* hand, we can NEVER disable either TSF or CUAS in Windows Vista, i.e.
|
|
* THIS CLASS IS NOT ONLY USED ON THE INPUT CONTEXTS OF EAST-ASIAN
|
|
* LANGUAGES BUT ALSO USED ON THE INPUT CONTEXTS OF ALL LANGUAGES.
|
|
*/
|
|
class GHOST_ImeWin32 {
|
|
public:
|
|
GHOST_ImeWin32();
|
|
~GHOST_ImeWin32();
|
|
|
|
/* Retrieves whether or not there is an ongoing composition. */
|
|
bool is_composing() const
|
|
{
|
|
return is_composing_;
|
|
}
|
|
|
|
/* Retrieve the input language from Windows and store it. */
|
|
void UpdateInputLanguage();
|
|
|
|
BOOL IsLanguage(const char name[W32_ISO639_LEN]);
|
|
|
|
/* Saves the current conversion status. */
|
|
void UpdateConversionStatus(HWND window_handle);
|
|
|
|
/* Is the IME currently in conversion mode? */
|
|
bool IsEnglishMode();
|
|
|
|
/* Checks a key whether IME has to do handling. */
|
|
bool IsImeKeyEvent(char ascii, GHOST_TKey key);
|
|
|
|
/**
|
|
* Create the IME windows, and allocate required resources for them.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
*/
|
|
void CreateImeWindow(HWND window_handle);
|
|
|
|
/**
|
|
* Update the style of the IME windows.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
* * message [in] (UINT)
|
|
* * wparam [in] (WPARAM)
|
|
* * lparam [in] (LPARAM)
|
|
* Represent the windows message of the caller.
|
|
* 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);
|
|
|
|
/**
|
|
* Destroy 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);
|
|
|
|
/**
|
|
* Update the position of the IME windows.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
*/
|
|
void UpdateImeWindow(HWND window_handle);
|
|
|
|
/**
|
|
* Clean up the all resources attached to the given GHOST_ImeWin32 object, and
|
|
* reset its composition status.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
*/
|
|
void CleanupComposition(HWND window_handle);
|
|
|
|
/**
|
|
* Reset the composition status.
|
|
* Cancel the ongoing composition if it exists.
|
|
* NOTE(hbono): This method does not release the allocated resources.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
*/
|
|
void ResetComposition(HWND window_handle);
|
|
|
|
/**
|
|
* Retrieve 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.
|
|
* 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);
|
|
|
|
/**
|
|
* Retrieve 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)
|
|
* 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);
|
|
|
|
/**
|
|
* Enable the IME attached to the given window, i.e. allows user-input
|
|
* events to be dispatched to the IME.
|
|
* In Chrome, this function is used when:
|
|
* * a renderer process moves its input focus to another edit control, or;
|
|
* * a renderer process moves the position of the focused edit control.
|
|
* 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.
|
|
* * complete [in] (bool)
|
|
* Represents whether or not to complete the ongoing composition.
|
|
* + true
|
|
* After finishing the ongoing composition and close its IME windows,
|
|
* start another composition and display its IME windows to the given
|
|
* position.
|
|
* + false
|
|
* Just move the IME windows of the ongoing composition to the given
|
|
* position without finishing it.
|
|
*/
|
|
void BeginIME(HWND window_handle, const GHOST_Rect &caret_rect, bool complete);
|
|
|
|
/**
|
|
* Disable the IME attached to the given window, i.e. prohibits any user-input
|
|
* events from being dispatched to the IME.
|
|
* In Chrome, this function is used when:
|
|
* * a renderer process sets its input focus to a password input.
|
|
* Parameters
|
|
* * window_handle [in] (HWND)
|
|
* Represents the window handle of the caller.
|
|
*/
|
|
void EndIME(HWND window_handle);
|
|
|
|
/** Update #resultInfo and #compInfo */
|
|
void UpdateInfo(HWND window_handle);
|
|
|
|
/** Disable IME when start up. */
|
|
void CheckFirst(HWND window_handle);
|
|
|
|
ImeComposition resultInfo, compInfo;
|
|
GHOST_TEventImeData eventImeData;
|
|
|
|
protected:
|
|
/* Determines whether or not the given attribute represents a target (a.k.a. a selection). */
|
|
bool IsTargetAttribute(char attribute) const
|
|
{
|
|
return (attribute == ATTR_TARGET_CONVERTED || attribute == ATTR_TARGET_NOTCONVERTED);
|
|
}
|
|
|
|
/* Retrieve the target area. */
|
|
void GetCaret(HIMC imm_context, LPARAM lparam, ImeComposition *composition);
|
|
|
|
/* Update the position of the IME windows. */
|
|
void MoveImeWindow(HWND window_handle, HIMC imm_context);
|
|
|
|
/* Complete the ongoing composition if it exists. */
|
|
void CompleteComposition(HWND window_handle, HIMC imm_context);
|
|
|
|
/* Retrieve a string from the IMM. */
|
|
bool GetString(HIMC imm_context, WPARAM lparam, int type, ImeComposition *composition);
|
|
|
|
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_;
|
|
|
|
/* Abbreviated ISO 639-1 name of the input language, such as "en" for English. */
|
|
char language_[W32_ISO639_LEN];
|
|
|
|
/* Current Conversion Mode Values. Retrieved with ImmGetConversionStatus. */
|
|
DWORD conversion_modes_;
|
|
|
|
/* Current Sentence Mode. Retrieved with ImmGetConversionStatus. */
|
|
DWORD sentence_mode_;
|
|
|
|
/**
|
|
* Represents whether or not the current input context has created a system
|
|
* caret to set the position of its IME candidate window.
|
|
* * 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. */
|
|
GHOST_Rect caret_rect_;
|
|
|
|
/* used for disable ime when start up */
|
|
bool is_first, is_enable;
|
|
};
|
|
|
|
#endif /* WITH_INPUT_IME */
|