Remove dead code, start to add some ktdoc (#2)

andrewparmet · Oct 13, 2021 · 36ca69e · 36ca69e
1 parent e237a23
commit 36ca69e
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 408 deletions.
diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/Annotator.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/Annotator.kt
@@ -30,6 +30,9 @@ import com.toasttab.protokt.codegen.protoc.Service
 import com.toasttab.protokt.codegen.protoc.TopLevelType
 import com.toasttab.protokt.codegen.protoc.TypeDesc
 
+/**
+ * Annotates an unannotated AST. This effectively converts the protobuf AST to a Kotlin AST.
+ */
 object Annotator {
     const val rootGoogleProto = "google.protobuf"
     const val googleProto = ".google.protobuf"

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/HeaderAccumulator.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/HeaderAccumulator.kt
@@ -41,7 +41,7 @@ object HeaderAccumulator {
                         is Import.PackageMethod -> addImport(it.pkg.toString(), it.name)
                     }
                 }
-            }
+            }.indent("    ")
 
     private fun `package`(protocol: Protocol) =
         kotlinPackage(protocol).let {

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/MessageAnnotator.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/MessageAnnotator.kt
@@ -60,16 +60,7 @@ private constructor(
         } else {
             val properties = annotateProperties(msg, ctx)
             val messageInfo = messageInfo()
-            MessageTemplate.render(
-                message = messageInfo(),
-                properties = annotateProperties(msg, ctx),
-                oneofs = listOf(), // annotateOneofs(msg, ctx),
-                sizeof = listOf(), // annotateMessageSizeOld(msg, ctx),
-                serialize = listOf(), // annotateSerializer(msg, ctx),
-                deserialize = listOf(), // annotateDeserializerNew(msg, ctx),
-                nested = listOf(), // nestedTypes(),
-                options = options()
-            )
+
             TypeSpec.classBuilder(msg.name)
                 .handleAnnotations(messageInfo)
                 .apply {

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/PropertyAnnotator.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/impl/PropertyAnnotator.kt
@@ -38,6 +38,9 @@ import com.toasttab.protokt.codegen.template.Renderers.DefaultValue
 import com.toasttab.protokt.codegen.template.Renderers.Standard
 import com.toasttab.protokt.codegen.template.Oneof as OneofTemplate
 
+/**
+ *
+ */
 internal class PropertyAnnotator
 private constructor(
     private val msg: Message,

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/protoc/Protocol.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/protoc/Protocol.kt
@@ -41,6 +41,9 @@ import com.toasttab.protokt.codegen.model.FieldType
 import com.toasttab.protokt.codegen.model.PClass
 import com.toasttab.protokt.ext.Protokt
 
+/**
+ * Converts a message in the format used by protoc to the unannotated AST used by protokt.
+ */
 fun toProtocol(ctx: ProtocolContext) =
     Protocol(
         FileDesc(

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Descriptor.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Descriptor.kt
diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Header.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Header.kt
diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Message.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Message.kt
@@ -19,28 +19,11 @@ import com.toasttab.protokt.codegen.impl.Deprecation
 import com.toasttab.protokt.codegen.model.PClass
 
 object Message {
-    object Message : StTemplate(StGroup.Message) {
-        fun render(
-            message: MessageInfo,
-            serialize: List<SerializerInfo>,
-            deserialize: List<DeserializerInfo>,
-            sizeof: List<SizeofInfo>,
-            properties: List<PropertyInfo>,
-            oneofs: List<String>,
-            nested: List<String>,
-            options: Options
-        ) =
-            renderArgs(
-                message,
-                serialize,
-                deserialize,
-                sizeof,
-                properties,
-                oneofs,
-                nested,
-                options
-            )
+    object Message  {
 
+        /**
+         * Contains metadata about the message. Does not contain information about the contents of the message.
+         */
         class MessageInfo(
             val name: String,
             val doesImplement: Boolean,
@@ -55,6 +38,9 @@ object Message {
             val name: String
         }
 
+        /**
+         * Contains type information about a protobuf field (or oneof) that is relevant to the Kotlin interface
+         */
         class PropertyInfo(
             override val name: String,
             val propertyType: String,
@@ -74,6 +60,9 @@ object Message {
             val deprecation: Deprecation.RenderOptions? = null
         ) : FieldInfo
 
+        /**
+         * Information relevant to reading and writing a message (and other stuff outside the standard access interface?)
+         */
         interface FieldWriteInfo : FieldInfo {
             val fieldName: String
             val conditionals: List<ConditionalParams>

diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Services.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/Services.kt
@@ -15,66 +15,13 @@
 
 package com.toasttab.protokt.codegen.template
 
+import com.toasttab.protokt.codegen.protoc.Method
+
 abstract class ServicesTemplate : StTemplate(StGroup.Services)
 
 object Services {
-    object Service : ServicesTemplate() {
-        fun render(
-            generateService: Boolean,
-            generateDescriptor: Boolean,
-            name: String,
-            qualifiedName: String,
-            grpcDescriptor: String,
-            methods: List<MethodInfo>,
-            reflectInfo: ReflectInfo
-        ) =
-            renderArgs(
-                generateService,
-                generateDescriptor,
-                name,
-                qualifiedName,
-                grpcDescriptor,
-                methods,
-                reflectInfo
-            )
-
-        class MethodInfo(
-            val name: String,
-            val lowerName: String,
-            val body: String,
-            val `in`: String,
-            val `out`: String
-        )
-
-        class ReflectInfo(
-            val index: Int,
-            val fileDescriptorObjectName: String
-        )
-    }
-
-    object Descriptor : ServicesTemplate() {
-        fun render(methods: List<String>) =
-            renderArgs(methods)
-    }
-
-    object Method : ServicesTemplate() {
-        fun render(
-            name: String,
-            type: String,
-            `in`: String,
-            out: String,
-            options: MethodOptions
-        ) =
-            renderArgs(name, type, `in`, out, options)
-
-        class MethodOptions(
-            val requestMarshaller: String?,
-            val responseMarshaller: String?
-        )
-    }
-
     object MethodType : ServicesTemplate() {
-        fun render(method: com.toasttab.protokt.codegen.protoc.Method) =
+        fun render(method: Method) =
             renderArgs(method)
     }
 }
diff --git a/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/StGroup.kt b/protokt-codegen/src/main/kotlin/com/toasttab/protokt/codegen/template/StGroup.kt
@@ -17,11 +17,8 @@ package com.toasttab.protokt.codegen.template
 
 sealed class StGroup {
     val fileName
-        get() = "${this::class.java.simpleName.decapitalize()}.stg"
+        get() = "${this::class.java.simpleName.decapitalize(java.util.Locale.ROOT)}.stg"
 
-    object Descriptor : StGroup()
-    object Header : StGroup()
-    object Message : StGroup()
     object Oneof : StGroup()
     object Options : StGroup()
     object Renderers : StGroup()

diff --git a/protokt-codegen/src/main/resources/header.stg b/protokt-codegen/src/main/resources/header.stg