Home | History | Annotate | Download | only in ime
      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 CHROMEOS_IME_EXTENSION_IME_UTIL_H_
      6 #define CHROMEOS_IME_EXTENSION_IME_UTIL_H_
      7 
      8 #include <string>
      9 
     10 #include "chromeos/chromeos_export.h"
     11 
     12 namespace chromeos {
     13 
     14 // Extension IME related utilities.
     15 namespace extension_ime_util {
     16 
     17 // Returns InputMethodID for |engine_id| in |extension_id| of extension IME.
     18 // This function does not check |extension_id| is installed extension IME nor
     19 // |engine_id| is really a member of |extension_id|.
     20 std::string CHROMEOS_EXPORT GetInputMethodID(const std::string& extension_id,
     21                                              const std::string& engine_id);
     22 
     23 // Returns InputMethodID for |engine_id| in |extension_id| of component
     24 // extension IME, This function does not check |extension_id| is component one
     25 // nor |engine_id| is really a member of |extension_id|.
     26 std::string CHROMEOS_EXPORT GetComponentInputMethodID(
     27     const std::string& extension_id,
     28     const std::string& engine_id);
     29 
     30 // Returns extension ID if |input_method_id| is extension IME ID or component
     31 // extension IME ID. Otherwise returns an empty string ("").
     32 std::string CHROMEOS_EXPORT GetExtensionIDFromInputMethodID(
     33     const std::string& input_method_id);
     34 
     35 // Returns true if |input_method_id| is extension IME ID. This function does not
     36 // check |input_method_id| is installed extension IME.
     37 bool CHROMEOS_EXPORT IsExtensionIME(const std::string& input_method_id);
     38 
     39 // Returns true if |input_method_id| is component extension IME ID. This
     40 // function does not check |input_method_id| is really whitelisted one or not.
     41 // If you want to check |input_method_id| is whitelisted component extension
     42 // IME, please use ComponentExtensionIMEManager::IsWhitelisted instead.
     43 bool CHROMEOS_EXPORT IsComponentExtensionIME(
     44     const std::string& input_method_id);
     45 
     46 // Returns true if the |input_method| is a member of |extension_id| of extension
     47 // IME, otherwise returns false.
     48 bool CHROMEOS_EXPORT IsMemberOfExtension(const std::string& input_method_id,
     49                                          const std::string& extension_id);
     50 
     51 }  // namespace extension_ime_util
     52 
     53 }  // namespace chromeos
     54 
     55 #endif  // CHROMEOS_IME_EXTENSION_IME_UTIL_H_
     56