gdharness 1.3.41 → 1.3.43

package/build/godot/addons/gdharness_editor/animation_reads.gd

@@ -1,13 +1,11 @@
 extends RefCounted
-
-## Animations and state machines read off their nodes: by the editor's tools from the scene it holds,
-## and by a headless engine with none connected from a bare node of the class given what the file
-## stores, which runs no script of the scene's, so a read answers the same either way.
+## Animations and state machines read off their nodes: by the editor's tools from the scene it
+## holds, and by a headless engine with none connected from a bare node of the class given what the
+## file stores, which runs no script of the scene's, so a read answers the same either way.
 
 const GdhFileReads = preload("file_reads.gd")
 const GdhRead = preload("reading.gd")
 const GdhSerialisation = preload("serialisation.gd")
-
 const LOOP_MODE_NAMES: Dictionary[int, String] = {
 	Animation.LOOP_NONE: "none",
 	Animation.LOOP_LINEAR: "linear",
@@ -37,7 +35,9 @@ const ADVANCE_MODE_NAMES: Dictionary[int, String] = {
 
 
 ## [method animations] of the AnimationPlayer at [param player_path] in the file [param scene_path].
-static func scene_animations(scene_path: String, player_path: String, animation_name: String) -> Dictionary:
+static func scene_animations(
+	scene_path: String, player_path: String, animation_name: String
+) -> Dictionary:
 	var made: Array = _bare(scene_path, player_path, "AnimationPlayer")
 	if made[0] == null:
 		return made[1]
@@ -48,7 +48,9 @@ static func scene_animations(scene_path: String, player_path: String, animation_
 
 
 ## [method states] of the AnimationTree at [param tree_path] in the file [param scene_path].
-static func scene_states(scene_path: String, tree_path: String, state_machine_path: String) -> Dictionary:
+static func scene_states(
+	scene_path: String, tree_path: String, state_machine_path: String
+) -> Dictionary:
 	var made: Array = _bare(scene_path, tree_path, "AnimationTree")
 	if made[0] == null:
 		return made[1]
@@ -64,7 +66,13 @@ static func scene_states(scene_path: String, tree_path: String, state_machine_pa
 			player_path = "."
 		var found: Array = _bare(scene_path, player_path, "AnimationPlayer")
 		player = found[0]
-	var answer: Dictionary = states(tree, state_machine_path, player, player_path)
+	var reached: Node = null
+	if player == null and not player_path.is_empty():
+		reached = _bare(scene_path, player_path, "Node")[0]
+	var unplayed: String = no_player(str(tree.anim_player), reached)
+	if reached != null:
+		reached.free()
+	var answer: Dictionary = states(tree, state_machine_path, player, player_path, unplayed)
 	tree.free()
 	if player != null:
 		player.free()
@@ -98,9 +106,9 @@ static func animations(player: AnimationPlayer, animation_name: String) -> Dicti
 			summary["animationName"] = called
 			summary["tracks"] = listed_one.get_track_count()
 			listed.append(summary)
-		return {"ok": true, "animations": listed}
+		return { "ok": true, "animations": listed }
 	if not player.has_animation(StringName(animation_name)):
-		return {"ok": false, "error": no_animation(player, str(player.name), animation_name)}
+		return { "ok": false, "error": no_animation(player, str(player.name), animation_name) }
 	var anim: Animation = player.get_animation(StringName(animation_name))
 	var answer: Dictionary = _summary(anim)
 	answer["ok"] = true
@@ -152,7 +160,8 @@ static func _track(anim: Animation, track: int, values: GdhSerialisation) -> Dic
 	var kind: int = anim.track_get_type(track)
 	var path: NodePath = anim.track_get_path(track)
 	var shaped: Dictionary = {
-		"type": TRACK_TYPE_NAMES.get(kind, str(kind)), "nodePath": str(path.get_concatenated_names())
+		"type": TRACK_TYPE_NAMES.get(kind, str(kind)),
+		"nodePath": str(path.get_concatenated_names()),
 	}
 	var property: String = str(path.get_concatenated_subnames())
 	if not property.is_empty():
@@ -160,7 +169,7 @@ static func _track(anim: Animation, track: int, values: GdhSerialisation) -> Dic
 	var keyframes: Array[Dictionary] = []
 	var methods: Dictionary = {}
 	for key: int in anim.track_get_key_count(track):
-		var keyframe: Dictionary = {"time": held_seconds(anim.track_get_key_time(track, key))}
+		var keyframe: Dictionary = { "time": held_seconds(anim.track_get_key_time(track, key)) }
 		if kind == Animation.TYPE_METHOD:
 			var method: String = str(anim.method_track_get_name(track, key))
 			methods[method] = true
@@ -182,7 +191,9 @@ static func _track(anim: Animation, track: int, values: GdhSerialisation) -> Dic
 ## The state machine at a slash-separated path of nested state machine names in [param tree], or
 ## null when any step of the path is not one. Every node in a tree of state machines is a state
 ## machine itself, so the walk asks each step for the child by name and refuses anything else.
-static func state_machine(tree: AnimationTree, state_machine_path: String) -> AnimationNodeStateMachine:
+static func state_machine(
+	tree: AnimationTree, state_machine_path: String
+) -> AnimationNodeStateMachine:
 	if tree == null:
 		return null
 	var current: AnimationNodeStateMachine = tree.tree_root as AnimationNodeStateMachine
@@ -201,8 +212,8 @@ static func no_machine(tree: AnimationTree, state_machine_path: String) -> Strin
 	if tree == null or tree.tree_root == null:
 		return (
 			"The AnimationTree has no tree_root. Give it one with scene_node set: tree_root "
-			+ '{"_type": "AnimationNodeStateMachine"} builds one into the scene, and the res:// path '
-			+ "of one made with resource_edit create keeps it in a file of its own."
+			+ '{"_type": "AnimationNodeStateMachine"} builds one into the scene, and the res:// '
+			+ "path of one made with resource_edit create keeps it in a file of its own."
 		)
 	var current: AnimationNodeStateMachine = tree.tree_root as AnimationNodeStateMachine
 	if current == null:
@@ -236,42 +247,74 @@ static func no_machine(tree: AnimationTree, state_machine_path: String) -> Strin
 	return "No state machine at " + state_machine_path
 
 
+## Why no state finds its animation when [param anim_player], an AnimationTree's path to its player,
+## reaches no AnimationPlayer: [param reached] is the node it reaches instead, null for none.
+static func no_player(anim_player: String, reached: Node) -> String:
+	var until: String = "so no state plays anything until scene_node set points anim_player at one."
+	if anim_player.is_empty():
+		return "The AnimationTree has no anim_player, " + until
+	if reached == null:
+		return "The AnimationTree's anim_player %s reaches no node, %s" % [anim_player, until]
+	return (
+		"The AnimationTree's anim_player %s reaches %s, a %s rather than an AnimationPlayer, %s"
+		% [anim_player, reached.name, reached.get_class(), until]
+	)
+
+
 ## Why a state playing [param animation_name] from [param player], at [param player_path] from the
 ## scene root as playerNodePath takes it, plays nothing yet. anim_player is relative to the tree
 ## ("../Anim"), which no argument takes.
-static func missing_animation(player: AnimationPlayer, player_path: String, animation_name: String) -> String:
+static func missing_animation(
+	player: AnimationPlayer, player_path: String, animation_name: String
+) -> String:
 	var said: String = (
-		"The AnimationPlayer at %s has no animation %s yet, so the state plays nothing until it has one."
+		(
+			"The AnimationPlayer at %s has no animation %s yet, so the state plays nothing until "
+			+ "it has one."
+		)
 		% [player_path, animation_name]
 	)
 	var close: PackedStringArray = GdhRead.nearest(animation_name, player.get_animation_list())
 	if close.is_empty():
 		return said
 	return (
-		said + " The nearest %s %s." % ["it has is" if close.size() == 1 else "it has are", ", ".join(close)]
+		said
+		+ (
+			" The nearest %s %s."
+			% ["it has is" if close.size() == 1 else "it has are", ", ".join(close)]
+		)
 	)
 
 
 ## The states and transitions of the state machine at [param state_machine_path] in [param tree].
 ## A state playing an animation says whether [param player], at [param player_path], has it, as
-## add_state answers: a state naming one it lacks plays nothing, and says so only in a log.
+## add_state answers: a state naming one it lacks plays nothing, and says so only in a log. With no
+## player, each says [param unplayed], what [method no_player] made of the tree's path.
 static func states(
-	tree: AnimationTree, state_machine_path: String, player: AnimationPlayer, player_path: String
+	tree: AnimationTree,
+	state_machine_path: String,
+	player: AnimationPlayer,
+	player_path: String,
+	unplayed: String
 ) -> Dictionary:
 	var sm: AnimationNodeStateMachine = state_machine(tree, state_machine_path)
 	if sm == null:
-		return {"ok": false, "error": no_machine(tree, state_machine_path)}
+		return { "ok": false, "error": no_machine(tree, state_machine_path) }
 	var listed: Array[Dictionary] = []
 	for state: StringName in sm.get_node_list():
 		var node: AnimationNode = sm.get_node(state)
-		var entry: Dictionary = {"stateName": str(state), "type": node.get_class()}
+		var entry: Dictionary = { "stateName": str(state), "type": node.get_class() }
 		if node is AnimationNodeAnimation:
 			var plays: AnimationNodeAnimation = node
 			entry["animationName"] = str(plays.animation)
 			var found: bool = player != null and player.has_animation(plays.animation)
 			entry["animationFound"] = found
-			if player != null and not found:
-				entry["animationMissing"] = missing_animation(player, player_path, str(plays.animation))
+			if player == null:
+				entry["animationMissing"] = unplayed
+			elif not found:
+				entry["animationMissing"] = missing_animation(
+					player, player_path, str(plays.animation)
+				)
 		listed.append(entry)
 	var transitions: Array[Dictionary] = []
 	for index: int in sm.get_transition_count():
@@ -279,8 +322,10 @@ static func states(
 		var shaped: Dictionary = {
 			"from": str(sm.get_transition_from(index)),
 			"to": str(sm.get_transition_to(index)),
-			"transitionType": SWITCH_MODE_NAMES.get(transition.switch_mode, str(transition.switch_mode)),
-			"advanceMode": ADVANCE_MODE_NAMES.get(transition.advance_mode, str(transition.advance_mode)),
+			"transitionType":
+			SWITCH_MODE_NAMES.get(transition.switch_mode, str(transition.switch_mode)),
+			"advanceMode":
+			ADVANCE_MODE_NAMES.get(transition.advance_mode, str(transition.advance_mode)),
 		}
 		var condition: String = str(transition.advance_condition)
 		if not condition.is_empty():
@@ -290,9 +335,9 @@ static func states(
 		if not condition.is_empty() and transition.advance_mode != transition.ADVANCE_MODE_AUTO:
 			shaped["conditionNote"] = (
 				(
-					"advanceMode is %s, so %s never advances it: the engine checks a condition only on an"
-					+ " auto transition%s. disconnect_states and connect_states again with the condition"
-					+ " write it as auto"
+					"advanceMode is %s, so %s never advances it: the engine checks a condition "
+					+ "only on an auto transition%s. disconnect_states and connect_states again "
+					+ "with the condition write it as auto"
 				)
 				% [
 					shaped["advanceMode"],
@@ -301,16 +346,16 @@ static func states(
 						", and travel() still takes this one"
 						if transition.advance_mode == transition.ADVANCE_MODE_ENABLED
 						else ""
-					)
+					),
 				]
 			)
 		transitions.append(shaped)
-	return {"ok": true, "states": listed, "transitions": transitions}
+	return { "ok": true, "states": listed, "transitions": transitions }
 
 
 ## The states of the AnimationTrees under [param root] that play [param animation_name] from
-## [param player], as [[node, {animTreePath, state}]], a state named by the path of the nodes leading
-## to it.
+## [param player], as [[node, {animTreePath, state}]], a state named by the path of the nodes
+## leading to it.
 static func states_playing(root: Node, player: AnimationPlayer, animation_name: String) -> Array:
 	var found: Array = []
 	var trees: Array[Node] = root.find_children("*", "AnimationTree", true, false)
@@ -331,7 +376,9 @@ static func _collect_playing(
 	if node is AnimationNodeAnimation:
 		var plays: AnimationNodeAnimation = node
 		if plays.animation == StringName(animation_name):
-			found.append([plays, {"animTreePath": tree_path, "state": "." if at.is_empty() else at}])
+			found.append(
+				[plays, { "animTreePath": tree_path, "state": "." if at.is_empty() else at }]
+			)
 		return
 	var children: Dictionary = {}
 	if node is AnimationNodeStateMachine:
@@ -352,4 +399,6 @@ static func _collect_playing(
 			children[str(point)] = plane.get_blend_point_node(point)
 	for step: String in children:
 		var child: AnimationNode = children[step]
-		_collect_playing(child, step if at.is_empty() else at + "/" + step, tree_path, animation_name, found)
+		_collect_playing(
+			child, step if at.is_empty() else at + "/" + step, tree_path, animation_name, found
+		)

package/build/godot/addons/gdharness_editor/bridge_client.gd

@@ -1,6 +1,5 @@
 @tool
 extends Node
-
 ## The editor's end of the bridge: one WebSocket to the gdharness server, reconnected on its
 ## own when it drops, carrying tool requests in and their results out.
 
@@ -9,7 +8,6 @@ signal disconnected
 signal tool_requested(request_id: String, tool_name: String, args: Dictionary)
 
 const GdhRead = preload("reading.gd")
-
 const DEFAULT_URL: String = "ws://127.0.0.1:6505/godot"
 ## Written beside the addon by the install, so it names the version this copy came from.
 const VERSION_MARKER: String = "res://addons/gdharness_editor/.gdharness-version"
@@ -24,7 +22,6 @@ const EDITORS_RECORDED: String = "res://.godot/gdharness-editors"
 const EDITORS_RECORDED_PROTOCOL: int = 1
 const RECONNECT_DELAY: float = 3.0
 const MAX_RECONNECT_DELAY: float = 30.0
-
 ## What a server closes with when the editor that said hello belongs to another project. Kept in
 ## step with `OTHER_PROJECT_CLOSE_CODE` in src/godot-bridge.ts.
 const ELSEWHERE_CLOSE_CODE: int = 4001
@@ -32,7 +29,6 @@ const ELSEWHERE_CLOSE_CODE: int = 4001
 ## rather than an editor: dialling in again changes nothing for the rest of the run. Kept in step
 ## with `ONE_SHOT_CLOSE_CODE` in src/godot-bridge.ts.
 const ONE_SHOT_CLOSE_CODE: int = 4002
-
 ## Where Godot keeps the three ports an editor serves. None of them is per editor: the settings
 ## file is one for every editor of this engine version on the machine, so two open at once want the
 ## same three and the second one binds nothing. Read here and never written, for the reason
@@ -58,7 +54,6 @@ const OPENED_BY_A_SERVER: String = "GDHARNESS_OPENED_BY_A_SERVER"
 ## tells the two apart when both are announced at once. Kept in step with `EDITOR_PID_VARIABLE`
 ## in the runtime autoload.
 const EDITOR_PID_VARIABLE: String = "GDHARNESS_EDITOR_PID"
-
 ## How long one attempt is given before the address is called a bad one.
 ##
 ## A socket pointed at a port nothing holds gives up by itself, in thirty seconds on Windows. One
@@ -67,7 +62,6 @@ const EDITOR_PID_VARIABLE: String = "GDHARNESS_EDITOR_PID"
 ## timeout of its own in 4.7. A leftover announcement can be either, and a port that has been
 ## reused by some other program is the second.
 const CONNECT_TIMEOUT: float = 10.0
-
 ## How often the announcement is read again while connected, so a newer server is moved to
 ## rather than waited for. A harness reconnect leaves the server it replaced running and holding
 ## the old port, and an editor with no reason to look elsewhere stayed on it for the session.
@@ -75,13 +69,11 @@ const FOLLOW_INTERVAL: float = 5.0
 
 var socket: WebSocketPeer = WebSocketPeer.new()
 var server_url: String = DEFAULT_URL
-
 ## What this copy was when it loaded, which is what the editor is running until it is restarted.
 ## See [method _loaded_version] for why it is held rather than read when it is wanted.
 var version_at_load: String = ""
 ## The digest of the editor addon code this copy loaded, held for the same reason.
 var digest_at_load: String = ""
-
 var _is_connected: bool = false
 var _reconnect_timer: Timer
 var _current_reconnect_delay: float = RECONNECT_DELAY
@@ -89,27 +81,23 @@ var _current_reconnect_delay: float = RECONNECT_DELAY
 var _should_reconnect: bool = false
 var _project_path: String
 var _initialized: bool = false
-
 ## Whether the address came from a caller rather than from the project, in which case it is not
 ## this node's to change.
 var _named_by_caller: bool = false
 var _since_looked: float = 0.0
-
 ## The announced address that did not answer, so the fallback gets a turn. Cleared the moment
 ## anything connects or the project names a different one.
 var _refused_url: String = ""
 var _tried_announced: bool = false
-
 ## The address this editor has already been told is another project's, so a reconnect loop says it
 ## once rather than every few seconds for the rest of the session.
 var _told_about_url: String = ""
 var _connecting_for: float = 0.0
-
 ## Whether this editor was started by another editor, which is Godot's own restart and the project
 ## manager opening a project: the new editor is the old one's child and has its environment, with
 ## the variable this addon sets as it loads still naming the old one. Its arguments are gone, since
-## the engine consumes `--lsp-port`, `--dap-port` and `--log-file` and hands none of them back, so the
-## ports and the marker a server put in that environment describe the editor before this one.
+## the engine consumes `--lsp-port`, `--dap-port` and `--log-file` and hands none of them back, so
+## the ports and the marker a server put in that environment describe the editor before this one.
 var _started_by_an_editor: bool = false
 
 
@@ -140,45 +128,6 @@ func _exit_tree() -> void:
 		var _removed: Error = DirAccess.remove_absolute(record)
 
 
-## The file saying which ports this editor serves, named by its process id, so `gdharness lsp` can
-## find its language server when a server moved it off the default. One for each process rather
-## than one for the project, because a gate's `--import` loads this addon too, and its plugin is
-## shown none of the options that would say so; the reader tells the two apart by command line.
-## Kept in step with `editorRecordsIn` in src/lsp-bridge.ts.
-static func _ports_record() -> String:
-	return ProjectSettings.globalize_path(EDITORS_RECORDED).path_join("%d.json" % OS.get_process_id())
-
-
-func _record_ports() -> void:
-	if not Engine.is_editor_hint():
-		return
-	var made: Error = DirAccess.make_dir_recursive_absolute(ProjectSettings.globalize_path(EDITORS_RECORDED))
-	if made != OK and made != ERR_ALREADY_EXISTS:
-		return
-	var file: FileAccess = FileAccess.open(_ports_record(), FileAccess.WRITE)
-	if file == null:
-		return
-	var written: bool = (
-		file
-		. store_string(
-			(
-				JSON
-				. stringify(
-					{
-						"protocol": EDITORS_RECORDED_PROTOCOL,
-						"pid": OS.get_process_id(),
-						"lsp_port": _serves(LSP_ASKED, LSP_SETTING),
-						"dap_port": _serves(DAP_ASKED, DAP_SETTING),
-						"written_at_ms": int(Time.get_unix_time_from_system() * 1000.0),
-					}
-				)
-			)
-		)
-	)
-	if not written:
-		push_warning("gdharness: could not write " + _ports_record())
-
-
 func _process(_delta: float) -> void:
 	if not _initialized:
 		return
@@ -220,6 +169,49 @@ func _process(_delta: float) -> void:
 				_handle_disconnect()
 
 
+## The file saying which ports this editor serves, named by its process id, so `gdharness lsp` can
+## find its language server when a server moved it off the default. One for each process rather
+## than one for the project, because a gate's `--import` loads this addon too, and its plugin is
+## shown none of the options that would say so; the reader tells the two apart by command line.
+## Kept in step with `editorRecordsIn` in src/lsp-bridge.ts.
+static func _ports_record() -> String:
+	return ProjectSettings.globalize_path(EDITORS_RECORDED).path_join(
+		"%d.json" % OS.get_process_id()
+	)
+
+
+func _record_ports() -> void:
+	if not Engine.is_editor_hint():
+		return
+	var made: Error = DirAccess.make_dir_recursive_absolute(
+		ProjectSettings.globalize_path(EDITORS_RECORDED)
+	)
+	if made != OK and made != ERR_ALREADY_EXISTS:
+		return
+	var file: FileAccess = FileAccess.open(_ports_record(), FileAccess.WRITE)
+	if file == null:
+		return
+	var written: bool = (
+		file
+		. store_string(
+			(
+				JSON
+				. stringify(
+					{
+						"protocol": EDITORS_RECORDED_PROTOCOL,
+						"pid": OS.get_process_id(),
+						"lsp_port": _serves(LSP_ASKED, LSP_SETTING),
+						"dap_port": _serves(DAP_ASKED, DAP_SETTING),
+						"written_at_ms": int(Time.get_unix_time_from_system() * 1000.0),
+					}
+				)
+			)
+		)
+	)
+	if not written:
+		push_warning("gdharness: could not write " + _ports_record())
+
+
 ## Moves to the server the project now names, when that is not the one this is talking to.
 ##
 ## A harness reconnect leaves the server it replaced running, still holding the port it bound and
@@ -371,7 +363,7 @@ func _handle_connect() -> void:
 			# as itself: the engine hands back none of the arguments it was given, so the arguments
 			# have to come from whoever wrote them. See `restart_editor` in play_tools.gd.
 			"opened_by_a_server": _opened_by_a_server() and not _started_by_an_editor,
-			"started_by_an_editor": _started_by_an_editor
+			"started_by_an_editor": _started_by_an_editor,
 		}
 	)
 
@@ -556,7 +548,7 @@ func _handle_message(json_string: String) -> void:
 
 	match message.get("type", ""):
 		"ping":
-			_send_message({"type": "pong"})
+			_send_message({ "type": "pong" })
 
 		"tool_invoke":
 			var request_id: String = message.get("id", "")
@@ -577,13 +569,16 @@ func send_busy(request_id: String, tool_name: String) -> void:
 			"id": request_id,
 			"success": false,
 			"busy": true,
-			"error": "The editor is scanning or importing its files, so %s was not run." % tool_name,
+			"error":
+			"The editor is scanning or importing its files, so %s was not run." % tool_name,
 		}
 	)
 
 
-func send_tool_result(request_id: String, success: bool, result: Variant = null, error: String = "") -> void:
-	var response: Dictionary = {"type": "tool_result", "id": request_id, "success": success}
+func send_tool_result(
+	request_id: String, success: bool, result: Variant = null, error: String = ""
+) -> void:
+	var response: Dictionary = { "type": "tool_result", "id": request_id, "success": success }
 
 	if success:
 		response["result"] = result