Feature/ios/update to graal 23 (#619)

* feat(ios): update cap cache and remoe HomeFinderFeature in order to build ios with graal 23

* chore: update gut to 9.2.1

* feat: Use new built ios JDK in iOS export

* doc: Remove experimental warning for ios and specify graal vm version to use

* chore: remove ios_graal_fix.c from repo

* chore: simplify gradle copyDefaultGraalIOSConfigsTask

* fix: set tests to run on macos-13 runners

* feat: download cap files from external project used to generate them

* chore: Add special thanks to MOE community

* doc: Add graal vm download link in iOS export guide

* doc: Add KB to update iOS JDK version in documentation

Author: piiertho

.github/workflows/check-pr-engine-editor-debug-and-tests.yaml

@@ -146,12 +146,13 @@ jobs:
       matrix:
         name: [ Debug, Release ]
         include:
+          # TODO: update macos and Java versions
           - name: Debug
-            os: macos-latest
+            os: macos-13
             java-version: 11
             target: debug
           - name: Release
-            os: macos-latest
+            os: macos-13
             java-version: 11
             target: release
     runs-on: ${{ matrix.os }}

README.md

@@ -57,3 +57,8 @@ JetBrains is helping us to develop this project by providing development tools t
 Intellij IDEA is our IDE of choice for Kotlin development and we strongly recommend using it.
 
 [![jblogo](.README/jetbrains.svg)](https://www.jetbrains.com/)
+
+## Special thanks
+
+We'd like to give a special thanks to [MOE](https://multi-os-engine.org/) community. They helped us a lot to get iOS
+platform working. If you intend to create a multi platform mobile app (not game), check out their project.

docs/src/doc/knowledge-base/update-ios-jdk.md

@@ -0,0 +1,14 @@
+In order to update the JDK for iOS, you will need to follow the next steps:
+
+- Create a repo similar to [ios-graal-jdk-21](https://github.com/utopia-rise/ios-graal-jdk-21).  
+This repo should contain `labs-openjdk` repo from GraalVM for the corresponding JDK version as a submodule.  
+It should also contain graal repo as a submodule, using release tag for the GraalVM version associated to the desired 
+JVM version.  
+You may need to update the git patch in this repo.  
+You may need to update xcode projects in this repo.  
+Once done and compiled, create a new release and upload new built static libraries to this release.  
+- Update CAP (C Annotation Processor) cache in [cap-cache-generator](https://github.com/utopia-rise/cap-cache-generator).  
+To do so, change your `GRAALVM_HOME` environment variable to point to the new GraalVM you're updating for.  
+Then tag a new release and upload new CAP files in it.  
+- Change iOS JDK versions and CAP cache versions in `libs.versions.toml` of this project.  
+- Change graalvm version and link in [exporting guide](https://github.com/utopia-rise/godot-kotlin-jvm/blob/master/docs/src/doc/user-guide/exporting.md) iOS section.

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

@@ -103,17 +103,13 @@ On desktop platform default export is inferred by the `godot_kotin_configuration
 ## iOS
 
 !!! warning
-    IOS export is experimental.
+With this export you don't have a choice regarding JVM version you use. Please use [GraalVM 23.1.3](https://download.oracle.com/graalvm/21/latest/graalvm-jdk-21_macos-aarch64_bin.tar.gz).
 
 Additionally, to the regular GraalVM configuration mentioned above, add the following in `build.gradle.kts`:
 
 ```kotlin
 godot {
-    isGraalNativeImageExportEnabled.set(true)
     graalVmDirectory.set(File("Path to your graalVM install")) // or setup GRAALVM_HOME environment variable.
     isIOSExportEnabled.set(true)
 }
-```
-
-!!! warning
-    With this export you don't have a choice regarding JVM embedding in the app. Godot Kotlin's Gradle plugin will automatically download a iOS static JDK libraries and pack it with your code for iOS.
+```

harness/tests/.gut_editor_config.json

@@ -6,7 +6,8 @@
   "res://test/unit"
  ],
  "disable_colors": false,
- "double_strategy": "partial",
+ "double_strategy": 1,
+ "errors_do_not_cause_failure": false,
  "font_color": "ccccccff",
  "font_name": "CourierPrime",
  "font_size": 16,
@@ -26,6 +27,8 @@
   "hide_output_text": false,
   "hide_result_tree": false,
   "hide_settings": false,
+  "output_font_name": "CourierPrime",
+  "output_font_size": 30,
   "use_colors": false
  },
  "post_run_script": "",

harness/tests/addons/gut/GutScene.gd

@@ -89,7 +89,7 @@ func set_font(font_name):
 
 func _set_font(rtl, font_name, custom_name):
 	if(font_name == null):
-		rtl.add_theme_font_override(custom_name, null)
+		rtl.remove_theme_font_override(custom_name)
 	else:
 		var dyn_font = FontFile.new()
 		dyn_font.load_dynamic_font('res://addons/gut/fonts/' + font_name + '.ttf')

harness/tests/addons/gut/doubler.gd

@@ -1,37 +1,3 @@
-# ##############################################################################
-#(G)odot (U)nit (T)est class
-#
-# ##############################################################################
-# The MIT License (MIT)
-# =====================
-#
-# Copyright (c) 2020 Tom "Butch" Wesley
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-#
-# ##############################################################################
-# Description
-# -----------
-# ##############################################################################
-
-
-
 # ------------------------------------------------------------------------------
 # A stroke of genius if I do say so.  This allows for doubling a scene without
 # having  to write any files.  By overloading the "instantiate" method  we can
@@ -47,8 +13,21 @@ class PackedSceneDouble:
 
 	func instantiate(edit_state=0):
 		var inst = _scene.instantiate(edit_state)
+		var export_props = []
+		var script_export_flag = (PROPERTY_USAGE_STORAGE | PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_SCRIPT_VARIABLE)
+
 		if(_script !=  null):
+			if(inst.get_script() != null):
+				# Get all the exported props and values so we can set them again
+				for prop in inst.get_property_list():
+					var is_export = prop.usage & (script_export_flag) == script_export_flag
+					if(is_export):
+						export_props.append([prop.name, inst.get(prop.name)])
+
 			inst.set_script(_script)
+			for exported_value in export_props:
+				inst.set(exported_value[0], exported_value[1])
+
 		return inst
 
 	func load_scene(path):
@@ -343,3 +322,34 @@ func partial_double_inner(parent, inner, strategy=_strategy):
 
 func add_ignored_method(obj, method_name):
 	_ignored_methods.add(obj, method_name)
+
+
+
+# ##############################################################################
+#(G)odot (U)nit (T)est class
+#
+# ##############################################################################
+# The MIT License (MIT)
+# =====================
+#
+# Copyright (c) 2024 Tom "Butch" Wesley
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# ##############################################################################

harness/tests/addons/gut/gui/BottomPanelShortcuts.gd

@@ -1,6 +1,9 @@
 @tool
 extends Window
 
+var GutEditorGlobals = load('res://addons/gut/gui/editor_globals.gd')
+var default_path = GutEditorGlobals.editor_shortcuts_path
+
 @onready var _ctrls = {
 	run_all = $Layout/CRunAll/ShortcutButton,
 	run_current_script = $Layout/CRunCurrentScript/ShortcutButton,
@@ -9,36 +12,51 @@ extends Window
 	panel_button = $Layout/CPanelButton/ShortcutButton,
 }
 
+var _user_prefs = GutEditorGlobals.user_prefs
+
 func _ready():
 	for key in _ctrls:
 		var sc_button = _ctrls[key]
 		sc_button.connect('start_edit', _on_edit_start.bind(sc_button))
 		sc_button.connect('end_edit', _on_edit_end)
 
-
 	# show dialog when running scene from editor.
 	if(get_parent() == get_tree().root):
 		popup_centered()
 
+
+func _cancel_all():
+	_ctrls.run_all.cancel()
+	_ctrls.run_current_script.cancel()
+	_ctrls.run_current_inner.cancel()
+	_ctrls.run_current_test.cancel()
+	_ctrls.panel_button.cancel()
+
 # ------------
 # Events
 # ------------
 func _on_Hide_pressed():
 	hide()
 
+
 func _on_edit_start(which):
 	for key in _ctrls:
 		var sc_button = _ctrls[key]
 		if(sc_button != which):
 			sc_button.disable_set(true)
 			sc_button.disable_clear(true)
 
+
 func _on_edit_end():
 	for key in _ctrls:
 		var sc_button = _ctrls[key]
 		sc_button.disable_set(false)
 		sc_button.disable_clear(false)
 
+
+func _on_popup_hide():
+	_cancel_all()
+
 # ------------
 # Public
 # ------------
@@ -57,26 +75,67 @@ func get_run_current_test():
 func get_panel_button():
 	return _ctrls.panel_button.get_shortcut()
 
+func _set_pref_value(pref, button):
+	pref.value = {shortcut = button.get_shortcut().events}
 
-func save_shortcuts(path):
-	var f = ConfigFile.new()
 
+func save_shortcuts():
+	save_shortcuts_to_file(default_path)
+
+
+func save_shortcuts_to_editor_settings():
+	_set_pref_value(_user_prefs.shortcut_run_all, _ctrls.run_all)
+	_set_pref_value(_user_prefs.shortcut_run_current_script, _ctrls.run_current_script)
+	_set_pref_value(_user_prefs.shortcut_run_current_inner, _ctrls.run_current_inner)
+	_set_pref_value(_user_prefs.shortcut_run_current_test, _ctrls.run_current_test)
+	_set_pref_value(_user_prefs.shortcut_panel_button, _ctrls.panel_button)
+
+	_user_prefs.save_it()
+
+
+func save_shortcuts_to_file(path):
+	var f = ConfigFile.new()
 	f.set_value('main', 'run_all', _ctrls.run_all.get_shortcut())
 	f.set_value('main', 'run_current_script', _ctrls.run_current_script.get_shortcut())
 	f.set_value('main', 'run_current_inner', _ctrls.run_current_inner.get_shortcut())
 	f.set_value('main', 'run_current_test', _ctrls.run_current_test.get_shortcut())
 	f.set_value('main', 'panel_button', _ctrls.panel_button.get_shortcut())
-
 	f.save(path)
 
 
-func load_shortcuts(path):
-	var emptyShortcut = Shortcut.new()
+func _load_shortcut_from_pref(user_pref):
+	var to_return = Shortcut.new()
+	# value with be _user_prefs.EMPTY which is a string when the value
+	# has not been set.
+	if(typeof(user_pref.value) == TYPE_DICTIONARY):
+		to_return.events.append(user_pref.value.shortcut[0])
+		# to_return = user_pref.value
+	return to_return
+
+
+func load_shortcuts():
+	load_shortcuts_from_file(default_path)
+
+
+func load_shortcuts_from_editor_settings():
+	var empty = Shortcut.new()
+
+	_ctrls.run_all.set_shortcut(_load_shortcut_from_pref(_user_prefs.shortcut_run_all))
+	_ctrls.run_current_script.set_shortcut(_load_shortcut_from_pref(_user_prefs.shortcut_run_current_script))
+	_ctrls.run_current_inner.set_shortcut(_load_shortcut_from_pref(_user_prefs.shortcut_run_current_inner))
+	_ctrls.run_current_test.set_shortcut(_load_shortcut_from_pref(_user_prefs.shortcut_run_current_test))
+	_ctrls.panel_button.set_shortcut(_load_shortcut_from_pref(_user_prefs.shortcut_panel_button))
+
+
+func load_shortcuts_from_file(path):
 	var f = ConfigFile.new()
+	var empty = Shortcut.new()
+
 	f.load(path)
+	_ctrls.run_all.set_shortcut(f.get_value('main', 'run_all', empty))
+	_ctrls.run_current_script.set_shortcut(f.get_value('main', 'run_current_script', empty))
+	_ctrls.run_current_inner.set_shortcut(f.get_value('main', 'run_current_inner', empty))
+	_ctrls.run_current_test.set_shortcut(f.get_value('main', 'run_current_test', empty))
+	_ctrls.panel_button.set_shortcut(f.get_value('main', 'panel_button', empty))
+
 
-	_ctrls.run_all.set_shortcut(f.get_value('main', 'run_all', emptyShortcut))
-	_ctrls.run_current_script.set_shortcut(f.get_value('main', 'run_current_script', emptyShortcut))
-	_ctrls.run_current_inner.set_shortcut(f.get_value('main', 'run_current_inner', emptyShortcut))
-	_ctrls.run_current_test.set_shortcut(f.get_value('main', 'run_current_test', emptyShortcut))
-	_ctrls.panel_button.set_shortcut(f.get_value('main', 'panel_button', emptyShortcut))

harness/tests/addons/gut/gui/BottomPanelShortcuts.tscn

@@ -8,6 +8,8 @@ title = "Shortcuts"
 size = Vector2i(500, 350)
 visible = true
 exclusive = true
+unresizable = false
+borderless = false
 script = ExtResource("2")
 
 [node name="Layout" type="VBoxContainer" parent="."]
@@ -147,4 +149,5 @@ custom_minimum_size = Vector2(0, 10)
 layout_mode = 2
 size_flags_horizontal = 3
 
+[connection signal="popup_hide" from="." to="." method="_on_popup_hide"]
 [connection signal="pressed" from="Layout/HBoxContainer/Hide" to="." method="_on_Hide_pressed"]