gdharness 1.3.3 → 1.3.4

package/build/godot/operations/animation_reads.gd

@@ -164,8 +164,9 @@ static func state_machine(tree: AnimationTree, state_machine_path: String) -> An
 static func no_machine(tree: AnimationTree, state_machine_path: String) -> String:
 	if tree == null or tree.tree_root == null:
 		return (
-			"The AnimationTree has no tree_root. Make one with resource_edit create of an "
-			+ "AnimationNodeStateMachine, then give its res:// path to tree_root with scene_node set."
+			"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."
 		)
 	var current: AnimationNodeStateMachine = tree.tree_root as AnimationNodeStateMachine
 	if current == null:

package/build/godot/operations/declared_values.gd

@@ -58,12 +58,46 @@ static func enum_named(choices: Dictionary, word: String) -> Variant:
 	return null
 
 
-static func enum_refusal(holder: String, property: String, word: String, choices: Dictionary) -> String:
+## The values of the engine enum [param property] of [param target] holds, by the constants its
+## class declares them as: blend_mode's Add is BLEND_MODE_ADD in a script, and the hint gives only
+## the inspector's word. Empty for an enum a script declares.
+##
+## The enum is named by the setter's argument, as Node.ProcessMode, since the property list gives
+## an engine enum property no class of its own.
+static func engine_constants(target: Object, property: String) -> Dictionary:
+	var values: Dictionary = {}
+	var engine_class: String = target.get_class()
+	var setter: String = str(ClassDB.class_get_property_setter(engine_class, property))
+	if setter.is_empty():
+		return values
+	var named: String = ""
+	for method: Dictionary in ClassDB.class_get_method_list(engine_class):
+		var arguments: Array = method.get("args", [])
+		if str(method.get("name", "")) == setter and not arguments.is_empty():
+			var value_argument: Dictionary = arguments[-1]
+			named = str(value_argument.get("class_name", ""))
+			break
+	var holder: String = named.get_slice(".", 0)
+	if named.count(".") != 1 or not ClassDB.class_exists(holder):
+		return values
+	for constant: String in ClassDB.class_get_enum_constants(holder, named.get_slice(".", 1)):
+		values[constant] = ClassDB.class_get_integer_constant(holder, constant)
+	return values
+
+
+static func enum_refusal(
+	holder: String, property: String, word: String, choices: Dictionary, constants: Dictionary = {}
+) -> String:
+	var ways: String = "by name or by number"
+	if not constants.is_empty():
+		ways = "by name, by number or by the engine's constant, such as %s" % str(constants.keys()[0])
 	var said: String = (
-		"%s.%s is an enum, and %s is none of its values: send %s by name or by number"
-		% [holder, property, word, _listed(choices)]
+		"%s.%s is an enum, and %s is none of its values: send %s %s"
+		% [holder, property, word, _listed(choices), ways]
 	)
-	var close: PackedStringArray = GdhRead.nearest(word, PackedStringArray(choices.keys()))
+	var named: PackedStringArray = PackedStringArray(choices.keys())
+	named.append_array(PackedStringArray(constants.keys()))
+	var close: PackedStringArray = GdhRead.nearest(word, named)
 	if close.is_empty():
 		return said + "."
 	return said + ". The nearest %s %s." % ["is" if close.size() == 1 else "are", ", ".join(close)]
@@ -76,6 +110,17 @@ static func outside(target: Object, declared: Dictionary, value: Variant, shown:
 	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
 	var hint_string: String = str(declared.get("hint_string", ""))
 	var property: String = str(declared.get("name", ""))
+	if hint == PROPERTY_HINT_ENUM and (typeof(value) == TYPE_STRING or typeof(value) == TYPE_STRING_NAME):
+		var names: PackedStringArray = PackedStringArray(enum_values(hint_string).keys())
+		if names.is_empty() or names.has(str(value)):
+			return ""
+		return (
+			(
+				"%s is none of the names %s lists: %s, which the inspector holds it to; the engine "
+				+ "stores it as given."
+			)
+			% [shown, property, ", ".join(names)]
+		)
 	if typeof(value) != TYPE_INT and typeof(value) != TYPE_FLOAT:
 		return ""
 	var number: float = GdhRead.as_float(value)
@@ -114,3 +159,111 @@ static func _listed(choices: Dictionary) -> String:
 ## A range's end as the script wrote it: the engine's hint gives @export_range(0, 10) as 0.0 and 10.0.
 static func _bound(end: float) -> String:
 	return str(int(end)) if end == floorf(end) and absf(end) < 1e15 else str(end)
+
+
+## Puts back on [param built] what its script set as it was attached and was not among
+## [param wanted], to the defaults it declares, outside the editor. Attaching runs the script's _init
+## there, which the editor never runs for a script that is not a tool, so a resource_name _init chose
+## was saved as if asked for. A property whose default the engine cannot report is left as made.
+static func unmade(built: Resource, wanted: Dictionary) -> void:
+	var attached: Variant = built.get_script()
+	if Engine.is_editor_hint() or not attached is Script:
+		return
+	var script: Script = attached
+	var asked: Dictionary = {}
+	for key: Variant in wanted:
+		asked[str(key).get_slice(":", 0)] = true
+	for entry: Dictionary in built.get_property_list():
+		var name: String = str(entry["name"])
+		var usage: int = GdhRead.as_int(entry["usage"])
+		if usage & PROPERTY_USAGE_STORAGE == 0 or name == "script" or asked.has(name):
+			continue
+		var declared: Variant = ClassDB.class_get_property_default_value(built.get_class(), name)
+		if usage & PROPERTY_USAGE_SCRIPT_VARIABLE:
+			declared = script.get_property_default_value(name)
+		var held: Variant = built.get(name)
+		if declared != null and not (typeof(held) == typeof(declared) and held == declared):
+			built.set(name, declared)
+
+
+## The element types a typed Array or Dictionary property declares: [element] for an array,
+## [key, value] for a dictionary, [] when nothing is declared.
+##
+## Read from the declaration because the value cannot say: a script's exported `Array[int]` sits
+## behind a placeholder in the editor, and measured on 4.7.2 that placeholder stores [1.5, 2.0]
+## as given, which the game then fails to load into the typed array.
+static func elements_of(declared: Dictionary) -> Array:
+	var type: int = GdhRead.as_int(declared.get("type", TYPE_NIL), TYPE_NIL)
+	var hint: int = GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE))
+	var wanted: String = str(declared.get("hint_string", ""))
+	if wanted.is_empty():
+		return []
+	if hint == PROPERTY_HINT_TYPE_STRING:
+		var parts: PackedStringArray = wanted.split(";")
+		if type == TYPE_ARRAY and parts.size() == 1:
+			return [_type_in_hint(parts[0])]
+		if type == TYPE_DICTIONARY and parts.size() == 2:
+			return [_type_in_hint(parts[0]), _type_in_hint(parts[1])]
+		return []
+	if hint == PROPERTY_HINT_ARRAY_TYPE and type == TYPE_ARRAY:
+		return [_type_named(wanted)]
+	if hint == PROPERTY_HINT_DICTIONARY_TYPE and type == TYPE_DICTIONARY:
+		var parts: PackedStringArray = wanted.split(";")
+		if parts.size() == 2:
+			return [_type_named(parts[0]), _type_named(parts[1])]
+	return []
+
+
+## The type at the front of one entry of a type-string hint, "2:" or "24/17:Texture2D".
+static func _type_in_hint(entry: String) -> int:
+	var number: String = entry.get_slice(":", 0).get_slice("/", 0)
+	return number.to_int() if number.is_valid_int() else TYPE_NIL
+
+
+## The Variant type [param name] names, or TYPE_OBJECT for a class.
+static func _type_named(name: String) -> int:
+	var named: String = name.get_slice(":", 0).strip_edges()
+	for type: int in TYPE_MAX:
+		if type_string(type) == named:
+			return type
+	return TYPE_OBJECT if not named.is_empty() else TYPE_NIL
+
+
+## The class the objects of a typed list or map hold, and whether they are nodes, as
+## [class, nodes], read from entry [param at] of [param declared]'s hint: "24/17:Item" in a type
+## string, "Item" in an array or dictionary type.
+static func object_kind(declared: Dictionary, at: int) -> Array:
+	var entry: String = str(declared.get("hint_string", "")).get_slice(";", at)
+	if GdhRead.as_int(declared.get("hint", PROPERTY_HINT_NONE)) != PROPERTY_HINT_TYPE_STRING:
+		return [entry.strip_edges(), false]
+	var nodes: bool = entry.get_slice(":", 0).get_slice("/", 1) == str(PROPERTY_HINT_NODE_TYPE)
+	return [entry.get_slice(":", 1), nodes]
+
+
+## The base class and script that type a list or map holding [param wanted], as [class, script],
+## or [] when nothing in the project or the engine is called that.
+static func object_typing(wanted: String) -> Array:
+	if ClassDB.class_exists(wanted):
+		return [StringName(wanted), null]
+	var script: Script = script_class(wanted)
+	return [] if script == null else [script.get_instance_base_type(), script]
+
+
+## The script declaring the class_name [param name], or null.
+static func script_class(name: String) -> Script:
+	for entry: Dictionary in ProjectSettings.get_global_class_list():
+		if str(entry.get("class", "")) == name:
+			return load(str(entry.get("path", ""))) as Script
+	return null
+
+
+## Whether [param value] is the class [param name] names, an engine class or a script's class_name.
+static func is_a(value: Object, name: String) -> bool:
+	if value.is_class(name):
+		return true
+	var script: Script = value.get_script()
+	while script != null:
+		if str(script.get_global_name()) == name:
+			return true
+		script = script.get_base_script()
+	return false

package/build/godot/operations/dependencies.gd

@@ -58,47 +58,21 @@ func get_dependencies(params: Dictionary) -> Dictionary:
 	var max_depth: int = depth if depth > 0 else 1000
 	var include_built_in: bool = GdhRead.as_bool(params.get("include_builtin", false))
 
-	_log.info(
-		(
-			"Getting dependencies"
-			+ (" for: " + resource_path if not resource_path.is_empty() else " for all resources")
-		)
-	)
+	if resource_path.is_empty():
+		return _log.failure("resource_path is required")
+	_log.info("Getting dependencies for: " + resource_path)
 
 	var dependencies: Dictionary = {}
 	var circular_references: Array = []
-	var total_resources: int = 0
-
-	if not resource_path.is_empty():
-		var full_path: String = resource_path
-		if not full_path.begins_with("res://"):
-			full_path = "res://" + full_path
-
-		if not FileAccess.file_exists(full_path):
-			return _log.failure(
-				_files.with_nearest_files("Resource file does not exist: " + full_path, full_path)
-			)
-
-		var walk: GdhDependencyWalk = GdhDependencyWalk.new(max_depth, include_built_in, circular_references)
-		dependencies[full_path] = _analyze_resource(full_path, 0, walk)
-		total_resources = 1
-	else:
-		var resource_extensions: Array[String] = ["tscn", "tres", "gd", "gdshader", "shader"]
-		var all_resources: Array[String] = []
-		for ext: String in resource_extensions:
-			all_resources.append_array(_files.find_files("res://", "." + ext))
-
-		# Each root gets a fresh walk so a cycle is reported from every resource it passes
-		# through, rather than only from whichever one happened to be walked first.
-		for res_path: String in all_resources:
-			var walk: GdhDependencyWalk = GdhDependencyWalk.new(
-				max_depth, include_built_in, circular_references
-			)
-			var deps: Array[Dictionary] = _analyze_resource(res_path, 0, walk)
-			if deps.size() > 0:
-				dependencies[res_path] = deps
-
-		total_resources = all_resources.size()
+	var full_path: String = resource_path
+	if not full_path.begins_with("res://"):
+		full_path = "res://" + full_path
+	if not FileAccess.file_exists(full_path):
+		return _log.failure(
+			_files.with_nearest_files("Resource file does not exist: " + full_path, full_path)
+		)
+	var walk: GdhDependencyWalk = GdhDependencyWalk.new(max_depth, include_built_in, circular_references)
+	dependencies[full_path] = _analyze_resource(full_path, 0, walk)
 
 	var references: int = 0
 	var distinct: Dictionary = {}
@@ -121,7 +95,8 @@ func get_dependencies(params: Dictionary) -> Dictionary:
 		"circular_references": circular_references,
 		"summary":
 		{
-			"total_resources": total_resources,
+			# The file the walk starts from, which a call always names one of.
+			"total_resources": 1,
 			# The files depended on, each once. The tree names a file again under everything that
 			# loads it, and counting its entries answered 11 for a scene with six dependencies.
 			"total_dependencies": distinct.size(),

package/build/godot/operations/editor_tools.gd

@@ -10,6 +10,7 @@ extends RefCounted
 const GdhAnimationTools = preload("../addons/gdharness_editor/tools/animation_tools.gd")
 const GdhResourceTools = preload("../addons/gdharness_editor/tools/resource_tools.gd")
 const GdhSceneTools = preload("../addons/gdharness_editor/tools/scene_tools.gd")
+const GdhSignalTools = preload("../addons/gdharness_editor/tools/signal_tools.gd")
 const GdhSceneFile = preload("../addons/gdharness_editor/scene_file.gd")
 
 const SCENE_COMMANDS: Array[String] = [
@@ -21,10 +22,8 @@ const SCENE_COMMANDS: Array[String] = [
 	"duplicate_node",
 	"reparent_node",
 	"delete_node",
-	"connect_signal",
-	"disconnect_signal",
-	"list_connections",
 ]
+const SIGNAL_COMMANDS: Array[String] = ["connect_signal", "disconnect_signal", "list_connections"]
 const RESOURCE_COMMANDS: Array[String] = [
 	"set_tilemap_cells",
 	"create_resource",
@@ -55,6 +54,8 @@ static func run(params: Dictionary) -> Dictionary:
 	var tools: Node = null
 	if command in SCENE_COMMANDS:
 		tools = GdhSceneTools.new()
+	elif command in SIGNAL_COMMANDS:
+		tools = GdhSignalTools.new()
 	elif command in RESOURCE_COMMANDS:
 		tools = GdhResourceTools.new()
 	elif command in ANIMATION_COMMANDS:

package/build/godot/operations/file_reads.gd

@@ -10,8 +10,8 @@ extends RefCounted
 ## without making a node. Loading the file still does what loading does in the game: static
 ## initialisers run, and a resource with a script is made with it.
 
-const GdhPropertyValues = preload("property_values.gd")
 const GdhRead = preload("reading.gd")
+const GdhSame = preload("same_values.gd")
 const GdhSerialisation = preload("serialisation.gd")
 
 
@@ -188,6 +188,12 @@ static func _lay(
 					path,
 					state.get_node_index(index)
 				)
+		# Every file on the way puts the node in its own groups: the scene making it, and each scene
+		# instancing or inheriting that one.
+		var grouped: Array[String] = nodes[path]["groups"]
+		for group: StringName in state.get_node_groups(index):
+			if not grouped.has(str(group)):
+				grouped.append(str(group))
 		var held: Dictionary = nodes[path]["properties"]
 		for property: int in state.get_node_property_count(index):
 			held[str(state.get_node_property_name(index, property))] = state.get_node_property_value(
@@ -281,7 +287,8 @@ static func _by_id(nodes: Dictionary, owner: String, id: int) -> String:
 
 static func _made(type: String) -> Dictionary:
 	var children: Array[String] = []
-	return {"name": "", "type": type, "properties": {}, "children": children}
+	var groups: Array[String] = []
+	return {"name": "", "type": type, "properties": {}, "children": children, "groups": groups}
 
 
 ## Puts [param path] among [param parent]'s children, at [param at] when the file says where (a node
@@ -317,6 +324,11 @@ static func _entry(
 		data["instanceOf"] = node["instanceOf"]
 		if node.has("editableChildren"):
 			data["editableChildren"] = node["editableChildren"]
+	var groups: Array[String] = node["groups"]
+	if not groups.is_empty():
+		var sorted: Array[String] = groups.duplicate()
+		sorted.sort()
+		data["groups"] = sorted
 	if include_properties:
 		var given: Dictionary = node["properties"]
 		data["properties"] = _stored(str(node["type"]), given)
@@ -419,7 +431,7 @@ static func resource(res_path: String, include_defaults: bool) -> Dictionary:
 				if scripted.has(property)
 				else ClassDB.class_get_property_default_value(loaded.get_class(), property)
 			)
-			if GdhPropertyValues.same(value, default):
+			if GdhSame.same(value, default):
 				continue
 		properties[property] = serialiser.serialize_value(value)
 	var answer: Dictionary = {