chrome/browser/chromeos/input_method/input_method_engine.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_ENGINE_H_
   6 #define CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_ENGINE_H_
   7
   8 #include <map>
   9 #include <string>
  10 #include <vector>
  11 #include "chrome/browser/chromeos/input_method/input_method_engine_interface.h"
  12 #include "chromeos/ime/input_method_descriptor.h"
  13 #include "url/gurl.h"
  14
  15 namespace ui {
  16 class CandidateWindow;
  17 class KeyEvent;
  18 }  // namespace ui
  19
  20 namespace chromeos {
  21
  22 class IBusText;
  23
  24 namespace input_method {
  25 struct InputMethodProperty;
  26 struct KeyEventHandle;
  27 }  // namespace input_method
  28
  29 class InputMethodEngine : public InputMethodEngineInterface {
  30  public:
  31   InputMethodEngine();
  32
  33   virtual ~InputMethodEngine();
  34
  35   void Initialize(
  36       InputMethodEngineInterface::Observer* observer,
  37       const char* engine_name,
  38       const char* extension_id,
  39       const char* engine_id,
  40       const std::vector<std::string>& languages,
  41       const std::vector<std::string>& layouts,
  42       const GURL& options_page,
  43       const GURL& input_view);
  44
  45   // InputMethodEngineInterface overrides.
  46   virtual const input_method::InputMethodDescriptor& GetDescriptor()
  47       const OVERRIDE;
  48   virtual void StartIme() OVERRIDE;
  49   virtual bool SetComposition(int context_id,
  50                               const char* text,
  51                               int selection_start,
  52                               int selection_end,
  53                               int cursor,
  54                               const std::vector<SegmentInfo>& segments,
  55                               std::string* error) OVERRIDE;
  56   virtual bool ClearComposition(int context_id, std::string* error) OVERRIDE;
  57   virtual bool CommitText(int context_id, const char* text,
  58                           std::string* error) OVERRIDE;
  59   virtual bool SendKeyEvents(int context_id,
  60                              const std::vector<KeyboardEvent>& events) OVERRIDE;
  61   virtual const CandidateWindowProperty&
  62     GetCandidateWindowProperty() const OVERRIDE;
  63   virtual void SetCandidateWindowProperty(
  64       const CandidateWindowProperty& property) OVERRIDE;
  65   virtual bool SetCandidateWindowVisible(bool visible,
  66                                          std::string* error) OVERRIDE;
  67   virtual bool SetCandidates(int context_id,
  68                              const std::vector<Candidate>& candidates,
  69                              std::string* error) OVERRIDE;
  70   virtual bool SetCursorPosition(int context_id, int candidate_id,
  71                                  std::string* error) OVERRIDE;
  72   virtual bool SetMenuItems(const std::vector<MenuItem>& items) OVERRIDE;
  73   virtual bool UpdateMenuItems(const std::vector<MenuItem>& items) OVERRIDE;
  74   virtual bool IsActive() const OVERRIDE;
  75   virtual void KeyEventDone(input_method::KeyEventHandle* key_data,
  76                             bool handled) OVERRIDE;
  77   virtual bool DeleteSurroundingText(int context_id,
  78                                      int offset,
  79                                      size_t number_of_chars,
  80                                      std::string* error) OVERRIDE;
  81
  82   // IBusEngineHandlerInterface overrides.
  83   virtual void FocusIn(
  84       const IBusEngineHandlerInterface::InputContext& input_context) OVERRIDE;
  85   virtual void FocusOut() OVERRIDE;
  86   virtual void Enable() OVERRIDE;
  87   virtual void Disable() OVERRIDE;
  88   virtual void PropertyActivate(const std::string& property_name) OVERRIDE;
  89   virtual void Reset() OVERRIDE;
  90   virtual void ProcessKeyEvent(const ui::KeyEvent& key_event,
  91                                const KeyEventDoneCallback& callback) OVERRIDE;
  92   virtual void CandidateClicked(uint32 index) OVERRIDE;
  93   virtual void SetSurroundingText(const std::string& text, uint32 cursor_pos,
  94                                   uint32 anchor_pos) OVERRIDE;
  95   virtual void HideInputView() OVERRIDE;
  96
  97  private:
  98   // Converts MenuItem to InputMethodProperty.
  99   void MenuItemToProperty(const MenuItem& item,
 100                           input_method::InputMethodProperty* property);
 101
 102   // Descriptor of this input method.
 103   input_method::InputMethodDescriptor descriptor_;
 104
 105   // True if the current context has focus.
 106   bool focused_;
 107
 108   // True if this engine is active.
 109   bool active_;
 110
 111   // ID that is used for the current input context.  False if there is no focus.
 112   int context_id_;
 113
 114   // Next id that will be assigned to a context.
 115   int next_context_id_;
 116
 117   // This IME ID in Chrome Extension.
 118   std::string engine_id_;
 119
 120   // This IME ID in InputMethodManager.
 121   std::string imm_id_;
 122
 123   // Pointer to the object recieving events for this IME.
 124   InputMethodEngineInterface::Observer* observer_;
 125
 126   // The current preedit text, and it's cursor position.
 127   scoped_ptr<IBusText> preedit_text_;
 128   int preedit_cursor_;
 129
 130   // The current candidate window.
 131   scoped_ptr<ui::CandidateWindow> candidate_window_;
 132
 133   // The current candidate window property.
 134   CandidateWindowProperty candidate_window_property_;
 135
 136   // Indicates whether the candidate window is visible.
 137   bool window_visible_;
 138
 139   // Mapping of candidate index to candidate id.
 140   std::vector<int> candidate_ids_;
 141
 142   // Mapping of candidate id to index.
 143   std::map<int, int> candidate_indexes_;
 144
 145   // Used for input view window.
 146   GURL input_view_url_;
 147 };
 148
 149 }  // namespace chromeos
 150
 151 #endif  // CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_ENGINE_H_