GDKotlin Rework: Module initialization #609
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
from
ba502c2
to
2373302
Compare
CedNaru
requested review from
chippmann and
piiertho
and removed request for
chippmann
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
3 times, most recently
from
e83700b
to
2fe7b51
Compare
CedNaru
force-pushed
the
gd_kotlin/import_export_and_co
branch
from
8e5ff25
to
839fbb9
Compare
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
2 times, most recently
from
e983afe
to
d3043bb
Compare
chippmann
reviewed
Apr 17, 2024
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
from
cef05e5
to
e48e07c
Compare
CedNaru
force-pushed
the
gd_kotlin/import_export_and_co
branch
from
839fbb9
to
b561986
Compare
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
from
e48e07c
to
ad08b33
Compare
chippmann
approved these changes
Apr 18, 2024
| #endif | ||
|
|
||
| #ifdef DEBUG_ENABLED | ||
| void GDKotlin::validate_state() { |
There was a problem hiding this comment.
I would probably move this to a separate class no? we could centralize the checks once we add more. Also for once we add back the editor plugin we could do some checks there.
But I'm also fine if we think about this later
There was a problem hiding this comment.
I want to keep it there. GDKotlin is now responsible for all the high level management of the module, so it's right where it should be.
Also I don't recommend having checks in the editor plugin, because it means we won't be able to use them when doing an export debug.
CedNaru
force-pushed
the
gd_kotlin/import_export_and_co
branch
from
c514de1
to
c173356
Compare
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
3 times, most recently
from
78a1ccb
to
d46573a
Compare
piiertho
reviewed
Apr 26, 2024
CedNaru
force-pushed
the
gd_kotlin/import_export_and_co
branch
from
c173356
to
7e7e6e8
Compare
piiertho
approved these changes
Apr 26, 2024
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
from
747f1f1
to
e92b2f5
Compare
Base automatically changed from
gd_kotlin/import_export_and_co
to
gd_kotlin_rework
April 26, 2024 11:46
CedNaru
force-pushed
the
gd_kotlin/initialization_management
branch
from
e92b2f5
to
23cb5d3
Compare
CedNaru
added a commit
that referenced
this pull request
Apr 30, 2024
* Initialize GDKotlin outside language. * Add proper initialization step for the module and remove many explicit crashes * Create JvmScriptManager * Remove NO_USE_STDLIB preprocessor, it has been removed from the engine since Godot 4
CedNaru
added a commit
that referenced
this pull request
May 7, 2024
* Initialize GDKotlin outside language. * Add proper initialization step for the module and remove many explicit crashes * Create JvmScriptManager * Remove NO_USE_STDLIB preprocessor, it has been removed from the engine since Godot 4
CedNaru
added a commit
that referenced
this pull request
May 8, 2024
* Initialize GDKotlin outside language. * Add proper initialization step for the module and remove many explicit crashes * Create JvmScriptManager * Remove NO_USE_STDLIB preprocessor, it has been removed from the engine since Godot 4
CedNaru
added a commit
that referenced
this pull request
May 9, 2024
* Initialize GDKotlin outside language. * Add proper initialization step for the module and remove many explicit crashes * Create JvmScriptManager * Remove NO_USE_STDLIB preprocessor, it has been removed from the engine since Godot 4
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Make the module more resilient to invalid states. Many of the previous explicit crashes got replaced by errors that won't stop the engine execution.
If something goes wrong somewhere in the initialization of the module, a helpful message will appear on-screen before falling back to a Godot with only JVM placeholders.
In debug/tool mode, it's even possible to start the game using JVM scripts that are not built yet. In such case, the script is just not created and only the naked native object will remain (Errors are still thrown in such cases).
GDKotlin got explicit initialization states and a custom error message exists for almost each of them (when the cause is likely a basic one) in case an issue was encountered.
If the final state is invalid, GDkotlin will be immediately freed and unloaded. The languages and resource loader are still registered to Godot, even in the case of an invalid state, so users can manipulate JVM scripts in the editor without a JAVA_HOME, embedded JRE, boostrap.jar or main.jar (They will have an alert appearing on-screen when the engine starts).
Note that the last part of the initialization still has to be done in GdjLanguage. This final step fetches all the Jvm Scripts from Kotlin to C++ as well as sending all method pointers from C++ to Kotlin.
This latter detail matters because this operation requires all classes to be initialized in Godot, so we can't do it as part of the module initialization itself, even using the latest initialization enum value in it. Sadly Godot doesn't have a "afterAll" phase for module initialization.