Skip to content

[cpp] Avoid temporary flecs::term objects in query builder with() methods #2193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AnonimiAngels wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[cpp] Avoid temporary flecs::term objects in query builder with() methods #2193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 31 additions & 7 deletions distr/flecs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35238,7 +35238,7 @@ struct query_builder_i : term_builder_i<Base> {
template<typename T>
Base& with() {
this->term();
*this->term_ = flecs::term(_::type<T>::id(this->world_v()));
this->set_term_id(_::type<T>::id(this->world_v()));
this->term_->inout = static_cast<ecs_inout_kind_t>(
_::type_to_inout<T>());
return *this;
Expand All @@ -35247,42 +35247,53 @@ struct query_builder_i : term_builder_i<Base> {
/** Add a term for the specified component ID. */
Base& with(id_t component_id) {
this->term();
*this->term_ = flecs::term(component_id);
this->set_term_id(component_id);
return *this;
}

/** Add a term for the specified component name. */
Base& with(const char *component_name) {
this->term();
*this->term_ = flecs::term().first(component_name);
this->set_term_id(0);
this->first(component_name);
this->src();
return *this;
}

/** Add a term for a pair specified by name. */
Base& with(const char *first, const char *second) {
this->term();
*this->term_ = flecs::term().first(first).second(second);
this->set_term_id(0);
this->first(first).second(second);
this->src();
return *this;
}

/** Add a term for a pair specified by entity IDs. */
Base& with(entity_t first, entity_t second) {
this->term();
*this->term_ = flecs::term(first, second);
this->set_term_id(0);
this->term_->first.id = first;
this->term_->second.id = second;
return *this;
}

/** Add a term for a pair with an entity ID first and a name second. */
Base& with(entity_t first, const char *second) {
this->term();
*this->term_ = flecs::term(first).second(second);
this->set_term_id(first);
this->second(second);
this->src();
return *this;
}

/** Add a term for a pair with a name first and an entity ID second. */
Base& with(const char *first, entity_t second) {
this->term();
*this->term_ = flecs::term().first(first).second(second);
this->set_term_id(0);
this->first(first);
this->second(second);
this->src();
return *this;
}

Expand Down Expand Up @@ -35609,6 +35620,19 @@ struct query_builder_i : term_builder_i<Base> {
return *static_cast<Base*>(this);
}

/* Reset the current term and set its component/pair id. Writing the term
* directly avoids a temporary flecs::term, which stores pointers to its
* own stack memory and gets flagged by static analyzers when assigned to
* the descriptor (clang-analyzer core.StackAddressEscape). */
void set_term_id(id_t component_id) {
*this->term_ = {};
if (component_id & ECS_ID_FLAGS_MASK) {
this->term_->id = component_id;
} else if (component_id) {
this->term_->first.id = component_id;
}
}

ecs_query_desc_t *desc_;
};

Expand Down
38 changes: 31 additions & 7 deletions include/flecs/addons/cpp/mixins/query/builder_i.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ struct query_builder_i : term_builder_i<Base> {
template<typename T>
Base& with() {
this->term();
*this->term_ = flecs::term(_::type<T>::id(this->world_v()));
this->set_term_id(_::type<T>::id(this->world_v()));
this->term_->inout = static_cast<ecs_inout_kind_t>(
_::type_to_inout<T>());
return *this;
Expand All @@ -73,42 +73,53 @@ struct query_builder_i : term_builder_i<Base> {
/** Add a term for the specified component ID. */
Base& with(id_t component_id) {
this->term();
*this->term_ = flecs::term(component_id);
this->set_term_id(component_id);
return *this;
}

/** Add a term for the specified component name. */
Base& with(const char *component_name) {
this->term();
*this->term_ = flecs::term().first(component_name);
this->set_term_id(0);
this->first(component_name);
this->src();
return *this;
}

/** Add a term for a pair specified by name. */
Base& with(const char *first, const char *second) {
this->term();
*this->term_ = flecs::term().first(first).second(second);
this->set_term_id(0);
this->first(first).second(second);
this->src();
return *this;
}

/** Add a term for a pair specified by entity IDs. */
Base& with(entity_t first, entity_t second) {
this->term();
*this->term_ = flecs::term(first, second);
this->set_term_id(0);
this->term_->first.id = first;
this->term_->second.id = second;
return *this;
}

/** Add a term for a pair with an entity ID first and a name second. */
Base& with(entity_t first, const char *second) {
this->term();
*this->term_ = flecs::term(first).second(second);
this->set_term_id(first);
this->second(second);
this->src();
return *this;
}

/** Add a term for a pair with a name first and an entity ID second. */
Base& with(const char *first, entity_t second) {
this->term();
*this->term_ = flecs::term().first(first).second(second);
this->set_term_id(0);
this->first(first);
this->second(second);
this->src();
return *this;
}

Expand Down Expand Up @@ -435,6 +446,19 @@ struct query_builder_i : term_builder_i<Base> {
return *static_cast<Base*>(this);
}

/* Reset the current term and set its component/pair id. Writing the term
* directly avoids a temporary flecs::term, which stores pointers to its
* own stack memory and gets flagged by static analyzers when assigned to
* the descriptor (clang-analyzer core.StackAddressEscape). */
void set_term_id(id_t component_id) {
*this->term_ = {};
if (component_id & ECS_ID_FLAGS_MASK) {
this->term_->id = component_id;
} else if (component_id) {
this->term_->first.id = component_id;
}
}

ecs_query_desc_t *desc_;
};

Expand Down
Loading