Generate overloads of onEnum to add support for using optional argume…

…nts.
touchlab · Nov 20, 2023 · ff48e3a · ff48e3a
1 parent aa4ad90
commit ff48e3a
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 11 deletions.
diff --git a/SKIE/acceptance-tests b/SKIE/acceptance-tests
diff --git a/..._common/kotlin/co/touchlab/skie/phases/features/sealed/SealedFunctionGeneratorDelegate.kt b/..._common/kotlin/co/touchlab/skie/phases/features/sealed/SealedFunctionGeneratorDelegate.kt
@@ -11,6 +11,8 @@ import co.touchlab.skie.sir.element.SirValueParameter
 import co.touchlab.skie.sir.element.copyTypeParametersFrom
 import co.touchlab.skie.sir.element.toTypeFromEnclosingTypeParameters
 import co.touchlab.skie.sir.element.toTypeParameterUsage
+import co.touchlab.skie.sir.type.SirType
+import co.touchlab.skie.sir.type.toNullable
 import io.outfoxx.swiftpoet.CodeBlock
 import io.outfoxx.swiftpoet.TypeName
 
@@ -20,10 +22,36 @@ class SealedFunctionGeneratorDelegate(
 
     context(SirPhase.Context)
     fun generate(kirClass: KirClass, enum: SirClass) {
+        val requiredFunction = generateRequiredOverload(kirClass, enum)
+        generateOptionalOverload(kirClass, enum, requiredFunction)
+    }
+
+    private fun generateRequiredOverload(kirClass: KirClass, enum: SirClass): SirSimpleFunction =
+        createFunctionDeclaration(kirClass, enum).apply {
+            addRequiredFunctionBody(kirClass, enum)
+        }
+
+    private fun generateOptionalOverload(kirClass: KirClass, enum: SirClass, requiredFunction: SirSimpleFunction) {
+        createFunctionDeclaration(
+            kirClass = kirClass,
+            enum = enum,
+            valueParameterType = { it.toNullable() },
+            returnTypeModifier = { it.toNullable() },
+        ).apply {
+            addOptionalFunctionBody(requiredFunction)
+        }
+    }
+
+    private fun createFunctionDeclaration(
+        kirClass: KirClass,
+        enum: SirClass,
+        valueParameterType: (SirType) -> SirType = { it },
+        returnTypeModifier: (SirType) -> SirType = { it },
+    ): SirSimpleFunction =
         SirSimpleFunction(
             identifier = kirClass.enumConstructorFunctionName,
-            parent = skieNamespaceProvider.getNamespaceFile(kirClass),
-            returnType = enum.toTypeFromEnclosingTypeParameters(enum.typeParameters),
+            parent = context.skieNamespaceProvider.getNamespaceFile(kirClass),
+            returnType = enum.toTypeFromEnclosingTypeParameters(enum.typeParameters).let(returnTypeModifier),
         ).apply {
             copyTypeParametersFrom(enum)
 
@@ -37,12 +65,9 @@ class SealedFunctionGeneratorDelegate(
             SirValueParameter(
                 label = kirClass.enumConstructorArgumentLabel,
                 name = kirClass.enumConstructorParameterName,
-                type = sealedTypeParameter.toTypeParameterUsage(),
+                type = sealedTypeParameter.toTypeParameterUsage().let(valueParameterType),
             )
-
-            addFunctionBody(kirClass, enum)
         }
-    }
 
     private val KirClass.enumConstructorFunctionName: String
         get() = configurationProvider.getConfiguration(this, SealedInterop.Function.Name)
@@ -53,7 +78,7 @@ class SealedFunctionGeneratorDelegate(
     private val KirClass.enumConstructorParameterName: String
         get() = configurationProvider.getConfiguration(this, SealedInterop.Function.ParameterName)
 
-    private fun SirSimpleFunction.addFunctionBody(
+    private fun SirSimpleFunction.addRequiredFunctionBody(
         kirClass: KirClass,
         enum: SirClass,
     ) {
@@ -132,4 +157,22 @@ class SealedFunctionGeneratorDelegate(
     private fun CodeBlock.Builder.addReturnElse(kirClass: KirClass, enumType: TypeName) {
         add("return %T.%N\n", enumType, kirClass.elseCaseName)
     }
+
+    private fun SirSimpleFunction.addOptionalFunctionBody(requiredFunction: SirSimpleFunction) {
+        bodyBuilder.add {
+            val valueParameter = valueParameters.first()
+
+            val escapedParameterName = CodeBlock.toString("%N", valueParameter.name)
+
+            addCode(
+                CodeBlock.builder()
+                    .beginControlFlow("if", "let $escapedParameterName")
+                    .add("return %L as %T", requiredFunction.call(escapedParameterName), requiredFunction.returnType.evaluate().swiftPoetTypeName)
+                    .nextControlFlow("else")
+                    .add("return nil")
+                    .endControlFlow("else")
+                    .build(),
+            )
+        }
+    }
 }
diff --git a/.../kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/memberconflicts/Signature.kt b/.../kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/phases/memberconflicts/Signature.kt
@@ -38,7 +38,7 @@ sealed class Signature {
         override fun toString(): String =
             ("static ".takeIf { scope == Scope.Static } ?: "") +
                 "func " +
-                "$receiver.".takeIf { receiver !is Receiver.None } +
+                ("$receiver.".takeIf { receiver !is Receiver.None } ?: "") +
                 identifier +
                 "(${valueParameters.joinToString()})" +
                 " -> $returnType"
@@ -75,7 +75,7 @@ sealed class Signature {
         override fun toString(): String =
             ("static ".takeIf { scope == Scope.Static } ?: "") +
                 "var " +
-                "$receiver.".takeIf { receiver !is Receiver.None } +
+                ("$receiver.".takeIf { receiver !is Receiver.None } ?: "") +
                 identifier
     }
 

diff --git a/.../compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/sir/element/SirFunction.kt b/.../compiler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/sir/element/SirFunction.kt
@@ -49,6 +49,9 @@ sealed class SirFunction(
         return "$identifierForReference($argumentsWithLabels)"
     }
 
+    fun call(vararg arguments: String): String =
+        call(arguments.toList())
+
     protected abstract val identifierForReference: String
 
     override fun toString(): String = this.signature.toString()

diff --git a/...ler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/sir/element/SirValueParameter.kt b/...ler/kotlin-plugin/src/kgp_common/kotlin/co/touchlab/skie/sir/element/SirValueParameter.kt
@@ -20,11 +20,16 @@ class SirValueParameter(
             label = label
         }
 
-    var label: String? = if (label != name) label else null
+    var label: String? = null
         set(value) {
             field = if (value != name && value?.isNotBlank() == true) value else null
         }
 
+    init {
+        // Calls setter
+        this.label = label
+    }
+
     val labelOrName: String
         get() = label ?: name