GHOST_ImeWin32.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2010 The Chromium Authors. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#ifdef WITH_INPUT_IME
 
#  define WIN32_LEAN_AND_MEAN
#  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:
  GHOST_EventIME(uint64_t msec, GHOST_TEventType type, GHOST_IWindow *window, void *customdata)
      : GHOST_Event(msec, type, window)
  {
    this->m_data = customdata;
  }
};

 
/* 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;

  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;
};

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);

  void CreateImeWindow(HWND window_handle);

  void SetImeWindowStyle(
      HWND window_handle, UINT message, WPARAM wparam, LPARAM lparam, BOOL *handled);

  void DestroyImeWindow(HWND window_handle);

  void UpdateImeWindow(HWND window_handle);

  void CleanupComposition(HWND window_handle);

  void ResetComposition(HWND window_handle);

  bool GetResult(HWND window_handle, LPARAM lparam, ImeComposition *composition);

  bool GetComposition(HWND window_handle, LPARAM lparam, ImeComposition *composition);

  void BeginIME(HWND window_handle, const GHOST_Rect &caret_rect, bool complete);

  void EndIME(HWND window_handle);

  void UpdateInfo(HWND window_handle);

  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:
  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_;

  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 */