fcitx5-android · rocka · Dec 20, 2024 · Dec 16, 2024 · Dec 16, 2024 · Dec 16, 2024
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -26,12 +26,6 @@ jobs:
           fetch-depth: 0
           submodules: recursive
 
-      - name: Regenerate symlinks pointing to submodule (Windows)
-        if: ${{ matrix.os == 'windows-2022' }}
-        run: |
-          Remove-Item -Recurse app/src/main/assets/usr/share, plugin/hangul/src/main/assets/usr/share/libhangul, plugin/chewing/src/main/assets/usr/share/libchewing, plugin/jyutping/src/main/assets/usr/share/libime
-          git checkout -- .
-
       - name: Setup Java
         uses: actions/setup-java@v4
         with:

diff --git a/.gitignore b/.gitignore
@@ -1,21 +1,12 @@
 # Module :app
 # Installed data
-/app/src/main/assets/usr/share/fcitx5/addon
-/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/inputmethod
-/app/src/main/assets/usr/share/fcitx5/lua
-/app/src/main/assets/usr/share/fcitx5/punctuation
-/app/src/main/assets/usr/share/fcitx5/unicode
-/app/src/main/assets/usr/share/locale
+/app/src/main/assets/usr/
 # Generated asset descriptor
 /app/src/main/assets/descriptor.json
 
 # Plugins
 # Installed data
-/plugin/*/src/main/assets/usr/share/fcitx5
-/plugin/*/src/main/assets/usr/share/locale
+/plugin/*/src/main/assets/usr/
 # Generated asset descriptor
 /plugin/*/src/main/assets/descriptor.json
 

diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ Discuss on Telegram: [@fcitx5_android_group](https://t.me/fcitx5_android_group)
 
 ### Dependencies
 
-- Android SDK Platform & Build-Tools 34.
+- Android SDK Platform & Build-Tools 35.
 - Android NDK (Side by side) 25 & CMake 3.22.1, they can be installed using SDK Manager in Android Studio or `sdkmanager` command line.
 - [KDE/extra-cmake-modules](https://github.com/KDE/extra-cmake-modules)
 - GNU Gettext >= 0.20 (for `msgfmt` binary; or install `appstream` if you really have to use gettext <= 0.19.)
@@ -96,29 +96,6 @@ git clone git@github.com:fcitx5-android/fcitx5-android.git
 git submodule update --init --recursive
 ```
 
-<details>
-<summary>On Windows, you may need to regenerate symlinks to submodules.</summary>
-
-Run in PowerShell:
-
-```powershell
-Remove-Item -Recurse app/src/main/assets/usr/share, plugin/hangul/src/main/assets/usr/share/libhangul, plugin/chewing/src/main/assets/usr/share/libchewing, plugin/jyutping/src/main/assets/usr/share/libime
-```
-
-Or Command Prompt:
-
-```bat
-RD /S /Q app\src\main\assets\usr\share plugin\hangul\src\main\assets\usr\share\libhangul plugin\chewing\src\main\assets\usr\share\libchewing plugin\jyutping\src\main\assets\usr\share\libime
-```
-
-Then let `git` regenerate symlinks:
-
-```shell
-git checkout -- .
-```
-
-</details>
-
 Install `extra-cmake-modules` and `gettext` with your system package manager:
 
 ```shell

diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -67,12 +67,8 @@ kotlin {
     }
 }
 
-aboutLibraries {
-    configPath = "app/licenses"
-}
-
 fcitxComponent {
-    installLibraries = listOf(
+    includeLibs = listOf(
         "fcitx5",
         "fcitx5-lua",
         "libime",
@@ -82,6 +78,7 @@ fcitxComponent {
     excludeFiles = listOf("cangjie", "erbi", "qxm", "wanfeng").map {
         "usr/share/fcitx5/inputmethod/$it.conf"
     }
+    installPrebuiltAssets = true
 }
 
 ksp {

diff --git a/app/src/main/assets/usr/share/fcitx5/pinyin/chaizi.dict b/app/src/main/assets/usr/share/fcitx5/pinyin/chaizi.dict
diff --git a/app/src/main/assets/usr/share/fcitx5/pinyin/symbols b/app/src/main/assets/usr/share/fcitx5/pinyin/symbols
diff --git a/app/src/main/assets/usr/share/fcitx5/pinyinhelper b/app/src/main/assets/usr/share/fcitx5/pinyinhelper
diff --git a/app/src/main/assets/usr/share/fcitx5/spell b/app/src/main/assets/usr/share/fcitx5/spell
diff --git a/app/src/main/assets/usr/share/fcitx5/table b/app/src/main/assets/usr/share/fcitx5/table
diff --git a/app/src/main/assets/usr/share/libime b/app/src/main/assets/usr/share/libime
diff --git a/app/src/main/assets/usr/share/opencc b/app/src/main/assets/usr/share/opencc
diff --git a/app/src/main/cpp/CMakeLists.txt b/app/src/main/cpp/CMakeLists.txt
@@ -65,22 +65,30 @@ target_link_libraries(native-lib
         pinyin-customphrase
         )
 
+# copy module libraries from dependency lib
 add_custom_target(copy-fcitx5-modules
-        # fcitx5
-        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}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::spell,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5::unicode,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        # fcitx5-lua
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-lua::luaaddonloader,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        # fcitx5-chinese-addons
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::pinyin,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::table,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::scel2org5,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::chttrans,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::fullwidth,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::pinyinhelper,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
-        COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:fcitx5-chinese-addons::punctuation,IMPORTED_LOCATION> ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different
+        $<TARGET_PROPERTY:fcitx5::clipboard,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5::imselector,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5::quickphrase,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5::spell,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5::unicode,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-lua::luaaddonloader,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::pinyin,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::table,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::scel2org5,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::chttrans,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::fullwidth,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::pinyinhelper,IMPORTED_LOCATION>
+        $<TARGET_PROPERTY:fcitx5-chinese-addons::punctuation,IMPORTED_LOCATION>
+        ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}
         COMMENT "Copying fcitx5 module libraries to :app"
         )
+
+# install prebuilt assets
+install(FILES "${PREBUILT_DIR}/spell-dict/en_dict.fscd" DESTINATION "${FCITX_INSTALL_PKGDATADIR}/spell" COMPONENT prebuilt-assets)
+install(FILES "${PREBUILT_DIR}/chinese-addons-data/pinyin/chaizi.dict" DESTINATION "${FCITX_INSTALL_PKGDATADIR}/pinyin" COMPONENT prebuilt-assets)
+install(DIRECTORY "${PREBUILT_DIR}/chinese-addons-data/pinyinhelper" DESTINATION "${FCITX_INSTALL_PKGDATADIR}" COMPONENT prebuilt-assets)
+install(DIRECTORY "${PREBUILT_DIR}/libime/table" DESTINATION "${FCITX_INSTALL_PKGDATADIR}" COMPONENT prebuilt-assets)
+install(DIRECTORY "${PREBUILT_DIR}/libime/data/" DESTINATION "${FCITX_INSTALL_DATADIR}/libime" COMPONENT prebuilt-assets)
+install(DIRECTORY "${PREBUILT_DIR}/opencc/data/" DESTINATION "${FCITX_INSTALL_DATADIR}/opencc" COMPONENT prebuilt-assets)
diff --git a/build-logic/convention/src/main/kotlin/AndroidAppConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidAppConventionPlugin.kt
@@ -141,6 +141,7 @@ class AndroidAppConventionPlugin : AndroidBaseConventionPlugin() {
         target.pluginManager.apply(target.libs.plugins.aboutlibraries.get().pluginId)
 
         target.configure<AboutLibrariesExtension> {
+            configPath = target.rootProject.relativePath(target.file("licenses"))
             excludeFields = arrayOf(
                 "generated", "developers", "organization", "scm", "funding", "content"
             )

diff --git a/build-logic/convention/src/main/kotlin/FcitxComponentPlugin.kt b/build-logic/convention/src/main/kotlin/FcitxComponentPlugin.kt
@@ -12,21 +12,20 @@ import org.gradle.kotlin.dsl.task
 import java.io.File
 import kotlin.io.path.isSymbolicLink
 
-/**
- * Add task installFcitxConfig and installFcitxTranslation, using a random variant's cxx dir
- */
 class FcitxComponentPlugin : Plugin<Project> {
 
     abstract class FcitxComponentExtension {
-        var installLibraries: List<String> = emptyList()
+        var includeLibs: List<String> = emptyList()
         var excludeFiles: List<String> = emptyList()
         var modifyFiles: Map<String, (File) -> Unit> = emptyMap()
+        var installPrebuiltAssets: Boolean = false
     }
 
     companion object {
         const val INSTALL_TASK = "installFcitxComponent"
         const val DELETE_TASK = "deleteFcitxComponentExcludeFiles"
         const val CLEAN_TASK = "cleanFcitxComponents"
+        const val EXTENSION = "fcitxComponent"
 
         val DEPENDENT_TASKS = arrayOf(INSTALL_TASK, DELETE_TASK)
     }
@@ -37,10 +36,10 @@ class FcitxComponentPlugin : Plugin<Project> {
         registerCMakeTask(target, "generate-desktop-file", "config")
         registerCMakeTask(target, "translation-file", "translation")
         registerCleanTask(target)
-        target.extensions.create<FcitxComponentExtension>("fcitxComponent")
+        target.extensions.create<FcitxComponentExtension>(EXTENSION)
         target.afterEvaluate {
-            val ext = extensions.getByName<FcitxComponentExtension>("fcitxComponent")
-            ext.installLibraries.forEach {
+            val ext = extensions.getByName<FcitxComponentExtension>(EXTENSION)
+            ext.includeLibs.forEach {
                 val project = rootProject.project(":lib:$it")
                 registerCMakeTask(target, "generate-desktop-file", "config", project)
                 registerCMakeTask(target, "translation-file", "translation", project)
@@ -55,6 +54,9 @@ class FcitxComponentPlugin : Plugin<Project> {
                     }
                 }
             }
+            if (ext.installPrebuiltAssets) {
+                registerCMakeTask(target, "", "prebuilt-assets")
+            }
         }
     }
 
@@ -67,17 +69,20 @@ class FcitxComponentPlugin : Plugin<Project> {
         component: String,
         sourceProject: Project = project
     ) {
+        val componentName = component.split('-').joinToString("") { it.capitalized() }
         val taskName = if (project === sourceProject) {
-            "installProject${component.capitalized()}"
+            "installProject$componentName"
         } else {
-            "installLibrary${component.capitalized()}[${sourceProject.name}]"
+            "installLibrary$componentName[${sourceProject.name}]"
         }
         val task = project.task(taskName) {
             runAfterNativeConfigure(sourceProject) { abiModel ->
                 val cmake = abiModel.variant.module.cmake!!.cmakeExe!!
-                sourceProject.exec {
-                    workingDir = abiModel.cxxBuildFolder
-                    commandLine(cmake, "--build", ".", "--target", target)
+                if (target.isNotEmpty()) {
+                    sourceProject.exec {
+                        workingDir = abiModel.cxxBuildFolder
+                        commandLine(cmake, "--build", ".", "--target", target)
+                    }
                 }
                 sourceProject.exec {
                     workingDir = abiModel.cxxBuildFolder

diff --git a/build-logic/convention/src/main/kotlin/FcitxHeadersPlugin.kt b/build-logic/convention/src/main/kotlin/FcitxHeadersPlugin.kt
@@ -8,32 +8,60 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.tasks.Delete
 import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.create
+import org.gradle.kotlin.dsl.getByName
 import org.gradle.kotlin.dsl.task
 import org.gradle.kotlin.dsl.withType
+import java.io.File
 
 class FcitxHeadersPlugin : Plugin<Project> {
 
+    abstract class FcitxHeadersExtension {
+        var installDevelComponent: Boolean = false
+    }
+
     companion object {
-        const val INSTALL_TASK = "installFcitxHeaders"
+        const val HEADERS_TASK = "installFcitxHeaders"
+        const val DEVEL_TASK = "installFcitxDevelComponent"
         const val CLEAN_TASK = "cleanFcitxHeaders"
+        const val EXTENSION = "fcitxHeaders"
     }
 
     private val Project.headersInstallDir
         get() = file("build/headers")
 
+    private val Project.develComponentInstallDir
+        get() = file("build/devel")
+
     override fun apply(target: Project) {
-        registerInstallTask(target)
+        // mkdir for all prefab library headers
+        target.extensions.configure<LibraryAndroidComponentsExtension> {
+            finalizeDsl {
+                @Suppress("UnstableApiUsage")
+                it.prefab.forEach { library ->
+                    library.headers?.let { path -> target.file(path).mkdirs() }
+                }
+            }
+        }
+        registerInstallTask(target, HEADERS_TASK, "header", target.headersInstallDir)
         registerCleanTask(target)
+        target.extensions.create<FcitxHeadersExtension>(EXTENSION)
+        target.afterEvaluate {
+            val ext = extensions.getByName<FcitxHeadersExtension>(EXTENSION)
+            if (ext.installDevelComponent) {
+                registerInstallTask(target, DEVEL_TASK, "Devel", target.develComponentInstallDir)
+            }
+        }
     }
 
-    private fun registerInstallTask(project: Project) {
-        val installHeadersTask = project.task(INSTALL_TASK) {
+    private fun registerInstallTask(project: Project, name: String, component: String, dest: File) {
+        val installHeadersTask = project.task(name) {
             runAfterNativeConfigure(project) { abiModel ->
                 val cmake = abiModel.variant.module.cmake!!.cmakeExe!!
                 project.exec {
                     workingDir = abiModel.cxxBuildFolder
-                    environment("DESTDIR", project.headersInstallDir.absolutePath)
-                    commandLine(cmake, "--install", ".", "--component", "header")
+                    environment("DESTDIR", dest.absolutePath)
+                    commandLine(cmake, "--install", ".", "--component", component)
                 }
             }
         }
@@ -42,20 +70,12 @@ class FcitxHeadersPlugin : Plugin<Project> {
         project.tasks.withType<PrefabPackageConfigurationTask>().all {
             dependsOn(installHeadersTask)
         }
-
-        project.extensions.configure<LibraryAndroidComponentsExtension> {
-            finalizeDsl {
-                @Suppress("UnstableApiUsage")
-                it.prefab.forEach { library ->
-                    library.headers?.let { path -> project.file(path).mkdirs() }
-                }
-            }
-        }
     }
 
     private fun registerCleanTask(project: Project) {
         project.task<Delete>(CLEAN_TASK) {
             delete(project.headersInstallDir)
+            delete(project.develComponentInstallDir)
         }.also {
             project.cleanTask.dependsOn(it)
         }

diff --git a/lib/fcitx5/build.gradle.kts b/lib/fcitx5/build.gradle.kts
@@ -4,6 +4,10 @@ plugins {
     id("org.fcitx.fcitx5.android.fcitx-headers")
 }
 
+fcitxHeaders {
+    installDevelComponent = true
+}
+
 android {
     namespace = "org.fcitx.fcitx5.android.lib.fcitx5"
 
@@ -14,6 +18,7 @@ android {
                 targets(
                     // dummy "cmake" target
                     "cmake",
+                    "devel",
                     // fcitx5
                     "Fcitx5Core",
                     "Fcitx5Config",
@@ -35,6 +40,10 @@ android {
             headerOnly = true
             headers = "src/main/cpp/cmake"
         }
+        create("devel") {
+            headerOnly = true
+            headers = "build/devel/usr/lib/cmake"
+        }
         val headersPrefix = "build/headers/usr/include/Fcitx5"
         create("Fcitx5Core") {
             libraryName = "libFcitx5Core"

diff --git a/lib/fcitx5/src/main/cpp/CMakeLists.txt b/lib/fcitx5/src/main/cpp/CMakeLists.txt
@@ -7,6 +7,8 @@ add_link_options("LINKER:--hash-style=gnu,--build-id=none")
 
 # dummy target to export src/main/cpp/cmake
 add_custom_target(cmake)
+# dummy target to export build/devel/usr/lib/cmake
+add_custom_target(devel)
 # dummy target to export "notifications_public.h"
 add_custom_target(notifications)
 

diff --git a/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5CompilerSettings.cmake b/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5CompilerSettings.cmake
diff --git a/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5Download.cmake.in b/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5Download.cmake.in
diff --git a/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5Macros.cmake b/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5Macros.cmake
diff --git a/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5ModuleTemplate.cmake.in b/lib/fcitx5/src/main/cpp/cmake/Fcitx5Utils/Fcitx5ModuleTemplate.cmake.in