kkc (#237)

Author: eagleoflqj

.github/workflows/js.yml

@@ -59,8 +59,10 @@ jobs:
           git apply --directory=libime patches/libime.patch
           git apply --directory=fcitx5-chinese-addons patches/chinese-addons.patch
           git apply --directory=fcitx5-jyutping patches/jyutping.patch
+          git apply --directory=fcitx5-kkc patches/kkc.patch
           git apply --directory=fcitx5-rime patches/rime.log.patch
           git apply --directory=fcitx5-rime patches/rime.js.patch
+          git apply --directory=fcitx5-skk patches/skk.patch
           emcmake cmake -B build/js -G Ninja -DCMAKE_BUILD_TYPE=Release
           cmake --build build/js
           ./scripts/install.sh js

.github/workflows/macos.yml

@@ -67,7 +67,9 @@ jobs:
         run: |
           git apply --directory=libime patches/libime.patch
           git apply --directory=fcitx5-jyutping patches/jyutping.patch
+          git apply --directory=fcitx5-kkc patches/kkc.patch
           git apply --directory=fcitx5-rime patches/rime.log.patch
+          git apply --directory=fcitx5-skk patches/skk.patch
           cmake -B build/macos-${{ matrix.arch }} -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=${{ matrix.arch }}
           cmake --build build/macos-${{ matrix.arch }}
           ./scripts/install.sh macos ${{ matrix.arch }}

.github/workflows/windows.yml

@@ -55,7 +55,7 @@ jobs:
         shell: bash
         run: |
           cmake -B build/windows-${{ matrix.arch }} -G Ninja \
-            -DANTHY=OFF -DBAMBOO=OFF -DCHEWING=OFF -DCHINESE_ADDONS=OFF -DHANGUL=OFF -DJYUTPING=OFF -DKEYMAN=OFF -DM17N=OFF -DMOZC=OFF -DRIME=OFF -DSKK=OFF -DTABLE_EXTRA=OFF \
+            -DANTHY=OFF -DBAMBOO=OFF -DCHEWING=OFF -DCHINESE_ADDONS=OFF -DHANGUL=OFF -DJYUTPING=OFF -DKEYMAN=OFF -DKKC=OFF -DM17N=OFF -DMOZC=OFF -DRIME=OFF -DSKK=OFF -DTABLE_EXTRA=OFF \
             -DCMAKE_BUILD_TYPE=Release \
             -DCMAKE_TOOLCHAIN_FILE='windows-cross/msys2.toolchain.cmake' \
             -DARCH=${{ matrix.cmake_arch }}

.gitmodules

@@ -25,6 +25,9 @@
 [submodule "fcitx5-keyman"]
 	path = fcitx5-keyman
 	url = https://github.com/fcitx/fcitx5-keyman
+[submodule "fcitx5-kkc"]
+	path = fcitx5-kkc
+	url = https://github.com/fcitx/fcitx5-kkc
 [submodule "fcitx5-lua"]
 	path = fcitx5-lua
 	url = https://github.com/fcitx/fcitx5-lua

CMakeLists.txt

@@ -10,6 +10,7 @@ option(HALLELUJAH "" ON)
 option(HANGUL "" ON)
 option(JYUTPING "" ON)
 option(KEYMAN "" ON)
+option(KKC "" ON)
 option(M17N "" ON)
 option(MOZC "" ON)
 option(RIME "" ON)
@@ -50,6 +51,8 @@ if (APPLE)
         "${FIND_ROOT_PATH}"
     )
     set(CMAKE_INSTALL_RPATH "${APP_CONTENTS_PATH}/lib") # scel2org5, libime_*
+    set(SKK_PATH "$XDG_DATA_DIRS/skk/" CACHE STRING "") # skk
+    set(SKK_DEFAULT_PATH "$XDG_DATA_DIRS/skk/" CACHE STRING "") # kkc
 elseif (WIN32)
     list(PREPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/relative")
     add_compile_definitions(-DFcitx5Core_EXPORTS -DFcitx5Utils_EXPORTS)
@@ -143,6 +146,12 @@ if (KEYMAN)
 add_subdirectory(fcitx5-keyman)
 endif()
 
+# kkc
+if (KKC)
+add_subdirectory(fcitx5-kkc)
+target_link_libraries(kkc "${PREBUILDER_LIB_DIR}/libmarisa.a")
+endif()
+
 # m17n
 if (M17N)
 add_library(m17n_static STATIC IMPORTED)
@@ -222,7 +231,6 @@ endif()
 
 # skk
 if (SKK)
-set(SKK_DEFAULT_PATH "$XDG_DATA_DIRS/skk/SKK-JISYO.L" CACHE STRING "")
 add_subdirectory(fcitx5-skk)
 target_include_directories(skk PRIVATE "${PREBUILDER_INCLUDE_DIR}/gee-0.8")
 set(SKK_LINK_LIBS "-L${PREBUILDER_LIB_DIR}" -lgee-0.8 -lgio-2.0 -lgmodule-2.0 -ljson-glib-1.0 -lz)

fcitx5-kkc

@@ -0,0 +1,16 @@
+diff --git a/src/kkc.cpp b/src/kkc.cpp
+index 3924b92..0d40f7b 100644
+--- a/src/kkc.cpp
++++ b/src/kkc.cpp
+@@ -637,6 +637,11 @@ void KkcEngine::loadDictionary() {
+         }
+ 
+         if (mode == 1) {
++            std::string_view partialpath = path;
++            if (stringutils::consumePrefix(partialpath, "$XDG_DATA_DIRS/")) {
++                path = StandardPaths::global().locate(StandardPathsType::Data,
++                                                      partialpath);
++            }
+             auto dict = makeGObjectUnique(reinterpret_cast<KkcDictionary *>(
+                 kkc_system_segment_dictionary_new(path.c_str(), "EUC-JP",
+                                                   NULL)));

patches/kkc.patch

@@ -0,0 +1,21 @@
+diff --git a/CMakeLists.txt b/CMakeLists.txt
+index a44053f..9d08988 100644
+--- a/CMakeLists.txt
++++ b/CMakeLists.txt
+@@ -21,7 +21,7 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
+ 
+ include("${FCITX_INSTALL_CMAKECONFIG_DIR}/Fcitx5Utils/Fcitx5CompilerSettings.cmake")
+ 
+-set(SKK_DEFAULT_PATH "/usr/share/skk/SKK-JISYO.L" CACHE STRING "Default path of SKK")
++set(SKK_PATH "/usr/share/skk/" CACHE STRING "Default path of SKK directory that has SKK-JISYO.L, could start with \$XDG_DATA_DIRS/")
+ 
+ include(GNUInstallDirs)
+ 
+diff --git a/src/dictionary_list.in b/src/dictionary_list.in
+index c12a4e5..e8a925e 100644
+--- a/src/dictionary_list.in
++++ b/src/dictionary_list.in
+@@ -1,2 +1,2 @@
+ type=file,file=$FCITX_CONFIG_DIR/skk/user.dict,mode=readwrite
+-type=file,file=@SKK_DEFAULT_PATH@,mode=readonly
++type=file,file=@SKK_PATH@SKK-JISYO.L,mode=readonly

patches/skk.patch

@@ -13,6 +13,7 @@ macos=(
   libchewing
   libgee
   libhangul
+  libkkc
   libmozc
   librime
   libskk
@@ -41,6 +42,7 @@ js=(
   libchewing
   libgee
   libhangul
+  libkkc
   libmozc
   librime
   libskk

scripts/install-deps.sh

@@ -9,6 +9,7 @@ macos=(
   hangul
   jyutping
   keyman
+  kkc
   lua
   m17n
   mozc
@@ -35,6 +36,7 @@ js=(
   hangul
   jyutping
   keyman
+  kkc
   lua
   m17n
   mozc
@@ -55,7 +57,7 @@ extract_dep() {
   local plugin=$1
   local dep=$2
   local file=$dep$POSTFIX.tar.bz2
-  tar xjf $CACHE_DIR/$file -C $TARGET_DIR/$plugin/usr --exclude include --exclude lib
+  tar xf $CACHE_DIR/$file -C $TARGET_DIR/$plugin/usr --exclude include --exclude lib
 }
 
 package() {
@@ -79,7 +81,7 @@ package() {
 
 cache_plugin() {
   local file=$1
-  [[ -f $ROOT/cache/$file ]] || wget -P $ROOT/cache https://github.com/fcitx-contrib/fcitx5-plugins/releases/download/macos-latest/$file
+  [[ -f $ROOT/cache/$file ]] || curl -LO --output-dir $ROOT/cache https://github.com/fcitx-contrib/fcitx5-plugins/releases/download/macos-latest/$file
 }
 
 for plugin in "${plugins[@]}"; do
@@ -133,7 +135,7 @@ skk_share_dir=$TARGET_DIR/skk/usr/share
 mkdir -p $skk_share_dir/skk
 cp -r $TARGET_DIR/usr/share/libskk $skk_share_dir
 skk_dict=SKK-JISYO.L.gz
-[[ -f $ROOT/cache/$skk_dict ]] || wget -P $ROOT/cache https://skk-dev.github.io/dict/$skk_dict
+[[ -f $ROOT/cache/$skk_dict ]] || curl -LO --output-dir $ROOT/cache https://skk-dev.github.io/dict/$skk_dict
 gunzip -fc $ROOT/cache/$skk_dict > $skk_share_dir/skk/SKK-JISYO.L
 fi
 fi
@@ -176,13 +178,26 @@ if [[ $PLATFORM != "windows" ]]; then
   fi
 fi
 
+# kkc
+if [[ $PLATFORM != "windows" ]]; then
+  libkkc_data=libkkc-data.tar.bz2
+  [[ -f $ROOT/cache/$libkkc_data ]] || curl -LO --output-dir $ROOT/cache https://github.com/fcitx-contrib/libkkc-data/releases/download/latest/$libkkc_data
+  # Model files are under lib/
+  if [[ $PLATFORM == "macos" ]]; then
+    tar xf $ROOT/cache/$libkkc_data -C $TARGET_DIR/kkc/data
+  else
+    tar xf $ROOT/cache/$libkkc_data -C $TARGET_DIR/kkc/usr
+  fi
+fi
+
 if [[ $PLATFORM != "windows" ]]; then
 package anthy anthy
 package chewing chewing
 package chinese-addons pinyin
 package hangul hangul
 package jyutping jyutping
 package keyman
+package kkc kkc
 package lua
 package m17n
 package mozc mozc