chrome/browser/chromeos/input_method/input_method_engine.cc - chromium/src - Git at Google

 // Copyright 2013 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.

 #include "chrome/browser/chromeos/input_method/input_method_engine.h"

 #include <map>
 #include <memory>
 #include <utility>

 #include "ash/shell.h"
 #include "base/logging.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/string_util.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/profiles/profile_manager.h"
 #include "ui/aura/window.h"
 #include "ui/aura/window_tree_host.h"
 #include "ui/base/ime/candidate_window.h"
 #include "ui/base/ime/chromeos/component_extension_ime_manager.h"
 #include "ui/base/ime/chromeos/extension_ime_util.h"
 #include "ui/base/ime/chromeos/ime_keymap.h"
 #include "ui/base/ime/composition_text.h"
 #include "ui/base/ime/ime_bridge.h"
 #include "ui/base/ime/text_input_flags.h"
 #include "ui/chromeos/ime/input_method_menu_item.h"
 #include "ui/chromeos/ime/input_method_menu_manager.h"
 #include "ui/events/event.h"
 #include "ui/events/event_sink.h"
 #include "ui/events/event_utils.h"
 #include "ui/events/keycodes/dom/dom_code.h"
 #include "ui/events/keycodes/dom/keycode_converter.h"
 #include "ui/keyboard/keyboard_controller.h"
 #include "ui/keyboard/keyboard_util.h"

 using input_method::InputMethodEngineBase;

 namespace chromeos {

 namespace {

 const char kErrorNotActive[] = "IME is not active";
 const char kErrorWrongContext[] = "Context is not active";
 const char kCandidateNotFound[] = "Candidate not found";

 // The default entry number of a page in CandidateWindowProperty.
 const int kDefaultPageSize = 9;

 }  // namespace

 InputMethodEngine::Candidate::Candidate() {}

 InputMethodEngine::Candidate::Candidate(const Candidate& other) = default;

 InputMethodEngine::Candidate::~Candidate() {}

 // When the default values are changed, please modify
 // CandidateWindow::CandidateWindowProperty defined in chromeos/ime/ too.
 InputMethodEngine::CandidateWindowProperty::CandidateWindowProperty()
     : page_size(kDefaultPageSize),
       is_cursor_visible(true),
       is_vertical(false),
       show_window_at_composition(false) {}

 InputMethodEngine::CandidateWindowProperty::~CandidateWindowProperty() {}

 InputMethodEngine::InputMethodEngine()
     : candidate_window_(new ui::CandidateWindow()), window_visible_(false) {}

 InputMethodEngine::~InputMethodEngine() {}

 const InputMethodEngine::CandidateWindowProperty&
 InputMethodEngine::GetCandidateWindowProperty() const {
   return candidate_window_property_;
 }

 void InputMethodEngine::SetCandidateWindowProperty(
     const CandidateWindowProperty& property) {
   // Type conversion from InputMethodEngine::CandidateWindowProperty to
   // CandidateWindow::CandidateWindowProperty defined in chromeos/ime/.
   ui::CandidateWindow::CandidateWindowProperty dest_property;
   dest_property.page_size = property.page_size;
   dest_property.is_cursor_visible = property.is_cursor_visible;
   dest_property.is_vertical = property.is_vertical;
   dest_property.show_window_at_composition =
       property.show_window_at_composition;
   dest_property.cursor_position =
       candidate_window_->GetProperty().cursor_position;
   dest_property.auxiliary_text = property.auxiliary_text;
   dest_property.is_auxiliary_text_visible = property.is_auxiliary_text_visible;

   candidate_window_->SetProperty(dest_property);
   candidate_window_property_ = property;

   if (IsActive()) {
     IMECandidateWindowHandlerInterface* cw_handler =
         ui::IMEBridge::Get()->GetCandidateWindowHandler();
     if (cw_handler)
       cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
   }
 }

 bool InputMethodEngine::SetCandidateWindowVisible(bool visible,
                                                   std::string* error) {
   if (!IsActive()) {
     *error = kErrorNotActive;
     return false;
   }

   window_visible_ = visible;
   IMECandidateWindowHandlerInterface* cw_handler =
       ui::IMEBridge::Get()->GetCandidateWindowHandler();
   if (cw_handler)
     cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
   return true;
 }

 bool InputMethodEngine::SetCandidates(
     int context_id,
     const std::vector<Candidate>& candidates,
     std::string* error) {
   if (!IsActive()) {
     *error = kErrorNotActive;
     return false;
   }
   if (context_id != context_id_ || context_id_ == -1) {
     *error = kErrorWrongContext;
     return false;
   }

   // TODO: Nested candidates
   candidate_ids_.clear();
   candidate_indexes_.clear();
   candidate_window_->mutable_candidates()->clear();
   for (std::vector<Candidate>::const_iterator ix = candidates.begin();
        ix != candidates.end(); ++ix) {
     ui::CandidateWindow::Entry entry;
     entry.value = base::UTF8ToUTF16(ix->value);
     entry.label = base::UTF8ToUTF16(ix->label);
     entry.annotation = base::UTF8ToUTF16(ix->annotation);
     entry.description_title = base::UTF8ToUTF16(ix->usage.title);
     entry.description_body = base::UTF8ToUTF16(ix->usage.body);

     // Store a mapping from the user defined ID to the candidate index.
     candidate_indexes_[ix->id] = candidate_ids_.size();
     candidate_ids_.push_back(ix->id);

     candidate_window_->mutable_candidates()->push_back(entry);
   }
   if (IsActive()) {
     IMECandidateWindowHandlerInterface* cw_handler =
         ui::IMEBridge::Get()->GetCandidateWindowHandler();
     if (cw_handler)
       cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
   }
   return true;
 }

 bool InputMethodEngine::SetCursorPosition(int context_id,
                                           int candidate_id,
                                           std::string* error) {
   if (!IsActive()) {
     *error = kErrorNotActive;
     return false;
   }
   if (context_id != context_id_ || context_id_ == -1) {
     *error = kErrorWrongContext;
     return false;
   }

   std::map<int, int>::const_iterator position =
       candidate_indexes_.find(candidate_id);
   if (position == candidate_indexes_.end()) {
     *error = kCandidateNotFound;
     return false;
   }

   candidate_window_->set_cursor_position(position->second);
   IMECandidateWindowHandlerInterface* cw_handler =
       ui::IMEBridge::Get()->GetCandidateWindowHandler();
   if (cw_handler)
     cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
   return true;
 }

 bool InputMethodEngine::SetMenuItems(
     const std::vector<input_method::InputMethodManager::MenuItem>& items) {
   return UpdateMenuItems(items);
 }

 bool InputMethodEngine::UpdateMenuItems(
     const std::vector<input_method::InputMethodManager::MenuItem>& items) {
   if (!IsActive())
     return false;

   ui::ime::InputMethodMenuItemList menu_item_list;
   for (std::vector<input_method::InputMethodManager::MenuItem>::const_iterator
            item = items.begin();
        item != items.end(); ++item) {
     ui::ime::InputMethodMenuItem property;
     MenuItemToProperty(*item, &property);
     menu_item_list.push_back(property);
   }

   ui::ime::InputMethodMenuManager::GetInstance()
       ->SetCurrentInputMethodMenuItemList(menu_item_list);

   input_method::InputMethodManager::Get()->NotifyImeMenuItemsChanged(
       active_component_id_, items);
   return true;
 }

 bool InputMethodEngine::IsActive() const {
   return !active_component_id_.empty();
 }

 void InputMethodEngine::HideInputView() {
   keyboard::KeyboardController* keyboard_controller =
       keyboard::KeyboardController::GetInstance();
   if (keyboard_controller) {
     keyboard_controller->HideKeyboard(
         keyboard::KeyboardController::HIDE_REASON_MANUAL);
   }
 }

 void InputMethodEngine::EnableInputView() {
   keyboard::SetOverrideContentUrl(input_method::InputMethodManager::Get()
                                       ->GetActiveIMEState()
                                       ->GetCurrentInputMethod()
                                       .input_view_url());
   keyboard::KeyboardController* keyboard_controller =
       keyboard::KeyboardController::GetInstance();
   if (keyboard_controller)
     keyboard_controller->Reload();
 }


 void InputMethodEngine::Enable(const std::string& component_id) {
   InputMethodEngineBase::Enable(component_id);
   EnableInputView();
 }

 void InputMethodEngine::PropertyActivate(const std::string& property_name) {
   observer_->OnMenuItemActivated(active_component_id_, property_name);
 }

 void InputMethodEngine::CandidateClicked(uint32_t index) {
   if (index > candidate_ids_.size()) {
     return;
   }

   // Only left button click is supported at this moment.
   observer_->OnCandidateClicked(active_component_id_, candidate_ids_.at(index),
                                 InputMethodEngineBase::MOUSE_BUTTON_LEFT);
 }

 // TODO(uekawa): rename this method to a more reasonable name.
 void InputMethodEngine::MenuItemToProperty(
     const input_method::InputMethodManager::MenuItem& item,
     ui::ime::InputMethodMenuItem* property) {
   property->key = item.id;

   if (item.modified & MENU_ITEM_MODIFIED_LABEL) {
     property->label = item.label;
   }
   if (item.modified & MENU_ITEM_MODIFIED_VISIBLE) {
     // TODO(nona): Implement it.
   }
   if (item.modified & MENU_ITEM_MODIFIED_CHECKED) {
     property->is_selection_item_checked = item.checked;
   }
   if (item.modified & MENU_ITEM_MODIFIED_ENABLED) {
     // TODO(nona): implement sensitive entry(crbug.com/140192).
   }
   if (item.modified & MENU_ITEM_MODIFIED_STYLE) {
     if (!item.children.empty()) {
       // TODO(nona): Implement it.
     } else {
       switch (item.style) {
         case input_method::InputMethodManager::MENU_ITEM_STYLE_NONE:
           NOTREACHED();
           break;
         case input_method::InputMethodManager::MENU_ITEM_STYLE_CHECK:
           // TODO(nona): Implement it.
           break;
         case input_method::InputMethodManager::MENU_ITEM_STYLE_RADIO:
           property->is_selection_item = true;
           break;
         case input_method::InputMethodManager::MENU_ITEM_STYLE_SEPARATOR:
           // TODO(nona): Implement it.
           break;
       }
     }
   }

   // TODO(nona): Support item.children.
 }

 void InputMethodEngine::UpdateComposition(
     const ui::CompositionText& composition_text,
     uint32_t cursor_pos,
     bool is_visible) {
   ui::IMEInputContextHandlerInterface* input_context =
       ui::IMEBridge::Get()->GetInputContextHandler();
   if (input_context)
     input_context->UpdateCompositionText(composition_text, cursor_pos,
                                          is_visible);
 }

 void InputMethodEngine::CommitTextToInputContext(int context_id,
                                                  const std::string& text) {
   ui::IMEBridge::Get()->GetInputContextHandler()->CommitText(text);

   // Records histograms for committed characters.
   if (!composition_text_->text.empty()) {
     base::string16 wtext = base::UTF8ToUTF16(text);
     UMA_HISTOGRAM_CUSTOM_COUNTS("InputMethod.CommitLength", wtext.length(), 1,
                                 25, 25);
     composition_text_.reset(new ui::CompositionText());
   }
 }

 bool InputMethodEngine::SendKeyEvent(ui::KeyEvent* event,
                                      const std::string& code) {
   DCHECK(event);
   if (event->key_code() == ui::VKEY_UNKNOWN)
     event->set_key_code(ui::DomKeycodeToKeyboardCode(code));

   ui::EventSink* sink =
       ash::Shell::GetPrimaryRootWindow()->GetHost()->event_sink();
   ui::EventDispatchDetails details = sink->OnEventFromSource(event);
   return !details.dispatcher_destroyed;
 }

 }  // namespace chromeos
	// Copyright 2013 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.

	#include "chrome/browser/chromeos/input_method/input_method_engine.h"

	#include <map>
	#include <memory>
	#include <utility>

	#include "ash/shell.h"
	#include "base/logging.h"
	#include "base/metrics/histogram_macros.h"
	#include "base/strings/string_number_conversions.h"
	#include "base/strings/string_util.h"
	#include "base/strings/utf_string_conversions.h"
	#include "chrome/browser/profiles/profile_manager.h"
	#include "ui/aura/window.h"
	#include "ui/aura/window_tree_host.h"
	#include "ui/base/ime/candidate_window.h"
	#include "ui/base/ime/chromeos/component_extension_ime_manager.h"
	#include "ui/base/ime/chromeos/extension_ime_util.h"
	#include "ui/base/ime/chromeos/ime_keymap.h"
	#include "ui/base/ime/composition_text.h"
	#include "ui/base/ime/ime_bridge.h"
	#include "ui/base/ime/text_input_flags.h"
	#include "ui/chromeos/ime/input_method_menu_item.h"
	#include "ui/chromeos/ime/input_method_menu_manager.h"
	#include "ui/events/event.h"
	#include "ui/events/event_sink.h"
	#include "ui/events/event_utils.h"
	#include "ui/events/keycodes/dom/dom_code.h"
	#include "ui/events/keycodes/dom/keycode_converter.h"
	#include "ui/keyboard/keyboard_controller.h"
	#include "ui/keyboard/keyboard_util.h"

	using input_method::InputMethodEngineBase;

	namespace chromeos {

	namespace {

	const char kErrorNotActive[] = "IME is not active";
	const char kErrorWrongContext[] = "Context is not active";
	const char kCandidateNotFound[] = "Candidate not found";

	// The default entry number of a page in CandidateWindowProperty.
	const int kDefaultPageSize = 9;

	} // namespace

	InputMethodEngine::Candidate::Candidate() {}

	InputMethodEngine::Candidate::Candidate(const Candidate& other) = default;

	InputMethodEngine::Candidate::~Candidate() {}

	// When the default values are changed, please modify
	// CandidateWindow::CandidateWindowProperty defined in chromeos/ime/ too.
	InputMethodEngine::CandidateWindowProperty::CandidateWindowProperty()
	: page_size(kDefaultPageSize),
	is_cursor_visible(true),
	is_vertical(false),
	show_window_at_composition(false) {}

	InputMethodEngine::CandidateWindowProperty::~CandidateWindowProperty() {}

	InputMethodEngine::InputMethodEngine()
	: candidate_window_(new ui::CandidateWindow()), window_visible_(false) {}

	InputMethodEngine::~InputMethodEngine() {}

	const InputMethodEngine::CandidateWindowProperty&
	InputMethodEngine::GetCandidateWindowProperty() const {
	return candidate_window_property_;
	}

	void InputMethodEngine::SetCandidateWindowProperty(
	const CandidateWindowProperty& property) {
	// Type conversion from InputMethodEngine::CandidateWindowProperty to
	// CandidateWindow::CandidateWindowProperty defined in chromeos/ime/.
	ui::CandidateWindow::CandidateWindowProperty dest_property;
	dest_property.page_size = property.page_size;
	dest_property.is_cursor_visible = property.is_cursor_visible;
	dest_property.is_vertical = property.is_vertical;
	dest_property.show_window_at_composition =
	property.show_window_at_composition;
	dest_property.cursor_position =
	candidate_window_->GetProperty().cursor_position;
	dest_property.auxiliary_text = property.auxiliary_text;
	dest_property.is_auxiliary_text_visible = property.is_auxiliary_text_visible;

	candidate_window_->SetProperty(dest_property);
	candidate_window_property_ = property;

	if (IsActive()) {
	IMECandidateWindowHandlerInterface* cw_handler =
	ui::IMEBridge::Get()->GetCandidateWindowHandler();
	if (cw_handler)
	cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
	}
	}

	bool InputMethodEngine::SetCandidateWindowVisible(bool visible,
	std::string* error) {
	if (!IsActive()) {
	*error = kErrorNotActive;
	return false;
	}

	window_visible_ = visible;
	IMECandidateWindowHandlerInterface* cw_handler =
	ui::IMEBridge::Get()->GetCandidateWindowHandler();
	if (cw_handler)
	cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
	return true;
	}

	bool InputMethodEngine::SetCandidates(
	int context_id,
	const std::vector<Candidate>& candidates,
	std::string* error) {
	if (!IsActive()) {
	*error = kErrorNotActive;
	return false;
	}
	if (context_id != context_id_ \|\| context_id_ == -1) {
	*error = kErrorWrongContext;
	return false;
	}

	// TODO: Nested candidates
	candidate_ids_.clear();
	candidate_indexes_.clear();
	candidate_window_->mutable_candidates()->clear();
	for (std::vector<Candidate>::const_iterator ix = candidates.begin();
	ix != candidates.end(); ++ix) {
	ui::CandidateWindow::Entry entry;
	entry.value = base::UTF8ToUTF16(ix->value);
	entry.label = base::UTF8ToUTF16(ix->label);
	entry.annotation = base::UTF8ToUTF16(ix->annotation);
	entry.description_title = base::UTF8ToUTF16(ix->usage.title);
	entry.description_body = base::UTF8ToUTF16(ix->usage.body);

	// Store a mapping from the user defined ID to the candidate index.
	candidate_indexes_[ix->id] = candidate_ids_.size();
	candidate_ids_.push_back(ix->id);

	candidate_window_->mutable_candidates()->push_back(entry);
	}
	if (IsActive()) {
	IMECandidateWindowHandlerInterface* cw_handler =
	ui::IMEBridge::Get()->GetCandidateWindowHandler();
	if (cw_handler)
	cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
	}
	return true;
	}

	bool InputMethodEngine::SetCursorPosition(int context_id,
	int candidate_id,
	std::string* error) {
	if (!IsActive()) {
	*error = kErrorNotActive;
	return false;
	}
	if (context_id != context_id_ \|\| context_id_ == -1) {
	*error = kErrorWrongContext;
	return false;
	}

	std::map<int, int>::const_iterator position =
	candidate_indexes_.find(candidate_id);
	if (position == candidate_indexes_.end()) {
	*error = kCandidateNotFound;
	return false;
	}

	candidate_window_->set_cursor_position(position->second);
	IMECandidateWindowHandlerInterface* cw_handler =
	ui::IMEBridge::Get()->GetCandidateWindowHandler();
	if (cw_handler)
	cw_handler->UpdateLookupTable(*candidate_window_, window_visible_);
	return true;
	}

	bool InputMethodEngine::SetMenuItems(
	const std::vector<input_method::InputMethodManager::MenuItem>& items) {
	return UpdateMenuItems(items);
	}

	bool InputMethodEngine::UpdateMenuItems(
	const std::vector<input_method::InputMethodManager::MenuItem>& items) {
	if (!IsActive())
	return false;

	ui::ime::InputMethodMenuItemList menu_item_list;
	for (std::vector<input_method::InputMethodManager::MenuItem>::const_iterator
	item = items.begin();
	item != items.end(); ++item) {
	ui::ime::InputMethodMenuItem property;
	MenuItemToProperty(*item, &property);
	menu_item_list.push_back(property);
	}

	ui::ime::InputMethodMenuManager::GetInstance()
	->SetCurrentInputMethodMenuItemList(menu_item_list);

	input_method::InputMethodManager::Get()->NotifyImeMenuItemsChanged(
	active_component_id_, items);
	return true;
	}

	bool InputMethodEngine::IsActive() const {
	return !active_component_id_.empty();
	}

	void InputMethodEngine::HideInputView() {
	keyboard::KeyboardController* keyboard_controller =
	keyboard::KeyboardController::GetInstance();
	if (keyboard_controller) {
	keyboard_controller->HideKeyboard(
	keyboard::KeyboardController::HIDE_REASON_MANUAL);
	}
	}

	void InputMethodEngine::EnableInputView() {
	keyboard::SetOverrideContentUrl(input_method::InputMethodManager::Get()
	->GetActiveIMEState()
	->GetCurrentInputMethod()
	.input_view_url());
	keyboard::KeyboardController* keyboard_controller =
	keyboard::KeyboardController::GetInstance();
	if (keyboard_controller)
	keyboard_controller->Reload();
	}


	void InputMethodEngine::Enable(const std::string& component_id) {
	InputMethodEngineBase::Enable(component_id);
	EnableInputView();
	}

	void InputMethodEngine::PropertyActivate(const std::string& property_name) {
	observer_->OnMenuItemActivated(active_component_id_, property_name);
	}

	void InputMethodEngine::CandidateClicked(uint32_t index) {
	if (index > candidate_ids_.size()) {
	return;
	}

	// Only left button click is supported at this moment.
	observer_->OnCandidateClicked(active_component_id_, candidate_ids_.at(index),
	InputMethodEngineBase::MOUSE_BUTTON_LEFT);
	}

	// TODO(uekawa): rename this method to a more reasonable name.
	void InputMethodEngine::MenuItemToProperty(
	const input_method::InputMethodManager::MenuItem& item,
	ui::ime::InputMethodMenuItem* property) {
	property->key = item.id;

	if (item.modified & MENU_ITEM_MODIFIED_LABEL) {
	property->label = item.label;
	}
	if (item.modified & MENU_ITEM_MODIFIED_VISIBLE) {
	// TODO(nona): Implement it.
	}
	if (item.modified & MENU_ITEM_MODIFIED_CHECKED) {
	property->is_selection_item_checked = item.checked;
	}
	if (item.modified & MENU_ITEM_MODIFIED_ENABLED) {
	// TODO(nona): implement sensitive entry(crbug.com/140192).
	}
	if (item.modified & MENU_ITEM_MODIFIED_STYLE) {
	if (!item.children.empty()) {
	// TODO(nona): Implement it.
	} else {
	switch (item.style) {
	case input_method::InputMethodManager::MENU_ITEM_STYLE_NONE:
	NOTREACHED();
	break;
	case input_method::InputMethodManager::MENU_ITEM_STYLE_CHECK:
	// TODO(nona): Implement it.
	break;
	case input_method::InputMethodManager::MENU_ITEM_STYLE_RADIO:
	property->is_selection_item = true;
	break;
	case input_method::InputMethodManager::MENU_ITEM_STYLE_SEPARATOR:
	// TODO(nona): Implement it.
	break;
	}
	}
	}

	// TODO(nona): Support item.children.
	}

	void InputMethodEngine::UpdateComposition(
	const ui::CompositionText& composition_text,
	uint32_t cursor_pos,
	bool is_visible) {
	ui::IMEInputContextHandlerInterface* input_context =
	ui::IMEBridge::Get()->GetInputContextHandler();
	if (input_context)
	input_context->UpdateCompositionText(composition_text, cursor_pos,
	is_visible);
	}

	void InputMethodEngine::CommitTextToInputContext(int context_id,
	const std::string& text) {
	ui::IMEBridge::Get()->GetInputContextHandler()->CommitText(text);

	// Records histograms for committed characters.
	if (!composition_text_->text.empty()) {
	base::string16 wtext = base::UTF8ToUTF16(text);
	UMA_HISTOGRAM_CUSTOM_COUNTS("InputMethod.CommitLength", wtext.length(), 1,
	25, 25);
	composition_text_.reset(new ui::CompositionText());
	}
	}

	bool InputMethodEngine::SendKeyEvent(ui::KeyEvent* event,
	const std::string& code) {
	DCHECK(event);
	if (event->key_code() == ui::VKEY_UNKNOWN)
	event->set_key_code(ui::DomKeycodeToKeyboardCode(code));

	ui::EventSink* sink =
	ash::Shell::GetPrimaryRootWindow()->GetHost()->event_sink();
	ui::EventDispatchDetails details = sink->OnEventFromSource(event);
	return !details.dispatcher_destroyed;
	}

	} // namespace chromeos