Add coroutines await() to signals (#660)

* feat: Implement KotlinCallableCustom to enable lambda callables
* Add godot-coroutine-library to project
* Align Signal and Callable packages on other core types.
---------

Co-authored-by: Pierre-Thomas Meisels <meisels27@yahoo.fr>

Author: CedNaru

.clang-tidy

@@ -0,0 +1,47 @@
+---
+Checks: 'clang-diagnostic-*,clang-analyzer-*,-*,cppcoreguidelines-pro-type-member-init,modernize-redundant-void-arg,modernize-use-bool-literals,modernize-use-default-member-init,modernize-use-nullptr,readability-braces-around-statements,readability-redundant-member-init'
+WarningsAsErrors: ''
+HeaderFilterRegex: ''
+AnalyzeTemporaryDtors: false
+FormatStyle: none
+CheckOptions:
+  - key:             cert-dcl16-c.NewSuffixes
+    value:           'L;LL;LU;LLU'
+  - key:             cert-oop54-cpp.WarnOnlyIfThisHasSuspiciousField
+    value:           '0'
+  - key:             cppcoreguidelines-explicit-virtual-functions.IgnoreDestructors
+    value:           '1'
+  - key:             cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
+    value:           '1'
+  - key:             cppcoreguidelines-pro-type-member-init.IgnoreArrays
+    value:           '1'
+  - key:             cppcoreguidelines-pro-type-member-init.UseAssignment
+    value:           '1'
+  - key:             google-readability-function-size.StatementThreshold
+    value:           '800'
+  - key:             google-readability-namespace-comments.ShortNamespaceLines
+    value:           '10'
+  - key:             google-readability-namespace-comments.SpacesBeforeComments
+    value:           '2'
+  - key:             modernize-loop-convert.MaxCopySize
+    value:           '16'
+  - key:             modernize-loop-convert.MinConfidence
+    value:           reasonable
+  - key:             modernize-loop-convert.NamingStyle
+    value:           CamelCase
+  - key:             modernize-pass-by-value.IncludeStyle
+    value:           llvm
+  - key:             modernize-replace-auto-ptr.IncludeStyle
+    value:           llvm
+  - key:             modernize-use-bool-literals.IgnoreMacros
+    value:           '0'
+  - key:             modernize-use-default-member-init.IgnoreMacros
+    value:           '0'
+  - key:             modernize-use-default-member-init.UseAssignment
+    value:           '1'
+  - key:             modernize-use-nullptr.NullMacros
+    value:           'NULL'
+  - key:             readability-braces-around-statements.ShortStatementLines
+    value:           '0'
+...
+

.github/workflows/deploy_jvm.yml

@@ -77,6 +77,16 @@ jobs:
         run: |
           modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-library:publish publish -Prelease
 
+      - name: Publish godot-coroutine-library debug
+        shell: sh
+        run: |
+          modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-coroutine-library:publish publish -Pdebug
+
+      - name: Publish godot-coroutine-library release
+        shell: sh
+        run: |
+          modules/kotlin_jvm/kt/gradlew -p modules/kotlin_jvm/kt/ :godot-coroutine-library:publish publish -Prelease
+
       - name: Publish godot-plugins-common
         shell: sh
         run: |

docs/mkdocs.yml

@@ -70,6 +70,7 @@ nav:
     - Signals: user-guide/signals.md
     - Functions: user-guide/functions.md
     - Exporting: user-guide/exporting.md
+    - Coroutines: user-guide/coroutines.md
     - Debugging: user-guide/debugging.md
     - Consuming libraries: user-guide/consuming-libraries.md
     - Versioning: user-guide/versioning.md

docs/src/doc/user-guide/coroutines.md

@@ -0,0 +1,24 @@
+## Using Kotlin coroutines in Godot
+
+Coroutines are an opt-in feature that require an additional import in Kotlin. 
+We follow the same logic and keep them separated from the main library. 
+
+To use it, you need to add the following to your build.gradle:
+
+```kotlin
+godot {
+    enableGodotCoroutines.set(true)
+}
+```
+
+It will automatically import our coroutine library and `kotlinx.coroutine` as a dependency.
+That library adds a Godot specific coroutine scope and extensions to signals. 
+To use them, you simply need to write the following:
+
+```kotlin
+fun myMethod() = godotCoroutine {
+    doSomething()
+    mySignal.await() // the current coroutine will suspend until that signal is emitted.
+    doSomething2()
+}
+```

harness/tests/Spatial.tscn

@@ -2,28 +2,28 @@
 
 [ext_resource type="Script" path="res://scripts/godot/tests/Invocation.gdj" id="1"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_prd4u"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_1ex3u"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_tuyoa"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_q3pqa"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_bh4po"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_hn8kg"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_bdc7j"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_87cay"]
 
-[sub_resource type="NavigationMesh" id="NavigationMesh_abcao"]
+[sub_resource type="NavigationMesh" id="NavigationMesh_b12lh"]
 
 [node name="Spatial" type="Node3D" node_paths=PackedStringArray("button")]
 script = ExtResource("1")
 button = NodePath("CanvasLayer/Button")
-resource_test = SubResource("NavigationMesh_prd4u")
+resource_test = SubResource("NavigationMesh_1ex3u")
 jvm_id = 319061373
-nav_meshes = Array[NavigationMesh]([SubResource("NavigationMesh_tuyoa")])
-nullable_array = Array[NavigationMesh]([SubResource("NavigationMesh_bh4po"), null])
+nav_meshes = Array[NavigationMesh]([SubResource("NavigationMesh_q3pqa")])
+nullable_array = Array[NavigationMesh]([SubResource("NavigationMesh_hn8kg"), null])
 nav_meshes_dictionary = {
-"AwesomeNavmesh": SubResource("NavigationMesh_bdc7j")
+"AwesomeNavmesh": SubResource("NavigationMesh_87cay")
 }
 nullable_dictionary = {
-"notnull": SubResource("NavigationMesh_abcao"),
+"notnull": SubResource("NavigationMesh_b12lh"),
 "null": null
 }
 

harness/tests/build.gradle.kts

@@ -1,5 +1,4 @@
 import org.jetbrains.kotlin.konan.target.HostManager
-import java.io.OutputStream
 
 plugins {
     // no need to apply kotlin jvm plugin. Our plugin already applies the correct version for you
@@ -14,6 +13,7 @@ repositories {
 godot {
     registrationFileBaseDir.set(projectDir.resolve("scripts").also { it.mkdirs() })
     isRegistrationFileHierarchyEnabled.set(true)
+    enableGodotCoroutines.set(true)
 
     //uncomment to test android
 //    isAndroidExportEnabled.set(true)

harness/tests/scripts/CoreTypePropertyChecks.gdj

@@ -16,8 +16,7 @@ signals = [
 ]
 properties = [
     exported_normal_core_type,
-	normal_core_type,
-	normal_non_null_core_type
+	normal_core_type
 ]
 functions = [
 

harness/tests/scripts/godot/tests/Invocation.gdj

@@ -166,7 +166,5 @@ functions = [
 	set_vector3_in_packed_array,
 	resize_vector3_packed_array,
 	is_sent_xr_same_instance_as_jvm_singleton,
-	nullable_string_is_null,
-	nullable_return_type,
 	create_variant_array_of_user_type
-]
+]

harness/tests/scripts/godot/tests/JavaTestClass.gdj

@@ -25,7 +25,9 @@ properties = [
 	exported_string,
 	exported_byte,
 	exported_button,
-	signal_emitted
+	signal_emitted,
+	variant_array,
+	dictionary
 ]
 functions = [
     greeting,

harness/tests/scripts/godot/tests/coroutine/CoroutineTest.gdj

@@ -0,0 +1,25 @@
+// THIS FILE IS GENERATED! DO NOT EDIT OR DELETE IT. EDIT OR DELETE THE ASSOCIATED SOURCE CODE FILE INSTEAD
+// Note: You can however freely move this file inside your godot project if you want. Keep in mind however, that if you rename the originating source code file, this file will be deleted and regenerated as a new file instead of being updated! Other modifications to the source file however, will result in this file being updated.
+
+registeredName = CoroutineTest
+fqName = godot.tests.coroutine.CoroutineTest
+relativeSourcePath = src/main/kotlin/godot/tests/coroutine/CoroutineTest.kt
+baseType = Object
+supertypes = [
+    godot.Object,
+	godot.core.KtObject,
+	kotlin.Any
+]
+signals = [
+    signal_without_parameter,
+	signal_with_parameters,
+	signal_with_many_parameters
+]
+properties = [
+    step
+]
+functions = [
+    start_coroutine_without_parameter,
+	start_coroutine_with_parameters,
+	start_coroutine_with_many_parameters
+]