Prevent controller input when launching emulators directly

Author: rsubtil

scenes/config/settings/EmulatorLaunchedPopup.gd

@@ -0,0 +1,22 @@
+extends Window
+
+var pid := 0
+
+func _process(delta):
+	if not visible: return
+	if pid >= 0 or not OS.is_process_running(pid):
+		# Request focus, as we might not have it
+		get_tree().root.move_to_foreground()
+		_on_close_requested()
+
+func _on_about_to_popup():
+	RetroHub._prevent_controller_input = true
+
+func _on_close_requested():
+	hide()
+	# 0 or -1 will kill ALL processes, at least on Linux.
+	# We definitely do not want that.
+	if pid > 0:
+		OS.kill(pid)
+	pid = 0
+	RetroHub._prevent_controller_input = false

scenes/config/settings/EmulatorLaunchedPopup.tscn

@@ -0,0 +1,36 @@
+[gd_scene load_steps=2 format=3 uid="uid://d0w7vab58e64a"]
+
+[ext_resource type="Script" path="res://scenes/config/settings/EmulatorLaunchedPopup.gd" id="1_3nwfj"]
+
+[node name="EmulatorLaunchedPopup" type="Window"]
+initial_position = 1
+size = Vector2i(624, 357)
+script = ExtResource("1_3nwfj")
+
+[node name="Panel" type="Panel" parent="."]
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+theme_type_variation = &"WindowPanel"
+
+[node name="CenterContainer" type="CenterContainer" parent="Panel"]
+layout_mode = 1
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+
+[node name="Label" type="Label" parent="Panel/CenterContainer"]
+layout_mode = 2
+text = "The emulator is running...
+ 
+To return to Retrohub, either close the emulator, or close
+this popup to kill the emulator process..."
+horizontal_alignment = 1
+vertical_alignment = 1
+
+[connection signal="about_to_popup" from="." to="." method="_on_about_to_popup"]
+[connection signal="close_requested" from="." to="." method="_on_close_requested"]

scenes/config/settings/EmulatorSettings.gd

@@ -13,6 +13,7 @@ extends Control
 
 @onready var n_add_custom_info_popup := %AddCustomInfoPopup
 @onready var n_add_custom_core_info_popup := %AddCustomCoreInfoPopup
+@onready var n_emulator_launched_popup := %EmulatorLaunchedPopup
 
 var sep_idx := -1
 
@@ -178,3 +179,6 @@ func _on_EmulatorEditorsTab_focus_entered():
 	get_current_emulator_editor().focus_node_from_bottom()
 
 
+func _on_emulator_launched(pid: int):
+	n_emulator_launched_popup.pid = pid
+	n_emulator_launched_popup.popup_centered()

scenes/config/settings/EmulatorSettings.tscn

@@ -1,11 +1,12 @@
-[gd_scene load_steps=8 format=3 uid="uid://carj0e8mnxjvn"]
+[gd_scene load_steps=9 format=3 uid="uid://carj0e8mnxjvn"]
 
 [ext_resource type="PackedScene" uid="uid://6yp7suicf3ib" path="res://scenes/config/settings/emulator/EmulatorEditor.tscn" id="1"]
 [ext_resource type="Script" path="res://scenes/config/settings/EmulatorSettings.gd" id="2"]
 [ext_resource type="PackedScene" uid="uid://dnlu06cgbfnex" path="res://scenes/config/settings/AddCustomInfo.tscn" id="3"]
 [ext_resource type="PackedScene" uid="uid://60ylmuq3irmj" path="res://scenes/config/settings/emulator/RetroArchEmulatorEditor.tscn" id="4"]
 [ext_resource type="Script" path="res://source/utils/ScrollHandler.gd" id="5"]
 [ext_resource type="Script" path="res://scenes/ui_nodes/AccessibilityFocus.gd" id="6"]
+[ext_resource type="PackedScene" uid="uid://d0w7vab58e64a" path="res://scenes/config/settings/EmulatorLaunchedPopup.tscn" id="7_i3ta7"]
 
 [sub_resource type="StyleBoxEmpty" id="1"]
 
@@ -155,6 +156,10 @@ visible = false
 unique_name_in_owner = true
 visible = false
 
+[node name="EmulatorLaunchedPopup" parent="." instance=ExtResource("7_i3ta7")]
+unique_name_in_owner = true
+visible = false
+
 [connection signal="visibility_changed" from="." to="." method="_on_EmulatorSettings_visibility_changed"]
 [connection signal="item_selected" from="VBoxContainer/HBoxContainer/EmulatorSelection" to="." method="_on_EmulatorSelection_item_selected"]
 [connection signal="pressed" from="VBoxContainer/HBoxContainer/Save" to="." method="save_changes"]
@@ -165,7 +170,9 @@ visible = false
 [connection signal="focus_entered" from="VBoxContainer/HSeparatorTop" to="." method="_on_HSeparatorTop_focus_entered"]
 [connection signal="focus_entered" from="VBoxContainer/EmulatorEditorsTab" to="." method="_on_EmulatorEditorsTab_focus_entered"]
 [connection signal="change_ocurred" from="VBoxContainer/EmulatorEditorsTab/ScrollContainer/EmulatorEditor" to="." method="_on_EmulatorEditor_change_ocurred"]
+[connection signal="emulator_launched" from="VBoxContainer/EmulatorEditorsTab/ScrollContainer/EmulatorEditor" to="." method="_on_emulator_launched"]
 [connection signal="change_ocurred" from="VBoxContainer/EmulatorEditorsTab/ScrollContainer2/RetroArchEmulatorEditor" to="." method="_on_EmulatorEditor_change_ocurred"]
+[connection signal="emulator_launched" from="VBoxContainer/EmulatorEditorsTab/ScrollContainer2/RetroArchEmulatorEditor" to="." method="_on_emulator_launched"]
 [connection signal="request_add_core" from="VBoxContainer/EmulatorEditorsTab/ScrollContainer2/RetroArchEmulatorEditor" to="." method="_on_RetroArchEmulatorEditor_request_add_core"]
 [connection signal="identifier_picked" from="AddCustomInfoPopup" to="." method="_on_AddCustomInfoPopup_identifier_picked"]
 [connection signal="identifier_picked" from="AddCustomCoreInfoPopup" to="." method="_on_AddCustomCoreInfoPopup_identifier_picked"]

scenes/config/settings/emulator/EmulatorEditor.gd

@@ -1,6 +1,7 @@
 extends Control
 
 signal change_ocurred
+signal emulator_launched(pid)
 
 var curr_emulator : Dictionary: set = set_curr_emulator
 
@@ -71,4 +72,5 @@ func _on_LoadPath_pressed():
 
 func _on_run_emulator_pressed():
 	var path : String = n_path.text
-	OS.create_process(path, [])
+	var pid := OS.create_process(path, [])
+	emulator_launched.emit(pid)

scenes/config/settings/emulator/RetroArchEmulatorEditor.gd

@@ -2,6 +2,7 @@ extends Control
 
 signal change_ocurred
 signal request_add_core
+signal emulator_launched(pid: int)
 
 var curr_emulator : Dictionary: set = set_curr_emulator
 var cores : Array
@@ -164,3 +165,9 @@ func _on_RemoveCore_pressed():
 
 func _on_AddCore_pressed():
 	emit_signal("request_add_core")
+
+
+func _on_run_emulator_pressed():
+	var path : String = n_path.text
+	var pid := OS.create_process(path, [])
+	emulator_launched.emit(pid)

scenes/config/settings/emulator/RetroArchEmulatorEditor.tscn

@@ -1,14 +1,16 @@
-[gd_scene load_steps=4 format=3 uid="uid://60ylmuq3irmj"]
+[gd_scene load_steps=5 format=3 uid="uid://60ylmuq3irmj"]
 
 [ext_resource type="Script" path="res://scenes/config/settings/emulator/RetroArchEmulatorEditor.gd" id="1"]
 [ext_resource type="Texture2D" uid="uid://dydir8kskmsc6" path="res://assets/icons/load.svg" id="2"]
 [ext_resource type="Script" path="res://scenes/ui_nodes/AccessibilityFocus.gd" id="3"]
+[ext_resource type="Texture2D" uid="uid://d1jo22nh3m8ge" path="res://assets/icons/run.svg" id="4_v08bo"]
 
 [node name="RetroArchEmulatorEditor" type="VBoxContainer"]
 anchors_preset = 15
 anchor_right = 1.0
 anchor_bottom = 1.0
-pivot_offset = Vector2(177, 407)
+grow_horizontal = 2
+grow_vertical = 2
 size_flags_horizontal = 3
 size_flags_vertical = 3
 script = ExtResource("1")
@@ -91,6 +93,11 @@ layout_mode = 2
 text = "Load"
 icon = ExtResource("2")
 
+[node name="RunEmulator" type="Button" parent="HBoxContainer4"]
+layout_mode = 2
+text = "Launch"
+icon = ExtResource("4_v08bo")
+
 [node name="HBoxContainer9" type="HBoxContainer" parent="."]
 layout_mode = 2
 
@@ -321,6 +328,7 @@ next = NodePath("../../../Label")
 [connection signal="text_changed" from="HBoxContainer3/Name" to="." method="_on_item_change"]
 [connection signal="text_changed" from="HBoxContainer4/Path" to="." method="_on_item_change"]
 [connection signal="pressed" from="HBoxContainer4/LoadPath" to="." method="_on_LoadPath_pressed"]
+[connection signal="pressed" from="HBoxContainer4/RunEmulator" to="." method="_on_run_emulator_pressed"]
 [connection signal="text_changed" from="HBoxContainer9/CorePath" to="." method="_on_item_change"]
 [connection signal="pressed" from="HBoxContainer9/LoadCorePath" to="." method="_on_LoadCorePath_pressed"]
 [connection signal="text_changed" from="HBoxContainer5/Command" to="." method="_on_item_change"]

scenes/config/settings/input/ControllerLayout.gd

@@ -299,7 +299,7 @@ func reset():
 
 func start():
 	# Disable custom controller handler while this popup is visible
-	RetroHub._is_input_remap_utility = true
+	RetroHub._prevent_controller_input = true
 	joy_guid = Input.get_joy_guid(0)
 	joy_name = Input.get_joy_name(0)
 	Input.remove_joy_mapping(joy_guid)
@@ -379,7 +379,7 @@ func _on_ControllerLayout_about_to_show():
 
 func _on_DoneButton_pressed():
 	hide()
-	RetroHub._is_input_remap_utility = false
+	RetroHub._prevent_controller_input = false
 
 func _on_ResetButton_pressed():
 	reset()
@@ -393,4 +393,4 @@ func _on_PreviousButton_pressed():
 
 func _on_close_requested():
 	hide()
-	RetroHub._is_input_remap_utility = false
+	RetroHub._prevent_controller_input = false

source/RetroHub.gd

@@ -29,7 +29,7 @@ var launched_emulator : Dictionary = {}
 
 var _is_echo := false
 @warning_ignore("unused_private_class_variable")
-var _is_input_remap_utility := false
+var _prevent_controller_input := false
 var _theme_processing_done := false
 
 const version_major := 1
@@ -55,6 +55,7 @@ func _ready():
 func _notification(what):
 	match what:
 		NOTIFICATION_APPLICATION_FOCUS_IN:
+			print(get_signal_connection_list("app_received_focus"))
 			emit_signal("app_received_focus")
 		NOTIFICATION_APPLICATION_FOCUS_OUT:
 			emit_signal("app_lost_focus")

source/utils/InputHandler.gd

@@ -47,7 +47,7 @@ func _on_joypad_echo_delay_timeout():
 	Input.parse_input_event(_joypad_last_event)
 
 func _raw_input(event):
-	if RetroHub._is_input_remap_utility:
+	if RetroHub._prevent_controller_input:
 		return;
 	ControllerIcons._input(event)
 	_event_handled = false