refactor: enhance Kotlin-made config parser

WhiredPlanck · WhiredPlanck · commit 1b24b0bcf7a7 · 2025-06-21T13:09:52.000+08:00
diff --git a/app/src/main/java/com/osfans/trime/data/base/DataManager.kt b/app/src/main/java/com/osfans/trime/data/base/DataManager.kt
@@ -53,6 +53,9 @@ object DataManager {
     val userDataDir
         get() = File(prefs.profile.userDataDir).also { it.mkdirs() }
 
+    val prebuiltDataDir = File(sharedDataDir, "build")
+    val stagingDir get() = File(userDataDir, "build")
+
     /**
      * Return the absolute path of the compiled config file
      * based on given resource id.
@@ -62,9 +65,6 @@ object DataManager {
      */
     @JvmStatic
     fun resolveDeployedResourcePath(resourceId: String): String {
-        val stagingDir = File(userDataDir, "build")
-        val prebuiltDataDir = File(sharedDataDir, "build")
-
         val defaultPath = File(stagingDir, "$resourceId.yaml")
         if (!defaultPath.exists()) {
             val fallbackPath = File(prebuiltDataDir, "$resourceId.yaml")
diff --git a/app/src/main/java/com/osfans/trime/data/schema/Schema.kt b/app/src/main/java/com/osfans/trime/data/schema/Schema.kt
@@ -5,33 +5,42 @@
 package com.osfans.trime.data.schema
 
 import com.osfans.trime.util.config.Config
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.Transient
+import timber.log.Timber
 
-class Schema(
-    schemaId: String = ".default",
+data class Schema(
+    val switches: List<Switch>,
+    val symbols: Map<String, Config>,
+    val alphabet: String,
 ) {
-    private val config =
-        if (schemaId == ".default") {
-            Config.create("default")
-        } else {
-            Config.create("$schemaId.schema")
-        }
-
-    val switches get() =
-        config?.getList("switches")
-
-    val symbols get() =
-        config?.getMap("punctuator/symbols")
-
-    val alphabet get() = config?.getString("speller/alphabet")
-
-    @Serializable
     data class Switch(
         val name: String = "",
         val options: List<String> = listOf(),
         val reset: Int = -1,
         val states: List<String> = listOf(),
-        @Transient var enabled: Int = 0,
+        var enabled: Int = 0,
     )
+
+    companion object {
+        fun open(schemaId: String): Schema {
+            val c = Config.openSchema(schemaId)
+            return Schema(
+                switches =
+                    c.getList("switches").mapNotNull decode@{ e ->
+                        try {
+                            Switch(
+                                name = e.getString("name"),
+                                options = e.getStringList("options"),
+                                reset = e.getInt("reset", -1),
+                                states = e.getStringList("states"),
+                            )
+                        } catch (e: Exception) {
+                            Timber.e(e, "Failed to decode switches of schema '$schemaId'")
+                            null
+                        }
+                    },
+                symbols = c.getMap("punctuator/symbols"),
+                alphabet = c.getString("speller/alphabet"),
+            )
+        }
+    }
 }
diff --git a/app/src/main/java/com/osfans/trime/data/schema/SchemaManager.kt b/app/src/main/java/com/osfans/trime/data/schema/SchemaManager.kt
@@ -5,25 +5,22 @@
 package com.osfans.trime.data.schema
 
 import com.osfans.trime.core.Rime
-import kotlinx.serialization.builtins.ListSerializer
 
 object SchemaManager {
     private lateinit var currentSchema: Schema
     var visibleSwitches: List<Schema.Switch> = listOf()
 
-    private val defaultSchema = Schema()
-
     @JvmStatic
     fun init(schemaId: String) {
-        currentSchema = runCatching { Schema(schemaId) }.getOrDefault(defaultSchema)
-        visibleSwitches = currentSchema.switches
-            ?.decode(ListSerializer(Schema.Switch.serializer()))
-            ?.filter { it.states.isNotEmpty() } ?: listOf() // 剔除没有 states 条目项的值，它们不作为开关使用
+        currentSchema = Schema.open(schemaId)
+        visibleSwitches =
+            currentSchema.switches
+                .filter { it.states.isNotEmpty() } // 剔除没有 states 条目项的值，它们不作为开关使用
         updateSwitchOptions()
     }
 
     val activeSchema: Schema
-        get() = runCatching { currentSchema }.getOrDefault(defaultSchema)
+        get() = currentSchema
 
     @JvmStatic
     fun updateSwitchOptions() {
diff --git a/app/src/main/java/com/osfans/trime/data/theme/ThemeFilesManager.kt b/app/src/main/java/com/osfans/trime/data/theme/ThemeFilesManager.kt
@@ -5,37 +5,33 @@
 
 package com.osfans.trime.data.theme
 
-import com.charleskorn.kaml.AnchorsAndAliases
-import com.charleskorn.kaml.Yaml
-import com.charleskorn.kaml.YamlConfiguration
-import com.charleskorn.kaml.YamlScalar
-import com.charleskorn.kaml.yamlMap
+import com.osfans.trime.data.base.DataManager
+import com.osfans.trime.util.config.Config
 import timber.log.Timber
 import java.io.File
 
 object ThemeFilesManager {
-    private val yaml =
-        Yaml(
-            configuration =
-                YamlConfiguration(
-                    strictMode = false,
-                    anchorsAndAliases = AnchorsAndAliases.Permitted(null),
-                ),
-        )
-
     fun listThemes(dir: File): MutableList<ThemeItem> {
         val files = dir.listFiles { _, name -> name.endsWith("trime.yaml") } ?: return mutableListOf()
+        val deployedMap = hashMapOf<String, String>()
+        DataManager.stagingDir.list()?.forEach {
+            deployedMap[it] = it
+        }
+        DataManager.prebuiltDataDir.list()?.forEach {
+            deployedMap[it] = it
+        }
         return files
             .sortedByDescending { it.lastModified() }
             .mapNotNull decode@{
                 val item =
                     runCatching {
-                        val map =
-                            yaml
-                                .parseToYamlNode(it.bufferedReader().readText())
-                                .yamlMap
                         val configId = it.nameWithoutExtension
-                        val name = map.get<YamlScalar>("name")?.content ?: ""
+                        val name =
+                            if (deployedMap[it.name] != null) {
+                                Config.openConfig(configId).getString("name")
+                            } else {
+                                configId.removeSuffix(".trime")
+                            }
                         ThemeItem(configId, name)
                     }.getOrElse { e ->
                         Timber.w("Failed to decode theme file ${it.absolutePath}: ${e.message}")
diff --git a/app/src/main/java/com/osfans/trime/ime/symbol/TabManager.kt b/app/src/main/java/com/osfans/trime/ime/symbol/TabManager.kt
@@ -88,7 +88,7 @@ object TabManager {
 
             val symbolMaps = SchemaManager.activeSchema.symbols
             for ((key, value) in p) {
-                if (symbolMaps?.containsKey(value) == true) {
+                if (symbolMaps.containsKey(value)) {
                     keysList.add(SimpleKeyBean(value, key))
                 }
             }
diff --git a/app/src/main/java/com/osfans/trime/util/config/Config.kt b/app/src/main/java/com/osfans/trime/util/config/Config.kt
@@ -14,9 +14,19 @@ class Config(
     private val data: ConfigData = ConfigData(),
 ) {
     companion object {
-        fun create(fileName: String): Config =
+        fun openSchema(schemaId: String): Config =
             Config().apply {
-                data.loadFromFile(DataManager.resolveDeployedResourcePath(fileName))
+                loadFromFile(DataManager.resolveDeployedResourcePath("$schemaId.schema"))
+            }
+
+        fun openConfig(configId: String): Config =
+            Config().apply {
+                loadFromFile(DataManager.resolveDeployedResourcePath(configId))
+            }
+
+        fun openUserConfig(configId: String): Config =
+            Config().apply {
+                loadFromFile(DataManager.userDataDir.resolve("$configId.yaml").absolutePath)
             }
     }
 
@@ -78,24 +88,46 @@ class Config(
         return runCatching { p?.getString() }.getOrNull() ?: defValue
     }
 
-    fun getItem(path: String): ConfigItem? {
+    fun getItem(path: String): Config {
+        Timber.d("read: $path")
+        return Config().also {
+            it.data.root = data.traverse(path)
+        }
+    }
+
+    fun getValue(path: String): Config {
+        Timber.d("read: $path")
+        return Config().also {
+            it.data.root = data.traverse(path)?.configValue
+        }
+    }
+
+    fun getList(path: String): List<Config> {
         Timber.d("read: $path")
-        return data.traverse(path)
+        return data.traverse(path)?.configList?.map { v ->
+            Config().also { it.data.root = v }
+        } ?: emptyList()
     }
 
-    fun getValue(path: String): ConfigValue? {
+    fun getStringList(path: String): List<String> {
         Timber.d("read: $path")
-        return data.traverse(path)?.configValue
+        return data.traverse(path)?.configList?.map { v ->
+            v.configValue.getString()
+        } ?: emptyList()
     }
 
-    fun getList(path: String): ConfigList? {
+    fun getMap(path: String): Map<String, Config> {
         Timber.d("read: $path")
-        return data.traverse(path)?.configList
+        return data.traverse(path)?.configMap?.mapValues { (_, v) ->
+            Config().also { it.data.root = v }
+        } ?: emptyMap()
     }
 
-    fun getMap(path: String): ConfigMap? {
+    fun getStringValueMap(path: String): Map<String, String> {
         Timber.d("read: $path")
-        return data.traverse(path)?.configMap
+        return data.traverse(path)?.configMap?.mapValues { (_, v) ->
+            v.configValue.getString()
+        } ?: emptyMap()
     }
 
     fun getItem() = data.root
diff --git a/app/src/main/java/com/osfans/trime/util/config/ConfigData.kt b/app/src/main/java/com/osfans/trime/util/config/ConfigData.kt
@@ -4,6 +4,7 @@
 
 package com.osfans.trime.util.config
 
+import com.charleskorn.kaml.AnchorsAndAliases
 import com.charleskorn.kaml.Yaml
 import com.charleskorn.kaml.YamlConfiguration
 import com.charleskorn.kaml.YamlException
@@ -41,6 +42,8 @@ class ConfigData {
             configuration =
                 YamlConfiguration(
                     strictMode = false,
+                    anchorsAndAliases = AnchorsAndAliases.Permitted(null),
+                    codePointLimit = CODE_POINT_LIMIT,
                 ),
         )
 
@@ -79,4 +82,8 @@ class ConfigData {
         }
         return p
     }
+
+    companion object {
+        private const val CODE_POINT_LIMIT = 6 * 1024 * 1024 // 6 MB
+    }
 }
diff --git a/app/src/main/java/com/osfans/trime/util/config/ConfigTypes.kt b/app/src/main/java/com/osfans/trime/util/config/ConfigTypes.kt
@@ -18,7 +18,7 @@ import com.charleskorn.kaml.yamlScalar
 import kotlinx.serialization.DeserializationStrategy
 
 /** Config item base class */
-abstract class ConfigItem(
+sealed class ConfigItem(
     val node: YamlNode,
 ) {
     enum class ValueType {

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ object TabManager {`
`88`	`88`
`89`	`89`	`val symbolMaps = SchemaManager.activeSchema.symbols`
`90`	`90`	`for ((key, value) in p) {`
`91`		`- if (symbolMaps?.containsKey(value) == true) {`
	`91`	`+ if (symbolMaps.containsKey(value)) {`
`92`	`92`	`keysList.add(SimpleKeyBean(value, key))`
`93`	`93`	`}`
`94`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`package com.osfans.trime.util.config`
`6`	`6`
	`7`	`+import com.charleskorn.kaml.AnchorsAndAliases`
`7`	`8`	`import com.charleskorn.kaml.Yaml`
`8`	`9`	`import com.charleskorn.kaml.YamlConfiguration`
`9`	`10`	`import com.charleskorn.kaml.YamlException`
`@@ -41,6 +42,8 @@ class ConfigData {`
`41`	`42`	`configuration =`
`42`	`43`	`YamlConfiguration(`
`43`	`44`	`strictMode = false,`
	`45`	`+ anchorsAndAliases = AnchorsAndAliases.Permitted(null),`
	`46`	`+ codePointLimit = CODE_POINT_LIMIT,`
`44`	`47`	`),`
`45`	`48`	`)`
`46`	`49`
`@@ -79,4 +82,8 @@ class ConfigData {`
`79`	`82`	`}`
`80`	`83`	`return p`
`81`	`84`	`}`
	`85`	`+`
	`86`	`+ companion object {`
	`87`	`+ private const val CODE_POINT_LIMIT = 6 * 1024 * 1024 // 6 MB`
	`88`	`+ }`
`82`	`89`	`}`