Build fcitx5 emoji module and use it in androidkeyboard

rocka · rocka · commit 11bd1ec6d231 · 2023-10-13T20:57:14.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@
 /app/src/main/assets/usr/share/fcitx5/chttrans
 /app/src/main/assets/usr/share/fcitx5/data
 /app/src/main/assets/usr/share/fcitx5/default
+/app/src/main/assets/usr/share/fcitx5/emoji
 /app/src/main/assets/usr/share/fcitx5/inputmethod
 /app/src/main/assets/usr/share/fcitx5/lua
 /app/src/main/assets/usr/share/fcitx5/punctuation
diff --git a/app/src/main/cpp/CMakeLists.txt b/app/src/main/cpp/CMakeLists.txt
@@ -67,6 +67,7 @@ target_link_libraries(native-lib
 
 add_custom_target(copy-fcitx5-modules
         # fcitx5
+        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::emoji,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::clipboard,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::imselector,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
         COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::quickphrase,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
diff --git a/app/src/main/cpp/androidkeyboard/CMakeLists.txt b/app/src/main/cpp/androidkeyboard/CMakeLists.txt
@@ -1,7 +1,7 @@
 add_definitions(-DFCITX_GETTEXT_DOMAIN=\"fcitx5-android\")
 
 add_library(androidkeyboard MODULE androidkeyboard.cpp)
-target_link_libraries(androidkeyboard Fcitx5::Core Fcitx5::Utils Fcitx5::Module::Spell)
+target_link_libraries(androidkeyboard Fcitx5::Core Fcitx5::Utils Fcitx5::Module::Spell Fcitx5::Module::Emoji)
 
 configure_file(androidkeyboard.conf.in.in androidkeyboard.conf.in @ONLY)
 fcitx5_translate_desktop_file(${CMAKE_CURRENT_BINARY_DIR}/androidkeyboard.conf.in androidkeyboard.conf)
diff --git a/app/src/main/cpp/androidkeyboard/androidkeyboard.conf.in.in b/app/src/main/cpp/androidkeyboard/androidkeyboard.conf.in.in
@@ -8,4 +8,5 @@ Configurable=True
 
 [Addon/OptionalDependencies]
 0=spell
-1=quickphrase
+1=quickphrase
+2=emoji
diff --git a/app/src/main/cpp/androidkeyboard/androidkeyboard.cpp b/app/src/main/cpp/androidkeyboard/androidkeyboard.cpp
@@ -6,6 +6,7 @@
 #include <fcitx/userinterfacemanager.h>
 
 #include "spell_public.h"
+#include "emoji_public.h"
 #include "../../../../../lib/fcitx5/src/main/cpp/fcitx5/src/im/keyboard/chardata.h" // dirty but works
 
 #include "androidkeyboard.h"
@@ -252,6 +253,16 @@ void AndroidKeyboardEngine::updateCandidate(const InputMethodEntry &entry, Input
                                                         state->buffer_.userInput(),
                                                         SpellCandidateSize);
     }
+    if (config_.enableEmoji.value() && emoji()) {
+        auto emojiResults = emoji()->call<IEmoji::query>(entry.languageCode(), state->buffer_.userInput(), true);
+        if (!emojiResults.empty()) {
+            // don't show emoji as 1st candidate if there are other candidates
+            int offset = results.empty() ? 0 : 1;
+            std::for_each(emojiResults.rbegin(), emojiResults.rend(), [&](std::string &e) {
+                results.insert(results.begin() + offset, {e, e});
+            });
+        }
+    }
     auto candidateList = std::make_unique<CommonCandidateList>();
     for (const auto &result: results) {
         candidateList->append<AndroidKeyboardCandidateWord>(this, Text(result.first), result.second);
@@ -329,7 +340,9 @@ void AndroidKeyboardEngine::commitBuffer(InputContext *inputContext) {
 
 bool AndroidKeyboardEngine::supportHint(const std::string &language) {
     const bool hasSpell = spell() && spell()->call<ISpell::checkDict>(language);
-    return hasSpell;
+    const bool hasEmoji = *config_.enableEmoji && emoji() &&
+                          emoji()->call<IEmoji::check>(language, true);
+    return hasSpell || hasEmoji;
 }
 
 std::pair<std::string, size_t> AndroidKeyboardEngine::preeditWithCursor(InputContext *inputContext) {
diff --git a/app/src/main/cpp/androidkeyboard/androidkeyboard.h b/app/src/main/cpp/androidkeyboard/androidkeyboard.h
@@ -26,6 +26,8 @@ FCITX_CONFIGURATION(
         AndroidKeyboardEngineConfig,
         Option<bool>
             enableWordHint{this, "EnableWordHint", _("Enable word hint"), true};
+        Option<bool>
+            enableEmoji{this, "EnableEmoji", _("Enable emoji in hint"), true};
         Option<int, IntConstrain>
             pageSize{this, "PageSize", _("Word hint page size"), 5, IntConstrain(3, 10)};
         OptionWithAnnotation<ChooseModifier, ChooseModifierI18NAnnotation>
@@ -81,7 +83,7 @@ class AndroidKeyboardEngine final : public InputMethodEngineV3 {
     void resetState(InputContext *inputContext, bool fromCandidate = false);
 
     FCITX_ADDON_DEPENDENCY_LOADER(spell, instance_->addonManager());
-//    FCITX_ADDON_DEPENDENCY_LOADER(emoji, instance_->addonManager());
+    FCITX_ADDON_DEPENDENCY_LOADER(emoji, instance_->addonManager());
 //    FCITX_ADDON_DEPENDENCY_LOADER(quickphrase, instance_->addonManager());
 
     void updateCandidate(const InputMethodEntry &entry, InputContext *inputContext);
diff --git a/lib/fcitx5/build.gradle.kts b/lib/fcitx5/build.gradle.kts
@@ -20,6 +20,7 @@ android {
                     "Fcitx5Config",
                     "Fcitx5Utils",
                     // fcitx5 modules
+                    "emoji",
                     "clipboard",
                     "imselector",
                     "notifications",
@@ -50,6 +51,10 @@ android {
             headers = "$headersPrefix/Utils"
         }
         val moduleHeadersPrefix = "$headersPrefix/Module/fcitx-module"
+        create("emoji") {
+            libraryName = "libemoji"
+            headers = "$moduleHeadersPrefix/emoji"
+        }
         create("clipboard") {
             libraryName = "libclipboard"
             headers = "$moduleHeadersPrefix/clipboard"
diff --git a/lib/fcitx5/src/main/cpp/CMakeLists.txt b/lib/fcitx5/src/main/cpp/CMakeLists.txt
@@ -45,6 +45,5 @@ option(ENABLE_SERVER "" OFF)
 option(ENABLE_KEYBOARD "" OFF)
 option(USE_SYSTEMD "" OFF)
 option(ENABLE_XDGAUTOSTART "" OFF)
-option(ENABLE_EMOJI "" OFF)
 option(ENABLE_LIBUUID "" OFF)
 add_subdirectory(fcitx5)
diff --git a/lib/fcitx5/src/main/cpp/cmake/FindFcitx5Module.cmake b/lib/fcitx5/src/main/cpp/cmake/FindFcitx5Module.cmake
@@ -3,7 +3,7 @@ set(Fcitx5Module_FOUND TRUE)
 # prefab dependency
 find_package(fcitx5 REQUIRED CONFIG)
 
-set(FCITX5_MODULE_NAMES Clipboard IMSelector Notifications QuickPhrase Spell Unicode)
+set(FCITX5_MODULE_NAMES Emoji Clipboard IMSelector Notifications QuickPhrase Spell Unicode)
 foreach(Mod IN LISTS FCITX5_MODULE_NAMES)
     string(TOLOWER "${Mod}" mod)
     set(MOD_INTERFACE "fcitx5-module-${mod}-interface")
@@ -18,6 +18,9 @@ foreach(Mod IN LISTS FCITX5_MODULE_NAMES)
     endif()
 endforeach()
 
+# fix target dependency
+set_target_properties(fcitx5::emoji PROPERTIES INTERFACE_LINK_LIBRARIES ZLIB::ZLIB)
+
 include(FindPackageHandleStandardArgs)
 find_package_handle_standard_args(Fcitx5Module
     FOUND_VAR
