Add usage display support for Extension IME.

In the case of Japanese, IME shows word usage or its description. This
feature is already supported in Chrome OS native ibus IME engines.
With this patch, Chrome supports same feature for Extension IME.

This change does not affect existing extension implementation in terms of
backward compatibility.

BUG=158486
TEST=manually done one lumpy.


Review URL: https://chromiumcodereview.appspot.com/11412268

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@170670 0039d316-1c4b-4281-b951-d872f2087c98

chrome/browser/chromeos/input_method/input_method_engine.h

@@ -78,6 +78,11 @@ class InputMethodEngine {
     std::string type;
   };
 
+  struct UsageEntry {
+    std::string title;
+    std::string body;
+  };
+
   struct Candidate {
     Candidate();
     virtual ~Candidate();
@@ -86,6 +91,7 @@ class InputMethodEngine {
     int id;
     std::string label;
     std::string annotation;
+    UsageEntry usage;
     std::vector<Candidate> candidates;
   };
 

chrome/browser/chromeos/input_method/input_method_engine_ibus.cc

@@ -276,6 +276,8 @@ bool InputMethodEngineIBus::SetCandidates(
     entry.value = ix->value;
     entry.label = ix->label;
     entry.annotation = ix->annotation;
+    entry.description_title = ix->usage.title;
+    entry.description_body = ix->usage.body;
 
     // Store a mapping from the user defined ID to the candidate index.
     candidate_indexes_[ix->id] = candidate_ids_.size();

chrome/browser/extensions/api/input_ime/input_ime_api.cc

@@ -661,6 +661,7 @@ bool SetCandidatesFunction::ReadCandidates(
     int id;
     std::string label;
     std::string annotation;
+    chromeos::InputMethodEngine::UsageEntry usage_entry;
 
     EXTENSION_FUNCTION_VALIDATE(candidate_dict->GetString(keys::kCandidateKey,
                                                           &candidate));
@@ -676,11 +677,22 @@ bool SetCandidatesFunction::ReadCandidates(
           &annotation));
     }
 
+    if (candidate_dict->HasKey(keys::kUsageKey)) {
+      DictionaryValue* usage_dict;
+      EXTENSION_FUNCTION_VALIDATE(candidate_dict->GetDictionary(keys::kUsageKey,
+                                                                &usage_dict));
+      EXTENSION_FUNCTION_VALIDATE(usage_dict->GetString(keys::kUsageTitleKey,
+                                                        &usage_entry.title));
+      EXTENSION_FUNCTION_VALIDATE(usage_dict->GetString(keys::kUsageBodyKey,
+                                                        &usage_entry.body));
+    }
+
     output->push_back(chromeos::InputMethodEngine::Candidate());
     output->back().value = candidate;
     output->back().id = id;
     output->back().label = label;
     output->back().annotation = annotation;
+    output->back().usage = usage_entry;
 
     if (candidate_dict->HasKey(keys::kCandidatesKey)) {
       ListValue* sub_list;

chrome/browser/extensions/extension_input_module_constants.cc

@@ -34,6 +34,9 @@ const char kStyleDoubleUnderline[] = "doubleUnderline";
 const char kStyleKey[] = "style";
 const char kStyleUnderline[] = "underline";
 const char kTextKey[] = "text";
+const char kUsageBodyKey[] = "body";
+const char kUsageKey[] = "usage";
+const char kUsageTitleKey[] = "title";
 const char kVerticalKey[] = "vertical";
 const char kVisibleKey[] = "visible";
 

chrome/browser/extensions/extension_input_module_constants.h

@@ -38,6 +38,9 @@ extern const char kStyleDoubleUnderline[];
 extern const char kStyleKey[];
 extern const char kStyleUnderline[];
 extern const char kTextKey[];
+extern const char kUsageBodyKey[];
+extern const char kUsageKey[];
+extern const char kUsageTitleKey[];
 extern const char kVerticalKey[];
 extern const char kVisibleKey[];
 

chrome/common/extensions/api/input_ime.json

@@ -250,7 +250,16 @@
                     "id": {"type": "integer", "description": "The candidate's id"},
                     "parentId": {"type": "integer", "optional": true, "description": "The id to add these candidates under"},
                     "label": {"type": "string", "optional": true, "description": "Short string displayed to next to the candidate, often the shortcut key or index"},
-                    "annotation": {"type": "string", "optional": true, "description": "Additional text describing the candidate"}
+                    "annotation": {"type": "string", "optional": true, "description": "Additional text describing the candidate"},
+                    "usage": {
+                      "type": "object",
+                      "optional": true,
+                      "description": "The usage or detail description of word.",
+                      "properties": {
+                        "title": { "type": "string", "description": "The title string of details description."},
+                        "body": { "type": "string", "description": "The body string of detail description."}
+                      }
+                    }
                   }
                 }
               }

chromeos/dbus/ibus/ibus_lookup_table.cc

@@ -46,6 +46,8 @@ void AppendIBusLookupTable(const IBusLookupTable& table,
     ibus::IBusText text;
     text.set_text(candidates[i].value);
     text.set_annotation(candidates[i].annotation);
+    text.set_description_title(candidates[i].description_title);
+    text.set_description_body(candidates[i].description_body);
     AppendIBusText(text, &text_writer);
     if (!candidates[i].label.empty())
       have_labels = true;