feat(gen-kotlin): PASCAL_CASE_ROUTINE_BASE_NAMES feature flag

Author: lsafer-meemer

mmrpc-gen-kotlin/src/commonMain/kotlin/Declarations.kt

@@ -61,6 +61,11 @@ enum class GenFeature {
      */
     KDOC_SIGNATURE,
 
+    /**
+     * Use PascalCase for routine functions inside a protocol.
+     */
+    PASCAL_CASE_ROUTINE_BASE_NAMES,
+
     /**
      * Keep original type class names.
      */

mmrpc-gen-kotlin/src/commonMain/kotlin/common/model/RoutineDefinition.kt

@@ -2,6 +2,7 @@ package org.cufy.mmrpc.gen.kotlin.common.model
 
 import com.squareup.kotlinpoet.*
 import net.pearx.kasechange.toCamelCase
+import net.pearx.kasechange.toPascalCase
 import org.cufy.mmrpc.RoutineDefinition
 import org.cufy.mmrpc.gen.kotlin.ContextScope
 import org.cufy.mmrpc.gen.kotlin.GenFeature
@@ -17,13 +18,25 @@ import org.cufy.mmrpc.runtime.FaultException
 
 @ContextScope
 context(ctx: Context)
-fun RoutineDefinition.nameOfFunction(): String {
+fun RoutineDefinition.nameOfExtFunction(): String {
     if (GenFeature.KEEP_ROUTINE_FUNCTION_NAMES in ctx.features)
         return name
 
     return name.toCamelCase()
 }
 
+@ContextScope
+context(ctx: Context)
+fun RoutineDefinition.nameOfBaseFunction(): String {
+    if (GenFeature.KEEP_ROUTINE_FUNCTION_NAMES in ctx.features)
+        return name
+
+    if (GenFeature.PASCAL_CASE_ROUTINE_BASE_NAMES in ctx.features)
+        return name.toPascalCase()
+
+    return name.toCamelCase()
+}
+
 @ContextScope
 context(ctx: Context)
 fun RoutineDefinition.generatedClassName(): ClassName {
@@ -114,7 +127,7 @@ fun RoutineDefinition.clientFlatImplCode(
     fields: List<String>,
 ): CodeBlock {
     return buildCodeBlock {
-        addStatement("♢return %L(\n⇥%L⇤\n)", nameOfFunction(), createCall(
+        addStatement("♢return %L(\n⇥%L⇤\n)", nameOfBaseFunction(), createCall(
             function = CodeBlock.of("%T", request),
             parameters = fields.associateWith {
                 CodeBlock.of(it)

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN0Gen.kt

@@ -47,7 +47,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N0 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT, KModifier.SUSPEND)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", routine.input.className())
@@ -64,7 +64,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N0 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE, KModifier.SUSPEND)
                     addParameter("request", routine.input.className())
                     returns(UNIT)
@@ -86,13 +86,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER0,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Companion.<routine>.invoke( handler: WrapHandler0<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedClassName().nestedClass("Companion"))
                 addParameter(
@@ -115,7 +115,7 @@ private fun apply(element: ProtocolDefinition) {
         for (routine in routines) {
             val fields = routine.input.collectAllFields().toList()
 
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 addModifiers(KModifier.SUSPEND)
                 receiver(element.generatedBaseClassName(BASE_NAME))
                 for (field in fields) {

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN0RGen.kt

@@ -47,7 +47,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N0R functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT, KModifier.SUSPEND)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", routine.output.className())
@@ -64,7 +64,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N0R functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE, KModifier.SUSPEND)
                     addParameter("request", routine.output.className())
                     returns(UNIT)
@@ -86,13 +86,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER0,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Reflux.Companion.<routine>.invoke( handler: WrapHandler0<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedRefluxClassName().nestedClass("Companion"))
                 addParameter(
@@ -115,7 +115,7 @@ private fun apply(element: ProtocolDefinition) {
         for (routine in routines) {
             val fields = routine.output.collectAllFields().toList()
 
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 addModifiers(KModifier.SUSPEND)
                 receiver(element.generatedBaseClassName(BASE_NAME))
                 for (field in fields) {

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN1Gen.kt

@@ -46,7 +46,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N1 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT, KModifier.SUSPEND)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", routine.input.className())
@@ -63,7 +63,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N1 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE, KModifier.SUSPEND)
                     addParameter("request", routine.input.className())
                     returns(routine.output.className())
@@ -85,13 +85,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER1,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Companion.<routine>.invoke( handler: WrapHandler1<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedClassName().nestedClass("Companion"))
                 addParameter(
@@ -117,7 +117,7 @@ private fun apply(element: ProtocolDefinition) {
         for (routine in routines) {
             val fields = routine.input.collectAllFields().toList()
 
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 addModifiers(KModifier.SUSPEND)
                 receiver(element.generatedBaseClassName(BASE_NAME))
                 for (field in fields) {

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN2Gen.kt

@@ -47,7 +47,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N2 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT, KModifier.SUSPEND)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", FLOW.parameterizedBy(routine.input.className()))
@@ -64,7 +64,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N2 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE, KModifier.SUSPEND)
                     addParameter("request", FLOW.parameterizedBy(routine.input.className()))
                     returns(routine.output.className())
@@ -86,13 +86,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER2,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Companion.<routine>.invoke( handler: WrapHandler2<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedClassName().nestedClass("Companion"))
                 addParameter(

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN3Gen.kt

@@ -47,7 +47,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N3 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", routine.input.className())
@@ -64,7 +64,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N3 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE)
                     addParameter("request", routine.input.className())
                     returns(FLOW.parameterizedBy(routine.output.className()))
@@ -86,13 +86,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER3,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Companion.<routine>.invoke( handler: WrapHandler3<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedClassName().nestedClass("Companion"))
                 addParameter(
@@ -118,7 +118,7 @@ private fun apply(element: ProtocolDefinition) {
         for (routine in routines) {
             val fields = routine.input.collectAllFields().toList()
 
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 receiver(element.generatedBaseClassName(BASE_NAME))
                 for (field in fields) {
                     addParameter(field.parameterSpec())

mmrpc-gen-kotlin/src/commonMain/kotlin/gen/base/ProtocolN4Gen.kt

@@ -47,7 +47,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // abstract N4 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.ABSTRACT)
                     addKdoc(createKdocCode(routine))
                     addParameter("request", FLOW.parameterizedBy(routine.input.className()))
@@ -64,7 +64,7 @@ private fun apply(element: ProtocolDefinition) {
 
             // impl N4 functions
             for (routine in routines) {
-                addFunction(funSpec(routine.nameOfFunction()) {
+                addFunction(funSpec(routine.nameOfBaseFunction()) {
                     addModifiers(KModifier.OVERRIDE)
                     addParameter("request", FLOW.parameterizedBy(routine.input.className()))
                     returns(FLOW.parameterizedBy(routine.output.className()))
@@ -86,13 +86,13 @@ private fun apply(element: ProtocolDefinition) {
             for (routine in routines) {
                 addStatement("%L", routine.serverRegisterCode(
                     register = Intrinsics.REGISTER4,
-                    handler = CodeBlock.of("impl::%L", routine.nameOfFunction()),
+                    handler = CodeBlock.of("impl::%L", routine.nameOfBaseFunction()),
                 ))
             }
         })
         // <protocol>.Companion.<routine>.invoke( handler: WrapHandler4<request> )
         for (routine in routines) {
-            addFunction(funSpec(routine.nameOfFunction()) {
+            addFunction(funSpec(routine.nameOfExtFunction()) {
                 contextParameter("engine", ServerEngine::class)
                 receiver(element.generatedClassName().nestedClass("Companion"))
                 addParameter(

mmrpc-gradle-plugin/src/main/kotlin/MmrpcExtension.kt

@@ -94,6 +94,8 @@ open class MmrpcExtension {
         fun kdocDescription() { features += GenFeature.KDOC_DESCRIPTION }
         fun kdocSignature() { features += GenFeature.KDOC_SIGNATURE }
 
+        fun pascalCaseRoutineBaseNames() { features += GenFeature.PASCAL_CASE_ROUTINE_BASE_NAMES }
+
         fun keepTypeClassNames() { features += GenFeature.KEEP_TYPE_CLASS_NAMES }
         fun keepFaultClassNames() { features += GenFeature.KEEP_FAULT_CLASS_NAMES }
         fun keepProtocolClassNames() { features += GenFeature.KEEP_PROTOCOL_CLASS_NAMES }