Merge pull request #116 from GsLogiMaker/feature/query-set-term-source

GsLogiMaker · web-flow · commit 2f0f00b60447 · 2026-04-08T16:36:42.000-05:00
Add method to set source in queries
diff --git a/cpp/src/doc_classes/GFComponentBuilder.xml b/cpp/src/doc_classes/GFComponentBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFComponentBuilder" inherits="GFEntityBuilder"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFComponentBuilder" inherits="GFEntityBuilder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		Builder for a new component type.
 	</brief_description>
diff --git a/cpp/src/doc_classes/GFEntityBuilder.xml b/cpp/src/doc_classes/GFEntityBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFEntityBuilder" inherits="RefCounted"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFEntityBuilder" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 	</brief_description>
 	<description>
diff --git a/cpp/src/doc_classes/GFModule.xml b/cpp/src/doc_classes/GFModule.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFModule" inherits="GFRegisterableEntity"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFModule" inherits="GFRegisterableEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 	</brief_description>
 	<description>
diff --git a/cpp/src/doc_classes/GFObserverBuilder.xml b/cpp/src/doc_classes/GFObserverBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFObserverBuilder" inherits="GFQuerylikeBuilder"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFObserverBuilder" inherits="GFQuerylikeBuilder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A builder for observers.
 	</brief_description>
@@ -67,44 +66,44 @@
 			</description>
 		</method>
 		<method name="from">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<param index="0" name="entity" type="Variant" />
 			<description>
 				Overrides [GFQuerylikeBuilder.from].
 			</description>
 		</method>
 		<method name="io_default">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_default].
 			</description>
 		</method>
 		<method name="io_filter">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_filter].
 			</description>
 		</method>
 		<method name="io_in">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_in].
 			</description>
 		</method>
 		<method name="io_inout">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_inout].
 			</description>
 		</method>
 		<method name="io_none">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_none].
 			</description>
 		</method>
 		<method name="io_out">
-			<return type="GFSystemBuilder" />
+			<return type="GFObserverBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_out].
 			</description>
@@ -159,6 +158,13 @@
 				Overrides [method GFEntityBuilder.set_target_entity].
 			</description>
 		</method>
+		<method name="src">
+			<return type="GFObserverBuilder" />
+			<param index="0" name="source" type="Variant" />
+			<description>
+				Overrides [method GFQuerylikeBuilder.src].
+			</description>
+		</method>
 		<method name="up">
 			<return type="GFObserverBuilder" />
 			<param index="0" name="traversal" type="Variant" default="0" />
diff --git a/cpp/src/doc_classes/GFPair.xml b/cpp/src/doc_classes/GFPair.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFPair" inherits="GFEntity"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFPair" inherits="GFEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to a pair of entity IDs.
 	</brief_description>
diff --git a/cpp/src/doc_classes/GFQueryBuilder.xml b/cpp/src/doc_classes/GFQueryBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFQueryBuilder" inherits="GFQuerylikeBuilder"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFQueryBuilder" inherits="GFQuerylikeBuilder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A builder for queries.
 	</brief_description>
@@ -53,44 +52,44 @@
 			</description>
 		</method>
 		<method name="from">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<param index="0" name="entity" type="Variant" />
 			<description>
 				Overrides [GFQuerylikeBuilder.from].
 			</description>
 		</method>
 		<method name="io_default">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_default].
 			</description>
 		</method>
 		<method name="io_filter">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_filter].
 			</description>
 		</method>
 		<method name="io_in">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_in].
 			</description>
 		</method>
 		<method name="io_inout">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_inout].
 			</description>
 		</method>
 		<method name="io_none">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_none].
 			</description>
 		</method>
 		<method name="io_out">
-			<return type="GFSystemBuilder" />
+			<return type="GFQueryBuilder" />
 			<description>
 				Overrides [GFQuerylikeBuilder.io_out].
 			</description>
@@ -131,6 +130,13 @@
 				Overrides [method GFEntityBuilder.set_target_entity].
 			</description>
 		</method>
+		<method name="src">
+			<return type="GFQueryBuilder" />
+			<param index="0" name="source" type="Variant" />
+			<description>
+				Overrides [method GFQuerylikeBuilder.src].
+			</description>
+		</method>
 		<method name="up">
 			<return type="GFQueryBuilder" />
 			<param index="0" name="traversal" type="Variant" default="0" />
diff --git a/cpp/src/doc_classes/GFQuerylikeBuilder.xml b/cpp/src/doc_classes/GFQuerylikeBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFQuerylikeBuilder" inherits="GFEntityBuilder"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFQuerylikeBuilder" inherits="GFEntityBuilder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		The abstract base class for different query-like builders.
 	</brief_description>
@@ -125,6 +124,19 @@
 				Overrides [GFEntityBuilder.set_target_entity].
 			</description>
 		</method>
+		<method name="src">
+			<return type="GFQuerylikeBuilder" />
+			<param index="0" name="source" type="Variant" />
+			<description>
+				Sets the source of last term.
+				In this example, the query matches for a child whose parent has the [i]Planet[/i] component:
+				[codeblock]
+				GFQueryBuilder.new() \
+					.with(ChildOf, "$par") \
+					.with(Planet).src("$par")
+				[/codeblock]
+			</description>
+		</method>
 		<method name="up">
 			<return type="GFQuerylikeBuilder" />
 			<param index="0" name="traversal" type="Variant" default="0" />
diff --git a/cpp/src/doc_classes/GFSystemBuilder.xml b/cpp/src/doc_classes/GFSystemBuilder.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFSystemBuilder" inherits="GFQuerylikeBuilder"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFSystemBuilder" inherits="GFQuerylikeBuilder" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A builder for systems.
 	</brief_description>
@@ -134,6 +133,13 @@
 				Overrides [method GFEntityBuilder.set_target_entity].
 			</description>
 		</method>
+		<method name="src">
+			<return type="GFSystemBuilder" />
+			<param index="0" name="source" type="Variant" />
+			<description>
+				Overrides [method GFQuerylikeBuilder.src].
+			</description>
+		</method>
 		<method name="up">
 			<return type="GFSystemBuilder" />
 			<param index="0" name="traversal" type="Variant" default="0" />
diff --git a/cpp/src/doc_classes/GFTag.xml b/cpp/src/doc_classes/GFTag.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<class name="GFTag" inherits="GFRegisterableEntity"
-	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
+<class name="GFTag" inherits="GFRegisterableEntity" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
 	<brief_description>
 		A reference to an entity with no data.
 	</brief_description>
diff --git a/cpp/src/entity.cpp b/cpp/src/entity.cpp
@@ -206,9 +206,7 @@ bool GFEntity::_set(StringName property, Variant value) {
 
 Ref<GFEntity> GFEntity::add_child(const Variant entity) {
 	ecs_entity_t id = get_world()->coerce_id(entity);
-	if (!get_world()->id_set_parent(id, get_id())) {
-		return nullptr;
-	}
+	get_world()->id_set_parent(id, get_id());
 	return Ref(this);
 }
 
diff --git a/cpp/src/querylike_builder.cpp b/cpp/src/querylike_builder.cpp
@@ -80,6 +80,24 @@ Ref<GFQuerylikeBuilder> GFQuerylikeBuilder::io_out() {
 	return Ref(this);
 }
 
+Ref<GFQuerylikeBuilder> GFQuerylikeBuilder::src(const Variant source) {
+	CHECK_HAS_A_TERM(Ref(this),
+		"Failed to set source in term\n"
+	);
+
+	GFWorld* w = get_world();
+	ecs_term_t* term = &query_desc.terms[get_term_count()-1];
+
+	handle_id_or_variable(
+		w,
+		source,
+		&term->first.id,
+		&source_names[get_term_count()-1]
+	);
+
+	return Ref(this);
+}
+
 Ref<GFQuerylikeBuilder> GFQuerylikeBuilder::with(const Variant term_v, const Variant second) {
 	return _add_term(term_v, second, ecs_oper_kind_t::EcsAnd);
 }
diff --git a/cpp/src/querylike_builder.h b/cpp/src/querylike_builder.h
@@ -28,6 +28,7 @@
 	Ref<Self> io_inout()	{ return GFQuerylikeBuilder::io_inout(); }	\
 	Ref<Self> io_none()	{ return GFQuerylikeBuilder::io_none(); }	\
 	Ref<Self> io_out()	{ return GFQuerylikeBuilder::io_out(); }	\
+	Ref<Self> src(const Variant v0)	{ return GFQuerylikeBuilder::src(v0); }	\
 	Ref<Self> from(const Variant v0)	{ return GFQuerylikeBuilder::from(v0); }	\
 ;
 
@@ -46,6 +47,7 @@
 	godot::ClassDB::bind_method(D_METHOD("io_inout"), &Self::io_inout);	\
 	godot::ClassDB::bind_method(D_METHOD("io_none"), &Self::io_none);	\
 	godot::ClassDB::bind_method(D_METHOD("io_out"), &Self::io_out);	\
+	godot::ClassDB::bind_method(D_METHOD("src", "source"), &Self::src);	\
 	godot::ClassDB::bind_method(D_METHOD("from", "entity"), &Self::from);	\
 ;
 
@@ -112,6 +114,7 @@ namespace godot {
 		Ref<GFQuerylikeBuilder> io_inout();
 		Ref<GFQuerylikeBuilder> io_none();
 		Ref<GFQuerylikeBuilder> io_out();
+		Ref<GFQuerylikeBuilder> src(const Variant source);
 		Ref<GFQuerylikeBuilder> with(const Variant, const Variant);
 		Ref<GFQuerylikeBuilder> with_maybe(const Variant, const Variant);
 		Ref<GFQuerylikeBuilder> without(const Variant, const Variant);
diff --git a/cpp/src/world.cpp b/cpp/src/world.cpp
@@ -1372,10 +1372,10 @@ bool GFWorld::id_set_parent(ecs_entity_t id, ecs_entity_t parent) const {
 
 	// TODO: Handle name conflicts rather than throw error
 	String new_name = String();
-	if (id_has_child(parent, ecs_get_name(raw(), id))) {
+	if (ecs_has_id(raw(), id, EcsName) && id_has_child(parent, ecs_get_name(raw(), id))) {
 		// Entity needs new name in parent
 		new_name = entity_unique_name(parent, ecs_get_name(raw(), id));
-		ecs_set_name(raw(), id, nullptr); // Remove name till added to parent
+		ecs_remove_id(raw(), id, EcsName);
 	}
 
 	ecs_add_id(raw(), id, ecs_childof(parent));
diff --git a/unittests/test_queries.gd b/unittests/test_queries.gd
@@ -143,22 +143,22 @@ func test_query_variable():
 	var world_2d:= GFEntity.new() \
 		.set_name("World2D") \
 		.add(world_e)
-	
+
 	# Setup entities to query for
 	var item:= GFEntity.new() \
 		.set_name("Item3D") \
 		.add_pair(rendering, world_3d)
 	var item2:= GFEntity.new() \
 		.set_name("Item2D") \
 		.add_pair(rendering, world_2d)
-	
+
 	# Run query
 	var q:= GFQueryBuilder.new() \
 		.with(rendering, "$world") \
 		.with(world_e).from("$world") \
 		.build()
 	var results:= q.iter().into_array()
-	
+
 	assert_eq(results.size(), 2, "Expected 2 query results")
 	assert_eq(
 		results[0][0].get_id(),
@@ -181,19 +181,44 @@ func test_src_doc_example():
 		.add(Velocity)
 	var asteroid = GFEntity.new() \
 		.add(Velocity)
-	
+
 	# Query only for Velocity of the ship, not the asteroid
 	var query = GFQueryBuilder.new() \
 		.with(Velocity).from(ship) \
 		.build()
-	
+
 	var arr = query.iter().into_array()
 	assert_eq(arr.size(), 1)
-	
+
 	var velocity_c:GFComponent = arr[0][0]
 	assert_eq(velocity_c.get_id(), Velocity.get_id())
 	assert_eq(velocity_c.get_source_id(), ship.get_id())
 
+
+func test_query_source():
+	var ChildOf = GFWorld.get_default_world().lookup("/root/flecs/core/ChildOf")
+
+	var p1:= GFEntity.new()
+	p1.set_name("WithBools")
+	p1.add(Bools)
+	var c1:= GFEntity.new()
+	p1.add_child(c1)
+	prints(2)
+	var p2:= GFEntity.new()
+	p2.set_name("WithoutBools")
+	p2.add_child(GFEntity.new())
+
+	var builder:= GFQueryBuilder.new()
+	builder.with(ChildOf, "$par")
+	builder.with(Bools).src("$par")
+	var query:GFQuery = builder.build()
+
+	var results = query.iter().into_array()
+	assert_eq(results.size(), 1)
+
+	var bools_c:GFComponent = results[0][1]
+	assert_eq(bools_c.get_source_entity().get_name(), "WithBools")
+
 #endregion
 
 #region Components

Original file line number	Diff line number	Diff line change
`@@ -206,9 +206,7 @@ bool GFEntity::_set(StringName property, Variant value) {`
`206`	`206`
`207`	`207`	`Ref<GFEntity> GFEntity::add_child(const Variant entity) {`
`208`	`208`	`ecs_entity_t id = get_world()->coerce_id(entity);`
`209`		`- if (!get_world()->id_set_parent(id, get_id())) {`
`210`		`- return nullptr;`
`211`		`- }`
	`209`	`+ get_world()->id_set_parent(id, get_id());`
`212`	`210`	`return Ref(this);`
`213`	`211`	`}`
`214`	`212`