Remove KSP (#823)

Author: CedNaru

.github/workflows/build_jvm.yml

@@ -55,11 +55,11 @@ jobs:
           name: jvm_entry-generator
           path: kt/entry-generation/godot-entry-generator/build/libs/godot-entry-generator-*.jar
 
-      - name: Upload ksp-symbol-processor artifact
+      - name: Upload class-graph-symbol-processor artifact
         uses: actions/upload-artifact@v4
         with:
-          name: jvm_ksp-symbol-processor
-          path: kt/entry-generation/godot-kotlin-symbol-processor/build/libs/godot-kotlin-symbol-processor-*.jar
+          name: jvm_class-graph-symbol-processor
+          path: kt/entry-generation/godot-class-graph-symbol-processor/build/libs/godot-class-graph-symbol-processor-*.jar
 
       - name: Upload gradle-plugin artifact
         uses: actions/upload-artifact@v4

.github/workflows/deploy_jvm.yml

@@ -67,10 +67,10 @@ jobs:
         run: |
           modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-entry-generator:publish
 
-      - name: Publish godot-kotlin-symbol-processor
+      - name: Publish godot-class-graph-symbol-processor
         shell: sh
         run: |
-          modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-kotlin-symbol-processor:publish
+          modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-class-graph-symbol-processor:publish
 
       - name: Publish godot-internal-library debug
         shell: sh

docs/src/doc/contribution/knowledge-base/entry-generation.md

@@ -2,35 +2,30 @@
 
 ## General
 
-To make it more language agnostic, the entry generator provides a set of model classes which represent the needed information about the source code by the entry genenerator.
+To make it more language agnostic, the entry generator provides a set of model classes which represent the needed information about the source code by the entry generator.
 It expects this information to be gathered and assembled by the calling tool and to be provided in the entry point of the entry generator.
 
 For Kotlin, Java and Scala, this tool is `godot-class-graph-symbol-processor`, which analyses the byte code, and gathers the information needed by the entry generator.
 It then calls the entry generator which in turn generates the needed entry files.
 
-## The godot-kotlin-symbol-processor
+## The godot-class-graph-symbol-processor
 
-Previously, we implemented our own compiler plugin based on the [mpapt](https://github.com/Foso/MpApt) project.
+Previously, we implemented our own compiler plugin based on the [mpapt](https://github.com/Foso/MpApt) and [ksp](https://github.com/google/ksp) project.
 Even though it worked very well, the code was far from easy to understand and as the compiler plugin API is not stable yet.
-Furthermore, `MpApt` introduced a lot of maintenance work to keep it up to date with the ever evolving Kotlin compiler.
+Furthermore, `MpApt` introduced a lot of maintenance work to keep it up to date with the ever evolving Kotlin compiler and `Ksp` wasn't able to process Scala files.
 
-To mitigate that problem we switched to [KSP (Kotlin Symbol Processing API)](https://github.com/google/ksp) which is basically a Kotlin Annotation Processor (KAPT) on steroids.
-Meaning it in essence is a compiler plugin which lets you inspect the source code being compiled through a abstracted and simplified API.
-This means for us that we can work against a more stable API and the work of keeping it up to date with Kotlin compiler changes is offloaded
-to a well maintained open source project with far more people with better knowledge about the internal workings of the Kotlin compiler.
+To mitigate that problem we switched to [ClassGraph](https://github.com/classgraph/classgraph) which is Bytecode processor.
+Meaning it in essence is a compiler plugin which lets you inspect the compiled bytecode with an abstracted and simplified API.
+This means for us that we can work against a more stable API and the work of keeping it up to date with the Kotlin language is removed.
 
-We use our implementation of a Kotlin Symbol Processing to gather all needed information for the entry generator and convert it into the format it understands.
-With this it should be more easy to implement additional JVM languages as the entry generator itself can stay the same for all languages. Only the symbol processor has to change per language.
-
-## Default Value Extraction
-
-We extract the default values with the help of JetBrains' [Program Structure Interface (PSI)](https://plugins.jetbrains.com/docs/intellij/psi.html),
-that is a language specific AST (Abstract Syntax Tree). But as the simplified API of KSP does not allow the introspection of the source code representation,
-we implemented this ourselves in the `godot-kotlin-symbol-processor` as well.
+We use ClassGraph to gather all needed information for the entry generator and convert it into the format it understands.
+With this it should be far easier to implement additional JVM languages as ClassGraph is language agnostic and only minor tweak are necessary to support additional static languages.
 
 ## Debugging
 
-As `godot-kotlin-symbol-processor` is a Kotlin compiler plugin and thus the execution context of the entry generator is as well,
+TODO: Write the new way to debug the bytecode processing
+
+As `godot-class-graph-symbol-processor` is a Kotlin compiler plugin and thus the execution context of the entry generator is as well,
 it cannot be debugged traditionally by just clicking the Debug button on the `build` task in IntelliJ IDEA like you would do normally for KAPT annotation processors.
 
 To debug a project, open a terminal, change to project's root directory and type the following command:

harness/benchmarks/settings.gradle.kts

@@ -10,7 +10,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-gradle-plugin")).using(project(":godot-gradle-plugin"))
         substitute(module("com.utopia-rise:godot-library-debug")).using(project(":godot-library"))
         substitute(module("com.utopia-rise:godot-library-release")).using(project(":godot-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
     }
 }

harness/bunnymark/settings.gradle.kts

@@ -10,7 +10,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-gradle-plugin")).using(project(":godot-gradle-plugin"))
         substitute(module("com.utopia-rise:godot-library-debug")).using(project(":godot-library"))
         substitute(module("com.utopia-rise:godot-library-release")).using(project(":godot-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
     }
 }

harness/flattened-library-tests/settings.gradle.kts

@@ -16,7 +16,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-extension-library-release")).using(project(":godot-extension-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-debug")).using(project(":godot-coroutine-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-release")).using(project(":godot-coroutine-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
         substitute(module("com.utopia-rise:godot-build-props")).using(project(":godot-build-props"))
     }

harness/fqname-library-tests/settings.gradle.kts

@@ -16,7 +16,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-extension-library-release")).using(project(":godot-extension-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-debug")).using(project(":godot-coroutine-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-release")).using(project(":godot-coroutine-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
         substitute(module("com.utopia-rise:godot-build-props")).using(project(":godot-build-props"))
     }

harness/hierarchical-library-tests/settings.gradle.kts

@@ -16,7 +16,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-extension-library-release")).using(project(":godot-extension-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-debug")).using(project(":godot-coroutine-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-release")).using(project(":godot-coroutine-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
         substitute(module("com.utopia-rise:godot-build-props")).using(project(":godot-build-props"))
     }

harness/tests/settings.gradle.kts

@@ -18,7 +18,7 @@ includeBuild("../../kt") {
         substitute(module("com.utopia-rise:godot-extension-library-release")).using(project(":godot-extension-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-debug")).using(project(":godot-coroutine-library"))
         substitute(module("com.utopia-rise:godot-coroutine-library-release")).using(project(":godot-coroutine-library"))
-        substitute(module("com.utopia-rise:godot-kotlin-symbol-processor")).using(project(":godot-kotlin-symbol-processor"))
+        substitute(module("com.utopia-rise:godot-class-graph-symbol-processor")).using(project(":godot-class-graph-symbol-processor"))
         substitute(module("com.utopia-rise:godot-entry-generator")).using(project(":godot-entry-generator"))
         substitute(module("com.utopia-rise:godot-build-props")).using(project(":godot-build-props"))
     }

kt/entry-generation/godot-entry-generator/src/main/kotlin/godot/entrygenerator/EntryGenerator.kt

@@ -126,7 +126,7 @@ object EntryGenerator {
         initialRegistrationFilesOutDir: File,
         existingRegistrationFilesMap: Map<String, File>
     ) {
-        val kspRegistrationFiles = generatedRegistrationFilesBaseDir
+        val registrationFiles = generatedRegistrationFilesBaseDir
             .walkTopDown()
             .filter { file ->
                 file.extension == FileExtensions.GodotKotlinJvm.registrationFile
@@ -135,15 +135,15 @@ object EntryGenerator {
                 file.name
             }
 
-        // compare ksp and existing registration files
+        // compare new and existing registration files
         val deletedRegistrationFiles = existingRegistrationFilesMap
-            .filterKeys { registrationFileName -> !kspRegistrationFiles.containsKey(registrationFileName) }
+            .filterKeys { registrationFileName -> !registrationFiles.containsKey(registrationFileName) }
             .values
 
         val updatedRegistrationFiles = existingRegistrationFilesMap
-            .filterKeys { registrationFileName -> kspRegistrationFiles.containsKey(registrationFileName) }
+            .filterKeys { registrationFileName -> registrationFiles.containsKey(registrationFileName) }
 
-        val newRegistrationFiles = kspRegistrationFiles
+        val newRegistrationFiles = registrationFiles
             .filterKeys { registrationFileName -> !existingRegistrationFilesMap.containsKey(registrationFileName) }
 
 
@@ -169,7 +169,7 @@ object EntryGenerator {
 
         // replace existing registration files
         updatedRegistrationFiles.forEach { (registrationFileName, registrationFile) ->
-            kspRegistrationFiles[registrationFileName]?.copyTo(registrationFile, overwrite = true)
+            registrationFiles[registrationFileName]?.copyTo(registrationFile, overwrite = true)
         }
 
         // copy new registration files