separated core module and fcitx5 part

*separated module is added as submodule.
*github CI action for release may not work after this update. if fails need to build install using build instructions from readme

Author: khumnath

.github/workflows/build.yml

@@ -1,4 +1,3 @@
-# .github/workflows/build.yml
 name: Build & Test
 
 on:
@@ -19,12 +18,16 @@ jobs:
       CC:  ${{ matrix.cc }}
       CXX: ${{ matrix.cc == 'gcc' && 'g++' || 'clang++' }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
 
       - name: Install distro dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y \
+            build-essential \
             cmake ninja-build extra-cmake-modules \
             libfcitx5core-dev libfcitx5utils-dev libfcitx5config-dev \
             libsqlite3-dev qt6-base-dev qt6-base-dev-tools libicu-dev \
@@ -34,21 +37,18 @@ jobs:
         run: |
           cmake -B build -G Ninja \
             -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+            -DCMAKE_INSTALL_PREFIX=/usr \
             -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 
       - name: Build
         run: cmake --build build
 
-      - name: Test (CTest)
-        run: |
-          cd build
-          ctest --output-on-failure || true   # add real tests later
+      - name: Stage install files into dist/ directory
+        run: DESTDIR=dist cmake --install build
 
       - name: Upload build artefacts
         uses: actions/upload-artifact@v4
         with:
           name: linux-${{ matrix.cc }}-${{ matrix.build_type }}
-          path: |
-            build/*.so
-            build/lekhika-trainer
-            build/Testing/Temporary/LastTest.log
+          path: dist/
+

.github/workflows/release.yml

@@ -14,20 +14,22 @@ jobs:
       tarball: ${{ steps.src.outputs.tarball }}
       version: ${{ steps.src.outputs.version }}
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout repository and submodules
+        uses: actions/checkout@v4
         with:
-          fetch-depth: 0   
+          fetch-depth: 0
+          submodules: 'recursive'
+      - id: version
+        run: echo "version=$(cat version.txt)" >> "$GITHUB_OUTPUT"
       - name: Update metainfo
         run: ./update-metainfo.sh
-
       - id: src
         run: |
           VER=${GITHUB_REF_NAME#v}
           TAR="fcitx5-lekhika-${VER}.tar.gz"
-          git archive --format=tar.gz --prefix="fcitx5-lekhika-${VER}/" \
-            -o "$TAR" "$GITHUB_REF_NAME"
+          # Create a source tarball that includes the submodule content
+          git archive --format=tar --prefix="fcitx5-lekhika-${VER}/" HEAD | (cd liblekhika && git archive --format=tar --prefix="fcitx5-lekhika-${VER}/liblekhika/" HEAD) | gzip > "$TAR"
           echo "tarball=$TAR" >> "$GITHUB_OUTPUT"
-          echo "version=$VER" >> "$GITHUB_OUTPUT"
       - uses: actions/upload-artifact@v4
         with:
           name: source-tarball
@@ -45,10 +47,9 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y --no-install-recommends \
             build-essential dpkg-dev debhelper devscripts \
-            cmake ninja-build \
+            cmake ninja-build extra-cmake-modules \
             libfcitx5core-dev libfcitx5utils-dev libfcitx5config-dev \
-            libsqlite3-dev qt6-base-dev libicu-dev libgl-dev
-      - uses: actions/checkout@v4
+            libsqlite3-dev qt6-base-dev libicu-dev
       - uses: actions/download-artifact@v4
         with:
           name: source-tarball
@@ -57,66 +58,66 @@ jobs:
           mkdir pkg && tar -xf *.tar.gz -C pkg --strip-components=1
           cd pkg
           mkdir -p debian
-          # control file
+          # control file to define the two final packages
           {
             echo 'Source: fcitx5-lekhika'
             echo 'Section: utils'
             echo 'Priority: optional'
             echo 'Maintainer: KHUMNATH CG<nath.khum@gmail.com>'
-            echo 'Build-Depends: debhelper-compat (= 13), cmake, ninja-build,'
+            echo 'Build-Depends: debhelper-compat (= 13), cmake, ninja-build, extra-cmake-modules,'
             echo ' libfcitx5core-dev, libfcitx5utils-dev, libfcitx5config-dev,'
-            echo ' libsqlite3-dev, qt6-base-dev, libicu-dev, libgl-dev'
+            echo ' libsqlite3-dev, qt6-base-dev, libicu-dev'
             echo 'Standards-Version: 4.6.0'
             echo ''
             echo 'Package: fcitx5-lekhika'
             echo 'Architecture: any'
-            echo 'Depends: ${shlibs:Depends}, ${misc:Depends}'
-            echo 'Description: Lekhika input-method addon for Fcitx5'
+            echo 'Depends: ${shlibs:Depends}, ${misc:Depends}, libfcitx5-qt1, libsqlite3-0, libicu70 | libicu71, libqt6core6'
+            echo 'Description: Lekhika input-method addon for Fcitx5 (with bundled liblekhika)'
             echo ''
             echo 'Package: lekhika-trainer'
             echo 'Architecture: any'
             echo 'Depends: ${shlibs:Depends}, ${misc:Depends}, libqt6widgets6t64 | libqt6widgets6'
             echo 'Description: GUI training tool for fcitx5-lekhika'
           } > debian/control
-          # Create .install files to map build artifacts to packages
+          
+          # .install file for the main IME package, including liblekhika files
           {
+            echo 'usr/lib/*/liblekhika.so.*'
+            echo 'usr/share/lekhika-core/*'
             echo 'usr/lib/*/fcitx5/fcitx5lekhika.so'
             echo 'usr/share/fcitx5/addon/fcitx5lekhika.conf'
-            echo 'usr/share/fcitx5/fcitx5-lekhika/*'
             echo 'usr/share/fcitx5/inputmethod/fcitx5lekhika.conf'
             echo 'usr/share/metainfo/fcitx5-lekhika.metainfo.xml'
           } > debian/fcitx5-lekhika.install
+
+          # .install file for the trainer GUI
           {
             echo 'usr/bin/lekhika-trainer'
             echo 'usr/share/applications/lekhika-trainer.desktop'
             echo 'usr/share/icons/hicolor/*/apps/*'
             echo 'usr/share/metainfo/lekhika-trainer.metainfo.xml'
           } > debian/lekhika-trainer.install
-          # rules file with real TABs, overriding the auto-test step
+
           printf '#!/usr/bin/make -f\n%%:\n\tdh $@ --buildsystem=cmake+ninja\noverride_dh_auto_configure:\n\tdh_auto_configure -- -DCMAKE_BUILD_TYPE=Release\noverride_dh_auto_test:\n' > debian/rules
           chmod +x debian/rules
+          
           export DEBEMAIL=nath.khum@gmail.com DEBFULLNAME="KHUMNATH CG"
-          VER=$(cat version.txt)
+          VER=${{ needs.source.outputs.version }}
           dch --create -v "${VER}-1" --package fcitx5-lekhika "CI build"
           dpkg-buildpackage -b -uc -us
       - name: Remove debug packages
         run: rm -f ./*.ddeb
       - name: Add t64 suffix for latest ubuntu build
         if: matrix.distro == 'ubuntu-latest'
         run: |
-          # Rename all build artifacts with a _t64 suffix to avoid name collisions in the release.
           shopt -s nullglob
-          for f in *.deb *.changes *.buildinfo; do
-            new_name="${f%.*}_t64.${f##*.}"
-            echo "Renaming $f to $new_name"
-            mv -- "$f" "$new_name"
+          for f in *.deb; do
+            mv -- "$f" "${f%.deb}_t64.deb"
           done
       - uses: actions/upload-artifact@v4
         with:
           name: debian-packages-${{ matrix.distro }}
-          path: |
-            *deb
-            *changes
+          path: "*.deb"
 
   rpm-fedora:
     needs: source
@@ -125,47 +126,56 @@ jobs:
     steps:
       - run: |
           dnf install -y rpm-build cmake ninja-build gcc-c++ \
-            fcitx5-devel qt6-qtbase-devel sqlite-devel libicu-devel
-      - uses: actions/checkout@v4
+            fcitx5-devel qt6-qtbase-devel sqlite-devel libicu-devel qt6-qtwidgets-devel
       - uses: actions/download-artifact@v4
         with:
           name: source-tarball
       - run: |
-          mkdir pkg && tar -xf *.tar.gz -C pkg --strip-components=1
-          cd pkg
-          VER=$(cat version.txt)
+          VER=${{ needs.source.outputs.version }}
           mkdir -p ~/rpmbuild/{BUILD,RPMS,SOURCES,SPECS,SRPMS}
-          tar -czf ~/rpmbuild/SOURCES/fcitx5-lekhika-${VER}.tar.gz \
-            --transform "s,^,fcitx5-lekhika-${VER}/," .
+          cp *.tar.gz ~/rpmbuild/SOURCES/
           {
-            echo "Name:           fcitx5-lekhika"
+            echo "Name:           fcitx5-lekhika-meta" # A meta name for the spec file
             echo "Version:        ${VER}"
             echo "Release:        1%{?dist}"
-            echo "Summary:        Lekhika input method for Fcitx5"
+            echo "Summary:        Lekhika input method for Fcitx5 and related tools"
             echo "License:        GPL-3.0+"
-            echo "Source0:        %{name}-%{version}.tar.gz"
-            echo "BuildRequires:  cmake ninja-build gcc-c++ fcitx5-devel qt6-qtbase-devel sqlite-devel libicu-devel"
+            echo "Source0:        fcitx5-lekhika-%{version}.tar.gz"
+            echo "BuildRequires:  cmake, ninja-build, gcc-c++, fcitx5-devel, qt6-qtbase-devel, sqlite-devel, libicu-devel, qt6-qtwidgets-devel"
             echo "%description"
-            echo "Lekhika input-method addon for Fcitx5"
+            echo "This package provides the fcitx5-lekhika input method and its GUI trainer."
             echo "%prep"
-            echo "%autosetup"
+            echo "%autosetup -n fcitx5-lekhika-%{version}"
             echo "%build"
             echo "%cmake -DCMAKE_BUILD_TYPE=Release"
             echo "%cmake_build"
             echo "%install"
             echo "%cmake_install"
-            echo "%files"
+            
+            echo "%package -n fcitx5-lekhika"
+            echo "Summary:        Lekhika input method for Fcitx5 (with bundled liblekhika)"
+            echo "Requires:       fcitx5-qt, sqlite, libicu"
+            echo "%description -n fcitx5-lekhika"
+            echo "The core fcitx5-lekhika addon with its bundled runtime library."
+            echo "%files -n fcitx5-lekhika"
+            echo "%{_libdir}/liblekhika.so.*"
+            echo "/usr/share/lekhika-core/*"
             echo "%{_libdir}/fcitx5/*.so"
-            echo "%{_bindir}/lekhika-trainer"
-            echo "%{_datadir}/metainfo/*.xml"
             echo "%{_datadir}/fcitx5/*"
+            echo "%{_datadir}/metainfo/fcitx5-lekhika.metainfo.xml"
+
+            echo "%package -n lekhika-trainer"
+            echo "Summary:        GUI training tool for fcitx5-lekhika"
+            echo "Requires:       fcitx5-lekhika = %{version}-%{release}, qt6-qtwidgets"
+            echo "%description -n lekhika-trainer"
+            echo "A Qt-based GUI to manage the lekhika dictionary."
+            echo "%files -n lekhika-trainer"
+            echo "%{_bindir}/lekhika-trainer"
             echo "%{_datadir}/applications/*.desktop"
             echo "%{_datadir}/icons/hicolor/*/apps/lekhika.*"
-            echo "%changelog"
-            echo "* $(date +"%a %b %d %Y") KHUMNATH CG <nath.khum@gmail.com> - ${VER}-1"
-            echo "- Automated build"
-          } > ~/rpmbuild/SPECS/fcitx5-lekhika.spec
-          rpmbuild -bb ~/rpmbuild/SPECS/fcitx5-lekhika.spec
+            echo "%{_datadir}/metainfo/lekhika-trainer.metainfo.xml"
+          } > ~/rpmbuild/SPECS/lekhika.spec
+          rpmbuild -bb ~/rpmbuild/SPECS/lekhika.spec
       - name: Remove debug packages
         run: rm -f ~/rpmbuild/RPMS/*/*-debug{info,source}-*.rpm
       - uses: actions/upload-artifact@v4
@@ -178,9 +188,7 @@ jobs:
     runs-on: ubuntu-latest
     container: archlinux:latest
     steps:
-      - run: |
-          pacman -Sy --noconfirm base-devel cmake ninja fcitx5-qt sqlite qt6-base icu
-      - uses: actions/checkout@v4
+      - run: pacman -Sy --noconfirm base-devel cmake ninja fcitx5-qt sqlite qt6-base icu qt6-widgets
       - uses: actions/download-artifact@v4
         with:
           name: source-tarball
@@ -197,74 +205,70 @@ jobs:
               cd arch_build
               VER=$PKGVER
               {
-                echo "pkgname=(fcitx5-lekhika lekhika-trainer)"
+                echo "pkgname=('fcitx5-lekhika' 'lekhika-trainer')"
                 echo "pkgver=${VER}"
                 echo "pkgrel=1"
-                echo "pkgdesc=\"Lekhika input method for Fcitx5\""
-                echo "arch=(x86_64)"
+                echo "arch=('x86_64')"
                 echo "url=\"https://github.com/${GITHUB_REPOSITORY}\""
-                echo "license=(GPL3)"
-                echo "options=(\"!debug\")"
-                echo "depends=(fcitx5 qt6-base icu sqlite)"
-                echo "makedepends=(cmake ninja)"
-                echo "source=(fcitx5-lekhika-\${pkgver}.tar.gz)"
+                echo "license=('GPL3')"
+                echo "makedepends=('cmake' 'ninja')"
+                echo "source=(\"fcitx5-lekhika-\${pkgver}.tar.gz\")"
                 echo "sha256sums=(\"SKIP\")"
                 echo "build() {"
                 echo "  cd \"fcitx5-lekhika-\${pkgver}\""
-                echo "  cmake -B build -G Ninja \\"
-                echo "    -DCMAKE_BUILD_TYPE=Release \\"
-                echo "    -DCMAKE_INSTALL_PREFIX=/usr"
+                echo "  cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr"
                 echo "  cmake --build build"
                 echo "}"
                 echo "package_fcitx5-lekhika() {"
-                echo "  cd \"fcitx5-lekhika-\${pkgver}\""
-                echo "  DESTDIR=\"\$pkgdir\" cmake --install build --component Runtime"
+                echo "  pkgdesc=\"Lekhika input method for Fcitx5 (with bundled liblekhika)\""
+                echo "  depends=(\"fcitx5-qt\" \"sqlite\" \"icu\")"
+                echo "  cd \"fcitx5-lekhika-\${pkgver}/build\""
+                # Install all runtime components, then remove trainer parts
+                echo "  DESTDIR=\"\$pkgdir\" cmake --install ."
+                echo "  rm -rf \"\$pkgdir/usr/bin/lekhika-trainer\""
+                echo "  rm -rf \"\$pkgdir/usr/share/applications/lekhika-trainer.desktop\""
+                echo "  rm -rf \"\$pkgdir/usr/share/metainfo/lekhika-trainer.metainfo.xml\""
+                echo "  rm -rf \"\$pkgdir/usr/bin/lekhika-cli\""
+                echo "  rm -rf \"\$pkgdir/usr/include\""
+                echo "  rm -rf \"\$pkgdir/usr/lib/cmake\""
                 echo "}"
                 echo "package_lekhika-trainer() {"
-                echo "  cd \"fcitx5-lekhika-\${pkgver}\""
-                echo "  DESTDIR=\"\$pkgdir\" cmake --install build --component Trainer"
+                echo "  pkgdesc=\"GUI training tool for fcitx5-lekhika\""
+                echo "  depends=(\"fcitx5-lekhika=\${pkgver}\" \"qt6-widgets\")"
+                echo "  cd \"fcitx5-lekhika-\${pkgver}/build\""
+                echo "  DESTDIR=\"\$pkgdir\" cmake --install . --component Trainer"
                 echo "}"
               } > PKGBUILD
-              makepkg -f
+              makepkg -f --noconfirm
             '
           mv arch_build/*.pkg.tar.zst .
       - uses: actions/upload-artifact@v4
         with:
           name: arch-packages
-          path: '*.pkg.tar.zst'
+          path: "*.pkg.tar.zst"
 
   release:
     needs: [source, deb, rpm-fedora, arch]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
       - uses: actions/download-artifact@v4
       - run: |
           mkdir release
           shopt -s nullglob globstar
-          files_to_copy=(
-            source-tarball/*
-            debian-packages-*/*
-            fedora-rpms/**/*.rpm
-            arch-packages/*.pkg.tar.zst
-          )
-          if [ ${#files_to_copy[@]} -gt 0 ]; then
-            cp -v "${files_to_copy[@]}" release/
-          fi
+          cp -v source-tarball/* release/
+          cp -v debian-packages-*/* release/
+          cp -v fedora-rpms/* release/
+          cp -v arch-packages/* release/
           cd release
-          if [ -n "$(ls -A .)" ]; then
-            sha256sum * > SHA256SUMS.txt
-          fi
+          sha2sum * > SHA256SUMS.txt
       - name: changelog
         run: |
-          PREV=$(git describe --tags --abbrev=0 HEAD~1 2/dev/null || true)
+          PREV=$(git describe --tags --abbrev=0 "$(git rev-list --tags --max-count=2)" | tail -n 1)
           if [ -n "$PREV" ]; then
             echo "### Changes since $PREV" > CHANGELOG.md
             git log --pretty=format:"- %s (%h)" "$PREV..HEAD" >> CHANGELOG.md
           else
-            echo "### Initial release" > CHANGELOG.md
+            git log --pretty=format:"- %s (%h)" > CHANGELOG.md
           fi
       - name: create GitHub release
         uses: softprops/action-gh-release@v1

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "liblekhika"]
+    path = liblekhika
+    url = https://github.com/khumnath/liblekhika.git