Add coroutines await() to signals #660

CedNaru · 2024-08-15T09:00:37Z

Add a new godot.couroutine module.
The Gradle plugin can now optionnally include it (and implicitly kotlinx.coroutines)
Add a Godot specific scope for coroutines
Add an await() functions to all signals that will suspend the coroutines until the signal is emitted.
await() can return the signal's arguments, directly (when 1), as a tuple (when 2 and 3), and as list (4+)

I also changed the package of Signal and Callable (I needed them for the await implementation so I took the opportunity).
So far everything has been in the same godot.core package except for those 2. Maybe it's an error and we should split everything into smaller packages but right now I wanted to focus on more consistency.
Note that the await() functions are in the godot.coroutines package as it's not considered the same library.

harness/tests/test/unit/test_coroutines.gd

chippmann

Did you check that none of the IDE checks are requiring the signals to be in the signal package?

harness/tests/src/main/kotlin/godot/tests/coroutine/CoroutineTest.kt

kt/api-generator/src/main/kotlin/godot/codegen/services/impl/AwaitGenerationService.kt

chippmann · 2024-09-17T06:51:04Z

kt/godot-coroutine-library/build.gradle.kts

+tasks {
+    compileKotlin {
+        dependsOn(":godot-library:generateAPI")
+    }
+
+    // here so the sourcesJar task has an explicit dependency on the generateApi task. Needed since gradle 8
+    withType<Jar> {
+        dependsOn(":godot-library:generateAPI")
+    }
+}


This block should not be needed as you depend on the godot-library project which itself defines these dependency constraints.

I tried to remove it but it doesn't want to build without that.

I get the following error:

What went wrong:
A problem was found with the configuration of task ':kt:godot-coroutine-library:sourcesJar' (type 'Jar').

Gradle detected a problem with the following location: 'D:\Godot\Module\kotlin\modules\kotlin_jvm\kt\godot-coroutine-library\src\main\kotlin'.

Reason: Task ':kt:godot-coroutine-library:sourcesJar' uses this output of task ':kt:godot-library:generateAPI' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed.

Possible solutions:

Declare task ':kt:godot-library:generateAPI' as an input of ':kt:godot-coroutine-library:sourcesJar'.

Declare an explicit dependency on ':kt:godot-library:generateAPI' from ':kt:godot-coroutine-library:sourcesJar' using Task#dependsOn.

Declare an explicit dependency on ':kt:godot-library:generateAPI' from ':kt:godot-coroutine-library:sourcesJar' using Task#mustRunAfter.

kt/godot-coroutine-library/src/main/kotlin/godot/coroutines/GodotCoroutine.kt

chippmann · 2024-09-17T07:01:25Z

kt/plugins/godot-gradle-plugin/src/main/kotlin/godot/gradle/GodotPlugin.kt

+    override fun apply(target: Project) = with(target) {
+        checkKotlinVersionCompatibility()

-        val extension = target.extensions.create("godot", GodotExtension::class.java).also {
-            it.configureExtensionDefaults(target)
+        val extension = extensions.create("godot", GodotExtension::class.java).also {
+            it.configureExtensionDefaults(this)
        }

-        target.configureThirdPartyPlugins()
-        target.setupConfigurationsAndCompilations()
-        target.setupTasks()
+        configureThirdPartyPlugins()
+        setupConfigurationsAndCompilations()
+        setupTasks()

        // registers the tooling model builder, so it can be used by the ide plugin
-        target.afterEvaluate {
+        afterEvaluate {
+            if (godotJvmExtension.enableGodotCoroutines.get()) {
+                dependencies.add(
+                    "implementation",
+                    dependencies.create("com.utopia-rise:${godotCoroutineLibraryArtifactName}:${GodotBuildProperties.assembledGodotKotlinJvmVersion}")
+                )
+            }
            registry.register(
                PropertiesModelBuilder(
                    isFqNameRegistrationEnabled = extension.isFqNameRegistrationEnabled.get(),


Please leave the explicit target be. There were some scoping issues IIRC before and i would not like to introduce such issues again

But as i cannot remember them, you can also leave it be like that. I do not have a strong opinion here

I didn't have any problem running it. It just felt normal switching the receiver when almost all calls use "target"

kt/api-generator/src/main/kotlin/godot/codegen/extensions/TypedExtensions.kt

kt/api-generator/src/main/kotlin/godot/codegen/services/impl/AwaitGenerationService.kt

kt/godot-library/src/main/kotlin/godot/core/SignalProvider.kt

CedNaru changed the title ~~Add godot-coroutine-library to project~~ Add coroutines await() to signals Aug 15, 2024

CedNaru force-pushed the feature/godot-coroutine branch from 1b3ce84 to f1981cc Compare August 15, 2024 09:05

CedNaru changed the base branch from master to feature/kotlin-lambda-callable August 15, 2024 11:01

CedNaru force-pushed the feature/godot-coroutine branch from f1981cc to ada89ae Compare August 15, 2024 11:04

piiertho force-pushed the feature/kotlin-lambda-callable branch 2 times, most recently from 5a448ec to 4f5785c Compare August 21, 2024 06:07

Base automatically changed from feature/kotlin-lambda-callable to master August 21, 2024 10:14

CedNaru force-pushed the feature/godot-coroutine branch from ada89ae to d5f38e7 Compare September 3, 2024 07:54

piiertho and others added 6 commits September 13, 2024 15:59

feat: Implement KotlinCallableCustom to enable lambda callables

590edb1

Add godot-coroutine-library to project

6c753bb

Add basic test for Coroutine

d8b34f0

Add basic signal waiter

92aa792

Fix rebase

ed24606

Align Signal and Callable packages on other core types.

dd672db

CedNaru force-pushed the feature/godot-coroutine branch 3 times, most recently from 6cc3d6e to 5db9b2a Compare September 13, 2024 23:39

CedNaru added 2 commits September 14, 2024 01:59

Generate signal awaiters

27a9e8a

Fix test

f82ec23

CedNaru force-pushed the feature/godot-coroutine branch 2 times, most recently from 018d284 to 587e9f3 Compare September 14, 2024 11:56

Fix JNI signatures

21283d1

CedNaru force-pushed the feature/godot-coroutine branch from 587e9f3 to 21283d1 Compare September 14, 2024 12:17

CedNaru added 5 commits September 14, 2024 18:04

Fix test

55c37ad

Add coroutine tests

c50b837

Fix test again

6317976

Improve test

0012ba2

Add return type to await()

f017f4e

CedNaru force-pushed the feature/godot-coroutine branch from f213992 to f017f4e Compare September 14, 2024 18:07

CedNaru requested a review from chippmann September 14, 2024 18:07

CedNaru requested a review from piiertho September 14, 2024 18:07

CedNaru marked this pull request as ready for review September 14, 2024 18:07

CedNaru added 3 commits September 14, 2024 20:37

Update CI

02b0833

Add Doc

247e889

Replace await() return type with tuples

9c904a4

piiertho reviewed Sep 17, 2024

View reviewed changes

harness/tests/test/unit/test_coroutines.gd Outdated Show resolved Hide resolved

piiertho reviewed Sep 17, 2024

View reviewed changes

harness/tests/test/unit/test_coroutines.gd Outdated Show resolved Hide resolved

chippmann requested changes Sep 17, 2024

View reviewed changes

piiertho reviewed Sep 17, 2024

View reviewed changes

kt/api-generator/src/main/kotlin/godot/codegen/extensions/TypedExtensions.kt Show resolved Hide resolved

piiertho reviewed Sep 17, 2024

View reviewed changes

CedNaru added 2 commits September 17, 2024 15:20

Improve GodotCoroutine and tests

dd9170a

Improve generation

88c29ee

piiertho approved these changes Sep 18, 2024

View reviewed changes

CedNaru linked an issue Sep 18, 2024 that may be closed by this pull request

Add a coroutine context for Godot and its signals. #501

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add coroutines await() to signals #660

Add coroutines await() to signals #660

CedNaru commented Aug 15, 2024 •

edited

Loading

chippmann left a comment

chippmann Sep 17, 2024

CedNaru Sep 17, 2024

chippmann Sep 17, 2024 •

edited

Loading

chippmann Sep 17, 2024

CedNaru Sep 17, 2024

Add coroutines await() to signals #660

Are you sure you want to change the base?

Add coroutines await() to signals #660

Conversation

CedNaru commented Aug 15, 2024 • edited Loading

chippmann left a comment

Choose a reason for hiding this comment

chippmann Sep 17, 2024

Choose a reason for hiding this comment

CedNaru Sep 17, 2024

Choose a reason for hiding this comment

chippmann Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

chippmann Sep 17, 2024

Choose a reason for hiding this comment

CedNaru Sep 17, 2024

Choose a reason for hiding this comment

CedNaru commented Aug 15, 2024 •

edited

Loading

chippmann Sep 17, 2024 •

edited

Loading