gdharness 1.3.0 → 1.3.2

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

@@ -23,14 +23,14 @@ extends RefCounted
 ## setter setting scale were both saved into the file by a write to another node, and a root whose
 ## script failed in [code]_init[/code] was saved without it. Outside the editor, then, what a node
 ## stores is put back to what the file holds wherever the tool did not ask for a change, before
-## anything is saved, and a write is refused when that does not hold. See [HeadlessCheck].
+## anything is saved, and a write is refused when that does not hold. See [GdhHeadlessCheck].
 
-const HeadlessCheck = preload("headless_check.gd")
+const GdhHeadlessCheck = preload("headless_check.gd")
 
 ## How many times what scripts changed is put back before a write is refused for it.
 const PUTTING_BACK_PASSES: int = 4
-const PropertyValues = preload("property_values.gd")
-const Read = preload("reading.gd")
+const GdhPropertyValues = preload("property_values.gd")
+const GdhRead = preload("reading.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] = {
@@ -135,12 +135,12 @@ func asked(node: Node, names: Array) -> void:
 	var id: int = node.get_instance_id()
 	var on: Dictionary = _asked.get_or_add(id, {})
 	if not _before.has(id):
-		_before[id] = HeadlessCheck.stored(node)
+		_before[id] = GdhHeadlessCheck.stored(node)
 	for name: Variant in names:
 		var property: String = str(name)
 		on[property] = true
 		on[property.get_slice(":", 0)] = true
-		_reached.merge(HeadlessCheck.reached(node, property))
+		_reached.merge(GdhHeadlessCheck.reached(node, property))
 
 
 ## Takes [param resource], built into the scene, as one the tool changed, which a write saves as it is.
@@ -199,7 +199,7 @@ func not_found(said: String, node_path: String) -> String:
 	if root == null:
 		return said
 	if not root.has_node(NodePath(node_path.get_slice("/", 0))):
-		var hinted: String = Read.from_the_root(said, node_path, str(root.name))
+		var hinted: String = GdhRead.from_the_root(said, node_path, str(root.name))
 		if hinted != said:
 			return hinted
 	var parts: PackedStringArray = node_path.trim_prefix("./").split("/", false)
@@ -216,7 +216,7 @@ func not_found(said: String, node_path: String) -> String:
 	var names: PackedStringArray = []
 	for child: Node in at.get_children():
 		var _named: bool = names.append(str(child.name))
-	return Read.missing_below(said, str(root.name), reached, parts[reached.size()], names)
+	return GdhRead.missing_below(said, str(root.name), reached, parts[reached.size()], names)
 
 
 func close() -> void:
@@ -477,7 +477,7 @@ func kept(saved: Node, loaded: Variant, given: Variant) -> bool:
 		var loaded_node: Node = loaded
 		var given_node: Node = given
 		return str(saved.get_path_to(loaded_node)) == str(root.get_path_to(given_node))
-	return PropertyValues.same(loaded, given)
+	return GdhPropertyValues.same(loaded, given)
 
 
 ## Packs [member root], has [param check] read the result as the file will hold it, and writes the
@@ -508,7 +508,7 @@ func write(check: Callable = Callable()) -> Dictionary:
 						)
 						% path
 					)
-					+ HeadlessCheck.REMEDY
+					+ GdhHeadlessCheck.REMEDY
 				)
 			)
 	if check.is_valid():
@@ -530,12 +530,14 @@ func write(check: Callable = Callable()) -> Dictionary:
 	var values: Array = []
 	for index: int in state.get_node_count():
 		values.append_array(_stored_at(state, index).values())
-	var unkept: String = HeadlessCheck.settle_saved(
+	var unkept: String = GdhHeadlessCheck.settle_saved(
 		path, _text, values, null, {}, _reached, func() -> Error: return save_keeping_uid(packed, path)
 	)
 	if unkept.is_empty():
 		return {}
-	return {"ok": false, "error": "Nothing was written: " + unkept + HeadlessCheck.put_back(path, previous)}
+	return {
+		"ok": false, "error": "Nothing was written: " + unkept + GdhHeadlessCheck.put_back(path, previous)
+	}
 
 
 func _holds_scripted_embedded() -> bool:
@@ -543,7 +545,7 @@ func _holds_scripted_embedded() -> bool:
 	var nodes: Array[Node] = [root]
 	while not nodes.is_empty():
 		var node: Node = nodes.pop_back()
-		if HeadlessCheck.holds_scripted_embedded(node, seen):
+		if GdhHeadlessCheck.holds_scripted_embedded(node, seen):
 			return true
 		nodes.append_array(node.get_children())
 	return false
@@ -742,7 +744,7 @@ func _settled(packed: PackedScene) -> Array:
 			var node: Node = found[0]
 			var before: Dictionary = _before[node.get_instance_id()]
 			for name: String in found[1]:
-				node.set(name, before.get(name, HeadlessCheck.default_of(node, name)))
+				node.set(name, before.get(name, GdhHeadlessCheck.default_of(node, name)))
 		current = PackedScene.new()
 		var packing: Error = current.pack(root)
 		if packing != OK:
@@ -766,10 +768,10 @@ func _moved_by_scripts() -> Array[Array]:
 		if node == null or not root.is_ancestor_of(node) and node != root:
 			continue
 		var on: Dictionary = _asked[id]
-		if not HeadlessCheck.through_script(node, on):
+		if not GdhHeadlessCheck.through_script(node, on):
 			continue
 		var before: Dictionary = _before[id]
-		var changed: Array[String] = HeadlessCheck.differing(node, before, on)
+		var changed: Array[String] = GdhHeadlessCheck.differing(node, before, on)
 		if not changed.is_empty():
 			moved.append([node, changed])
 	return moved
@@ -792,7 +794,10 @@ func _strays(state: SceneState) -> Array[Array]:
 		# changes is Godot's doing and the editor's pack does it too: a Control saved without its
 		# grow directions gets them back from anchors_preset's setter, and loses an anchors_preset
 		# its layout mode does not store.
-		if not HeadlessCheck.untooled(node.get_script()) and not HeadlessCheck.untooled(filed.get("script")):
+		if (
+			not GdhHeadlessCheck.untooled(node.get_script())
+			and not GdhHeadlessCheck.untooled(filed.get("script"))
+		):
 			continue
 		var stored: Dictionary = _stored_at(state, index)
 		var names: Dictionary = filed.duplicate()
@@ -800,9 +805,9 @@ func _strays(state: SceneState) -> Array[Array]:
 		for key: Variant in names:
 			var name: String = str(key)
 			var held: bool = filed.has(name)
-			if held == stored.has(name) and (not held or PropertyValues.same(stored[name], filed[name])):
+			if held == stored.has(name) and (not held or GdhPropertyValues.same(stored[name], filed[name])):
 				continue
-			if not held and HeadlessCheck.at_default(node, name):
+			if not held and GdhHeadlessCheck.at_default(node, name):
 				continue
 			stray.append([node, name, held, filed.get(name)])
 	return stray
@@ -819,7 +824,7 @@ func _stray_text(node: Node, name: String) -> String:
 				)
 				% [at, path]
 			)
-			+ HeadlessCheck.REMEDY
+			+ GdhHeadlessCheck.REMEDY
 		)
 	return (
 		(
@@ -830,7 +835,7 @@ func _stray_text(node: Node, name: String) -> String:
 			)
 			% [at, name, path]
 		)
-		+ HeadlessCheck.REMEDY
+		+ GdhHeadlessCheck.REMEDY
 	)
 
 
@@ -845,7 +850,7 @@ func _unset_value(node: Node, name: String) -> Variant:
 	while top != root and top.owner != root:
 		top = top.get_parent()
 	if top == root or top.scene_file_path.is_empty():
-		return HeadlessCheck.default_of(node, name)
+		return GdhHeadlessCheck.default_of(node, name)
 	if _base_paths.has(path_of(top)):
 		return _value_in(base, path_of(node), node, name)
 	var instanced: PackedScene = ResourceLoader.load(top.scene_file_path) as PackedScene
@@ -881,7 +886,7 @@ func _value_in(state: SceneState, at: String, node: Node, name: String) -> Varia
 			state = instanced.get_state()
 		else:
 			state = state.get_base_scene_state()
-	return HeadlessCheck.default_of(node, name)
+	return GdhHeadlessCheck.default_of(node, name)
 
 
 func _node_at(node_path: String) -> Node:

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

@@ -8,7 +8,8 @@ extends RefCounted
 ## before: the same Vector2 came back three ways depending on which tool was asked, and a caller
 ## reading a property off the editor could not feed it back to the game.
 
-const Read = preload("reading.gd")
+const GdhRead = preload("reading.gd")
+const GdhShapes = preload("value_shapes.gd")
 
 # What the engine carries from one to another without complaint, which is what a value written to a
 # property or handed to a parameter may arrive as. Numbers include bool because the engine counts it
@@ -120,35 +121,6 @@ const BUILDERS: Dictionary = {
 	"Dictionary": "_build_dictionary",
 }
 
-# What each tag has to carry before it is built. A tag naming a type whose keys are not there is a
-# tag somebody wrote by mistake or wrote for a different shape, and building one out of defaults
-# answers with a Transform2D of zeros where the caller meant something else entirely. Unbuilt, it
-# comes back as it arrived, and whoever asked can read it against the type they were expecting.
-const REQUIRED: Dictionary = {
-	"Vector2": [["x", "y"]],
-	"Vector2i": [["x", "y"]],
-	"Vector3": [["x", "y", "z"]],
-	"Vector3i": [["x", "y", "z"]],
-	"Vector4": [["x", "y", "z", "w"]],
-	"Vector4i": [["x", "y", "z", "w"]],
-	"Rect2": [["position", "size"], ["x", "y", "width", "height"]],
-	"Rect2i": [["position", "size"], ["x", "y", "width", "height"]],
-	"Plane": [["normal", "d"]],
-	"Quaternion": [["x", "y", "z", "w"]],
-	"AABB": [["position", "size"]],
-	"Basis": [["x", "y", "z"]],
-	"Transform2D": [["x", "y", "origin"]],
-	"Transform3D": [["basis", "origin"]],
-	"Projection": [["x", "y", "z", "w"]],
-	"Color": [["r", "g", "b"]],
-	"NodePath": [["path"]],
-	"PackedByteArray": [["base64"]],
-	"float": [["value"]],
-	"int": [["value"]],
-	"RID": [["id"]],
-	"Dictionary": [["entries"]],
-}
-
 
 # Converts a Godot value into something JSON can carry. A type with no entry in the table
 # passes through as itself, which is what the JSON-native ones want.
@@ -246,8 +218,8 @@ func deserialize_value(value: Variant) -> Variant:
 	# under the target project's warning levels, so one such project lost every headless call.
 	var tag: String = str(fields["_type"])
 	var builder: String = BUILDERS.get(tag, "")
-	var needed: Array = REQUIRED.get(tag, [])
-	if builder.is_empty() or not _carries(fields, needed):
+	var spare: Array = GdhShapes.spare(fields, tag)
+	if builder.is_empty() or not spare.any(func(left: Array) -> bool: return left.is_empty()):
 		return fields
 	if tag == "float" and str(fields["value"]) not in ["inf", "-inf", "nan"]:
 		return fields
@@ -430,9 +402,18 @@ func fitted(value: Variant, type: int) -> Variant:
 	if rebuilt is Array and LIST_TYPES.has(type):
 		return type_convert(rebuilt, type)
 
+	# The inspector and every colour picker give a colour as its html code. Anything else stays the
+	# text it is, for the refusal to name.
+	if type == TYPE_COLOR and rebuilt is String and Color.html_is_valid(str(rebuilt)):
+		return Color.html(str(rebuilt))
+
 	var simple: Array[int] = [TYPE_BOOL, TYPE_INT, TYPE_FLOAT, TYPE_STRING]
 	if not simple.has(type) or not simple.has(typeof(rebuilt)):
 		return rebuilt
+	# A number or a truth value stays as sent where text is wanted, for the refusal to name. Converted,
+	# 1 arrived as the double it is in JSON and was saved as "1.0", which is not the text anyone sends.
+	if type == TYPE_STRING and not rebuilt is String:
+		return rebuilt
 
 	# Digits are read as digits, since read as JSON they become a double and one past 2^53 a
 	# neighbour of the number written.
@@ -441,7 +422,7 @@ func fitted(value: Variant, type: int) -> Variant:
 
 	if rebuilt is String and type != TYPE_STRING:
 		var text: String = rebuilt
-		var parsed: Variant = Read.json_or_null(text)
+		var parsed: Variant = GdhRead.json_or_null(text)
 		# A string that does not read as the type wanted is handed back as the string it is, so
 		# whoever asked can refuse it. type_convert answers 0 for "not an index" and true for any
 		# text at all, and a caller who sent a word got back a number they never sent: get_child
@@ -461,7 +442,7 @@ func fitted(value: Variant, type: int) -> Variant:
 static func inexact(given: Variant, type: int) -> String:
 	if type != TYPE_INT or (typeof(given) != TYPE_FLOAT and typeof(given) != TYPE_INT):
 		return ""
-	var number: float = Read.as_float(given)
+	var number: float = GdhRead.as_float(given)
 	if not is_finite(number) or absf(number) < EXACT:
 		return ""
 	return (
@@ -474,34 +455,6 @@ static func inexact(given: Variant, type: int) -> String:
 	)
 
 
-## How a value of [param type] is written to be read as one, for a refusal to name, or empty for a
-## type that is not built from fields. A refusal naming only the two types left a caller to find
-## the shape in the description of another op.
-static func written_as(type: int) -> String:
-	var tag: String = type_string(type)
-	var alternatives: Array = REQUIRED.get(tag, [])
-	if alternatives.is_empty() or tag in ["float", "int", "Dictionary"]:
-		return ""
-	var keys: Array = alternatives[0]
-	var parts: Array[String] = []
-	for key: Variant in keys:
-		parts.append('"%s": ...' % key)
-	return "{%s}" % ", ".join(parts)
-
-
-## Whether [param fields] carries every key of any one of [param alternatives].
-##
-## More than one spelling because a rectangle has two: the two corners it is answered with, and the
-## four numbers the editor's own tools answered with before the serialisers were made one, which a
-## caller may have kept.
-func _carries(fields: Dictionary, alternatives: Array) -> bool:
-	for alternative: Variant in alternatives:
-		var keys: Array = alternative
-		if keys.all(func(key: Variant) -> bool: return fields.has(key)):
-			return true
-	return false
-
-
 func _serialize_nil(_value: Variant) -> Variant:
 	return null
 
@@ -769,42 +722,44 @@ func _describe_object(value: Object) -> Dictionary:
 
 
 func _build_vector2(fields: Dictionary) -> Vector2:
-	return Vector2(Read.as_float(fields.get("x", 0)), Read.as_float(fields.get("y", 0)))
+	return Vector2(GdhRead.as_float(fields.get("x", 0)), GdhRead.as_float(fields.get("y", 0)))
 
 
 func _build_vector2i(fields: Dictionary) -> Vector2i:
-	return Vector2i(Read.as_int(fields.get("x", 0)), Read.as_int(fields.get("y", 0)))
+	return Vector2i(GdhRead.as_int(fields.get("x", 0)), GdhRead.as_int(fields.get("y", 0)))
 
 
 func _build_vector3(fields: Dictionary) -> Vector3:
 	return Vector3(
-		Read.as_float(fields.get("x", 0)),
-		Read.as_float(fields.get("y", 0)),
-		Read.as_float(fields.get("z", 0))
+		GdhRead.as_float(fields.get("x", 0)),
+		GdhRead.as_float(fields.get("y", 0)),
+		GdhRead.as_float(fields.get("z", 0))
 	)
 
 
 func _build_vector3i(fields: Dictionary) -> Vector3i:
 	return Vector3i(
-		Read.as_int(fields.get("x", 0)), Read.as_int(fields.get("y", 0)), Read.as_int(fields.get("z", 0))
+		GdhRead.as_int(fields.get("x", 0)),
+		GdhRead.as_int(fields.get("y", 0)),
+		GdhRead.as_int(fields.get("z", 0))
 	)
 
 
 func _build_vector4(fields: Dictionary) -> Vector4:
 	return Vector4(
-		Read.as_float(fields.get("x", 0)),
-		Read.as_float(fields.get("y", 0)),
-		Read.as_float(fields.get("z", 0)),
-		Read.as_float(fields.get("w", 0))
+		GdhRead.as_float(fields.get("x", 0)),
+		GdhRead.as_float(fields.get("y", 0)),
+		GdhRead.as_float(fields.get("z", 0)),
+		GdhRead.as_float(fields.get("w", 0))
 	)
 
 
 func _build_vector4i(fields: Dictionary) -> Vector4i:
 	return Vector4i(
-		Read.as_int(fields.get("x", 0)),
-		Read.as_int(fields.get("y", 0)),
-		Read.as_int(fields.get("z", 0)),
-		Read.as_int(fields.get("w", 0))
+		GdhRead.as_int(fields.get("x", 0)),
+		GdhRead.as_int(fields.get("y", 0)),
+		GdhRead.as_int(fields.get("z", 0)),
+		GdhRead.as_int(fields.get("w", 0))
 	)
 
 
@@ -813,10 +768,10 @@ func _build_vector4i(fields: Dictionary) -> Vector4i:
 func _build_rect2(fields: Dictionary) -> Rect2:
 	if not fields.has("position"):
 		return Rect2(
-			Read.as_float(fields.get("x", 0)),
-			Read.as_float(fields.get("y", 0)),
-			Read.as_float(fields.get("width", 0)),
-			Read.as_float(fields.get("height", 0))
+			GdhRead.as_float(fields.get("x", 0)),
+			GdhRead.as_float(fields.get("y", 0)),
+			GdhRead.as_float(fields.get("width", 0)),
+			GdhRead.as_float(fields.get("height", 0))
 		)
 	return Rect2(_vector2_at(fields, "position"), _vector2_at(fields, "size"))
 
@@ -824,24 +779,24 @@ func _build_rect2(fields: Dictionary) -> Rect2:
 func _build_rect2i(fields: Dictionary) -> Rect2i:
 	if not fields.has("position"):
 		return Rect2i(
-			Read.as_int(fields.get("x", 0)),
-			Read.as_int(fields.get("y", 0)),
-			Read.as_int(fields.get("width", 0)),
-			Read.as_int(fields.get("height", 0))
+			GdhRead.as_int(fields.get("x", 0)),
+			GdhRead.as_int(fields.get("y", 0)),
+			GdhRead.as_int(fields.get("width", 0)),
+			GdhRead.as_int(fields.get("height", 0))
 		)
 	return Rect2i(_vector2i_at(fields, "position"), _vector2i_at(fields, "size"))
 
 
 func _build_plane(fields: Dictionary) -> Plane:
-	return Plane(_vector3_at(fields, "normal"), Read.as_float(fields.get("d", 0)))
+	return Plane(_vector3_at(fields, "normal"), GdhRead.as_float(fields.get("d", 0)))
 
 
 func _build_quaternion(fields: Dictionary) -> Quaternion:
 	return Quaternion(
-		Read.as_float(fields.get("x", 0)),
-		Read.as_float(fields.get("y", 0)),
-		Read.as_float(fields.get("z", 0)),
-		Read.as_float(fields.get("w", 0))
+		GdhRead.as_float(fields.get("x", 0)),
+		GdhRead.as_float(fields.get("y", 0)),
+		GdhRead.as_float(fields.get("z", 0)),
+		GdhRead.as_float(fields.get("w", 0))
 	)
 
 
@@ -881,10 +836,10 @@ func _build_projection(fields: Dictionary) -> Projection:
 
 func _build_color(fields: Dictionary) -> Color:
 	return Color(
-		Read.as_float(fields.get("r", 0)),
-		Read.as_float(fields.get("g", 0)),
-		Read.as_float(fields.get("b", 0)),
-		Read.as_float(fields.get("a", 1), 1.0)
+		GdhRead.as_float(fields.get("r", 0)),
+		GdhRead.as_float(fields.get("g", 0)),
+		GdhRead.as_float(fields.get("b", 0)),
+		GdhRead.as_float(fields.get("a", 1), 1.0)
 	)
 
 
@@ -897,7 +852,7 @@ func _build_bytes(fields: Dictionary) -> PackedByteArray:
 
 
 func _build_float(fields: Dictionary) -> float:
-	return Read.as_float(fields)
+	return GdhRead.as_float(fields)
 
 
 func _build_int(fields: Dictionary) -> int:

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

@@ -5,25 +5,25 @@ extends Node
 ## preloaded rather than looked up on disk at runtime, so a missing one fails to parse here
 ## instead of leaving a command silently unanswered.
 
-const SceneTools = preload("tools/scene_tools.gd")
-const ResourceTools = preload("tools/resource_tools.gd")
-const AnimationTools = preload("tools/animation_tools.gd")
-const PlayTools = preload("tools/play_tools.gd")
-const ClassTools = preload("tools/class_tools.gd")
-const SettingsTools = preload("tools/settings_tools.gd")
-const FilesystemTools = preload("tools/filesystem_tools.gd")
-const ProfileTools = preload("tools/profile_tools.gd")
+const GdhSceneTools = preload("tools/scene_tools.gd")
+const GdhResourceTools = preload("tools/resource_tools.gd")
+const GdhAnimationTools = preload("tools/animation_tools.gd")
+const GdhPlayTools = preload("tools/play_tools.gd")
+const GdhClassTools = preload("tools/class_tools.gd")
+const GdhSettingsTools = preload("tools/settings_tools.gd")
+const GdhFilesystemTools = preload("tools/filesystem_tools.gd")
+const GdhProfileTools = preload("tools/profile_tools.gd")
 
 var _editor_plugin: EditorPlugin = null
 
-var _scene_tools: SceneTools = null
-var _resource_tools: ResourceTools = null
-var _animation_tools: AnimationTools = null
-var _play_tools: PlayTools = null
-var _class_tools: ClassTools = null
-var _settings_tools: SettingsTools = null
-var _filesystem_tools: FilesystemTools = null
-var _profile_tools: ProfileTools = null
+var _scene_tools: GdhSceneTools = null
+var _resource_tools: GdhResourceTools = null
+var _animation_tools: GdhAnimationTools = null
+var _play_tools: GdhPlayTools = null
+var _class_tools: GdhClassTools = null
+var _settings_tools: GdhSettingsTools = null
+var _filesystem_tools: GdhFilesystemTools = null
+var _profile_tools: GdhProfileTools = null
 
 var _tool_map: Dictionary = {}
 var _initialized: bool = false
@@ -46,35 +46,35 @@ func _init_tools() -> void:
 		return
 	_initialized = true
 
-	_scene_tools = SceneTools.new()
+	_scene_tools = GdhSceneTools.new()
 	_scene_tools.name = "SceneTools"
 	add_child(_scene_tools)
 
-	_resource_tools = ResourceTools.new()
+	_resource_tools = GdhResourceTools.new()
 	_resource_tools.name = "ResourceTools"
 	add_child(_resource_tools)
 
-	_animation_tools = AnimationTools.new()
+	_animation_tools = GdhAnimationTools.new()
 	_animation_tools.name = "AnimationTools"
 	add_child(_animation_tools)
 
-	_play_tools = PlayTools.new()
+	_play_tools = GdhPlayTools.new()
 	_play_tools.name = "PlayTools"
 	add_child(_play_tools)
 
-	_class_tools = ClassTools.new()
+	_class_tools = GdhClassTools.new()
 	_class_tools.name = "ClassTools"
 	add_child(_class_tools)
 
-	_settings_tools = SettingsTools.new()
+	_settings_tools = GdhSettingsTools.new()
 	_settings_tools.name = "SettingsTools"
 	add_child(_settings_tools)
 
-	_filesystem_tools = FilesystemTools.new()
+	_filesystem_tools = GdhFilesystemTools.new()
 	_filesystem_tools.name = "FilesystemTools"
 	add_child(_filesystem_tools)
 
-	_profile_tools = ProfileTools.new()
+	_profile_tools = GdhProfileTools.new()
 	_profile_tools.name = "ProfileTools"
 	add_child(_profile_tools)