GHOST_ImeWin32.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (c) 2010 The Chromium Authors. All rights reserved.
 * All rights reserved.
 *
 * The Original Code is: some of this file.
 */
 
#pragma once
 
#ifdef WITH_INPUT_IME
 
#  define WIN32_LEAN_AND_MEAN
#  include <windows.h>
 
#  include <string>
 
#  include "GHOST_Event.h"
#  include "GHOST_Rect.h"
#  include <vector>
 
class GHOST_EventIME : public GHOST_Event {
 public:
  GHOST_EventIME(GHOST_TUns64 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_;
  }
 
  bool SetInputLanguage();
 
  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_;
 
  bool ime_status_;
 
  LANGID input_language_id_;
 
  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