refactor(util/config): polish new config parser

WhiredPlanck · WhiredPlanck · commit 1b6821310fd3 · 2023-03-24T00:48:37.000+08:00
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
@@ -1,13 +1,5 @@
 package com.osfans.trime.util.config
 
-import com.charleskorn.kaml.YamlList
-import com.charleskorn.kaml.YamlMap
-import com.charleskorn.kaml.YamlNode
-import com.charleskorn.kaml.YamlNull
-import com.charleskorn.kaml.YamlScalar
-import com.charleskorn.kaml.yamlList
-import com.charleskorn.kaml.yamlMap
-import com.charleskorn.kaml.yamlScalar
 import timber.log.Timber
 
 /**
@@ -19,65 +11,65 @@ class Config(private val data: ConfigData = ConfigData()) {
 
     fun isNull(path: String): Boolean {
         val p = data.traverse(path)
-        return p == null || p is YamlNull
+        return p == null || p.type == ConfigItem.ValueType.Null
     }
 
     fun isValue(path: String): Boolean {
         val p = data.traverse(path)
-        return p == null || p is YamlScalar
+        return p == null || p.type == ConfigItem.ValueType.Scalar
     }
 
     fun isList(path: String): Boolean {
         val p = data.traverse(path)
-        return p == null || p is YamlList
+        return p == null || p.type == ConfigItem.ValueType.List
     }
 
     fun isMap(path: String): Boolean {
         val p = data.traverse(path)
-        return p == null || p is YamlMap
+        return p == null || p.type == ConfigItem.ValueType.Map
     }
 
     fun getBool(path: String, defValue: Boolean = false): Boolean {
         Timber.d("read: $path")
-        val p = data.traverse(path)?.yamlScalar
-        return p?.toBoolean() ?: defValue
+        val p = data.traverse(path)?.configValue
+        return p?.getBool() ?: defValue
     }
 
     fun getInt(path: String, defValue: Int = 0): Int {
         Timber.d("read: $path")
-        val p = data.traverse(path)?.yamlScalar
-        return p?.toInt() ?: defValue
+        val p = data.traverse(path)?.configValue
+        return p?.getInt() ?: defValue
     }
 
     fun getFloat(path: String, defValue: Float = 0f): Float {
         Timber.d("read: $path")
-        val p = data.traverse(path)?.yamlScalar
-        return p?.toFloat() ?: defValue
+        val p = data.traverse(path)?.configValue
+        return p?.getFloat() ?: defValue
     }
 
     fun getString(path: String, defValue: String = ""): String {
         Timber.d("read: $path")
-        val p = data.traverse(path)?.yamlScalar
-        return p?.content ?: defValue
+        val p = data.traverse(path)?.configValue
+        return p?.getString() ?: defValue
     }
 
-    fun getNode(path: String): YamlNode? {
+    fun getItem(path: String): ConfigItem? {
         Timber.d("read: $path")
         return data.traverse(path)
     }
 
-    fun getValue(path: String): YamlScalar? {
+    fun getValue(path: String): ConfigValue? {
         Timber.d("read: $path")
-        return data.traverse(path)?.yamlScalar
+        return data.traverse(path)?.configValue
     }
 
-    fun getList(path: String): YamlList? {
+    fun getList(path: String): ConfigList? {
         Timber.d("read: $path")
-        return data.traverse(path)?.yamlList
+        return data.traverse(path)?.configList
     }
 
-    fun getMap(path: String): YamlMap? {
+    fun getMap(path: String): ConfigMap? {
         Timber.d("read: $path")
-        return data.traverse(path)?.yamlMap
+        return data.traverse(path)?.configMap
     }
 }
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
@@ -3,17 +3,32 @@ package com.osfans.trime.util.config
 import com.charleskorn.kaml.Yaml
 import com.charleskorn.kaml.YamlConfiguration
 import com.charleskorn.kaml.YamlException
+import com.charleskorn.kaml.YamlList
 import com.charleskorn.kaml.YamlMap
 import com.charleskorn.kaml.YamlNode
+import com.charleskorn.kaml.YamlNull
+import com.charleskorn.kaml.YamlScalar
+import com.charleskorn.kaml.yamlList
 import com.charleskorn.kaml.yamlMap
+import com.charleskorn.kaml.yamlScalar
 import timber.log.Timber
 import java.io.File
 
+fun convertFromYaml(node: YamlNode): ConfigItem? {
+    return when (node) {
+        is YamlNull -> null
+        is YamlScalar -> ConfigValue(node.yamlScalar)
+        is YamlList -> ConfigList(node.yamlList)
+        is YamlMap -> ConfigMap(node.yamlMap)
+        else -> null
+    }
+}
+
 /**
  * The wrapper of parsed YAML node.
  */
 class ConfigData {
-    var root: YamlNode? = null
+    var root: ConfigItem? = null
 
     private val yaml = Yaml(
         configuration = YamlConfiguration(
@@ -33,24 +48,25 @@ class ConfigData {
                 .inputStream()
                 .bufferedReader()
                 .use { it.readText() }
-            root = yaml.parseToYamlNode(doc)
+            val node = yaml.parseToYamlNode(doc)
+            root = convertFromYaml(node)
         } catch (e: YamlException) {
-            Timber.e("Error parsing YAML: ${e.message}")
+            Timber.e(e, "Error parsing YAML")
             return false
         }
         return true
     }
 
-    fun traverse(path: String): YamlNode? {
+    fun traverse(path: String): ConfigItem? {
         Timber.d("traverse: $path")
         if (path.isEmpty() || path == "/") return root
         val keys = path.trimEnd('/').split('/')
         var p = root
         for (key in keys) {
-            if (p == null || p !is YamlMap) {
+            if (p == null || p !is ConfigMap) {
                 return null
             }
-            p = p.yamlMap[key]
+            p = p.configMap[key]
         }
         return p
     }
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
@@ -0,0 +1,80 @@
+package com.osfans.trime.util.config
+
+import com.charleskorn.kaml.YamlList
+import com.charleskorn.kaml.YamlMap
+import com.charleskorn.kaml.YamlNode
+import com.charleskorn.kaml.YamlNull
+import com.charleskorn.kaml.YamlScalar
+import com.charleskorn.kaml.yamlList
+import com.charleskorn.kaml.yamlMap
+import com.charleskorn.kaml.yamlScalar
+
+/** Config item base class */
+open class ConfigItem(val node: YamlNode) {
+    enum class ValueType {
+        Null, Scalar, List, Map, Tagged
+    }
+    open fun isEmpty() = node is YamlNull
+    val type get() = when (node) {
+        is YamlNull -> ValueType.Null
+        is YamlScalar -> ValueType.Scalar
+        is YamlList -> ValueType.List
+        is YamlMap -> ValueType.Map
+        else -> ValueType.Null
+    }
+
+    val configValue: ConfigValue
+        get() = this as? ConfigValue ?: error(this, "ConfigValue")
+
+    val configList: ConfigList
+        get() = this as? ConfigList ?: error(this, "ConfigList")
+
+    val configMap: ConfigMap
+        get() = this as? ConfigMap ?: error(this, "ConfigMap")
+
+    private fun error(item: ConfigItem, expectedType: String): Nothing {
+        throw IllegalArgumentException("Expected element to be $expectedType bus is ${item::class.simpleName}")
+    }
+}
+
+/** The wrapper of [YamlScalar] */
+class ConfigValue(private val scalar: YamlScalar) : ConfigItem(scalar) {
+    constructor(item: ConfigItem) : this(item.node.yamlScalar)
+
+    fun getString() = scalar.content
+    fun getInt() = scalar.toInt()
+    fun getFloat() = scalar.toFloat()
+    fun getBool() = scalar.toBoolean()
+
+    override fun isEmpty() = scalar.content.isEmpty()
+}
+
+/** The wrapper of [YamlList] */
+class ConfigList(private val list: YamlList) : ConfigItem(list) {
+    constructor(item: ConfigItem) : this(item.node.yamlList)
+
+    val items get() = list.items.map { convertFromYaml(it) }
+
+    override fun isEmpty() = list.items.isEmpty()
+
+    operator fun get(index: Int) = items[index]
+    fun getValue(index: Int) = get(index)?.configValue
+}
+
+class ConfigMap(private val map: YamlMap) : ConfigItem(map) {
+    constructor(item: ConfigItem) : this(item.node.yamlMap)
+
+    override fun isEmpty() = map.entries.isEmpty()
+
+    fun hasKey(key: String) = map.getKey(key) != null
+
+    val entries get() = map.entries.entries.associate { (s, n) ->
+        s.content to convertFromYaml(n)
+    }
+
+    @Suppress("UNCHECKED_CAST")
+    operator fun <T : ConfigItem> get(key: String): T? =
+        entries.entries.firstOrNull { it.key == key }?.value as T?
+
+    fun getValue(key: String): ConfigValue? = get<ConfigValue>(key)?.configValue
+}
