rime (#13)

eagleoflqj · web-flow · commit ba7e83abd403 · 2024-10-09T21:59:40.000-04:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -45,8 +45,10 @@ jobs:
         run: |
           git apply --directory=fcitx5 patches/fcitx5.patch
           git apply --directory=engines/fcitx5-hallelujah patches/hallelujah.patch
+          git apply --directory=engines/fcitx5-rime patches/rime.patch
           PKG_CONFIG_PATH=build/sysroot/usr/lib/pkgconfig cmake -B build -G Xcode \
-            -DENGINE=hallelujah \
+            -DHALLELUJAH=ON \
+            -DRIME=ON \
             -DCMAKE_TOOLCHAIN_FILE=cmake/ios.cmake \
             -DIOS_PLATFORM=SIMULATOR
           cmake --build build --config Release
diff --git a/.gitmodules b/.gitmodules
@@ -4,3 +4,18 @@
 [submodule "engines/fcitx5-hallelujah"]
 	path = engines/fcitx5-hallelujah
 	url = https://github.com/fcitx-contrib/fcitx5-hallelujah
+[submodule "engines/fcitx5-rime"]
+	path = engines/fcitx5-rime
+	url = https://github.com/fcitx/fcitx5-rime
+[submodule "data/rime-essay"]
+	path = data/rime-essay
+	url = https://github.com/rime/rime-essay
+[submodule "data/rime-prelude"]
+	path = data/rime-prelude
+	url = https://github.com/rime/rime-prelude
+[submodule "data/rime-luna-pinyin"]
+	path = data/rime-luna-pinyin
+	url = https://github.com/rime/rime-luna-pinyin
+[submodule "data/rime-stroke"]
+	path = data/rime-stroke
+	url = https://github.com/rime/rime-stroke
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -26,16 +26,12 @@ include(AddSwift)
 set(KEYBOARD_NAME "Keyboard")
 set(KEYBOARD_LANGUAGE "zh-Hans")
 
-set(ENGINE "" CACHE STRING "fcitx5 engine to bundle")
-
-if (ENGINE STREQUAL "hallelujah")
-    add_definitions(-DHALLELUJAH)
-endif()
+set(PREBUILDER_LIB_DIR "${PROJECT_BINARY_DIR}/sysroot/usr/lib")
 
 # For dependencies not to be find via pkg-config
-set(LibIntl_DIR "build/sysroot/usr/lib/cmake")
+set(LibIntl_DIR "${PREBUILDER_LIB_DIR}/cmake")
 find_package(LibIntl)
-set(fmt_DIR "build/sysroot/usr/lib/cmake/fmt")
+set(fmt_DIR "${PREBUILDER_LIB_DIR}/cmake/fmt")
 find_package(fmt)
 
 option(ENABLE_TEST "" OFF)
@@ -62,7 +58,25 @@ add_subdirectory(protocol)
 add_subdirectory(iosfrontend)
 add_subdirectory(uipanel)
 
-add_subdirectory(engines)
+option(HALLELUJAH "" OFF)
+option(RIME "" OFF)
+
+set(ENGINES)
+
+if (HALLELUJAH)
+    add_definitions(-DHALLELUJAH)
+    add_subdirectory(engines/fcitx5-hallelujah)
+    list(APPEND ENGINES hallelujah)
+endif()
+if (RIME)
+    # RIME_DATA_DIR is not actually used but must exist.
+    set(RIME_DATA_DIR "/usr/share/rime-data")
+    set(RIME_TARGET "${PREBUILDER_LIB_DIR}/librime.a" "-L${PREBUILDER_LIB_DIR}" leveldb yaml-cpp marisa opencc glog)
+    set(Rime_VERSION "1.11.2")
+    add_definitions(-DRIME)
+    add_subdirectory(engines/fcitx5-rime)
+    list(APPEND ENGINES rime)
+endif()
 
 add_subdirectory(keyboard)
 add_subdirectory(src)
diff --git a/data/default.yaml b/data/default.yaml
@@ -0,0 +1,63 @@
+# Rime default settings
+# encoding: utf-8
+
+config_version: '0.40'
+
+schema_list:
+  - schema: luna_pinyin
+  - schema: luna_pinyin_tw
+  - schema: luna_pinyin_simp
+  - schema: luna_pinyin_fluency
+  - schema: stroke
+
+switcher:
+  caption: 〔方案選單〕
+  hotkeys:
+    - Control+grave
+    - Control+Shift+grave
+    - F4
+  save_options:
+    - full_shape
+    - ascii_punct
+    - simplification
+    - extended_charset
+    - zh_hant
+    - zh_hans
+    - zh_hant_tw
+  fold_options: true
+  abbreviate_options: true
+  option_list_separator: '／'
+
+menu:
+  page_size: 5
+
+punctuator:
+  full_shape:
+    __include: punctuation:/full_shape
+  half_shape:
+    __include: punctuation:/half_shape
+
+key_binder:
+  bindings:
+    __patch:
+      - key_bindings:/emacs_editing
+      - key_bindings:/move_by_word_with_tab
+      - key_bindings:/paging_with_minus_equal
+      - key_bindings:/paging_with_comma_period
+      - key_bindings:/numbered_mode_switch
+
+recognizer:
+  patterns:
+    email: "^[A-Za-z][-_.0-9A-Za-z]*@.*$"
+    uppercase: "[A-Z][-_+.'0-9A-Za-z]*$"
+    url: "^(www[.]|https?:|ftp[.:]|mailto:|file:).*$|^[a-z]+[.].+$"
+
+ascii_composer:
+  good_old_caps_lock: true
+  switch_key:
+    Shift_L: inline_ascii
+    Shift_R: commit_text
+    Control_L: noop
+    Control_R: noop
+    Caps_Lock: clear
+    Eisu_toggle: clear
diff --git a/data/rime-essay b/data/rime-essay
@@ -0,0 +1 @@
+Subproject commit e0519d0579722a0871efb68189272cba61a7350b
diff --git a/data/rime-luna-pinyin b/data/rime-luna-pinyin
@@ -0,0 +1 @@
+Subproject commit ce5c828d99b0777c7a6bc6b1699e34f8c25623ef
diff --git a/data/rime-prelude b/data/rime-prelude
@@ -0,0 +1 @@
+Subproject commit 3803f09458072e03b9ed396692ce7e1d35c88c95
diff --git a/data/rime-stroke b/data/rime-stroke
@@ -0,0 +1 @@
+Subproject commit 65fdbbf2f9485cc907cb9a6d6b9210938a50f71e
diff --git a/engines/CMakeLists.txt b/engines/CMakeLists.txt
diff --git a/engines/fcitx5-rime b/engines/fcitx5-rime
@@ -0,0 +1 @@
+Subproject commit fd8bf83dcd731eacd095f8b01cd2ea1f9e9aa429
diff --git a/install-deps.sh b/install-deps.sh
@@ -1,9 +1,14 @@
 deps=(
   fmt
+  glog
   json-c
+  leveldb
   libintl
+  librime
   libuv
   marisa
+  opencc
+  yaml-cpp
 )
 
 EXTRACT_DIR=build/sysroot/usr
@@ -21,6 +26,6 @@ for dep in "${deps[@]}"; do
   tar xjvf cache/$file -C $EXTRACT_DIR
 done
 
-sed -i '' "s|=/usr/include|=$(pwd)/$EXTRACT_DIR/include|" $EXTRACT_DIR/lib/pkgconfig/{json-c,libuv,marisa}.pc
+sed -i '' "s|=/usr/include|=$(pwd)/$EXTRACT_DIR/include|" $EXTRACT_DIR/lib/pkgconfig/{json-c,libuv,marisa,rime}.pc
 sed -i '' "s|-L\${libdir} -luv|$(pwd)/$EXTRACT_DIR/lib/libuv.a|" $EXTRACT_DIR/lib/pkgconfig/libuv.pc
 sed -E -i '' "s|Libs:.*-l(.*)|Libs: $(pwd)/$EXTRACT_DIR/lib/lib\1.a|" $EXTRACT_DIR/lib/pkgconfig/json-c.pc
diff --git a/keyboard/CMakeLists.txt b/keyboard/CMakeLists.txt
@@ -20,5 +20,5 @@ target_link_libraries(keyboard PRIVATE
     SwiftFrontend
     KeyboardUI
     uipanel
-    "${ENGINE}"
+    ${ENGINES}
 )
diff --git a/keyboard/fcitx.cpp b/keyboard/fcitx.cpp
@@ -1,3 +1,6 @@
+#include "../engines/fcitx5-hallelujah/src/hallelujah.h"
+#include "../engines/fcitx5-rime/src/rimeengine.h"
+
 #include "../fcitx5/src/modules/spell/spell.h"
 #include "../iosfrontend/iosfrontend.h"
 #include "../uipanel/uipanel.h"
@@ -10,14 +13,12 @@
 #include "fcitx.h"
 #include "util.h"
 
-#if defined(HALLELUJAH)
-
-#include "../engines/fcitx5-hallelujah/src/hallelujah.h"
-#define ENGINE_ADDON "hallelujah"
-fcitx::HallelujahFactory
-
+#ifdef HALLELUJAH
+fcitx::HallelujahFactory HallelujahFactory;
+#endif
+#ifdef RIME
+fcitx::RimeEngineFactory RimeFactory;
 #endif
-    EngineFactory;
 
 namespace fs = std::filesystem;
 
@@ -32,8 +33,13 @@ fcitx::StaticAddonRegistry addons = {
                                                        &IosFrontendFactory),
     std::make_pair<std::string, fcitx::AddonFactory *>("uipanel",
                                                        &UIPanelFactory),
-    std::make_pair<std::string, fcitx::AddonFactory *>(ENGINE_ADDON,
-                                                       &EngineFactory),
+#ifdef HALLELUJAH
+    std::make_pair<std::string, fcitx::AddonFactory *>("hallelujah",
+                                                       &HallelujahFactory),
+#endif
+#ifdef RIME
+    std::make_pair<std::string, fcitx::AddonFactory *>("rime", &RimeFactory),
+#endif
 };
 
 native_streambuf log_streambuf;
@@ -51,10 +57,17 @@ void setupLog() {
 
 void setupEnv(const char *bundlePath) {
     fs::path bundle = bundlePath;
+    fs::path home = getenv("HOME");
     std::string xdg_data_dirs = bundle / "share";
-    std::string fcitx_data_home = bundle / "share/fcitx5";
+    std::string xdg_data_home = home / "Documents";
+    std::string fcitx_config_home = home / "Library/config";
     setenv("XDG_DATA_DIRS", xdg_data_dirs.c_str(), 1);
-    setenv("FCITX_DATA_HOME", fcitx_data_home.c_str(), 1);
+    setenv("XDG_DATA_HOME", xdg_data_home.c_str(), 1);
+    // By default FCITX_DATA_HOME is XDG_DATA_HOME/fcitx5. Flatten it like f5a.
+    setenv("FCITX_DATA_HOME", xdg_data_home.c_str(), 1);
+    // By default FCITX_CONFIG_HOME is XDG_CONFIG_HOME/fcitx5. Move it from
+    // ~/.config/fcitx5 to ~/Library/config.
+    setenv("FCITX_CONFIG_HOME", fcitx_config_home.c_str(), 1);
 }
 
 void startFcitx(const char *bundlePath) {
diff --git a/patches/rime.patch b/patches/rime.patch
@@ -0,0 +1,79 @@
+diff --git a/CMakeLists.txt b/CMakeLists.txt
+index 1a1637a..92a41e0 100644
+--- a/CMakeLists.txt
++++ b/CMakeLists.txt
+@@ -10,8 +10,6 @@ include(ECMSetupVersion)
+ include(ECMUninstallTarget)
+ 
+ find_package(Gettext REQUIRED)
+-find_package(Fcitx5Core 5.1.11 REQUIRED)
+-find_package(Fcitx5Module REQUIRED COMPONENTS Notifications)
+ find_package(PkgConfig REQUIRED)
+ find_package(Pthread REQUIRED)
+ 
+@@ -45,7 +43,7 @@ add_definitions(-DFCITX_GETTEXT_DOMAIN=\"fcitx5-rime\")
+ add_definitions(-DFCITX_RIME_VERSION=\"${PROJECT_VERSION}\")
+ fcitx5_add_i18n_definition()
+ 
+-include("${FCITX_INSTALL_CMAKECONFIG_DIR}/Fcitx5Utils/Fcitx5CompilerSettings.cmake")
++include("../../fcitx5/cmake/Fcitx5CompilerSettings.cmake")
+ 
+ add_subdirectory(po)
+ add_subdirectory(src)
+diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
+index 0854a9a..9e6aea8 100644
+--- a/src/CMakeLists.txt
++++ b/src/CMakeLists.txt
+@@ -22,7 +22,7 @@ else()
+     add_definitions(-DFCITX_RIME_NO_DBUS)
+ endif()
+ 
+-add_library(rime MODULE ${RIME_SOURCES})
++add_library(rime STATIC ${RIME_SOURCES})
+ target_link_libraries(rime ${RIME_LINK_LIBRARIES})
+ install(TARGETS rime DESTINATION "${CMAKE_INSTALL_LIBDIR}/fcitx5")
+ fcitx5_translate_desktop_file(rime.conf.in rime.conf)
+@@ -31,3 +31,31 @@ fcitx5_translate_desktop_file("${CMAKE_CURRENT_BINARY_DIR}/rime-addon.conf.in" r
+ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/rime.conf" DESTINATION "${FCITX_INSTALL_PKGDATADIR}/inputmethod" COMPONENT config)
+ install(FILES "${CMAKE_CURRENT_BINARY_DIR}/rime-addon.conf" RENAME rime.conf DESTINATION "${FCITX_INSTALL_PKGDATADIR}/addon" COMPONENT config)
+ 
++
++add_custom_command(
++    TARGET rime
++    POST_BUILD COMMAND /bin/sh -c
++    \"
++    ${CMAKE_COMMAND} -E copy
++        ${CMAKE_CURRENT_BINARY_DIR}/rime-addon.conf
++        ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/fcitx5/addon/rime.conf
++    \;
++    ${CMAKE_COMMAND} -E copy
++        ${CMAKE_CURRENT_BINARY_DIR}/rime.conf
++        ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/fcitx5/inputmethod/rime.conf
++    \;
++    mkdir -p ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data
++    \;
++    cp ${CMAKE_SOURCE_DIR}/data/rime-prelude/*.yaml ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data
++    \;
++    cp ${CMAKE_SOURCE_DIR}/data/rime-essay/essay.txt ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data
++    \;
++    cp ${CMAKE_SOURCE_DIR}/data/rime-luna-pinyin/*.yaml ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data
++    \;
++    cp ${CMAKE_SOURCE_DIR}/data/rime-stroke/*.yaml ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data
++    \;
++    ${CMAKE_COMMAND} -E copy
++        ${CMAKE_SOURCE_DIR}/data/default.yaml
++        ${CMAKE_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/rime-data/default.yaml
++    \"
++)
+diff --git a/src/rimeengine.h b/src/rimeengine.h
+index 6bec003..10940c8 100644
+--- a/src/rimeengine.h
++++ b/src/rimeengine.h
+@@ -238,7 +238,6 @@ private:
+ class RimeEngineFactory : public AddonFactory {
+ public:
+     AddonInstance *create(AddonManager *manager) override {
+-        registerDomain("fcitx5-rime", FCITX_INSTALL_LOCALEDIR);
+         return new RimeEngine(manager->instance());
+     }
+ };
