Reducing the amount of compiler warnings in gen-enums.kt (#269)

* Reducing the amount of compiler warnings in gen-enums.kt * Updating code generation after merging in changes from master
Kotlin · May 15, 2024 · 83e61ef · 83e61ef
1 parent 0832e98
commit 83e61ef
Show file tree

Hide file tree

Showing 5 changed files with 235 additions and 208 deletions.
diff --git a/buildSrc/src/main/kotlin/kotlinx/html/generate/attributes.kt b/buildSrc/src/main/kotlin/kotlinx/html/generate/attributes.kt
@@ -62,10 +62,11 @@ fun Appendable.facade(repository: Repository, facade: AttributeFacade) {
 fun Appendable.eventProperty(parent: String, attribute: AttributeInfo, shouldUnsafeCast: Boolean) {
     val type = "(org.w3c.dom.events.Event) -> Unit"
     variable(
-        receiver = parent, variable = Var(
+        receiver = parent,
+        variable = Var(
             name = attribute.fieldName + "Function",
             type = type,
-            mutable = true
+            varType = VarType.MUTABLE,
         )
     )
     emptyLine()

diff --git a/buildSrc/src/main/kotlin/kotlinx/html/generate/codegen.kt b/buildSrc/src/main/kotlin/kotlinx/html/generate/codegen.kt
@@ -46,10 +46,16 @@ fun Appendable.const(value: Const<*>) {
     append(value.asValue)
 }
 
+enum class VarType {
+    MUTABLE,
+    IMMUTABLE,
+    CONST,
+}
+
 data class Var(
     val name: String,
     val type: String,
-    val mutable: Boolean = false,
+    val varType: VarType = VarType.IMMUTABLE,
     val override: Boolean = false,
     val forceOmitValVar: Boolean = false,
     val defaultValue: String = "",
@@ -72,7 +78,12 @@ fun Appendable.variable(variable: Var, omitValVar: Boolean = false, receiver: St
         if (variable.override) {
             append("override ")
         }
-        append(if (variable.mutable) "var " else "val ")
+        val typeString = when (variable.varType) {
+            VarType.MUTABLE -> "var "
+            VarType.IMMUTABLE -> "val "
+            VarType.CONST -> "const val "
+        }
+        append(typeString)
     }
 
     if (receiver.isNotEmpty()) {

diff --git a/buildSrc/src/main/kotlin/kotlinx/html/generate/enums.kt b/buildSrc/src/main/kotlin/kotlinx/html/generate/enums.kt
@@ -1,7 +1,5 @@
 package kotlinx.html.generate
 
-import java.util.*
-
 val reservedNames = setOf("class", "val", "var", "object", "true", "false", "as", "is", "for")
 
 fun String.replaceIfReserved() = if (this in reservedNames) "html" + this.capitalize() else this
@@ -12,18 +10,25 @@ fun List<String>.toAttributeValues() : List<AttributeEnumValue> =
 fun Appendable.enumObject(attribute : AttributeInfo) {
     val name = attribute.enumTypeName
 
-    appendLine("@Suppress(\"unused\")")
+    appendLine("@Suppress(\"unused\", \"ConstPropertyName\")")
     clazz(Clazz(name, isObject = true)) {
         attribute.enumValues.forEach {
             append("    ")
-            variable(Var(it.fieldName, "String", false, defaultValue = "\"${it.realName}\""))
+            variable(Var(it.fieldName, "String", varType = VarType.CONST, defaultValue = "\"${it.realName}\""))
             emptyLine()
         }
 
         emptyLine()
         append("    ")
-//        append("private ")
-        variable(Var("values", "List<String>", defaultValue = attribute.enumValues.map {"\"${it.fieldName}\""}.joinToString(", ", "listOf(", ")")))
+        variable(
+            Var(
+                name = "values",
+                type = "List<String>",
+                defaultValue = attribute
+                    .enumValues
+                    .joinToString(", ", "listOf(", ")") { "\"${it.fieldName}\"" },
+            )
+        )
         emptyLine()
     }
 
@@ -32,9 +37,9 @@ fun Appendable.enumObject(attribute : AttributeInfo) {
 
 fun Appendable.enum(attribute : AttributeInfo) {
     val name = attribute.enumTypeName
-    val realValue = Var("realValue", "String", false, true)
+    val realValue = Var(name = "realValue", type = "String", varType = VarType.IMMUTABLE, override = true)
 
-    appendLine("@Suppress(\"unused\")")
+    appendLine("@Suppress(\"unused\", \"EnumEntryName\")")
     append("enum ")
     clazz(Clazz(name, variables = listOf(realValue), parents = listOf("AttributeEnum"))) {
         attribute.enumValues.forEachIndexed { idx, it ->
@@ -53,6 +58,13 @@ fun Appendable.enum(attribute : AttributeInfo) {
 
     emptyLine()
     append("internal ")
-    variable(Var(name.decapitalize() + "Values", "Map<String, $name>", false, defaultValue = "$name.values().associateBy { it.realValue }"))
+    variable(
+        Var(
+            name = name.decapitalize() + "Values",
+            type = "Map<String, $name>",
+            varType = VarType.IMMUTABLE,
+            defaultValue = "$name.entries.associateBy { it.realValue }",
+        ),
+    )
     emptyLine()
 }
diff --git a/buildSrc/src/main/kotlin/kotlinx/html/generate/tagsgen.kt b/buildSrc/src/main/kotlin/kotlinx/html/generate/tagsgen.kt
@@ -29,18 +29,18 @@ fun Appendable.tagClass(repository: Repository, tag: TagInfo, excludeAttributes:
             Var(
                 name = "initialAttributes",
                 type = "Map<String, String>",
-                mutable = false,
+                varType = VarType.IMMUTABLE,
                 override = false,
                 forceOmitValVar = true
             )
         )
-        add(Var(name = "consumer", type = "TagConsumer<*>", mutable = false, override = true))
+        add(Var(name = "consumer", type = "TagConsumer<*>", varType = VarType.IMMUTABLE, override = true))
         if (customizableNamespace) {
             add(
                 Var(
                     name = "namespace",
                     type = "String?",
-                    mutable = false,
+                    varType = VarType.IMMUTABLE,
                     override = false,
                     forceOmitValVar = true,
                     defaultValue = namespace?.quote() ?: "null"
@@ -197,7 +197,10 @@ internal fun Appendable.tagAttributeVar(
     repository.attributeDelegateRequests.add(attributeRequest)
 
     indent(indent)
-    variable(Var(attribute.fieldName, attribute.typeName, true), receiver = receiver ?: "")
+    variable(
+        Var(name = attribute.fieldName, type = attribute.typeName, varType = VarType.MUTABLE),
+        receiver = receiver ?: "",
+    )
     return attributeRequest
 }
 
@@ -524,7 +527,7 @@ private fun tagBuilderFunctionArguments(tag: TagInfo, blockOrContent: Boolean):
                 Var(
                     name = "namespace",
                     type = "String?",
-                    mutable = false,
+                    varType = VarType.IMMUTABLE,
                     override = false,
                     forceOmitValVar = true,
                     defaultValue = defaultNamespace