gdharness 1.2.41 → 1.3.0

package/build/godot/addons/gdharness_editor/tools/scene_tools.gd

@@ -5,22 +5,14 @@ extends Node
 
 const FileReads = preload("../file_reads.gd")
 const Read = preload("../reading.gd")
+const Kin = preload("scene_kin.gd")
+const Paths = preload("scene_paths.gd")
 const Placing = preload("scene_placing.gd")
 const PropertyValues = preload("../property_values.gd")
 const ResourceTools = preload("resource_tools.gd")
 const SceneFile = preload("../scene_file.gd")
 const Serialisation = preload("../serialisation.gd")
 
-## The names Object.ConnectFlags gives each bit. The number alone left a reader guessing that 2 is
-## the persistence every connection in a saved scene carries.
-const CONNECT_FLAG_NAMES: Dictionary[int, String] = {
-	Object.CONNECT_DEFERRED: "deferred",
-	Object.CONNECT_PERSIST: "persist",
-	Object.CONNECT_ONE_SHOT: "one_shot",
-	Object.CONNECT_REFERENCE_COUNTED: "reference_counted",
-	Object.CONNECT_APPEND_SOURCE_OBJECT: "append_source_object",
-}
-
 var _editor_plugin: EditorPlugin = null
 var _values: Serialisation = Serialisation.new()
 var _properties: PropertyValues = PropertyValues.new()
@@ -30,19 +22,6 @@ func set_editor_plugin(plugin: EditorPlugin) -> void:
 	_editor_plugin = plugin
 
 
-## Each bit set in [param flags] by name, and whatever bits are left unnamed as one number.
-static func _flag_names(flags: int) -> Array[String]:
-	var names: Array[String] = []
-	var rest: int = flags
-	for bit: int in CONNECT_FLAG_NAMES:
-		if flags & bit:
-			names.append(CONNECT_FLAG_NAMES[bit])
-			rest &= ~bit
-	if rest != 0:
-		names.append(str(rest))
-	return names
-
-
 func _ensure_res_path(path: String) -> String:
 	if not path.begins_with("res://"):
 		return "res://" + path
@@ -175,17 +154,42 @@ func _collect_nodes_recursive(node: Node, path: String, out_nodes: Array) -> voi
 		_collect_nodes_recursive(child, child_path, out_nodes)
 
 
+func _inherited(args: Dictionary) -> Dictionary:
+	var project_path: String = str(args.get("projectPath", ""))
+	var script_path: String = str(args.get("script", ""))
+	return Kin.inherited(
+		args,
+		_new_scene_path(args),
+		_to_scene_res_path(project_path, str(args.get("inherits", ""))),
+		"" if script_path.is_empty() else _to_scene_res_path(project_path, script_path)
+	)
+
+
+## The res:// path a create in [param args] writes, given .tscn when it has no extension, or "".
+func _new_scene_path(args: Dictionary) -> String:
+	var scene_path: String = _to_scene_res_path(
+		str(args.get("projectPath", "")), str(args.get("scenePath", ""))
+	)
+	if scene_path == "res://":
+		return ""
+	return scene_path if scene_path.ends_with(".tscn") else scene_path + ".tscn"
+
+
 func create_scene(args: Dictionary) -> Dictionary:
+	if str(args.get("inherits", "")).is_empty():
+		return _create_of_a_class(args)
+	return _inherited(args)
+
+
+func _create_of_a_class(args: Dictionary) -> Dictionary:
 	var project_path: String = str(args.get("projectPath", ""))
-	var scene_path: String = _to_scene_res_path(project_path, str(args.get("scenePath", "")))
+	var scene_path: String = _new_scene_path(args)
 	var root_node_type: String = str(args.get("rootNodeType", "Node"))
 	var root_node_name: String = str(args.get("rootNodeName", root_node_type))
 	var script_path: String = str(args.get("script", ""))
 
-	if scene_path == "res://":
+	if scene_path.is_empty():
 		return {"ok": false, "error": "Missing scenePath"}
-	if not scene_path.ends_with(".tscn"):
-		scene_path += ".tscn"
 	var asked_type: String = root_node_type
 	var made: Dictionary = SceneFile.made_as(
 		root_node_type,
@@ -208,19 +212,8 @@ func create_scene(args: Dictionary) -> Dictionary:
 	var unfit: String = SceneFile.unfit_name(root_node_name)
 	if not unfit.is_empty():
 		return {"ok": false, "error": unfit}
-	# Saving over a scene that is there replaced it, nodes and all, and answered as a new scene.
 	if FileAccess.file_exists(scene_path):
-		return {
-			"ok": false,
-			"error":
-			(
-				(
-					"%s already exists, and scene_create op=create would replace everything in it. Edit it "
-					+ "with scene_node, or create the scene under another path."
-				)
-				% scene_path
-			)
-		}
+		return Kin.taken(scene_path)
 
 	var root: Node = ClassDB.instantiate(root_node_type)
 	root.name = root_node_name
@@ -395,6 +388,8 @@ func delete_node(args: Dictionary) -> Dictionary:
 	var at: String = scene.path_of(node)
 	node.get_parent().remove_child(node)
 	node.free()
+	var carried: Paths = Paths.new()
+	var _rewritten: int = carried.carry(scene, {at: ""})
 
 	var written: Dictionary = scene.write(
 		func(saved: Node) -> String:
@@ -405,7 +400,9 @@ func delete_node(args: Dictionary) -> Dictionary:
 	if not written.is_empty():
 		return written
 
-	return {"ok": true, "deletedNodePath": at}
+	var answer: Dictionary = {"ok": true, "deletedNodePath": at}
+	answer.merge(Kin.follow(scene_path, at, "", carried))
+	return answer
 
 
 func duplicate_node(args: Dictionary) -> Dictionary:
@@ -413,7 +410,7 @@ func duplicate_node(args: Dictionary) -> Dictionary:
 	var scene_path: String = _to_scene_res_path(project_path, str(args.get("scenePath", "")))
 	var node_path: String = str(args.get("nodePath", ""))
 	var new_name: String = str(args.get("newName", ""))
-	var parent_path: String = str(args.get("parentPath", ""))
+	var parent_path: String = str(args.get("parentNodePath", ""))
 
 	if node_path.is_empty() or new_name.is_empty():
 		return {"ok": false, "error": "Missing nodePath or newName"}
@@ -458,6 +455,7 @@ func duplicate_node(args: Dictionary) -> Dictionary:
 	scene.copied(copies)
 
 	var new_path: String = scene.path_of(duplicated_node)
+	var placed: Array = [scene.path_of(target_parent), duplicated_node.get_index()]
 	var written: Dictionary = scene.write(
 		func(saved: Node) -> String:
 			if saved.get_node_or_null(new_path) == null:
@@ -467,7 +465,14 @@ func duplicate_node(args: Dictionary) -> Dictionary:
 	if not written.is_empty():
 		return written
 
-	return {"ok": true, "nodePath": node_path, "newName": new_name, "newNodePath": new_path}
+	return {
+		"ok": true,
+		"nodePath": node_path,
+		"newName": new_name,
+		"newNodePath": new_path,
+		"parentNodePath": placed[0],
+		"index": placed[1],
+	}
 
 
 func reparent_node(args: Dictionary) -> Dictionary:
@@ -525,6 +530,8 @@ func reparent_node(args: Dictionary) -> Dictionary:
 
 	var new_path: String = scene.path_of(node)
 	var index: int = node.get_index()
+	var carried: Paths = Paths.new()
+	var _rewritten: int = carried.carry(scene, {old_path: new_path} if new_path != old_path else {})
 	var written: Dictionary = scene.write(
 		func(saved: Node) -> String:
 			var copy: Node = saved.get_node_or_null(new_path)
@@ -537,15 +544,19 @@ func reparent_node(args: Dictionary) -> Dictionary:
 			return ""
 	)
 	if not written.is_empty():
+		carried.put_back(scene_path)
 		return written
 
-	return {
+	var answer: Dictionary = {
 		"ok": true,
 		"nodePath": old_path,
 		"newParentPath": new_parent_path,
 		"newNodePath": new_path,
 		"index": index,
 	}
+	if new_path != old_path:
+		answer.merge(Kin.follow(scene_path, old_path, new_path, carried))
+	return answer
 
 
 func set_node_properties(args: Dictionary) -> Dictionary:
@@ -553,6 +564,9 @@ func set_node_properties(args: Dictionary) -> Dictionary:
 	var scene_path: String = _to_scene_res_path(project_path, str(args.get("scenePath", "")))
 	var node_path: String = str(args.get("nodePath", "."))
 	var properties: Dictionary = _parse_properties_arg(args.get("properties", {}))
+	var editable: Variant = args.get("editableChildren")
+	if properties.is_empty() and editable == null:
+		return {"ok": false, "error": "set takes properties, editableChildren, or both."}
 
 	var opened: Array = _open(scene_path, true)
 	var scene: SceneFile = opened[0]
@@ -574,6 +588,15 @@ func set_node_properties(args: Dictionary) -> Dictionary:
 		if not unusable.is_empty():
 			return scene.refuse(unusable)
 
+	var dropped: Dictionary = {}
+	if editable != null:
+		var not_an_instance: String = Kin.set_editable(scene, node, Read.as_bool(editable))
+		if not not_an_instance.is_empty():
+			return scene.refuse(not_an_instance)
+		if not Read.as_bool(editable):
+			dropped = scene.held_under(scene.path_of(node))
+
+	var old_path: String = scene.path_of(node)
 	scene.asked(node, properties.keys())
 	var refused_property: String = _properties.write_all(node, properties)
 	if not refused_property.is_empty():
@@ -583,13 +606,29 @@ func set_node_properties(args: Dictionary) -> Dictionary:
 	for key: Variant in properties:
 		held[str(key)] = _readable(node, _properties.read_at(node, str(key)))
 	var new_path: String = scene.path_of(node)
+	var carried: Paths = Paths.new()
+	var _rewritten: int = carried.carry(scene, {old_path: new_path} if new_path != old_path else {})
 	var written: Dictionary = scene.write(
-		func(saved: Node) -> String: return _kept(scene, saved, node, properties.keys())
+		func(saved: Node) -> String:
+			var unkept: String = _kept(scene, saved, node, properties.keys())
+			if unkept.is_empty() and editable != null:
+				if saved.is_editable_instance(saved.get_node(new_path)) != Read.as_bool(editable):
+					return "%s would load with editableChildren %s." % [new_path, not Read.as_bool(editable)]
+			return unkept
 	)
 	if not written.is_empty():
+		carried.put_back(scene_path)
 		return written
 
-	return {"ok": true, "nodePath": new_path, "properties": held}
+	var answer: Dictionary = {"ok": true, "nodePath": new_path, "properties": held}
+	if editable != null:
+		answer["editableChildren"] = Read.as_bool(editable)
+	if not dropped.is_empty():
+		answer["droppedValues"] = dropped["values"]
+		answer["droppedNodes"] = dropped["nodes"]
+	if new_path != old_path:
+		answer.merge(Kin.follow(scene_path, old_path, new_path, carried))
+	return answer
 
 
 func get_node_properties(args: Dictionary) -> Dictionary:
@@ -614,8 +653,11 @@ func get_node_properties(args: Dictionary) -> Dictionary:
 	# names this scene's file sets are always answered.
 	var props: Dictionary = _properties_of(node, include_defaults, scene.set_here(node))
 	var cells: Dictionary = ResourceTools.cells_of(node)
-	scene.close()
 	var answer: Dictionary = {"ok": true, "nodePath": node_path, "properties": props}
+	if node != scene.root and node.owner != null and not node.scene_file_path.is_empty():
+		answer["instanceOf"] = node.scene_file_path
+		answer["editableChildren"] = scene.root.is_editable_instance(node)
+	scene.close()
 	# Only an editor holds anything unsaved; a headless engine answering false would say it looked.
 	if Engine.is_editor_hint():
 		answer["unsavedInEditor"] = SceneFile.unsaved(scene_path)
@@ -770,7 +812,7 @@ func connect_signal(args: Dictionary) -> Dictionary:
 		"targetNodePath": to,
 		"methodName": method_name,
 		"flags": saved_flags[0],
-		"flagNames": _flag_names(Read.as_int(saved_flags[0])),
+		"flagNames": SceneFile.flag_names(Read.as_int(saved_flags[0])),
 		# Connected either way, as the editor's own dialog allows, since the method may be written
 		# next; a caller told nothing learnt of a misspelt one only when the signal fired.
 		"methodFound": method_found
@@ -781,7 +823,7 @@ func connect_signal(args: Dictionary) -> Dictionary:
 	if flags_before >= 0:
 		answer["alreadyConnected"] = true
 		if flags_before != Read.as_int(saved_flags[0]):
-			answer["flagsBefore"] = _flag_names(flags_before)
+			answer["flagsBefore"] = SceneFile.flag_names(flags_before)
 	return answer
 
 
@@ -934,7 +976,7 @@ func list_connections(args: Dictionary) -> Dictionary:
 							"targetNodePath": target_path,
 							"methodName": str(callable.get_method()),
 							"flags": flags,
-							"flagNames": _flag_names(flags),
+							"flagNames": SceneFile.flag_names(flags),
 							# False for a connection an instanced scene makes inside itself, which only that
 							# scene can change.
 							"editable": editable

package/build/godot/addons/gdharness_runtime/reading.gd

@@ -22,6 +22,9 @@ extends RefCounted
 # number was expected. Absent keys never reach here: the callers pass their own default to
 # `Dictionary.get`, so what arrives is that default.
 
+## How many of a node's children a refusal for a path missing below it names.
+const NAMED_CHILDREN: int = 12
+
 
 static func as_int(value: Variant, fallback: int = 0) -> int:
 	if value is int:
@@ -114,3 +117,25 @@ static func from_the_root(said: String, node_path: String, root_name: String) ->
 	if not rest.is_empty():
 		how += ', so this one is "%s"' % rest
 	return "%s%s %s." % [said, "" if said.ends_with(".") else ".", how]
+
+
+## [param said], the refusal for a path a scene does not have, with where the path leaves it: the
+## last node of the path it has, [param reached] from the root, called [param root_name], when that
+## is empty; the name below it that is missing; and [param children], the names that node has, as
+## after a node was moved or renamed. Names up to [constant NAMED_CHILDREN] of them.
+static func missing_below(
+	said: String, root_name: String, reached: PackedStringArray, missing: String, children: PackedStringArray
+) -> String:
+	var shown: String = ", ".join(children.slice(0, NAMED_CHILDREN))
+	if children.size() > NAMED_CHILDREN:
+		shown += " and %d more" % (children.size() - NAMED_CHILDREN)
+	return (
+		"%s%s %s has no %s; %s."
+		% [
+			said,
+			"" if said.ends_with(".") else ".",
+			"The root, %s," % root_name if reached.is_empty() else "/".join(reached),
+			missing,
+			"its children are " + shown if not children.is_empty() else "it has no children",
+		]
+	)

package/build/godot/addons/gdharness_runtime/runtime_autoload.gd

@@ -23,7 +23,7 @@ const Typing = preload("runtime_typing.gd")
 const Values = preload("runtime_values.gd")
 const Waits = preload("runtime_waits.gd")
 
-const PROTOCOL: int = 2
+const PROTOCOL: int = 3
 const DEFAULT_BIND_ADDRESS: String = "127.0.0.1"
 const BIND_ADDRESS_SETTING: String = "gdharness/runtime/bind_address"
 ## 0 asks the operating system for a free port, which is the default and what the server
@@ -502,7 +502,7 @@ func _announce(bind_address: String) -> void:
 	# Written whole under a name no server reads and moved into place, so no look ever meets
 	# the file empty: a server sweeping the directory between an open and a write took the
 	# announcement for a dead game's leftover, and the directory is shared by every server on
-	# the machine, older ones included.
+	# the machine.
 	var staged: String = path + ".tmp"
 	var file: FileAccess = FileAccess.open(staged, FileAccess.WRITE)
 	if file == null:

package/build/godot/addons/gdharness_runtime/runtime_capture.gd

@@ -36,6 +36,35 @@ func capture_viewport(params: Dictionary) -> Dictionary:
 	if not node is Viewport:
 		return {"type": "error", "message": "Node is not a Viewport: " + viewport_path}
 	var viewport: Viewport = node
+	# The root's own state is refused in _capture. Another window of the game's that is hidden or
+	# minimised holds no frame, and asking it for its image makes the engine log the empty read into
+	# the game's output, so the run would stop unclean for an error the capture raised.
+	if viewport is Window and viewport != _host.get_tree().root:
+		var window: Window = viewport
+		if not window.visible:
+			return {
+				"type": "error",
+				"message":
+				(
+					(
+						"The Window at %s is hidden, so nothing is drawn to it. Show it (its visible "
+						+ "property) and ask again."
+					)
+					% viewport_path
+				),
+			}
+		if not window.can_draw():
+			return {
+				"type": "error",
+				"message":
+				(
+					(
+						"Nothing is being drawn to the Window at %s, which is minimised. Restore it and "
+						+ "ask again."
+					)
+					% viewport_path
+				),
+			}
 	if not viewport is SubViewport:
 		return await _capture(viewport, params)
 	# Drawn now rather than taken as it stands. A SubViewport the game does not redraw every frame

package/build/godot/addons/gdharness_runtime/runtime_input.gd

@@ -284,7 +284,7 @@ func _glyph_of(keycode: Key, shifted: bool) -> int:
 ## `pressed` is how a caller asks for one half, the way a drag is made: true holds the button down,
 ## false lets go of one being held.
 func inject_mouse_click(params: Dictionary) -> Dictionary:
-	var point: Variant = Mouse.read_point(params, "x", "y", "position")
+	var point: Variant = Mouse.read_point(params, "x", "y")
 	if point is String:
 		return {"type": "error", "message": point}
 	var position: Vector2 = point
@@ -349,7 +349,7 @@ func inject_mouse_click(params: Dictionary) -> Dictionary:
 ## would have carried. A relative the caller gives is kept, since a game may want to read a motion
 ## the position does not show.
 func inject_mouse_motion(params: Dictionary) -> Dictionary:
-	var point: Variant = Mouse.read_point(params, "x", "y", "position")
+	var point: Variant = Mouse.read_point(params, "x", "y")
 	if point is String:
 		return {"type": "error", "message": point}
 	var position: Vector2 = point
@@ -358,11 +358,6 @@ func inject_mouse_motion(params: Dictionary) -> Dictionary:
 		relative = Vector2(
 			Read.as_float(params.get("relativeX", 0.0)), Read.as_float(params.get("relativeY", 0.0))
 		)
-	elif params.has("relative"):
-		var movement: Variant = Mouse.read_point(params, "relativeX", "relativeY", "relative")
-		if movement is String:
-			return {"type": "error", "message": movement}
-		relative = movement
 
 	var supplied: bool = _follow_in_the_window(position)
 	Input.parse_input_event(_motion(position, relative))

package/build/godot/addons/gdharness_runtime/runtime_mouse.gd

@@ -6,20 +6,12 @@ extends RefCounted
 const Read = preload("reading.gd")
 
 
-## A point the tool schema sends as two flat numbers, or the older form of one [x, y] value.
-## Answers a Vector2, or the String that says what was wrong with it.
-static func read_point(params: Dictionary, x_key: String, y_key: String, pair_key: String) -> Variant:
-	if params.has(x_key) and params.has(y_key):
-		return Vector2(Read.as_float(params[x_key]), Read.as_float(params[y_key]))
-	var raw: Variant = params.get(pair_key, Vector2.ZERO)
-	if raw is Vector2:
-		return raw
-	if raw is Array:
-		var pair: Array = raw
-		if pair.size() < 2:
-			return "%s array must contain [x, y]" % pair_key
-		return Vector2(Read.as_float(pair[0]), Read.as_float(pair[1]))
-	return "%s must be Vector2 or [x, y]" % pair_key
+## A point the tool schema sends as two flat numbers. Answers a Vector2, or the String that says
+## which was missing.
+static func read_point(params: Dictionary, x_key: String, y_key: String) -> Variant:
+	if not params.has(x_key) or not params.has(y_key):
+		return "%s and %s are both needed." % [x_key, y_key]
+	return Vector2(Read.as_float(params[x_key]), Read.as_float(params[y_key]))
 
 
 ## The points of a drag: x, y, then each of via, then toX, toY. Answers the String saying what is

package/build/godot/addons/gdharness_runtime/serialisation.gd

@@ -664,8 +664,12 @@ func _serialize_array(value: Array) -> Array:
 
 # Base64 rather than a list of numbers. A byte array is a texture, a sound or a save file often
 # enough that the list would be the whole answer, megabytes of it, and unreadable either way.
+#
+# The engine's encoder raises an error on an empty array, and an empty tile_map_data is every
+# TileMapLayer with nothing painted yet, so a read of one carried an engine error in its answer.
 func _serialize_bytes(value: PackedByteArray) -> Dictionary:
-	return {"base64": Marshalls.raw_to_base64(value), "size": value.size(), "_type": "PackedByteArray"}
+	var text: String = "" if value.is_empty() else Marshalls.raw_to_base64(value)
+	return {"base64": text, "size": value.size(), "_type": "PackedByteArray"}
 
 
 # The packed vector and colour arrays, each element serialised the way one of them on its own is.

package/build/godot/operations/animation_reads.gd

@@ -62,10 +62,13 @@ static func _bare(scene_path: String, node_path: String, kind: String) -> Array:
 	var type: String = str(read.get("type", ""))
 	if not ClassDB.class_exists(type) or not ClassDB.is_parent_class(type, kind):
 		var said: String = "%s not found at: %s" % [kind, node_path]
-		if read.is_empty() and FileReads.scene_node(scene_path, node_path.get_slice("/", 0)).is_empty():
-			said = Read.from_the_root(
-				said, node_path, str(FileReads.scene_node(scene_path, ".").get("name", ""))
-			)
+		if read.is_empty():
+			var hinted: String = said
+			if FileReads.scene_node(scene_path, node_path.get_slice("/", 0)).is_empty():
+				hinted = Read.from_the_root(
+					said, node_path, str(FileReads.scene_node(scene_path, ".").get("name", ""))
+				)
+			said = hinted if hinted != said else FileReads.missing_from(said, scene_path, node_path)
 		return [null, {"ok": false, "error": said}]
 	var bare: Node = ClassDB.instantiate(type)
 	bare.name = str(read["name"])

package/build/godot/operations/editor_tools.gd

@@ -10,6 +10,7 @@ extends RefCounted
 const AnimationTools = preload("../addons/gdharness_editor/tools/animation_tools.gd")
 const ResourceTools = preload("../addons/gdharness_editor/tools/resource_tools.gd")
 const SceneTools = preload("../addons/gdharness_editor/tools/scene_tools.gd")
+const SceneFile = preload("../addons/gdharness_editor/scene_file.gd")
 
 const SCENE_COMMANDS: Array[String] = [
 	"create_scene",
@@ -60,7 +61,24 @@ static func run(params: Dictionary) -> Dictionary:
 	var answer: Variant = tools.call(command, arguments)
 	tools.free()
 	if answer is Dictionary:
-		return answer
+		var answered: Dictionary = answer
+		if not SceneFile.by_path.is_empty():
+			answered["namedByPath"] = (
+				(
+					"%s %s named by path rather than by uid. A uid in a file's own header is resolved "
+					+ "through the project's uid cache, which holds none for %s yet, as with a file "
+					+ "made since the project was last scanned, and a uid it does not hold would warn "
+					+ "on every load. project_import refresh_uids scans the project, and writes after "
+					+ "it name %s by uid."
+				)
+				% [
+					", ".join(SceneFile.by_path),
+					"is" if SceneFile.by_path.size() == 1 else "are",
+					"it" if SceneFile.by_path.size() == 1 else "them",
+					"it" if SceneFile.by_path.size() == 1 else "them",
+				]
+			)
+		return answered
 	return {
 		"ok": false, "error": "%s answered %s rather than an object." % [command, type_string(typeof(answer))]
 	}