Refactor set_name

Author: GsLogiMaker

cpp/src/entity.cpp

@@ -525,44 +525,13 @@ Ref<GFEntity> GFEntity::get_target_for(const Variant rel, int index) const {
 }
 
 Ref<GFEntity> GFEntity::set_name(const String name_) {
+	GFWorld* w = get_world();
 	ecs_entity_t parent = ecs_get_parent(
-		get_world()->raw(),
+		w->raw(),
 		get_id()
 	);
 
-	if (ecs_lookup_child(
-		get_world()->raw(),
-		parent,
-		name_.utf8()
-	) == 0) {
-		// No name conflicts, set name and return
-		ecs_set_name(get_world()->raw(), get_id(), name_.utf8());
-		return Ref(this);
-	}
-
-	int trailing_digits = 0;
-	for (int i=0; i != name_.length(); i++) {
-		char32_t digit = name_[name_.length()-i-1];
-		if (digit >= '0' && digit >= '9') {
-			trailing_digits++;
-		} else {
-			break;
-		}
-	}
-
-	String number = name_.substr(name_.length()-1-trailing_digits);
-	String base_name = name_.substr(0, name_.length()-1-trailing_digits);
-	String name = name_;
-	do {
-		int name_int = number.to_int();
-		name_int += 1;
-		number = String::num_uint64(name_int);
-		name = base_name + number;
-	} while (ecs_lookup_child(
-		get_world()->raw(),
-		parent,
-		name.utf8()
-	));
+	String name = w->entity_unique_name(parent, name_);
 
 	ecs_set_name(get_world()->raw(), get_id(), name.utf8());
 	return Ref(this);

cpp/src/world.cpp

@@ -7,6 +7,7 @@
 #include "godot_cpp/classes/text_server_manager.hpp"
 #include "godot_cpp/classes/wrapped.hpp"
 #include "godot_cpp/variant/packed_string_array.hpp"
+#include "godot_cpp/variant/string.hpp"
 #include "godot_cpp/variant/utility_functions.hpp"
 #include "observer_builder.h"
 #include "pair.h"
@@ -778,6 +779,48 @@ Variant::Type GFWorld::id_to_variant_type(ecs_entity_t id) {
 	return type;
 }
 
+// ----------------------------------------------
+// --- Maybe expose later ---
+// ----------------------------------------------
+
+String GFWorld::entity_unique_name(ecs_entity_t parent, String g_name) const {
+	if (ecs_lookup_child(
+		raw(),
+		parent,
+		g_name.utf8()
+	) == 0) {
+		// No name conflicts, set name and return
+		return g_name;
+	}
+
+	// Find have many digits are at the end of the name
+	int trailing_digits = 0;
+	for (int i=0; i != g_name.length(); i++) {
+		char32_t digit = g_name[g_name.length()-i-1];
+		if (digit >= '0' && digit <= '9') {
+			trailing_digits++;
+		} else {
+			break;
+		}
+	}
+
+	String number = g_name.substr(g_name.length()-trailing_digits);
+	String base_name = g_name.substr(0, g_name.length()-trailing_digits);
+	String name = String();
+	do {
+		int name_int = number.to_int();
+		name_int += 1;
+		number = String::num_uint64(name_int);
+		name = base_name + number;
+	} while (ecs_lookup_child(
+		raw(),
+		parent,
+		name.utf8()
+	));
+
+	return name;
+}
+
 // ----------------------------------------------
 // --- Unexposed ---
 // ----------------------------------------------
@@ -1063,15 +1106,19 @@ bool GFWorld::id_has_child(ecs_entity_t parent, const char* child_name) const {
 
 bool GFWorld::id_set_parent(ecs_entity_t id, ecs_entity_t parent) const {
 	CHECK_ENTITY_ALIVE(id, this, false,
-		"Failed to set parent\nChild is not alive\n"
+		"Failed to set parent\n	Child is not alive\n"
 	);
 	CHECK_ENTITY_ALIVE(parent, this, false,
-		"Failed to set parent\nParent is not alive\n"
+		"Failed to set parent\n	Parent is not alive\n"
 	);
 
 	// TODO: Handle name conflicts rather than throw error
+	String new_name = String();
+	if (id_has_child(parent, ecs_get_name(raw(), id))) {
+		new_name = entity_unique_name(parent, ecs_get_name(raw(), id));
+	}
 	CHECK_NOT_HAS_CHILD(parent, ecs_get_name(raw(), id), this, false,
-		"Failed to set parent\n"
+		"Failed to set parent\n	"
 	);
 
 	ecs_add_id(raw(), id, ecs_childof(parent));

cpp/src/world.h

@@ -63,6 +63,12 @@ namespace godot {
 		String id_to_text(ecs_entity_t) const;
 		static Variant::Type id_to_variant_type(ecs_entity_t);
 
+		// **************************************
+		// *** Maybe expose later ***
+		// **************************************
+
+		String entity_unique_name(ecs_entity_t parent, String) const;
+
 		// **************************************
 		// *** Unexposed ***
 		// **************************************

unittests/test_entities.gd

@@ -377,6 +377,28 @@ func test_clear():
 
 	assert_false(e.has(tag))
 
+func test_set_name():
+	# Entities should get a unique name when
+	# their name is explicitely set.
+	var e1:= GFEntity.new_in_world(world).set_name("E1")
+	var e2:= GFEntity.new_in_world(world).set_name("E1")
+	var e3:= GFEntity.new_in_world(world).set_name("E1")
+	assert_eq(e1.get_name(), "E1")
+	assert_eq(e1.get_name(), "E2")
+	assert_eq(e1.get_name(), "E3")
+	
+	# Entities should make get a unique name
+	# when moved to a parent.
+	var parent:= GFEntity.new_in_world(world)
+	var child_1:= GFEntity.new_in_world(world) \
+		.set_name("Child") \
+		.set_parent(parent)
+	var child_2:= GFEntity.new_in_world(world) \
+		.set_name("Child") \
+		.set_parent(parent)
+	assert_eq(child_1.get_name(), "Child")
+	assert_eq(child_2.get_name(), "Child1")
+
 #endregion
 
 #region Classes