From 2d40ed776f59ae112ce97f44e474f72e235381b1 Mon Sep 17 00:00:00 2001 From: Sander Mertens Date: Fri, 18 Mar 2022 14:31:43 -0700 Subject: [PATCH] #680 inline type info --- flecs.c | 65418 +++++++++++++++++++++--------------------- flecs.h | 9 +- include/flecs.h | 9 +- src/private_types.h | 2 +- src/table.c | 156 +- 5 files changed, 32772 insertions(+), 32822 deletions(-) diff --git a/flecs.c b/flecs.c index b3173ce60..576bd6ead 100644 --- a/flecs.c +++ b/flecs.c @@ -475,7 +475,7 @@ struct ecs_table_t { ecs_graph_node_t node; /* Graph node */ ecs_data_t storage; /* Component storage */ - ecs_type_info_t **type_info; /* Cached pointers to type info */ + ecs_type_info_t *type_info; /* Cached pointers to type info */ int32_t *dirty_state; /* Keep track of changes in columns */ int32_t alloc_count; /* Increases when columns are reallocd */ @@ -2109,2455 +2109,2521 @@ void _assert_func( #endif -#include - -/* Marker object used to differentiate a component vs. a tag edge */ -static ecs_table_diff_t ecs_table_edge_is_component; +/* Table sanity check to detect storage issues. Only enabled in SANITIZE mode as + * this can severly slow down many ECS operations. */ +#ifdef FLECS_SANITIZE static -uint64_t ids_hash(const void *ptr) { - const ecs_ids_t *type = ptr; - ecs_id_t *ids = type->array; - int32_t count = type->count; - uint64_t hash = flecs_hash(ids, count * ECS_SIZEOF(ecs_id_t)); - return hash; -} +void check_table_sanity(ecs_table_t *table) { + int32_t size = ecs_vector_size(table->storage.entities); + int32_t count = ecs_vector_count(table->storage.entities); + + ecs_assert(size == ecs_vector_size(table->storage.record_ptrs), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(count == ecs_vector_count(table->storage.record_ptrs), + ECS_INTERNAL_ERROR, NULL); -static -int ids_compare(const void *ptr_1, const void *ptr_2) { - const ecs_ids_t *type_1 = ptr_1; - const ecs_ids_t *type_2 = ptr_2; + int32_t sw_offset = table->sw_column_offset; + int32_t sw_count = table->sw_column_count; + int32_t bs_offset = table->bs_column_offset; + int32_t bs_count = table->bs_column_count; + int32_t type_count = ecs_vector_count(table->type); + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - int32_t count_1 = type_1->count; - int32_t count_2 = type_2->count; + ecs_assert((sw_count + sw_offset) <= type_count, ECS_INTERNAL_ERROR, NULL); + ecs_assert((bs_count + bs_offset) <= type_count, ECS_INTERNAL_ERROR, NULL); - if (count_1 != count_2) { - return (count_1 > count_2) - (count_1 < count_2); - } + ecs_type_t storage_type = table->storage_type; + ecs_table_t *storage_table = table->storage_table; + ecs_assert(table->storage_type == NULL || table->storage_table != NULL, + ECS_INTERNAL_ERROR, NULL); - const ecs_id_t *ids_1 = type_1->array; - const ecs_id_t *ids_2 = type_2->array; - int32_t i; - for (i = 0; i < count_1; i ++) { - ecs_id_t id_1 = ids_1[i]; - ecs_id_t id_2 = ids_2[i]; - - if (id_1 != id_2) { - return (id_1 > id_2) - (id_1 < id_2); - } - } - - return 0; -} + if (storage_table) { + ecs_assert(storage_type == storage_table->type, + ECS_INTERNAL_ERROR, NULL); + int32_t storage_count = ecs_vector_count(storage_type); + ecs_assert(type_count >= storage_count, ECS_INTERNAL_ERROR, NULL); -void flecs_table_hashmap_init(ecs_hashmap_t *hm) { - flecs_hashmap_init(hm, ecs_ids_t, ecs_table_t*, ids_hash, ids_compare); -} + int32_t *storage_map = table->storage_map; + ecs_assert(storage_map != NULL, ECS_INTERNAL_ERROR, NULL); -const EcsComponent* flecs_component_from_id( - const ecs_world_t *world, - ecs_entity_t e) -{ - ecs_entity_t pair = 0; + ecs_id_t *storage_ids = ecs_vector_first(storage_type, ecs_id_t); + for (i = 0; i < type_count; i ++) { + if (storage_map[i] != -1) { + ecs_assert(ids[i] == storage_ids[storage_map[i]], + ECS_INTERNAL_ERROR, NULL); + } + } - /* If this is a pair, get the pair component from the identifier */ - if (ECS_HAS_ROLE(e, PAIR)) { - pair = e; - e = ecs_get_alive(world, ECS_PAIR_FIRST(e)); + for (i = 0; i < storage_count; i ++) { + ecs_type_info_t *ti = &table->type_info[i]; + ecs_column_t *column = &table->storage.columns[i]; - if (ecs_has_id(world, e, EcsTag)) { - return NULL; + ecs_assert(ti->size == column->size, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ti->alignment == column->alignment, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(size == ecs_vector_size(column->data), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(count == ecs_vector_count(column->data), + ECS_INTERNAL_ERROR, NULL); + ecs_vector_assert_size(column->data, column->size); + int32_t storage_map_id = storage_map[i + type_count]; + ecs_assert(storage_map_id >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ids[storage_map_id] == storage_ids[i], + ECS_INTERNAL_ERROR, NULL); } } - if (e & ECS_ROLE_MASK) { - return NULL; + if (sw_count) { + ecs_assert(table->storage.sw_columns != NULL, + ECS_INTERNAL_ERROR, NULL); + for (i = 0; i < sw_count; i ++) { + ecs_sw_column_t *sw = &table->storage.sw_columns[i]; + ecs_assert(sw->data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ecs_vector_count(sw->data->values) == count, + ECS_INTERNAL_ERROR, NULL); + ecs_assert((ids[i + sw_offset] & ECS_ROLE_MASK) == + ECS_SWITCH, ECS_INTERNAL_ERROR, NULL); + } } - const EcsComponent *component = ecs_get(world, e, EcsComponent); - if ((!component || !component->size) && pair) { - /* If this is a pair column and the pair is not a component, use - * the component type of the component the pair is applied to. */ - e = ECS_PAIR_SECOND(pair); - - /* Because generations are not stored in the pair, get the currently - * alive id */ - e = ecs_get_alive(world, e); - - /* If a pair is used with a not alive id, the pair is not valid */ - ecs_assert(e != 0, ECS_INTERNAL_ERROR, NULL); - - component = ecs_get(world, e, EcsComponent); + if (bs_count) { + ecs_assert(table->storage.bs_columns != NULL, + ECS_INTERNAL_ERROR, NULL); + for (i = 0; i < bs_count; i ++) { + ecs_bs_column_t *bs = &table->storage.bs_columns[i]; + ecs_assert(flecs_bitset_count(&bs->data) == count, + ECS_INTERNAL_ERROR, NULL); + ecs_assert((ids[i + bs_offset] & ECS_ROLE_MASK) == + ECS_DISABLED, ECS_INTERNAL_ERROR, NULL); + } } - - return component; } +#else +#define check_table_sanity(table) +#endif -/* Ensure the ids used in the columns exist */ +/* Count number of switch columns */ static -int32_t ensure_columns( - ecs_world_t *world, +int32_t switch_column_count( ecs_table_t *table) { - int32_t i, count = ecs_vector_count(table->type); - ecs_id_t* ids = ecs_vector_first(table->type, ecs_id_t); + int32_t i, sw_count = 0, count = ecs_vector_count(table->type); + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - for (i = 0; i < count; i++) { - ecs_ensure_id(world, ids[i]); + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; + if (ECS_HAS_ROLE(id, SWITCH)) { + if (!sw_count) { + table->sw_column_offset = i; + } + sw_count ++; + } } - return count; -} - -static -ecs_vector_t* ids_to_vector( - const ecs_ids_t *entities) -{ - if (entities->count) { - ecs_vector_t *result = NULL; - ecs_vector_set_count(&result, ecs_entity_t, entities->count); - ecs_entity_t *array = ecs_vector_first(result, ecs_entity_t); - ecs_os_memcpy_n(array, entities->array, ecs_entity_t, entities->count); - return result; - } else { - return NULL; - } + return sw_count; } +/* Count number of bitset columns */ static -void table_diff_free( - ecs_table_diff_t *diff) +int32_t bitset_column_count( + ecs_table_t *table) { - ecs_os_free(diff->added.array); - ecs_os_free(diff->removed.array); - ecs_os_free(diff->on_set.array); - ecs_os_free(diff->un_set.array); - ecs_os_free(diff); -} + int32_t count = 0; + ecs_vector_each(table->type, ecs_entity_t, c_ptr, { + ecs_entity_t component = *c_ptr; -static -ecs_graph_edge_t* graph_edge_new( - ecs_world_t *world) -{ - ecs_graph_edge_t *result = (ecs_graph_edge_t*)world->store.first_free; - if (result) { - world->store.first_free = result->hdr.next; - ecs_os_zeromem(result); - } else { - result = ecs_os_calloc_t(ecs_graph_edge_t); - } - return result; -} + if (ECS_HAS_ROLE(component, DISABLED)) { + if (!count) { + table->bs_column_offset = c_ptr_i; + } + count ++; + } + }); -static -void graph_edge_free( - ecs_world_t *world, - ecs_graph_edge_t *edge) -{ - if (world->is_fini) { - ecs_os_free(edge); - } else { - edge->hdr.next = world->store.first_free; - world->store.first_free = &edge->hdr; - } + return count; } static -ecs_graph_edge_t* ensure_hi_edge( - ecs_world_t *world, - ecs_graph_edges_t *edges, - ecs_id_t id) +void init_storage_map( + ecs_table_t *table) { - if (!ecs_map_is_initialized(&edges->hi)) { - ecs_map_init(&edges->hi, ecs_graph_edge_t*, 1); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + if (!table->storage_table) { + return; } - ecs_graph_edge_t **ep = ecs_map_ensure(&edges->hi, ecs_graph_edge_t*, id); - ecs_graph_edge_t *edge = ep[0]; - if (edge) { - return edge; - } + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + int32_t t, ids_count = ecs_vector_count(table->type); + ecs_id_t *storage_ids = ecs_vector_first(table->storage_type, ecs_id_t); + int32_t s, storage_ids_count = ecs_vector_count(table->storage_type); - if (id < ECS_HI_COMPONENT_ID) { - edge = &edges->lo[id]; - } else { - edge = graph_edge_new(world); + if (!ids_count) { + table->storage_map = NULL; + return; } - ep[0] = edge; - return edge; -} + table->storage_map = ecs_os_malloc_n( + int32_t, ids_count + storage_ids_count); -static -ecs_graph_edge_t* ensure_edge( - ecs_world_t *world, - ecs_graph_edges_t *edges, - ecs_id_t id) -{ - ecs_graph_edge_t *edge; - - if (id < ECS_HI_COMPONENT_ID) { - if (!edges->lo) { - edges->lo = ecs_os_calloc_n(ecs_graph_edge_t, ECS_HI_COMPONENT_ID); - } - edge = &edges->lo[id]; - } else { - if (!ecs_map_is_initialized(&edges->hi)) { - ecs_map_init(&edges->hi, ecs_graph_edge_t*, 1); - } - edge = ensure_hi_edge(world, edges, id); - } + int32_t *t2s = table->storage_map; + int32_t *s2t = &table->storage_map[ids_count]; - return edge; -} + for (s = 0, t = 0; (t < ids_count) && (s < storage_ids_count); ) { + ecs_id_t id = ids[t]; + ecs_id_t storage_id = storage_ids[s]; -static -void disconnect_edge( - ecs_world_t *world, - ecs_id_t id, - ecs_graph_edge_t *edge) -{ - ecs_assert(edge != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->id == id, ECS_INTERNAL_ERROR, NULL); - (void)id; + if (id == storage_id) { + t2s[t] = s; + s2t[s] = t; + } else { + t2s[t] = -1; + } - /* Remove backref from destination table */ - ecs_graph_edge_hdr_t *next = edge->hdr.next; - ecs_graph_edge_hdr_t *prev = edge->hdr.prev; + /* Ids can never get ahead of storage id, as ids are a superset of the + * storage ids */ + ecs_assert(id <= storage_id, ECS_INTERNAL_ERROR, NULL); - if (next) { - next->prev = prev; - } - if (prev) { - prev->next = next; + t += (id <= storage_id); + s += (id == storage_id); } - /* Remove data associated with edge */ - ecs_table_diff_t *diff = edge->diff; - if (diff && diff != &ecs_table_edge_is_component) { - table_diff_free(diff); - } + /* Storage ids is always a subset of ids, so all should be iterated */ + ecs_assert(s == storage_ids_count, ECS_INTERNAL_ERROR, NULL); - /* If edge id is low, clear it from fast lookup array */ - if (id < ECS_HI_COMPONENT_ID) { - edge->from = NULL; - } else { - graph_edge_free(world, edge); + /* Initialize remainder of type -> storage_type map */ + for (; (t < ids_count); t ++) { + t2s[t] = -1; } } static -void remove_edge( +void init_storage_table( ecs_world_t *world, - ecs_graph_edges_t *edges, - ecs_id_t id, - ecs_graph_edge_t *edge) + ecs_table_t *table) { - ecs_assert(edges != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ecs_map_is_initialized(&edges->hi), ECS_INTERNAL_ERROR, NULL); - disconnect_edge(world, id, edge); - ecs_map_remove(&edges->hi, id); -} + if (table->storage_table) { + return; + } + + int32_t i, count = ecs_vector_count(table->type); + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + ecs_ids_t storage_ids = { + .array = ecs_os_alloca_n(ecs_id_t, count) + }; -static -void init_edges( - ecs_graph_edges_t *edges) -{ - edges->lo = NULL; - ecs_os_zeromem(&edges->hi); -} + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; -static -void init_node( - ecs_graph_node_t *node) -{ - init_edges(&node->add); - init_edges(&node->remove); -} + if ((id == ecs_id(EcsComponent)) || + (ECS_PAIR_FIRST(id) == ecs_id(EcsIdentifier))) + { + storage_ids.array[storage_ids.count ++] = id; + continue; + } -typedef struct { - int32_t first; - int32_t count; -} id_first_count_t; + const EcsComponent *comp = flecs_component_from_id(world, id); + if (!comp || !comp->size) { + continue; + } -static -void set_trigger_flags_for_id( - ecs_world_t *world, - ecs_table_t *table, - ecs_id_t id) -{ - /* Set flags if triggers are registered for table */ - if (flecs_check_triggers_for_event(world, id, EcsOnAdd)) { - table->flags |= EcsTableHasOnAdd; - } - if (flecs_check_triggers_for_event(world, id, EcsOnRemove)) { - table->flags |= EcsTableHasOnRemove; + storage_ids.array[storage_ids.count ++] = id; } - if (flecs_check_triggers_for_event(world, id, EcsOnSet)) { - table->flags |= EcsTableHasOnSet; + + if (storage_ids.count && storage_ids.count != count) { + table->storage_table = flecs_table_find_or_create(world, &storage_ids); + table->storage_type = table->storage_table->type; + table->storage_table->refcount ++; + ecs_assert(table->storage_table != NULL, ECS_INTERNAL_ERROR, NULL); + } else if (storage_ids.count) { + table->storage_table = table; + table->storage_type = table->storage_table->type; + ecs_assert(table->storage_table != NULL, ECS_INTERNAL_ERROR, NULL); } - if (flecs_check_triggers_for_event(world, id, EcsUnSet)) { - table->flags |= EcsTableHasUnSet; + + if (!table->storage_map) { + init_storage_map(table); } } static -void register_table_for_id( - ecs_world_t *world, - ecs_table_t *table, - ecs_id_t id, - int32_t column, - int32_t count, - ecs_table_record_t *tr) +ecs_flags32_t type_info_flags( + const ecs_type_info_t *ti) { - id = ecs_strip_generation(id); + ecs_flags32_t flags = 0; - ecs_id_record_t *idr = flecs_ensure_id_record(world, id); - ecs_table_cache_insert(&idr->cache, table, &tr->hdr); - tr->column = column; - tr->count = count; - tr->id = id; - set_trigger_flags_for_id(world, table, id); - ecs_assert(tr->hdr.table == table, ECS_INTERNAL_ERROR, NULL); + if (ti->lifecycle.ctor) { + flags |= EcsTableHasCtors; + } + if (ti->lifecycle.dtor) { + flags |= EcsTableHasDtors; + } + if (ti->lifecycle.on_remove) { + flags |= EcsTableHasDtors; + } + if (ti->lifecycle.copy) { + flags |= EcsTableHasCopy; + } + if (ti->lifecycle.move) { + flags |= EcsTableHasMove; + } + + return flags; } static -void flecs_table_records_register( +void init_type_info( ecs_world_t *world, ecs_table_t *table) { - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - int32_t count = ecs_vector_count(table->type); + ecs_table_t *storage_table = table->storage_table; + if (!storage_table) { + return; + } - if (!count) { + if (storage_table != table) { + /* Because the storage table is guaranteed to have the same components + * (but not tags) as this table, we can share the type info cache */ + table->type_info = storage_table->type_info; + table->flags |= storage_table->flags; return; } - /* Count number of unique ids, pairs, relations and objects so we can figure - * out how many table records are needed for this table. */ - int32_t id_count = 0, pair_count = 0, type_flag_count = 0; - int32_t first_id = -1, first_pair = -1; - ecs_map_t relations = ECS_MAP_INIT(0), objects = ECS_MAP_INIT(0); - bool has_childof = false; + ecs_type_t type = table->storage_type; + ecs_assert(type != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t i, count = ecs_vector_count(type); + + table->type_info = ecs_os_calloc_n(ecs_type_info_t, count); - int32_t i; for (i = 0; i < count; i ++) { ecs_id_t id = ids[i]; - ecs_entity_t rel = 0, obj = 0; + ecs_entity_t t = ecs_get_typeid(world, id); - if (ECS_HAS_ROLE(id, PAIR)) { - id_first_count_t *r; + /* Component type info must have been registered before using it */ + const ecs_type_info_t *ti = flecs_get_type_info(world, t); + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + table->flags |= type_info_flags(ti); + table->type_info[i] = *ti; + } +} - rel = ECS_PAIR_FIRST(id); - obj = ECS_PAIR_SECOND(id); +void flecs_table_init_data( + ecs_world_t *world, + ecs_table_t *table) +{ + init_storage_table(world, table); + init_type_info(world, table); - if (0 == pair_count ++) { - first_pair = i; - } + int32_t sw_count = table->sw_column_count = switch_column_count(table); + int32_t bs_count = table->bs_column_count = bitset_column_count(table); - if (rel == EcsChildOf) { - has_childof = true; - } + ecs_data_t *storage = &table->storage; + ecs_type_t type = table->storage_type; - if (!ecs_map_is_initialized(&relations)) { - ecs_map_init(&relations, id_first_count_t, count); - ecs_map_init(&objects, id_first_count_t, count); - } + int32_t i, count = ecs_vector_count(type); - r = ecs_map_ensure(&relations, id_first_count_t, rel); - if ((++r->count) == 1) { - r->first = i; - } + /* Root tables don't have columns */ + if (!count && !sw_count && !bs_count) { + storage->columns = NULL; + } - r = ecs_map_ensure(&objects, id_first_count_t, obj); - if ((++r->count) == 1) { - r->first = i; - } - } else { - rel = id & ECS_COMPONENT_MASK; - if (rel != id) { - type_flag_count ++; - } + if (count) { + ecs_entity_t *ids = ecs_vector_first(type, ecs_entity_t); + storage->columns = ecs_os_calloc_n(ecs_column_t, count); - if (0 == id_count ++) { - first_id = i; + for (i = 0; i < count; i ++) { + ecs_entity_t id = ids[i]; + + /* Bootstrap components */ + if (id == ecs_id(EcsComponent)) { + storage->columns[i].size = ECS_SIZEOF(EcsComponent); + storage->columns[i].alignment = ECS_ALIGNOF(EcsComponent); + continue; + } else if (ECS_PAIR_FIRST(id) == ecs_id(EcsIdentifier)) { + storage->columns[i].size = ECS_SIZEOF(EcsIdentifier); + storage->columns[i].alignment = ECS_ALIGNOF(EcsIdentifier); + continue; } + + const EcsComponent *component = flecs_component_from_id(world, id); + ecs_assert(component != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(component->size != 0, ECS_INTERNAL_ERROR, NULL); + + storage->columns[i].size = flecs_itoi16(component->size); + storage->columns[i].alignment = flecs_itoi16(component->alignment); } } - int32_t record_count = count + type_flag_count + (id_count != 0) + - (pair_count != 0) + ecs_map_count(&relations) + ecs_map_count(&objects) - + 1 /* for any */; - int32_t r = 0; + if (sw_count) { + ecs_entity_t *ids = ecs_vector_first(table->type, ecs_entity_t); + int32_t sw_offset = table->sw_column_offset; + storage->sw_columns = ecs_os_calloc_n(ecs_sw_column_t, sw_count); - if (!has_childof) { - record_count ++; - } + for (i = 0; i < sw_count; i ++) { + ecs_entity_t e = ids[i + sw_offset]; + ecs_assert(ECS_HAS_ROLE(e, SWITCH), ECS_INTERNAL_ERROR, NULL); + e = e & ECS_COMPONENT_MASK; + const EcsType *type_ptr = ecs_get(world, e, EcsType); + ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_table_t *sw_table = type_ptr->normalized; + ecs_type_t sw_type = sw_table->type; - table->records = ecs_os_calloc_n(ecs_table_record_t, record_count); - table->record_count = record_count; + ecs_entity_t *sw_array = ecs_vector_first(sw_type, ecs_entity_t); + int32_t sw_array_count = ecs_vector_count(sw_type); - /* First initialize records for regular (non-wildcard) ids */ - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - register_table_for_id(world, table, id, i, 1, &table->records[r]); - r ++; - - ecs_entity_t role = id & ECS_ROLE_MASK; - if (role && role != ECS_PAIR) { - id &= ECS_COMPONENT_MASK; - id = ecs_pair(id, EcsWildcard); - register_table_for_id(world, table, id, i, 1, &table->records[r]); - r ++; + ecs_switch_t *sw = flecs_switch_new( + sw_array[0], + sw_array[sw_array_count - 1], + 0); + + storage->sw_columns[i].data = sw; + storage->sw_columns[i].type = sw_table; } } - /* Initialize records for relation wildcards */ - ecs_map_iter_t mit = ecs_map_iter(&relations); - id_first_count_t *elem; - uint64_t key; - while ((elem = ecs_map_next(&mit, id_first_count_t, &key))) { - ecs_id_t id = ecs_pair(key, EcsWildcard); - register_table_for_id(world, table, id, elem->first, elem->count, - &table->records[r]); - r ++; + if (bs_count) { + storage->bs_columns = ecs_os_calloc_n(ecs_bs_column_t, bs_count); + for (i = 0; i < bs_count; i ++) { + flecs_bitset_init(&storage->bs_columns[i].data); + } } +} - /* Initialize records for object wildcards */ - mit = ecs_map_iter(&objects); - while ((elem = ecs_map_next(&mit, id_first_count_t, &key))) { - ecs_id_t id = ecs_pair(EcsWildcard, key); - register_table_for_id(world, table, id, elem->first, elem->count, - &table->records[r]); - r ++; - } +static +void notify_trigger( + ecs_world_t *world, + ecs_table_t *table, + ecs_entity_t event) +{ + (void)world; - /* Initialize records for all wildcards ids */ - if (id_count) { - register_table_for_id(world, table, EcsWildcard, - first_id, id_count, &table->records[r]); - r ++; - } - if (pair_count) { - register_table_for_id(world, table, ecs_pair(EcsWildcard, EcsWildcard), - first_pair, pair_count, &table->records[r]); - r ++; + if (event == EcsOnAdd) { + table->flags |= EcsTableHasOnAdd; + } else if (event == EcsOnRemove) { + table->flags |= EcsTableHasOnRemove; + } else if (event == EcsOnSet) { + table->flags |= EcsTableHasOnSet; + } else if (event == EcsUnSet) { + table->flags |= EcsTableHasUnSet; } +} + +static +void run_on_remove( + ecs_world_t *world, + ecs_table_t *table, + ecs_data_t *data) +{ + int32_t count = ecs_vector_count(data->entities); if (count) { - register_table_for_id(world, table, EcsAny, 0, 1, &table->records[r]); - r ++; + ecs_ids_t removed = { + .array = ecs_vector_first(table->type, ecs_id_t), + .count = ecs_vector_count(table->type) + }; + + ecs_table_diff_t diff = { + .removed = removed, + .un_set = removed + }; + + flecs_notify_on_remove(world, table, NULL, 0, count, &diff); } +} - /* Insert into (ChildOf, 0) (root) if table doesn't have childof */ - if (!has_childof && count) { - register_table_for_id(world, table, ecs_pair(EcsChildOf, 0), - 0, 1, &table->records[r]); +/* -- Private functions -- */ + +static +void ctor_component( + ecs_world_t *world, + ecs_type_info_t *ti, + ecs_column_t *column, + ecs_entity_t *entities, + int32_t row, + int32_t count) +{ + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + + /* A new component is constructed */ + ecs_xtor_t ctor = ti->lifecycle.ctor; + if (ctor) { + int16_t size = column->size; + int16_t alignment = column->alignment; + void *ptr = ecs_vector_get_t(column->data, size, alignment, row); + ctor(world, entities, ptr, count, ti); } +} - ecs_map_fini(&relations); - ecs_map_fini(&objects); +static +void on_remove_component( + ecs_world_t *world, + ecs_table_t *table, + ecs_iter_action_t on_remove, + void *ptr, + ecs_size_t size, + ecs_entity_t *entities, + ecs_id_t id, + int32_t count, + void *ctx) +{ + ecs_iter_t it = { .term_count = 1 }; + it.entities = entities; + + flecs_iter_init(&it); + it.world = world; + it.real_world = world; + it.table = table; + it.type = table->type; + it.ptrs[0] = ptr; + it.sizes[0] = size; + it.ids[0] = id; + it.event = EcsOnRemove; + it.event_id = id; + it.ctx = ctx; + it.count = count; + on_remove(&it); } -void flecs_table_records_unregister( +static +void dtor_component( ecs_world_t *world, - ecs_table_t *table) + ecs_table_t *table, + ecs_type_info_t *ti, + ecs_column_t *column, + ecs_entity_t *entities, + ecs_id_t id, + int32_t row, + int32_t count, + bool is_remove) { - int32_t i, count = table->record_count; - for (i = 0; i < count; i ++) { - ecs_table_record_t *tr = &table->records[i]; - ecs_table_cache_t *cache = tr->hdr.cache; - ecs_id_t id = tr->id; + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(tr->hdr.cache == cache, ECS_INTERNAL_ERROR, NULL); - ecs_assert(tr->hdr.table == table, ECS_INTERNAL_ERROR, NULL); - ecs_assert(flecs_get_id_record(world, id) == (ecs_id_record_t*)cache, - ECS_INTERNAL_ERROR, NULL); + if (!count) { + return; + } - ecs_table_cache_remove(cache, table, &tr->hdr); + ecs_iter_action_t on_remove = 0; + if (is_remove) { + on_remove = ti->lifecycle.on_remove; + } - if (ecs_table_cache_is_empty(cache)) { - ecs_id_record_t *idr = (ecs_id_record_t*)cache; - flecs_remove_id_record(world, id, idr); - } + ecs_xtor_t dtor = ti->lifecycle.dtor; + if (!on_remove && !dtor) { + return; } - - ecs_os_free(table->records); -} -bool flecs_table_records_update_empty( - ecs_table_t *table) -{ - bool result = false; - bool is_empty = ecs_table_count(table) == 0; + void *ctx = ti->lifecycle.ctx; + int16_t size = column->size; + int16_t alignment = column->alignment; + ecs_entity_t *entity_elem = &entities[row]; - int32_t i, count = table->record_count; - for (i = 0; i < count; i ++) { - ecs_table_record_t *tr = &table->records[i]; - ecs_table_cache_t *cache = tr->hdr.cache; - result |= ecs_table_cache_set_empty(cache, table, is_empty); + ecs_assert(column->data != NULL, ECS_INTERNAL_ERROR, NULL); + void *ptr = ecs_vector_get_t(column->data, size, alignment, row); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + + if (on_remove) { + on_remove_component(world, table, on_remove, ptr, size, + entity_elem, id, count, ctx); } - return result; + if (dtor) { + dtor(world, entity_elem, ptr, count, ti); + } } static -void init_flags( +void dtor_all_components( ecs_world_t *world, - ecs_table_t *table) + ecs_table_t *table, + ecs_data_t *data, + int32_t row, + int32_t count, + bool update_entity_index, + bool is_delete) { - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - int32_t count = ecs_vector_count(table->type); - - /* Iterate components to initialize table flags */ - int32_t i; - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - - /* As we're iterating over the table components, also set the table - * flags. These allow us to quickly determine if the table contains - * data that needs to be handled in a special way, like prefabs or - * containers */ - if (id <= EcsLastInternalComponentId) { - table->flags |= EcsTableHasBuiltins; - } + /* Can't delete and not update the entity index */ + ecs_assert(!is_delete || update_entity_index, ECS_INTERNAL_ERROR, NULL); - if (id == EcsModule) { - table->flags |= EcsTableHasBuiltins; - table->flags |= EcsTableHasModule; - } + ecs_id_t *ids = ecs_vector_first(table->storage_type, ecs_id_t); + ecs_record_t **records = ecs_vector_first(data->record_ptrs, ecs_record_t*); + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + int32_t i, c, end = row + count; + int32_t column_count = ecs_vector_count(table->storage_type); - if (id == EcsPrefab) { - table->flags |= EcsTableIsPrefab; - } + (void)records; - /* If table contains disabled entities, mark it as disabled */ - if (id == EcsDisabled) { - table->flags |= EcsTableIsDisabled; - } + /* If table has components with destructors, iterate component columns */ + if (table->flags & EcsTableHasDtors) { + /* Prevent the storage from getting modified while deleting */ + ecs_defer_begin(world); - /* Does table have exclusive or columns */ - if (ECS_HAS_ROLE(id, XOR)) { - table->flags |= EcsTableHasXor; - } + /* Throw up a lock just to be sure */ + table->lock = true; - /* Does the table have pairs */ - if (ECS_HAS_ROLE(id, PAIR)) { - table->flags |= EcsTableHasPairs; + /* Run on_remove callbacks in bulk for improved performance */ + for (c = 0; c < column_count; c++) { + ecs_column_t *column = &data->columns[c]; + ecs_type_info_t *ti = &table->type_info[c]; + ecs_iter_action_t on_remove = ti->lifecycle.on_remove; + if (on_remove) { + ecs_size_t size = column->size; + ecs_size_t align = column->alignment; + void *ptr = ecs_vector_get_t(column->data, size, align, row); + on_remove_component(world, table, on_remove, ptr, column->size, + &entities[row], ids[c], count, ti->lifecycle.ctx); + } } - /* Does table have IsA relations */ - if (ECS_HAS_RELATION(id, EcsIsA)) { - table->flags |= EcsTableHasIsA; - } + /* Iterate entities first, then components. This ensures that only one + * entity is invalidated at a time, which ensures that destructors can + * safely access other entities. */ + for (i = row; i < end; i ++) { + for (c = 0; c < column_count; c++) { + ecs_column_t *column = &data->columns[c]; + dtor_component(world, table, &table->type_info[c], column, + entities, ids[c], i, 1, false); + } - /* Does table have ChildOf relations */ - if (ECS_HAS_RELATION(id, EcsChildOf)) { - table->flags |= EcsTableHasChildOf; - } + /* Update entity index after invoking destructors so that entity can + * be safely used in destructor callbacks. */ + if (update_entity_index) { + ecs_entity_t e = entities[i]; + ecs_assert(!e || ecs_is_valid(world, e), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i] == ecs_eis_get(world, e), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i]->table == table, + ECS_INTERNAL_ERROR, NULL); - /* Does table have switch columns */ - if (ECS_HAS_ROLE(id, SWITCH)) { - table->flags |= EcsTableHasSwitch; + if (is_delete) { + ecs_eis_delete(world, e); + ecs_assert(ecs_is_valid(world, e) == false, + ECS_INTERNAL_ERROR, NULL); + } else { + // If this is not a delete, clear the entity index record + records[i]->table = NULL; + records[i]->row = 0; + } + } else { + /* This should only happen in rare cases, such as when the data + * cleaned up is not part of the world (like with snapshots) */ + } } - /* Does table support component disabling */ - if (ECS_HAS_ROLE(id, DISABLED)) { - table->flags |= EcsTableHasDisabled; - } + table->lock = false; + + ecs_defer_end(world); - if (ECS_HAS_RELATION(id, EcsChildOf)) { - ecs_poly_assert(world, ecs_world_t); - ecs_entity_t obj = ecs_pair_second(world, id); - ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); + /* If table does not have destructors, just update entity index */ + } else if (update_entity_index) { + if (is_delete) { + for (i = row; i < end; i ++) { + ecs_entity_t e = entities[i]; + ecs_assert(!e || ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i] == ecs_eis_get(world, e), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i]->table == table, + ECS_INTERNAL_ERROR, NULL); - if (obj == EcsFlecs || obj == EcsFlecsCore || - ecs_has_id(world, obj, EcsModule)) - { - /* If table contains entities that are inside one of the builtin - * modules, it contains builtin entities */ - table->flags |= EcsTableHasBuiltins; - table->flags |= EcsTableHasModule; + ecs_eis_delete(world, e); + ecs_assert(!ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); + } + } else { + for (i = row; i < end; i ++) { + ecs_entity_t e = entities[i]; + ecs_assert(!e || ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i] == ecs_eis_get(world, e), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!e || records[i]->table == table, + ECS_INTERNAL_ERROR, NULL); + records[i]->table = NULL; + records[i]->row = 0; + (void)e; } } } } static -void init_table( +void fini_data( ecs_world_t *world, - ecs_table_t *table) + ecs_table_t *table, + ecs_data_t *data, + bool do_on_remove, + bool update_entity_index, + bool is_delete, + bool deactivate) { - table->type_info = NULL; - table->flags = 0; - table->dirty_state = NULL; - table->alloc_count = 0; - table->lock = 0; - table->refcount = 1; + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - /* Ensure the component ids for the table exist */ - ensure_columns(world, table); + if (!data) { + return; + } - init_node(&table->node); - init_flags(world, table); - flecs_table_records_register(world, table); - flecs_table_init_data(world, table); -} + ecs_flags32_t flags = table->flags; -static -ecs_table_t *create_table( - ecs_world_t *world, - ecs_vector_t *type, - flecs_hashmap_result_t table_elem) -{ - ecs_table_t *result = flecs_sparse_add(&world->store.tables, ecs_table_t); - ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); + if (do_on_remove && (flags & EcsTableHasOnRemove)) { + run_on_remove(world, table, data); + } - ecs_vector_reclaim(&type, ecs_id_t); + int32_t count = flecs_table_data_count(data); + if (count) { + dtor_all_components(world, table, data, 0, count, + update_entity_index, is_delete); + } - result->id = flecs_sparse_last_id(&world->store.tables); - result->type = type; + /* Sanity check */ + ecs_assert(ecs_vector_count(data->record_ptrs) == + ecs_vector_count(data->entities), ECS_INTERNAL_ERROR, NULL); - init_table(world, result); + ecs_column_t *columns = data->columns; + if (columns) { + int32_t c, column_count = ecs_vector_count(table->storage_type); + for (c = 0; c < column_count; c ++) { + /* Sanity check */ + ecs_assert(!columns[c].data || (ecs_vector_count(columns[c].data) == + ecs_vector_count(data->entities)), ECS_INTERNAL_ERROR, NULL); - if (ecs_should_log_2()) { - char *expr = ecs_type_str(world, result->type); - ecs_dbg_2( - "#[green]table#[normal] [%s] #[green]created#[normal] with id %d", - expr, result->id); - ecs_os_free(expr); + ecs_vector_free(columns[c].data); + } + ecs_os_free(columns); + data->columns = NULL; } - ecs_log_push_2(); - - /* Store table in table hashmap */ - *(ecs_table_t**)table_elem.value = result; + ecs_sw_column_t *sw_columns = data->sw_columns; + if (sw_columns) { + int32_t c, column_count = table->sw_column_count; + for (c = 0; c < column_count; c ++) { + flecs_switch_free(sw_columns[c].data); + } + ecs_os_free(sw_columns); + data->sw_columns = NULL; + } - /* Set keyvalue to one that has the same lifecycle as the table */ - ecs_ids_t key = { - .array = ecs_vector_first(result->type, ecs_id_t), - .count = ecs_vector_count(result->type) - }; - *(ecs_ids_t*)table_elem.key = key; + ecs_bs_column_t *bs_columns = data->bs_columns; + if (bs_columns) { + int32_t c, column_count = table->bs_column_count; + for (c = 0; c < column_count; c ++) { + flecs_bitset_fini(&bs_columns[c].data); + } + ecs_os_free(bs_columns); + data->bs_columns = NULL; + } - flecs_notify_queries(world, &(ecs_query_event_t) { - .kind = EcsQueryTableMatch, - .table = result - }); + ecs_vector_free(data->entities); + ecs_vector_free(data->record_ptrs); - ecs_log_pop_2(); + data->entities = NULL; + data->record_ptrs = NULL; - return result; -} - -static -ecs_table_t* find_or_create( - ecs_world_t *world, - const ecs_ids_t *ids, - ecs_vector_t *type) -{ - ecs_poly_assert(world, ecs_world_t); - - /* Make sure array is ordered and does not contain duplicates */ - int32_t id_count = ids->count; - - if (!id_count) { - return &world->store.root; - } - - ecs_table_t *table; - flecs_hashmap_result_t elem = flecs_hashmap_ensure( - &world->store.table_map, ids, ecs_table_t*); - if ((table = *(ecs_table_t**)elem.value)) { - if (type) { - ecs_vector_free(type); - } - return table; - } - - if (!type) { - type = ids_to_vector(ids); + if (deactivate && count) { + flecs_table_set_empty(world, table); } - - /* If we get here, table needs to be created which is only allowed when the - * application is not currently in progress */ - ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); - - /* If we get here, the table has not been found, so create it. */ - return create_table(world, type, elem); } -static -void add_id_to_ids( - ecs_vector_t **idv, - ecs_entity_t add, - ecs_entity_t r_exclusive) +/* Cleanup, no OnRemove, don't update entity index, don't deactivate table */ +void flecs_table_clear_data( + ecs_world_t *world, + ecs_table_t *table, + ecs_data_t *data) { - int32_t i, count = ecs_vector_count(idv[0]); - ecs_id_t *array = ecs_vector_first(idv[0], ecs_id_t); - - for (i = 0; i < count; i ++) { - ecs_id_t e = array[i]; + fini_data(world, table, data, false, false, false, false); +} - if (e == add) { - return; - } +/* Cleanup, no OnRemove, clear entity index, deactivate table */ +void flecs_table_clear_entities_silent( + ecs_world_t *world, + ecs_table_t *table) +{ + fini_data(world, table, &table->storage, false, true, false, true); +} - if (r_exclusive && ECS_HAS_ROLE(e, PAIR)) { - if (ECS_PAIR_FIRST(e) == r_exclusive) { - array[i] = add; /* Replace */ - return; - } - } +/* Cleanup, run OnRemove, clear entity index, deactivate table */ +void flecs_table_clear_entities( + ecs_world_t *world, + ecs_table_t *table) +{ + fini_data(world, table, &table->storage, true, true, false, true); +} - if (e >= add) { - if (e != add) { - ecs_id_t *ptr = ecs_vector_insert_at(idv, ecs_id_t, i); - ptr[0] = add; - return; - } - } - } +/* Cleanup, run OnRemove, delete from entity index, deactivate table */ +void flecs_table_delete_entities( + ecs_world_t *world, + ecs_table_t *table) +{ + fini_data(world, table, &table->storage, true, true, true, true); +} - ecs_id_t *ptr = ecs_vector_add(idv, ecs_id_t); - ptr[0] = add; +/* Unset all components in table. This function is called before a table is + * deleted, and invokes all UnSet handlers, if any */ +void flecs_table_remove_actions( + ecs_world_t *world, + ecs_table_t *table) +{ + (void)world; + run_on_remove(world, table, &table->storage); } -static -void remove_id_from_ids( - ecs_type_t type, - ecs_id_t remove, - ecs_ids_t *out) +/* Free table resources. */ +void flecs_table_free( + ecs_world_t *world, + ecs_table_t *table) { - int32_t count = ecs_vector_count(type); - ecs_id_t *array = ecs_vector_first(type, ecs_id_t); - int32_t i, el = 0; + bool is_root = table == &world->store.root; + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + ecs_assert(is_root || table->id != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(is_root || flecs_sparse_is_alive(&world->store.tables, table->id), + ECS_INTERNAL_ERROR, NULL); + (void)world; - if (ecs_id_is_wildcard(remove)) { - for (i = 0; i < count; i ++) { - ecs_id_t id = array[i]; - if (!ecs_id_match(id, remove)) { - out->array[el ++] = id; - ecs_assert(el <= count, ECS_INTERNAL_ERROR, NULL); - } - } - } else { - for (i = 0; i < count; i ++) { - ecs_id_t id = array[i]; - if (id != remove) { - out->array[el ++] = id; - ecs_assert(el <= count, ECS_INTERNAL_ERROR, NULL); - } - } + ecs_assert(table->refcount == 0, ECS_INTERNAL_ERROR, NULL); + + if (!is_root) { + flecs_notify_queries( + world, &(ecs_query_event_t){ + .kind = EcsQueryTableUnmatch, + .table = table + }); } - out->count = el; -} + if (ecs_should_log_2()) { + char *expr = ecs_type_str(world, table->type); + ecs_dbg_2( + "#[green]table#[normal] [%s] #[red]deleted#[normal] with id %d", + expr, table->id); + ecs_os_free(expr); + } -int32_t flecs_table_switch_from_case( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_entity_t add) -{ - ecs_type_t type = table->type; - ecs_entity_t *array = ecs_vector_first(type, ecs_entity_t); + /* Cleanup data, no OnRemove, delete from entity index, don't deactivate */ + fini_data(world, table, &table->storage, false, true, true, false); - int32_t i, count = table->sw_column_count; - ecs_assert(count != 0, ECS_INTERNAL_ERROR, NULL); + flecs_table_clear_edges(world, table); - add = add & ECS_COMPONENT_MASK; + if (!is_root) { + ecs_ids_t ids = { + .array = ecs_vector_first(table->type, ecs_id_t), + .count = ecs_vector_count(table->type) + }; - ecs_sw_column_t *sw_columns = NULL; + flecs_hashmap_remove(&world->store.table_map, &ids, ecs_table_t*); + } - if ((sw_columns = table->storage.sw_columns)) { - /* Fast path, we can get the switch type from the column data */ - for (i = 0; i < count; i ++) { - ecs_table_t *sw_type = sw_columns[i].type; - if (ecs_search(world, sw_type, add, 0) != -1) { - return i; - } - } - } else { - /* Slow path, table is empty, so we'll have to get the switch types by - * actually inspecting the switch type entities. */ - for (i = 0; i < count; i ++) { - ecs_entity_t e = array[i + table->sw_column_offset]; - ecs_assert(ECS_HAS_ROLE(e, SWITCH), ECS_INTERNAL_ERROR, NULL); - e = e & ECS_COMPONENT_MASK; + ecs_os_free(table->dirty_state); + ecs_os_free(table->storage_map); - const EcsType *type_ptr = ecs_get(world, e, EcsType); - ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); + flecs_table_records_unregister(world, table); - if (ecs_search(world, type_ptr->normalized, add, 0) != -1) { - return i; - } + ecs_table_t *storage_table = table->storage_table; + if (storage_table == table) { + if (table->type_info) { + ecs_os_free(table->type_info); } + } else if (storage_table) { + flecs_table_release(world, storage_table); } - /* If a table was not found, this is an invalid switch case */ - ecs_abort(ECS_TYPE_INVALID_CASE, NULL); - - return -1; + if (!world->is_fini) { + ecs_assert(!is_root, ECS_INTERNAL_ERROR, NULL); + flecs_table_free_type(table); + flecs_sparse_remove(&world->store.tables, table->id); + } } -static -void ids_append( - ecs_ids_t *ids, - ecs_id_t id) +void flecs_table_claim( + ecs_world_t *world, + ecs_table_t *table) { - ids->array = ecs_os_realloc_n(ids->array, ecs_id_t, ids->count + 1); - ids->array[ids->count ++] = id; + ecs_poly_assert(world, ecs_world_t); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table->refcount > 0, ECS_INTERNAL_ERROR, NULL); + table->refcount ++; + (void)world; } -static -void diff_insert_isa( +bool flecs_table_release( ecs_world_t *world, - ecs_table_t *table, - ecs_table_diff_t *base_diff, - ecs_ids_t *append_to, - ecs_ids_t *append_from, - ecs_id_t add) + ecs_table_t *table) { - ecs_entity_t base = ecs_pair_second(world, add); - ecs_table_t *base_table = ecs_get_table(world, base); - if (!base_table) { - return; - } - - ecs_type_t base_type = base_table->type, type = table->type; - ecs_table_t *table_wo_base = base_table; - - /* If the table does not have a component from the base, it should - * trigger an OnSet */ - ecs_id_t *ids = ecs_vector_first(base_type, ecs_id_t); - int32_t j, i, count = ecs_vector_count(base_type); - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - - if (ECS_HAS_RELATION(id, EcsIsA)) { - /* The base has an IsA relation. Find table without the base, which - * gives us the list of ids the current base inherits and doesn't - * override. This saves us from having to recursively check for each - * base in the hierarchy whether the component is overridden. */ - table_wo_base = flecs_table_traverse_remove( - world, table_wo_base, &id, base_diff); - - /* Because we removed, the ids are stored in un_set vs. on_set */ - for (j = 0; j < append_from->count; j ++) { - ecs_id_t base_id = append_from->array[j]; - /* We still have to make sure the id isn't overridden by the - * current table */ - if (!type || ecs_search(world, table, base_id, NULL) == -1) { - ids_append(append_to, base_id); - } - } - - continue; - } - - /* Identifiers are not inherited */ - if (ECS_HAS_RELATION(id, ecs_id(EcsIdentifier))) { - continue; - } - - if (!ecs_get_typeid(world, id)) { - continue; - } + ecs_poly_assert(world, ecs_world_t); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table->refcount > 0, ECS_INTERNAL_ERROR, NULL); - if (!type || ecs_search(world, table, id, NULL) == -1) { - ids_append(append_to, id); - } + if (--table->refcount == 0) { + flecs_table_free(world, table); + return true; } + + return false; } -static -void diff_insert_added_isa( +/* Free table type. Do this separately from freeing the table as types can be + * in use by application destructors. */ +void flecs_table_free_type( + ecs_table_t *table) +{ + ecs_vector_free((ecs_vector_t*)table->type); +} + +/* Reset a table to its initial state. */ +void flecs_table_reset( ecs_world_t *world, - ecs_table_t *table, - ecs_table_diff_t *diff, - ecs_id_t id) + ecs_table_t *table) { - ecs_table_diff_t base_diff; - diff_insert_isa(world, table, &base_diff, &diff->on_set, - &base_diff.un_set, id); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + flecs_table_clear_edges(world, table); } static -void diff_insert_removed_isa( +void mark_table_dirty( ecs_world_t *world, ecs_table_t *table, - ecs_table_diff_t *diff, - ecs_id_t id) + int32_t index) { - ecs_table_diff_t base_diff; - diff_insert_isa(world, table, &base_diff, &diff->un_set, - &base_diff.un_set, id); + (void)world; + if (table->dirty_state) { + table->dirty_state[index] ++; + } } -static -void diff_insert_added( +void flecs_table_mark_dirty( ecs_world_t *world, ecs_table_t *table, - ecs_table_diff_t *diff, - ecs_id_t id) + ecs_entity_t component) { - diff->added.array[diff->added.count ++] = id; + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - if (ECS_HAS_RELATION(id, EcsIsA)) { - diff_insert_added_isa(world, table, diff, id); + if (table->dirty_state) { + int32_t index = ecs_search(world, table->storage_table, component, 0); + ecs_assert(index != -1, ECS_INTERNAL_ERROR, NULL); + table->dirty_state[index + 1] ++; } } static -void diff_insert_removed( - ecs_world_t *world, - ecs_table_t *table, - ecs_table_diff_t *diff, - ecs_id_t id) +void move_switch_columns( + ecs_table_t *new_table, + ecs_data_t *new_data, + int32_t new_index, + ecs_table_t *old_table, + ecs_data_t *old_data, + int32_t old_index, + int32_t count, + bool clear) { - diff->removed.array[diff->removed.count ++] = id; + int32_t i_old = 0, old_column_count = old_table->sw_column_count; + int32_t i_new = 0, new_column_count = new_table->sw_column_count; - if (ECS_HAS_RELATION(id, EcsIsA)) { - /* Removing an IsA relation also "removes" all components from the - * instance. Any id from base that's not overridden should be UnSet. */ - diff_insert_removed_isa(world, table, diff, id); + if (!old_column_count && !new_column_count) { return; } - if (table->flags & EcsTableHasIsA) { - if (!ecs_get_typeid(world, id)) { - /* Do nothing if id is not a component */ - return; - } + ecs_sw_column_t *old_columns = old_data->sw_columns; + ecs_sw_column_t *new_columns = new_data->sw_columns; - /* If next table has a base and component is removed, check if - * the removed component was an override. Removed overrides reexpose the - * base component, thus "changing" the value which requires an OnSet. */ - if (ecs_search_relation(world, table, 0, id, EcsIsA, - 1, -1, NULL, NULL, NULL) != -1) - { - ids_append(&diff->on_set, id); - return; + ecs_type_t new_type = new_table->type; + ecs_type_t old_type = old_table->type; + + int32_t offset_new = new_table->sw_column_offset; + int32_t offset_old = old_table->sw_column_offset; + + ecs_id_t *new_ids = ecs_vector_first(new_type, ecs_id_t); + ecs_id_t *old_ids = ecs_vector_first(old_type, ecs_id_t); + + for (; (i_new < new_column_count) && (i_old < old_column_count);) { + ecs_entity_t new_id = new_ids[i_new + offset_new]; + ecs_entity_t old_id = old_ids[i_old + offset_old]; + + if (new_id == old_id) { + ecs_switch_t *old_switch = old_columns[i_old].data; + ecs_switch_t *new_switch = new_columns[i_new].data; + + flecs_switch_ensure(new_switch, new_index + count); + + int i; + for (i = 0; i < count; i ++) { + uint64_t value = flecs_switch_get(old_switch, old_index + i); + flecs_switch_set(new_switch, new_index + i, value); + } + + if (clear) { + ecs_assert(count == flecs_switch_count(old_switch), + ECS_INTERNAL_ERROR, NULL); + flecs_switch_clear(old_switch); + } } + + i_new += new_id <= old_id; + i_old += new_id >= old_id; } - if (ecs_get_typeid(world, id) != 0) { - ids_append(&diff->un_set, id); + /* Clear remaining columns */ + if (clear) { + for (; (i_old < old_column_count); i_old ++) { + ecs_switch_t *old_switch = old_columns[i_old].data; + ecs_assert(count == flecs_switch_count(old_switch), + ECS_INTERNAL_ERROR, NULL); + flecs_switch_clear(old_switch); + } } } static -void compute_table_diff( - ecs_world_t *world, - ecs_table_t *node, - ecs_table_t *next, - ecs_graph_edge_t *edge, - ecs_id_t id) +void move_bitset_columns( + ecs_table_t *new_table, + ecs_data_t *new_data, + int32_t new_index, + ecs_table_t *old_table, + ecs_data_t *old_data, + int32_t old_index, + int32_t count, + bool clear) { - if (node == next) { + int32_t i_old = 0, old_column_count = old_table->bs_column_count; + int32_t i_new = 0, new_column_count = new_table->bs_column_count; + + if (!old_column_count && !new_column_count) { return; } - ecs_type_t node_type = node->type; - ecs_type_t next_type = next->type; + ecs_bs_column_t *old_columns = old_data->bs_columns; + ecs_bs_column_t *new_columns = new_data->bs_columns; - ecs_id_t *ids_node = ecs_vector_first(node_type, ecs_id_t); - ecs_id_t *ids_next = ecs_vector_first(next_type, ecs_id_t); - int32_t i_node = 0, node_count = ecs_vector_count(node_type); - int32_t i_next = 0, next_count = ecs_vector_count(next_type); - int32_t added_count = 0; - int32_t removed_count = 0; - bool trivial_edge = !ECS_HAS_RELATION(id, EcsIsA) && - !(node->flags & EcsTableHasIsA) && !(next->flags & EcsTableHasIsA); + ecs_type_t new_type = new_table->type; + ecs_type_t old_type = old_table->type; - /* First do a scan to see how big the diff is, so we don't have to realloc - * or alloc more memory than required. */ - for (; i_node < node_count && i_next < next_count; ) { - ecs_id_t id_node = ids_node[i_node]; - ecs_id_t id_next = ids_next[i_next]; + int32_t offset_new = new_table->bs_column_offset; + int32_t offset_old = old_table->bs_column_offset; - bool added = id_next < id_node; - bool removed = id_node < id_next; + ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); + ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - trivial_edge &= !added || id_next == id; - trivial_edge &= !removed || id_node == id; + for (; (i_new < new_column_count) && (i_old < old_column_count);) { + ecs_entity_t new_component = new_components[i_new + offset_new]; + ecs_entity_t old_component = old_components[i_old + offset_old]; - added_count += added; - removed_count += removed; + if (new_component == old_component) { + ecs_bitset_t *old_bs = &old_columns[i_old].data; + ecs_bitset_t *new_bs = &new_columns[i_new].data; - i_node += id_node <= id_next; - i_next += id_next <= id_node; - } + flecs_bitset_ensure(new_bs, new_index + count); - added_count += next_count - i_next; - removed_count += node_count - i_node; + int i; + for (i = 0; i < count; i ++) { + uint64_t value = flecs_bitset_get(old_bs, old_index + i); + flecs_bitset_set(new_bs, new_index + i, value); + } - trivial_edge &= (added_count + removed_count) <= 1 && - !ecs_id_is_wildcard(id); + if (clear) { + ecs_assert(count == flecs_bitset_count(old_bs), + ECS_INTERNAL_ERROR, NULL); + flecs_bitset_fini(old_bs); + } + } - if (trivial_edge) { - /* If edge is trivial there's no need to create a diff element for it. - * Store whether the id is a tag or not, so that we can still tell - * whether an UnSet handler should be called or not. */ - if (node->storage_table != next->storage_table) { - edge->diff = &ecs_table_edge_is_component; + i_new += new_component <= old_component; + i_old += new_component >= old_component; + } + + /* Clear remaining columns */ + if (clear) { + for (; (i_old < old_column_count); i_old ++) { + ecs_bitset_t *old_bs = &old_columns[i_old].data; + ecs_assert(count == flecs_bitset_count(old_bs), + ECS_INTERNAL_ERROR, NULL); + flecs_bitset_fini(old_bs); } - return; } +} - ecs_table_diff_t *diff = ecs_os_calloc_t(ecs_table_diff_t); - edge->diff = diff; - if (added_count) { - diff->added.array = ecs_os_malloc_n(ecs_id_t, added_count); - diff->added.count = 0; - diff->added.size = added_count; - } - if (removed_count) { - diff->removed.array = ecs_os_malloc_n(ecs_id_t, removed_count); - diff->removed.count = 0; - diff->removed.size = removed_count; - } - - for (i_node = 0, i_next = 0; i_node < node_count && i_next < next_count; ) { - ecs_id_t id_node = ids_node[i_node]; - ecs_id_t id_next = ids_next[i_next]; +static +void grow_column( + ecs_world_t *world, + ecs_entity_t *entities, + ecs_column_t *column, + ecs_type_info_t *ti, + int32_t to_add, + int32_t new_size, + bool construct) +{ + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); - if (id_next < id_node) { - diff_insert_added(world, node, diff, id_next); - } else if (id_node < id_next) { - diff_insert_removed(world, next, diff, id_node); - } + ecs_vector_t *vec = column->data; + int16_t alignment = column->alignment; - i_node += id_node <= id_next; - i_next += id_next <= id_node; - } + int32_t size = column->size; + int32_t count = ecs_vector_count(vec); + int32_t old_size = ecs_vector_size(vec); + int32_t new_count = count + to_add; + bool can_realloc = new_size != old_size; - for (; i_next < next_count; i_next ++) { - diff_insert_added(world, node, diff, ids_next[i_next]); - } - for (; i_node < node_count; i_node ++) { - diff_insert_removed(world, next, diff, ids_node[i_node]); - } + ecs_assert(new_size >= new_count, ECS_INTERNAL_ERROR, NULL); - ecs_assert(diff->added.count == added_count, ECS_INTERNAL_ERROR, NULL); - ecs_assert(diff->removed.count == removed_count, ECS_INTERNAL_ERROR, NULL); -} + /* If the array could possibly realloc and the component has a move action + * defined, move old elements manually */ + ecs_move_t move_ctor; + if (count && can_realloc && (move_ctor = ti->lifecycle.move_ctor)) + { + ecs_xtor_t ctor = ti->lifecycle.ctor; + ecs_assert(ctor != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(move_ctor != NULL, ECS_INTERNAL_ERROR, NULL); -static -void add_with_ids_to_ids( - ecs_world_t *world, - ecs_vector_t **idv, - ecs_entity_t r, - ecs_entity_t o) -{ - /* Check if component/relation has With pairs, which contain ids - * that need to be added to the table. */ - ecs_table_t *id_table = ecs_get_table(world, r); - if (!id_table) { - return; - } - - ecs_table_record_t *tr = flecs_get_table_record(world, id_table, - ecs_pair(EcsWith, EcsWildcard)); - if (tr) { - int32_t i, with_count = tr->count; - int32_t start = tr->column; - int32_t end = start + with_count; - ecs_id_t *id_ids = ecs_vector_first(id_table->type, ecs_id_t); + /* Create new vector */ + ecs_vector_t *new_vec = ecs_vector_new_t(size, alignment, new_size); + ecs_vector_set_count_t(&new_vec, size, alignment, new_count); - for (i = start; i < end; i ++) { - ecs_assert(ECS_PAIR_FIRST(id_ids[i]) == EcsWith, - ECS_INTERNAL_ERROR, NULL); - ecs_id_t id_r = ECS_PAIR_SECOND(id_ids[i]); - ecs_id_t id = id_r; - if (o) { - id = ecs_pair(id_r, o); - } + void *old_buffer = ecs_vector_first_t(vec, size, alignment); + void *new_buffer = ecs_vector_first_t(new_vec, size, alignment); - /* Always make sure vector has room for one more */ - add_id_to_ids(idv, id, 0); + /* Move (and construct) existing elements to new vector */ + move_ctor(world, entities, entities, new_buffer, old_buffer, count, ti); - /* Add recursively in case id also has With pairs */ - add_with_ids_to_ids(world, idv, id_r, o); + if (construct) { + /* Construct new element(s) */ + void *elem = ECS_OFFSET(new_buffer, size * count); + ctor(world, &entities[count], elem, to_add, ti); } - } -} -static -ecs_table_t* find_or_create_table_with_id( - ecs_world_t *world, - ecs_table_t *node, - ecs_entity_t id) -{ - /* If table has one or more switches and this is a case, return self */ - if (ECS_HAS_ROLE(id, CASE)) { - ecs_assert((node->flags & EcsTableHasSwitch) != 0, - ECS_TYPE_INVALID_CASE, NULL); - return node; - } else { - ecs_type_t type = node->type; - ecs_entity_t r_exclusive = 0; - ecs_entity_t r = 0, o = 0, re = 0; + /* Free old vector */ + ecs_vector_free(vec); - if (ECS_HAS_ROLE(id, PAIR)) { - r = ECS_PAIR_FIRST(id); - o = ECS_PAIR_SECOND(id); - re = ecs_get_alive(world, r); - if (re && ecs_has_id(world, re, EcsExclusive)) { - r_exclusive = (uint32_t)re; - } - } else { - r = id & ECS_COMPONENT_MASK; - re = ecs_get_alive(world, r); + column->data = new_vec; + } else { + /* If array won't realloc or has no move, simply add new elements */ + if (can_realloc) { + ecs_vector_set_size_t(&vec, size, alignment, new_size); } - ecs_vector_t *idv = ecs_vector_copy(type, ecs_id_t); - add_id_to_ids(&idv, id, r_exclusive); - if (re) { - add_with_ids_to_ids(world, &idv, re, o); - } + void *elem = ecs_vector_addn_t(&vec, size, alignment, to_add); - ecs_ids_t ids = { - .array = ecs_vector_first(idv, ecs_id_t), - .count = ecs_vector_count(idv) - }; + ecs_xtor_t ctor; + if (construct && (ctor = ti->lifecycle.ctor)) { + /* If new elements need to be constructed and component has a + * constructor, construct */ + ctor(world, &entities[count], elem, to_add, ti); + } - return find_or_create(world, &ids, idv); + column->data = vec; } + + ecs_assert(ecs_vector_size(column->data) == new_size, + ECS_INTERNAL_ERROR, NULL); } static -ecs_table_t* find_or_create_table_without_id( +int32_t grow_data( ecs_world_t *world, - ecs_table_t *node, - ecs_entity_t id) + ecs_table_t *table, + ecs_data_t *data, + int32_t to_add, + int32_t size, + const ecs_entity_t *ids) { - /* If table has one or more switches and this is a case, return self */ - if (ECS_HAS_ROLE(id, CASE)) { - ecs_assert((node->flags & EcsTableHasSwitch) != 0, - ECS_TYPE_INVALID_CASE, NULL); - return node; - } else { - ecs_type_t type = node->type; - int32_t count = ecs_vector_count(type); - - ecs_ids_t ids = { - .array = ecs_os_alloca_n(ecs_id_t, count), - .count = count - }; + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); - remove_id_from_ids(type, id, &ids); + int32_t cur_count = flecs_table_data_count(data); + int32_t column_count = ecs_vector_count(table->storage_type); + int32_t sw_column_count = table->sw_column_count; + int32_t bs_column_count = table->bs_column_count; + ecs_column_t *columns = data->columns; + ecs_sw_column_t *sw_columns = data->sw_columns; + ecs_bs_column_t *bs_columns = data->bs_columns; - return flecs_table_find_or_create(world, &ids);; + /* Add record to record ptr array */ + ecs_vector_set_size(&data->record_ptrs, ecs_record_t*, size); + ecs_record_t **r = ecs_vector_addn(&data->record_ptrs, ecs_record_t*, to_add); + ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); + if (ecs_vector_size(data->record_ptrs) > size) { + size = ecs_vector_size(data->record_ptrs); } -} -static -ecs_table_t* find_or_create_table_with_isa( - ecs_world_t *world, - ecs_table_t *node, - ecs_entity_t base) -{ - ecs_type_t base_type = ecs_get_type(world, base); - ecs_id_t *ids = ecs_vector_first(base_type, ecs_id_t); - int32_t i, count = ecs_vector_count(base_type); + /* Add entity to column with entity ids */ + ecs_vector_set_size(&data->entities, ecs_entity_t, size); + ecs_entity_t *e = ecs_vector_addn(&data->entities, ecs_entity_t, to_add); + ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ecs_vector_size(data->entities) == size, ECS_INTERNAL_ERROR, NULL); - /* Start from back, as roles have high ids */ - for (i = count - 1; i >= 0; i --) { - ecs_id_t id = ids[i]; - if (!(id & ECS_ROLE_MASK)) { /* early out if we found everything */ - break; + /* Initialize entity ids and record ptrs */ + int32_t i; + if (ids) { + for (i = 0; i < to_add; i ++) { + e[i] = ids[i]; } + } else { + ecs_os_memset(e, 0, ECS_SIZEOF(ecs_entity_t) * to_add); + } + ecs_os_memset(r, 0, ECS_SIZEOF(ecs_record_t*) * to_add); - if (ECS_HAS_RELATION(id, EcsIsA)) { - ecs_entity_t base_of_base = ecs_pair_second(world, id); - node = find_or_create_table_with_isa(world, node, base_of_base); - } + /* Add elements to each column array */ + ecs_type_info_t *type_info = table->type_info; + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); - if (ECS_HAS_ROLE(id, OVERRIDE)) { - /* Override found, add it to table */ - id &= ECS_COMPONENT_MASK; - node = flecs_table_traverse_add(world, node, &id, NULL); - } + ecs_type_info_t *ti = &type_info[i]; + grow_column(world, entities, column, ti, to_add, size, true); + ecs_assert(ecs_vector_size(columns[i].data) == size, + ECS_INTERNAL_ERROR, NULL); } - return node; + /* Add elements to each switch column */ + for (i = 0; i < sw_column_count; i ++) { + ecs_switch_t *sw = sw_columns[i].data; + flecs_switch_addn(sw, to_add); + } + + /* Add elements to each bitset column */ + for (i = 0; i < bs_column_count; i ++) { + ecs_bitset_t *bs = &bs_columns[i].data; + flecs_bitset_addn(bs, to_add); + } + + /* If the table is monitored indicate that there has been a change */ + mark_table_dirty(world, table, 0); + + if (!world->is_readonly && !cur_count) { + flecs_table_set_empty(world, table); + } + + table->alloc_count ++; + + /* Return index of first added entity */ + return cur_count; } static -void init_edge( - ecs_table_t *table, - ecs_graph_edge_t *edge, - ecs_id_t id, - ecs_table_t *to) +void fast_append( + ecs_column_t *columns, + int32_t column_count) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->id == 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->hdr.next == NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->hdr.prev == NULL, ECS_INTERNAL_ERROR, NULL); - - edge->from = table; - edge->to = to; - edge->id = id; + /* Add elements to each column array */ + int32_t i; + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + int16_t size = column->size; + if (size) { + int16_t alignment = column->alignment; + ecs_vector_add_t(&column->data, size, alignment); + } + } } -static -void init_add_edge( +int32_t flecs_table_append( ecs_world_t *world, ecs_table_t *table, - ecs_graph_edge_t *edge, - ecs_id_t id, - ecs_table_t *to) + ecs_data_t *data, + ecs_entity_t entity, + ecs_record_t *record, + bool construct) { - init_edge(table, edge, id, to); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - ensure_hi_edge(world, &table->node.add, id); + check_table_sanity(table); - if (table != to) { - /* Add edges are appended to refs.next */ - ecs_graph_edge_hdr_t *to_refs = &to->node.refs; - ecs_graph_edge_hdr_t *next = to_refs->next; - - to_refs->next = &edge->hdr; - edge->hdr.prev = to_refs; + /* Get count & size before growing entities array. This tells us whether the + * arrays will realloc */ + int32_t count = ecs_vector_count(data->entities); + int32_t size = ecs_vector_size(data->entities); + int32_t column_count = ecs_vector_count(table->storage_type); + ecs_column_t *columns = table->storage.columns; + + /* Grow buffer with entity ids, set new element to new entity */ + ecs_entity_t *e = ecs_vector_add(&data->entities, ecs_entity_t); + ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); + *e = entity; - edge->hdr.next = next; - if (next) { - next->prev = &edge->hdr; - } + /* Keep track of alloc count. This allows references to check if cached + * pointers need to be updated. */ + table->alloc_count += (count == size); - compute_table_diff(world, table, to, edge, id); + /* Add record ptr to array with record ptrs */ + ecs_record_t **r = ecs_vector_add(&data->record_ptrs, ecs_record_t*); + ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); + *r = record; + + /* If the table is monitored indicate that there has been a change */ + mark_table_dirty(world, table, 0); + ecs_assert(count >= 0, ECS_INTERNAL_ERROR, NULL); + + /* Fast path: no switch columns, no lifecycle actions */ + if (!(table->flags & EcsTableIsComplex)) { + fast_append(columns, column_count); + if (!count) { + flecs_table_set_empty(world, table); /* See below */ + } + return count; } -} -static -void init_remove_edge( - ecs_world_t *world, - ecs_table_t *table, - ecs_graph_edge_t *edge, - ecs_id_t id, - ecs_table_t *to) -{ - init_edge(table, edge, id, to); + int32_t sw_column_count = table->sw_column_count; + int32_t bs_column_count = table->bs_column_count; + ecs_sw_column_t *sw_columns = table->storage.sw_columns; + ecs_bs_column_t *bs_columns = table->storage.bs_columns; - ensure_hi_edge(world, &table->node.remove, id); + ecs_type_info_t *type_info = table->type_info; + ecs_entity_t *entities = ecs_vector_first( + data->entities, ecs_entity_t); - if (table != to) { - /* Remove edges are appended to refs.prev */ - ecs_graph_edge_hdr_t *to_refs = &to->node.refs; - ecs_graph_edge_hdr_t *prev = to_refs->prev; + /* Reobtain size to ensure that the columns have the same size as the + * entities and record vectors. This keeps reasoning about when allocations + * occur easier. */ + size = ecs_vector_size(data->entities); - to_refs->prev = &edge->hdr; - edge->hdr.next = to_refs; + /* Grow component arrays with 1 element */ + int32_t i; + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); - edge->hdr.prev = prev; - if (prev) { - prev->next = &edge->hdr; - } + ecs_type_info_t *ti = &type_info[i]; + grow_column(world, entities, column, ti, 1, size, construct); + + ecs_assert( + ecs_vector_size(columns[i].data) == ecs_vector_size(data->entities), + ECS_INTERNAL_ERROR, NULL); + ecs_assert( + ecs_vector_count(columns[i].data) == ecs_vector_count(data->entities), + ECS_INTERNAL_ERROR, NULL); + } - compute_table_diff(world, table, to, edge, id); + /* Add element to each switch column */ + for (i = 0; i < sw_column_count; i ++) { + ecs_assert(sw_columns != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_switch_t *sw = sw_columns[i].data; + flecs_switch_add(sw); } -} -static -ecs_table_t* find_or_create_table_without( - ecs_world_t *world, - ecs_table_t *node, - ecs_graph_edge_t *edge, - ecs_id_t id) -{ - ecs_table_t *to = find_or_create_table_without_id(world, node, id); - - init_remove_edge(world, node, edge, id, to); + /* Add element to each bitset column */ + for (i = 0; i < bs_column_count; i ++) { + ecs_assert(bs_columns != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_bitset_t *bs = &bs_columns[i].data; + flecs_bitset_addn(bs, 1); + } - return to; + /* If this is the first entity in this table, signal queries so that the + * table moves from an inactive table to an active table. */ + if (!count) { + flecs_table_set_empty(world, table); + } + + check_table_sanity(table); + + return count; } static -ecs_table_t* find_or_create_table_with( - ecs_world_t *world, - ecs_table_t *node, - ecs_graph_edge_t *edge, - ecs_id_t id) +void fast_delete_last( + ecs_column_t *columns, + int32_t column_count) { - ecs_table_t *to = find_or_create_table_with_id(world, node, id); - - if (ECS_HAS_ROLE(id, PAIR) && ECS_PAIR_FIRST(id) == EcsIsA) { - ecs_entity_t base = ecs_pair_second(world, id); - to = find_or_create_table_with_isa(world, to, base); + int i; + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + ecs_vector_remove_last(column->data); } - - init_add_edge(world, node, edge, id, to); - - return to; } static -void populate_diff( - ecs_graph_edge_t *edge, - ecs_id_t *add_ptr, - ecs_id_t *remove_ptr, - ecs_table_diff_t *out) +void fast_delete( + ecs_column_t *columns, + int32_t column_count, + int32_t index) { - if (out) { - ecs_table_diff_t *diff = edge->diff; - - if (diff && diff != &ecs_table_edge_is_component) { - ecs_assert(!add_ptr || !ECS_HAS_ROLE(add_ptr[0], CASE), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!remove_ptr || !ECS_HAS_ROLE(remove_ptr[0], CASE), - ECS_INTERNAL_ERROR, NULL); - *out = *diff; - } else { - out->on_set.count = 0; - - if (add_ptr) { - out->added.array = add_ptr; - out->added.count = 1; - } else { - out->added.count = 0; - } + int i; + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + int16_t size = column->size; + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); - if (remove_ptr) { - out->removed.array = remove_ptr; - out->removed.count = 1; - if (diff == &ecs_table_edge_is_component) { - out->un_set.array = remove_ptr; - out->un_set.count = 1; - } else { - out->un_set.count = 0; - } - } else { - out->removed.count = 0; - out->un_set.count = 0; - } - } + int16_t alignment = column->alignment; + ecs_vector_remove_t(column->data, size, alignment, index); } } -ecs_table_t* flecs_table_traverse_remove( +void flecs_table_delete( ecs_world_t *world, - ecs_table_t *node, - ecs_id_t *id_ptr, - ecs_table_diff_t *diff) + ecs_table_t *table, + ecs_data_t *data, + int32_t index, + bool destruct) { - ecs_poly_assert(world, ecs_world_t); + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - node = node ? node : &world->store.root; + check_table_sanity(table); - /* Removing 0 from an entity is not valid */ - ecs_check(id_ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(id_ptr[0] != 0, ECS_INVALID_PARAMETER, NULL); + ecs_vector_t *v_entities = data->entities; + int32_t count = ecs_vector_count(v_entities); - ecs_id_t id = id_ptr[0]; - ecs_graph_edge_t *edge = ensure_edge(world, &node->node.remove, id); - ecs_table_t *to = edge->to; + ecs_assert(count > 0, ECS_INTERNAL_ERROR, NULL); + count --; + ecs_assert(index <= count, ECS_INTERNAL_ERROR, NULL); - if (!to) { - to = find_or_create_table_without(world, node, edge, id); - ecs_assert(to != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->to != NULL, ECS_INTERNAL_ERROR, NULL); + /* Move last entity id to index */ + ecs_entity_t *entities = ecs_vector_first(v_entities, ecs_entity_t); + ecs_entity_t entity_to_move = entities[count]; + ecs_entity_t entity_to_delete = entities[index]; + entities[index] = entity_to_move; + ecs_vector_remove_last(v_entities); + + /* Move last record ptr to index */ + ecs_vector_t *v_records = data->record_ptrs; + ecs_assert(count < ecs_vector_count(v_records), ECS_INTERNAL_ERROR, NULL); + + ecs_record_t **records = ecs_vector_first(v_records, ecs_record_t*); + ecs_record_t *record_to_move = records[count]; + records[index] = record_to_move; + ecs_vector_remove_last(v_records); + + /* Update record of moved entity in entity index */ + if (index != count) { + if (record_to_move) { + uint32_t row_flags = record_to_move->row & ECS_ROW_FLAGS_MASK; + record_to_move->row = ECS_ROW_TO_RECORD(index, row_flags); + ecs_assert(record_to_move->table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(record_to_move->table == table, ECS_INTERNAL_ERROR, NULL); + } + } + + /* If the table is monitored indicate that there has been a change */ + mark_table_dirty(world, table, 0); + + /* If table is empty, deactivate it */ + if (!count) { + flecs_table_set_empty(world, table); } - populate_diff(edge, NULL, id_ptr, diff); + /* Destruct component data */ + ecs_type_info_t *type_info = table->type_info; + ecs_column_t *columns = data->columns; + int32_t column_count = ecs_vector_count(table->storage_type); + int32_t i; - return to; -error: - return NULL; -} + /* If this is a table without lifecycle callbacks or special columns, take + * fast path that just remove an element from the array(s) */ + if (!(table->flags & EcsTableIsComplex)) { + if (index == count) { + fast_delete_last(columns, column_count); + } else { + fast_delete(columns, column_count, index); + } -ecs_table_t* flecs_table_traverse_add( - ecs_world_t *world, - ecs_table_t *node, - ecs_id_t *id_ptr, - ecs_table_diff_t *diff) -{ - ecs_poly_assert(world, ecs_world_t); + check_table_sanity(table); - node = node ? node : &world->store.root; + return; + } - /* Adding 0 to an entity is not valid */ - ecs_check(id_ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(id_ptr[0] != 0, ECS_INVALID_PARAMETER, NULL); + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - ecs_id_t id = id_ptr[0]; - ecs_graph_edge_t *edge = ensure_edge(world, &node->node.add, id); - ecs_table_t *to = edge->to; + /* Last element, destruct & remove */ + if (index == count) { + /* If table has component destructors, invoke */ + if (destruct && (table->flags & EcsTableHasDtors)) { + for (i = 0; i < column_count; i ++) { + ecs_type_info_t *ti = &type_info[i]; + if (!ti) { + continue; + } - if (!to) { - to = find_or_create_table_with(world, node, edge, id); - ecs_assert(to != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->to != NULL, ECS_INTERNAL_ERROR, NULL); + dtor_component(world, table, ti, &columns[i], + entities, ids[i], index, 1, true); + } + } + + fast_delete_last(columns, column_count); + + /* Not last element, move last element to deleted element & destruct */ + } else { + /* If table has component destructors, invoke */ + if (destruct && (table->flags & (EcsTableHasDtors | EcsTableHasMove))) { + for (i = 0; i < column_count; i ++) { + ecs_column_t *column = &columns[i]; + ecs_size_t size = column->size; + ecs_size_t align = column->alignment; + ecs_vector_t *vec = column->data; + void *dst = ecs_vector_get_t(vec, size, align, index); + void *src = ecs_vector_last_t(vec, size, align); + ecs_type_info_t *ti = &type_info[i]; + + ecs_iter_action_t on_remove = ti->lifecycle.on_remove; + if (on_remove) { + on_remove_component(world, table, on_remove, dst, + size, &entity_to_delete, ids[i], 1, + ti->lifecycle.ctx); + } + + ecs_move_t move_dtor = ti->lifecycle.move_dtor; + if (move_dtor) { + move_dtor(world, &entity_to_move, + &entity_to_delete, dst, src, 1, ti); + } else { + ecs_os_memcpy(dst, src, size); + } + + ecs_vector_remove_last(vec); + } + } else { + fast_delete(columns, column_count, index); + } } - populate_diff(edge, id_ptr, NULL, diff); + /* Remove elements from switch columns */ + ecs_sw_column_t *sw_columns = data->sw_columns; + int32_t sw_column_count = table->sw_column_count; + for (i = 0; i < sw_column_count; i ++) { + flecs_switch_remove(sw_columns[i].data, index); + } - return to; -error: - return NULL; -} + /* Remove elements from bitset columns */ + ecs_bs_column_t *bs_columns = data->bs_columns; + int32_t bs_column_count = table->bs_column_count; + for (i = 0; i < bs_column_count; i ++) { + flecs_bitset_remove(&bs_columns[i].data, index); + } -ecs_table_t* flecs_table_find_or_create( - ecs_world_t *world, - const ecs_ids_t *ids) -{ - ecs_poly_assert(world, ecs_world_t); - return find_or_create(world, ids, NULL); + check_table_sanity(table); } -void flecs_init_root_table( - ecs_world_t *world) +static +void fast_move( + ecs_table_t *new_table, + ecs_data_t *new_data, + int32_t new_index, + ecs_table_t *old_table, + ecs_data_t *old_data, + int32_t old_index) { - ecs_poly_assert(world, ecs_world_t); + ecs_type_t new_type = new_table->storage_type; + ecs_type_t old_type = old_table->storage_type; - ecs_ids_t entities = { - .array = NULL, - .count = 0 - }; + int32_t i_new = 0, new_column_count = ecs_vector_count(new_table->storage_type); + int32_t i_old = 0, old_column_count = ecs_vector_count(old_table->storage_type); + ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); + ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - world->store.root.type = ids_to_vector(&entities); - init_table(world, &world->store.root); + ecs_column_t *old_columns = old_data->columns; + ecs_column_t *new_columns = new_data->columns; - /* Ensure table indices start at 1, as 0 is reserved for the root */ - uint64_t new_id = flecs_sparse_new_id(&world->store.tables); - ecs_assert(new_id == 0, ECS_INTERNAL_ERROR, NULL); - (void)new_id; + + for (; (i_new < new_column_count) && (i_old < old_column_count);) { + ecs_entity_t new_component = new_components[i_new]; + ecs_entity_t old_component = old_components[i_old]; + + if (new_component == old_component) { + ecs_column_t *new_column = &new_columns[i_new]; + ecs_column_t *old_column = &old_columns[i_old]; + int16_t size = new_column->size; + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + + int16_t alignment = new_column->alignment; + void *dst = ecs_vector_get_t( + new_column->data, size, alignment, new_index); + void *src = ecs_vector_get_t( + old_column->data, size, alignment, old_index); + + ecs_assert(dst != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(src != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_os_memcpy(dst, src, size); + } + + i_new += new_component <= old_component; + i_old += new_component >= old_component; + } } -void flecs_table_clear_edges( +void flecs_table_move( ecs_world_t *world, - ecs_table_t *table) + ecs_entity_t dst_entity, + ecs_entity_t src_entity, + ecs_table_t *new_table, + ecs_data_t *new_data, + int32_t new_index, + ecs_table_t *old_table, + ecs_data_t *old_data, + int32_t old_index, + bool construct) { - (void)world; - ecs_poly_assert(world, ecs_world_t); + ecs_assert(new_table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(old_table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!new_table->lock, ECS_LOCKED_STORAGE, NULL); + ecs_assert(!old_table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_log_push_1(); + ecs_assert(old_index >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(new_index >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_map_iter_t it; - ecs_graph_node_t *table_node = &table->node; - ecs_graph_edges_t *node_add = &table_node->add; - ecs_graph_edges_t *node_remove = &table_node->remove; - ecs_map_t *add_hi = &node_add->hi; - ecs_map_t *remove_hi = &node_remove->hi; - ecs_graph_edge_hdr_t *node_refs = &table_node->refs; - ecs_graph_edge_t *edge; - uint64_t key; + ecs_assert(old_data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(new_data != NULL, ECS_INTERNAL_ERROR, NULL); - /* Cleanup outgoing edges */ - it = ecs_map_iter(add_hi); - while ((edge = ecs_map_next_ptr(&it, ecs_graph_edge_t*, &key))) { - disconnect_edge(world, key, edge); - } + check_table_sanity(new_table); + check_table_sanity(old_table); - it = ecs_map_iter(remove_hi); - while ((edge = ecs_map_next_ptr(&it, ecs_graph_edge_t*, &key))) { - disconnect_edge(world, key, edge); + if (!((new_table->flags | old_table->flags) & EcsTableIsComplex)) { + fast_move(new_table, new_data, new_index, old_table, old_data, + old_index); + check_table_sanity(new_table); + check_table_sanity(old_table); + return; } - /* Cleanup incoming add edges */ - ecs_graph_edge_hdr_t *next, *cur = node_refs->next; - if (cur) { - do { - edge = (ecs_graph_edge_t*)cur; - ecs_assert(edge->to == table, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->from != NULL, ECS_INTERNAL_ERROR, NULL); - next = cur->next; - remove_edge(world, &edge->from->node.add, edge->id, edge); - } while ((cur = next)); + move_switch_columns(new_table, new_data, new_index, old_table, old_data, + old_index, 1, false); + move_bitset_columns(new_table, new_data, new_index, old_table, old_data, + old_index, 1, false); + + bool same_entity = dst_entity == src_entity; + + ecs_type_t new_type = new_table->storage_type; + ecs_type_t old_type = old_table->storage_type; + + ecs_type_info_t *new_type_info = new_table->type_info; + ecs_type_info_t *old_type_info = old_table->type_info; + + int32_t i_new = 0, new_column_count = ecs_vector_count(new_table->storage_type); + int32_t i_old = 0, old_column_count = ecs_vector_count(old_table->storage_type); + ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); + ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); + + ecs_column_t *old_columns = old_data->columns; + ecs_column_t *new_columns = new_data->columns; + + for (; (i_new < new_column_count) && (i_old < old_column_count);) { + ecs_entity_t new_component = new_components[i_new]; + ecs_entity_t old_component = old_components[i_old]; + + if (new_component == old_component) { + ecs_column_t *new_column = &new_columns[i_new]; + ecs_column_t *old_column = &old_columns[i_old]; + int16_t size = new_column->size; + int16_t alignment = new_column->alignment; + + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + + void *dst = ecs_vector_get_t( + new_column->data, size, alignment, new_index); + void *src = ecs_vector_get_t( + old_column->data, size, alignment, old_index); + + ecs_assert(dst != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(src != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_type_info_t *ti = &new_type_info[i_new]; + if (same_entity) { + ecs_move_t callback = ti->lifecycle.ctor_move_dtor; + if (callback) { + /* ctor + move + dtor */ + callback(world, &dst_entity, &src_entity, dst, src, 1, ti); + } else { + ecs_os_memcpy(dst, src, size); + } + } else { + ecs_copy_t copy = ti->lifecycle.copy_ctor; + if (copy) { + copy(world, &dst_entity, &src_entity, dst, src, 1, ti); + } else { + ecs_os_memcpy(dst, src, size); + } + } + } else { + if (new_component < old_component) { + if (construct) { + ctor_component(world, &new_type_info[i_new], + &new_columns[i_new], &dst_entity, new_index, 1); + } + } else { + dtor_component(world, old_table, &old_type_info[i_old], + &old_columns[i_old], &src_entity, old_component, + old_index, 1, true); + } + } + + i_new += new_component <= old_component; + i_old += new_component >= old_component; } - /* Cleanup incoming remove edges */ - cur = node_refs->prev; - if (cur) { - do { - edge = (ecs_graph_edge_t*)cur; - ecs_assert(edge->to == table, ECS_INTERNAL_ERROR, NULL); - ecs_assert(edge->from != NULL, ECS_INTERNAL_ERROR, NULL); - next = cur->prev; - remove_edge(world, &edge->from->node.remove, edge->id, edge); - } while ((cur = next)); + if (construct) { + for (; (i_new < new_column_count); i_new ++) { + ctor_component(world, &new_type_info[i_new], + &new_columns[i_new], &dst_entity, new_index, 1); + } } - ecs_os_free(node_add->lo); - ecs_os_free(node_remove->lo); - ecs_map_fini(add_hi); - ecs_map_fini(remove_hi); - table_node->add.lo = NULL; - table_node->remove.lo = NULL; + for (; (i_old < old_column_count); i_old ++) { + dtor_component(world, old_table, &old_type_info[i_old], + &old_columns[i_old], &src_entity, old_components[i_old], + old_index, 1, true); + } - ecs_log_pop_1(); + check_table_sanity(new_table); + check_table_sanity(old_table); } -/* Public convenience functions for traversing table graph */ -ecs_table_t* ecs_table_add_id( +int32_t flecs_table_appendn( ecs_world_t *world, ecs_table_t *table, - ecs_id_t id) + ecs_data_t *data, + int32_t to_add, + const ecs_entity_t *ids) { - return flecs_table_traverse_add(world, table, &id, NULL); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + + check_table_sanity(table); + + int32_t cur_count = flecs_table_data_count(data); + int32_t result = grow_data( + world, table, data, to_add, cur_count + to_add, ids); + check_table_sanity(table); + return result; } -ecs_table_t* ecs_table_remove_id( +void flecs_table_set_size( ecs_world_t *world, ecs_table_t *table, - ecs_id_t id) + ecs_data_t *data, + int32_t size) { - return flecs_table_traverse_remove(world, table, &id, NULL); -} + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); -#include + check_table_sanity(table); -static -int32_t count_events( - const ecs_entity_t *events) -{ - int32_t i; + int32_t cur_count = flecs_table_data_count(data); - for (i = 0; i < ECS_TRIGGER_DESC_EVENT_COUNT_MAX; i ++) { - if (!events[i]) { - break; - } + if (cur_count < size) { + grow_data(world, table, data, 0, size, NULL); + check_table_sanity(table); } +} - return i; +int32_t flecs_table_data_count( + const ecs_data_t *data) +{ + return data ? ecs_vector_count(data->entities) : 0; } static -ecs_entity_t get_actual_event( - ecs_trigger_t *trigger, - ecs_entity_t event) +void swap_switch_columns( + ecs_table_t *table, + ecs_data_t *data, + int32_t row_1, + int32_t row_2) { - /* If operator is Not, reverse the event */ - if (trigger->term.oper == EcsNot) { - if (event == EcsOnAdd) { - event = EcsOnRemove; - } else if (event == EcsOnRemove) { - event = EcsOnAdd; - } + int32_t i = 0, column_count = table->sw_column_count; + if (!column_count) { + return; } - return event; -} + ecs_sw_column_t *columns = data->sw_columns; -static -void unregister_event_trigger( - ecs_event_record_t *evt, - ecs_id_t id) -{ - if (ecs_map_remove(&evt->event_ids, id) == 0) { - ecs_map_fini(&evt->event_ids); + for (i = 0; i < column_count; i ++) { + ecs_switch_t *sw = columns[i].data; + flecs_switch_swap(sw, row_1, row_2); } } static -ecs_event_id_record_t* ensure_event_id_record( - ecs_map_t *map, - ecs_id_t id) +void swap_bitset_columns( + ecs_table_t *table, + ecs_data_t *data, + int32_t row_1, + int32_t row_2) { - ecs_event_id_record_t **idt = ecs_map_ensure( - map, ecs_event_id_record_t*, id); - if (!idt[0]) { - idt[0] = ecs_os_calloc_t(ecs_event_id_record_t); + int32_t i = 0, column_count = table->bs_column_count; + if (!column_count) { + return; } - return idt[0]; -} - -static -void inc_trigger_count( - ecs_world_t *world, - ecs_entity_t event, - ecs_event_record_t *evt, - ecs_id_t id, - int32_t value) -{ - ecs_event_id_record_t *idt = ensure_event_id_record(&evt->event_ids, id); - ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t result = idt->trigger_count += value; - if (result == 1) { - /* Notify framework that there are triggers for the event/id. This - * allows parts of the code to skip event evaluation early */ - flecs_notify_tables(world, id, &(ecs_table_event_t){ - .kind = EcsTableTriggersForId, - .event = event - }); - } else if (result == 0) { - /* Ditto, but the reverse */ - flecs_notify_tables(world, id, &(ecs_table_event_t){ - .kind = EcsTableNoTriggersForId, - .event = event - }); + ecs_bs_column_t *columns = data->bs_columns; - /* Remove admin for id for event */ - if (!ecs_map_is_initialized(&idt->triggers) && - !ecs_map_is_initialized(&idt->set_triggers)) - { - unregister_event_trigger(evt, id); - ecs_os_free(idt); - } + for (i = 0; i < column_count; i ++) { + ecs_bitset_t *bs = &columns[i].data; + flecs_bitset_swap(bs, row_1, row_2); } } -static -void register_trigger_for_id( +void flecs_table_swap( ecs_world_t *world, - ecs_observable_t *observable, - ecs_trigger_t *trigger, - ecs_id_t id, - size_t triggers_offset) -{ - ecs_sparse_t *events = observable->events; - ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_id_t term_id = trigger->term.id; + ecs_table_t *table, + ecs_data_t *data, + int32_t row_1, + int32_t row_2) +{ + (void)world; - int i; - for (i = 0; i < trigger->event_count; i ++) { - ecs_entity_t event = get_actual_event(trigger, trigger->events[i]); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(row_1 >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(row_2 >= 0, ECS_INTERNAL_ERROR, NULL); - /* Get triggers for event */ - ecs_event_record_t *evt = flecs_sparse_ensure( - events, ecs_event_record_t, event); - ecs_assert(evt != NULL, ECS_INTERNAL_ERROR, NULL); + check_table_sanity(table); + + if (row_1 == row_2) { + return; + } - if (!ecs_map_is_initialized(&evt->event_ids)) { - ecs_map_init(&evt->event_ids, ecs_event_id_record_t*, 1); - } + /* If the table is monitored indicate that there has been a change */ + mark_table_dirty(world, table, 0); - /* Get triggers for (component) id for event */ - ecs_event_id_record_t *idt = ensure_event_id_record( - &evt->event_ids, id); - ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + ecs_entity_t e1 = entities[row_1]; + ecs_entity_t e2 = entities[row_2]; - ecs_map_t *triggers = ECS_OFFSET(idt, triggers_offset); - if (!ecs_map_is_initialized(triggers)) { - ecs_map_init(triggers, ecs_trigger_t*, 1); - } + ecs_record_t **record_ptrs = ecs_vector_first(data->record_ptrs, ecs_record_t*); + ecs_record_t *record_ptr_1 = record_ptrs[row_1]; + ecs_record_t *record_ptr_2 = record_ptrs[row_2]; - ecs_map_ensure(triggers, ecs_trigger_t*, trigger->id)[0] = trigger; + ecs_assert(record_ptr_1 != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(record_ptr_2 != NULL, ECS_INTERNAL_ERROR, NULL); - inc_trigger_count(world, event, evt, term_id, 1); - if (term_id != id) { - inc_trigger_count(world, event, evt, id, 1); - } + /* Keep track of whether entity is watched */ + uint32_t flags_1 = ECS_RECORD_TO_ROW_FLAGS(record_ptr_1->row); + uint32_t flags_2 = ECS_RECORD_TO_ROW_FLAGS(record_ptr_2->row); + + /* Swap entities & records */ + entities[row_1] = e2; + entities[row_2] = e1; + record_ptr_1->row = ECS_ROW_TO_RECORD(row_2, flags_1); + record_ptr_2->row = ECS_ROW_TO_RECORD(row_1, flags_2); + record_ptrs[row_1] = record_ptr_2; + record_ptrs[row_2] = record_ptr_1; + + swap_switch_columns(table, data, row_1, row_2); + swap_bitset_columns(table, data, row_1, row_2); + + ecs_column_t *columns = data->columns; + if (!columns) { + check_table_sanity(table); + return; + } + + /* Swap columns */ + int32_t i, column_count = ecs_vector_count(table->storage_type); + + for (i = 0; i < column_count; i ++) { + int16_t size = columns[i].size; + int16_t alignment = columns[i].alignment; + + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + + void *ptr = ecs_vector_first_t(columns[i].data, size, alignment); + void *tmp = ecs_os_alloca(size); + + void *el_1 = ECS_OFFSET(ptr, size * row_1); + void *el_2 = ECS_OFFSET(ptr, size * row_2); + + ecs_os_memcpy(tmp, el_1, size); + ecs_os_memcpy(el_1, el_2, size); + ecs_os_memcpy(el_2, tmp, size); } + + check_table_sanity(table); } static -void register_trigger( - ecs_world_t *world, - ecs_observable_t *observable, - ecs_trigger_t *trigger) +void merge_vector( + ecs_vector_t **dst_out, + ecs_vector_t *src, + int16_t size, + int16_t alignment) { - ecs_term_t *term = &trigger->term; + ecs_vector_t *dst = *dst_out; + int32_t dst_count = ecs_vector_count(dst); - if (term->subj.set.mask & EcsSelf) { - if (term->subj.entity == EcsThis) { - register_trigger_for_id(world, observable, trigger, term->id, - offsetof(ecs_event_id_record_t, triggers)); - } else { - register_trigger_for_id(world, observable, trigger, term->id, - offsetof(ecs_event_id_record_t, entity_triggers)); + if (!dst_count) { + if (dst) { + ecs_vector_free(dst); } - } - if (trigger->term.subj.set.mask & EcsSuperSet) { - ecs_id_t pair = ecs_pair(term->subj.set.relation, EcsWildcard); - register_trigger_for_id(world, observable, trigger, pair, - offsetof(ecs_event_id_record_t, set_triggers)); - } + *dst_out = src; + + /* If the new table is not empty, copy the contents from the + * src into the dst. */ + } else { + int32_t src_count = ecs_vector_count(src); + ecs_vector_set_count_t(&dst, size, alignment, dst_count + src_count); + + void *dst_ptr = ecs_vector_first_t(dst, size, alignment); + void *src_ptr = ecs_vector_first_t(src, size, alignment); - if (ECS_HAS_ROLE(term->id, SWITCH)) { - ecs_entity_t sw = term->id & ECS_COMPONENT_MASK; - ecs_id_t sw_case = ecs_case(sw, EcsWildcard); - register_trigger_for_id(world, observable, trigger, sw_case, - offsetof(ecs_event_id_record_t, triggers)); - } + dst_ptr = ECS_OFFSET(dst_ptr, size * dst_count); + + ecs_os_memcpy(dst_ptr, src_ptr, size * src_count); - if (ECS_HAS_ROLE(term->id, CASE)) { - ecs_entity_t sw = ECS_PAIR_FIRST(term->id); - register_trigger_for_id(world, observable, trigger, ECS_SWITCH | sw, - offsetof(ecs_event_id_record_t, triggers)); + ecs_vector_free(src); + *dst_out = dst; } } static -void unregister_trigger_for_id( +void merge_column( ecs_world_t *world, - ecs_observable_t *observable, - ecs_trigger_t *trigger, - ecs_id_t id, - size_t triggers_offset) + ecs_table_t *table, + ecs_data_t *data, + int32_t column_id, + ecs_vector_t *src) { - ecs_sparse_t *events = observable->events; - ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_id_t term_id = trigger->term.id; - - int i; - for (i = 0; i < trigger->event_count; i ++) { - ecs_entity_t event = get_actual_event(trigger, trigger->events[i]); - - /* Get triggers for event */ - ecs_event_record_t *evt = flecs_sparse_get( - events, ecs_event_record_t, event); - ecs_assert(evt != NULL, ECS_INTERNAL_ERROR, NULL); - - /* Get triggers for (component) id */ - ecs_event_id_record_t *idt = ecs_map_get_ptr( - &evt->event_ids, ecs_event_id_record_t*, id); - ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_map_t *id_triggers = ECS_OFFSET(idt, triggers_offset); + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + ecs_type_info_t *ti = &table->type_info[column_id]; + ecs_column_t *column = &data->columns[column_id]; + ecs_vector_t *dst = column->data; + int16_t size = column->size; + int16_t alignment = column->alignment; + int32_t dst_count = ecs_vector_count(dst); - if (ecs_map_remove(id_triggers, trigger->id) == 0) { - ecs_map_fini(id_triggers); + if (!dst_count) { + if (dst) { + ecs_vector_free(dst); } - inc_trigger_count(world, event, evt, term_id, -1); + column->data = src; + + /* If the new table is not empty, copy the contents from the + * src into the dst. */ + } else { + int32_t src_count = ecs_vector_count(src); + ecs_vector_set_count_t(&dst, size, alignment, dst_count + src_count); + column->data = dst; - if (id != term_id) { - /* Id is different from term_id in case of a set trigger. If they're - * the same, inc_trigger_count could already have done cleanup */ - if (!ecs_map_is_initialized(&idt->triggers) && - !ecs_map_is_initialized(&idt->set_triggers) && - !idt->trigger_count) - { - unregister_event_trigger(evt, id); - } + /* Construct new values */ + ctor_component(world, ti, column, entities, dst_count, src_count); + + void *dst_ptr = ecs_vector_first_t(dst, size, alignment); + void *src_ptr = ecs_vector_first_t(src, size, alignment); - inc_trigger_count(world, event, evt, id, -1); + dst_ptr = ECS_OFFSET(dst_ptr, size * dst_count); + + /* Move values into column */ + ecs_move_t move = ti->lifecycle.move; + if (move) { + move(world, entities, entities, dst_ptr, src_ptr, src_count, ti); + } else { + ecs_os_memcpy(dst_ptr, src_ptr, size * src_count); } + + ecs_vector_free(src); } } static -void unregister_trigger( +void merge_table_data( ecs_world_t *world, - ecs_observable_t *observable, - ecs_trigger_t *trigger) -{ - ecs_term_t *term = &trigger->term; + ecs_table_t *new_table, + ecs_table_t *old_table, + int32_t old_count, + int32_t new_count, + ecs_data_t *old_data, + ecs_data_t *new_data) +{ + ecs_type_t new_type = new_table->storage_type; + ecs_type_t old_type = old_table->storage_type; + int32_t i_new = 0, new_column_count = ecs_vector_count(new_type); + int32_t i_old = 0, old_column_count = ecs_vector_count(old_type); + ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); + ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - if (term->subj.set.mask & EcsSelf) { - if (term->subj.entity == EcsThis) { - unregister_trigger_for_id(world, observable, trigger, term->id, - offsetof(ecs_event_id_record_t, triggers)); - } else { - unregister_trigger_for_id(world, observable, trigger, term->id, - offsetof(ecs_event_id_record_t, entity_triggers)); - } - } + ecs_type_info_t *new_type_info = new_table->type_info; + ecs_type_info_t *old_type_info = old_table->type_info; - if (term->subj.set.mask & EcsSuperSet) { - ecs_id_t pair = ecs_pair(term->subj.set.relation, EcsWildcard); - unregister_trigger_for_id(world, observable, trigger, pair, - offsetof(ecs_event_id_record_t, set_triggers)); + ecs_column_t *old_columns = old_data->columns; + ecs_column_t *new_columns = new_data->columns; + + if (!new_columns && !new_data->entities) { + new_columns = new_data->columns; } + + ecs_assert(!new_column_count || new_columns, ECS_INTERNAL_ERROR, NULL); - if (ECS_HAS_ROLE(term->id, SWITCH)) { - ecs_entity_t sw = term->id & ECS_COMPONENT_MASK; - ecs_id_t sw_case = ecs_case(sw, EcsWildcard); - unregister_trigger_for_id(world, observable, trigger, sw_case, - offsetof(ecs_event_id_record_t, triggers)); + if (!old_count) { + return; } - if (ECS_HAS_ROLE(term->id, CASE)) { - ecs_entity_t sw = ECS_PAIR_FIRST(term->id); - unregister_trigger_for_id(world, observable, trigger, ECS_SWITCH | sw, - offsetof(ecs_event_id_record_t, triggers)); + /* Merge entities */ + merge_vector(&new_data->entities, old_data->entities, ECS_SIZEOF(ecs_entity_t), + ECS_ALIGNOF(ecs_entity_t)); + old_data->entities = NULL; + ecs_entity_t *entities = ecs_vector_first(new_data->entities, ecs_entity_t); + + ecs_assert(ecs_vector_count(new_data->entities) == old_count + new_count, + ECS_INTERNAL_ERROR, NULL); + + /* Merge entity index record pointers */ + merge_vector(&new_data->record_ptrs, old_data->record_ptrs, + ECS_SIZEOF(ecs_record_t*), ECS_ALIGNOF(ecs_record_t*)); + old_data->record_ptrs = NULL; + + for (; (i_new < new_column_count) && (i_old < old_column_count); ) { + ecs_entity_t new_component = new_components[i_new]; + ecs_entity_t old_component = old_components[i_old]; + int16_t size = new_columns[i_new].size; + int16_t alignment = new_columns[i_new].alignment; + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + + if (new_component == old_component) { + merge_column(world, new_table, new_data, i_new, + old_columns[i_old].data); + old_columns[i_old].data = NULL; + + /* Mark component column as dirty */ + mark_table_dirty(world, new_table, i_new + 1); + + i_new ++; + i_old ++; + } else if (new_component < old_component) { + /* New column does not occur in old table, make sure vector is large + * enough. */ + ecs_column_t *column = &new_columns[i_new]; + ecs_vector_set_count_t(&column->data, size, alignment, + old_count + new_count); + + /* Construct new values */ + ecs_type_info_t *ti = &new_type_info[i_new]; + ctor_component(world, ti, column, + entities, 0, old_count + new_count); + + i_new ++; + } else if (new_component > old_component) { + ecs_column_t *column = &old_columns[i_old]; + + /* Destruct old values */ + ecs_type_info_t *ti = &old_type_info[i_old]; + dtor_component(world, old_table, ti, column, + entities, 0, 0, old_count, false); + + /* Old column does not occur in new table, remove */ + ecs_vector_free(column->data); + column->data = NULL; + + i_old ++; + } } -} -static -ecs_map_t* get_triggers_for_event( - const ecs_observable_t *observable, - ecs_entity_t event) -{ - ecs_check(observable != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(event != 0, ECS_INTERNAL_ERROR, NULL); + move_switch_columns(new_table, new_data, new_count, old_table, old_data, 0, + old_count, true); + move_bitset_columns(new_table, new_data, new_count, old_table, old_data, 0, + old_count, true); - ecs_sparse_t *events = observable->events; - ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); + /* Initialize remaining columns */ + for (; i_new < new_column_count; i_new ++) { + ecs_column_t *column = &new_columns[i_new]; + int16_t size = column->size; + int16_t alignment = column->alignment; + ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); - const ecs_event_record_t *evt = flecs_sparse_get( - events, ecs_event_record_t, event); - - if (evt) { - return (ecs_map_t*)&evt->event_ids; + ecs_vector_set_count_t(&column->data, size, alignment, + old_count + new_count); + + /* Construct new values */ + ecs_type_info_t *ti = &new_type_info[i_new]; + ctor_component(world, ti, column, entities, 0, old_count + new_count); } -error: - return NULL; + /* Destroy remaining columns */ + for (; i_old < old_column_count; i_old ++) { + ecs_column_t *column = &old_columns[i_old]; + + /* Destruct old values */ + ecs_type_info_t *ti = &old_type_info[i_old]; + dtor_component(world, old_table, ti, column, entities, 0, + 0, old_count, false); + + /* Old column does not occur in new table, remove */ + ecs_vector_free(column->data); + column->data = NULL; + } + + /* Mark entity column as dirty */ + mark_table_dirty(world, new_table, 0); } -static -ecs_event_id_record_t* get_triggers_for_id( - const ecs_map_t *evt, - ecs_id_t id) +int32_t ecs_table_count( + const ecs_table_t *table) { - return ecs_map_get_ptr(evt, ecs_event_id_record_t*, id); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + return flecs_table_data_count(&table->storage); } -bool flecs_check_triggers_for_event( - const ecs_poly_t *object, - ecs_id_t id, - ecs_entity_t event) -{ - ecs_observable_t *observable = ecs_get_observable(object); - const ecs_map_t *evt = get_triggers_for_event(observable, event); - if (!evt) { - return false; - } +void flecs_table_merge( + ecs_world_t *world, + ecs_table_t *new_table, + ecs_table_t *old_table, + ecs_data_t *new_data, + ecs_data_t *old_data) +{ + ecs_assert(old_table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!old_table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_event_id_record_t *edr = get_triggers_for_id(evt, id); - if (edr) { - return edr->trigger_count != 0; + check_table_sanity(new_table); + check_table_sanity(old_table); + + bool move_data = false; + + /* If there is nothing to merge to, just clear the old table */ + if (!new_table) { + flecs_table_clear_data(world, old_table, old_data); + check_table_sanity(old_table); + return; } else { - return false; + ecs_assert(!new_table->lock, ECS_LOCKED_STORAGE, NULL); } -} -static -void init_iter( - ecs_iter_t *it, - bool *iter_set) -{ - ecs_assert(it != NULL, ECS_INTERNAL_ERROR, NULL); - - if (*iter_set) { + /* If there is no data to merge, drop out */ + if (!old_data) { return; } - if (it->table_only) { - it->ids = it->priv.cache.ids; - it->ids[0] = it->event_id; - return; + if (!new_data) { + new_data = &new_table->storage; + if (new_table == old_table) { + move_data = true; + } } - flecs_iter_init(it); + ecs_entity_t *old_entities = ecs_vector_first(old_data->entities, ecs_entity_t); + int32_t old_count = ecs_vector_count(old_data->entities); + int32_t new_count = ecs_vector_count(new_data->entities); - *iter_set = true; + ecs_record_t **old_records = ecs_vector_first( + old_data->record_ptrs, ecs_record_t*); - it->ids[0] = it->event_id; + /* First, update entity index so old entities point to new type */ + int32_t i; + for(i = 0; i < old_count; i ++) { + ecs_record_t *record; + if (new_table != old_table) { + record = old_records[i]; + ecs_assert(record != NULL, ECS_INTERNAL_ERROR, NULL); + } else { + record = ecs_eis_ensure(world, old_entities[i]); + } - ecs_assert(it->table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!it->count || it->offset < ecs_table_count(it->table), - ECS_INTERNAL_ERROR, NULL); - ecs_assert((it->offset + it->count) <= ecs_table_count(it->table), - ECS_INTERNAL_ERROR, NULL); + uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(record->row); + record->row = ECS_ROW_TO_RECORD(new_count + i, flags); + record->table = new_table; + } - int32_t index = ecs_search_relation(it->world, it->table, 0, - it->event_id, EcsIsA, 0, 0, it->subjects, NULL, NULL); - - if (index == -1) { - it->columns[0] = 0; - } else if (it->subjects[0]) { - it->columns[0] = -index - 1; + /* Merge table columns */ + if (move_data) { + *new_data = *old_data; } else { - it->columns[0] = index + 1; + merge_table_data(world, new_table, old_table, old_count, new_count, + old_data, new_data); } - ecs_term_t term = { - .id = it->event_id - }; + new_table->alloc_count ++; - it->term_count = 1; - it->terms = &term; - flecs_iter_populate_data(it->world, it, it->table, it->offset, - it->count, it->ptrs, it->sizes); + if (old_count) { + if (!new_count) { + flecs_table_set_empty(world, new_table); + } + flecs_table_set_empty(world, old_table); + } + + check_table_sanity(old_table); + check_table_sanity(new_table); } -static -bool ignore_trigger( +void flecs_table_replace_data( ecs_world_t *world, - ecs_trigger_t *t, - ecs_table_t *table) + ecs_table_t *table, + ecs_data_t *data) { - int32_t *last_event_id = t->last_event_id; - if (last_event_id && last_event_id[0] == world->event_id) { - return true; - } + int32_t prev_count = 0; + ecs_data_t *table_data = &table->storage; + ecs_assert(!data || data != table_data, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - if (!table) { - return false; - } + check_table_sanity(table); - if (!t->match_prefab && (table->flags & EcsTableIsPrefab)) { - return true; + prev_count = ecs_vector_count(table_data->entities); + run_on_remove(world, table, table_data); + flecs_table_clear_data(world, table, table_data); + + if (data) { + table->storage = *data; + } else { + flecs_table_init_data(world, table); } - if (!t->match_disabled && (table->flags & EcsTableIsDisabled)) { - return true; + + int32_t count = ecs_table_count(table); + + if (!prev_count && count) { + flecs_table_set_empty(world, table); + } else if (prev_count && !count) { + flecs_table_set_empty(world, table); } - - return false; + + table->alloc_count ++; + + check_table_sanity(table); } -static -void notify_self_triggers( - ecs_world_t *world, - ecs_iter_t *it, - const ecs_map_t *triggers) -{ - ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_map_iter_t mit = ecs_map_iter(triggers); - ecs_trigger_t *t; - while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { - if (ignore_trigger(world, t, it->table)) { - continue; +int32_t* flecs_table_get_dirty_state( + ecs_table_t *table) +{ + if (!table->dirty_state) { + int32_t column_count = ecs_vector_count(table->storage_type); + table->dirty_state = ecs_os_malloc_n( int32_t, column_count + 1); + ecs_assert(table->dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); + + for (int i = 0; i < column_count + 1; i ++) { + table->dirty_state[i] = 1; } + } + return table->dirty_state; +} - it->is_filter = t->term.inout == EcsInOutFilter; - it->system = t->entity; - it->self = t->self; - it->ctx = t->ctx; - it->binding_ctx = t->binding_ctx; - it->term_index = t->term.index; - it->terms = &t->term; +int32_t* flecs_table_get_monitor( + ecs_table_t *table) +{ + int32_t *dirty_state = flecs_table_get_dirty_state(table); + ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - t->callback(it); - } + int32_t column_count = ecs_vector_count(table->storage_type); + return ecs_os_memdup(dirty_state, (column_count + 1) * ECS_SIZEOF(int32_t)); } -static -void notify_entity_triggers( +void flecs_table_notify( ecs_world_t *world, - ecs_iter_t *it, - const ecs_map_t *triggers) + ecs_table_t *table, + ecs_table_event_t *event) { - ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - - if (it->table_only) { + if (world->is_fini) { return; } - ecs_map_iter_t mit = ecs_map_iter(triggers); - ecs_trigger_t *t; - int32_t offset = it->offset, count = it->count; - ecs_entity_t *entities = it->entities; - - ecs_entity_t dummy = 0; - it->entities = &dummy; + switch(event->kind) { + case EcsTableTriggersForId: + notify_trigger(world, table, event->event); + break; + case EcsTableNoTriggersForId: + break; + } +} - while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { - if (ignore_trigger(world, t, it->table)) { - continue; +void ecs_table_lock( + ecs_world_t *world, + ecs_table_t *table) +{ + if (table) { + if (ecs_poly_is(world, ecs_world_t) && !world->is_readonly) { + table->lock ++; } + } +} - int32_t i, entity_count = it->count; - for (i = 0; i < entity_count; i ++) { - if (entities[i] != t->term.subj.entity) { - continue; - } - - it->is_filter = t->term.inout == EcsInOutFilter; - it->system = t->entity; - it->self = t->self; - it->ctx = t->ctx; - it->binding_ctx = t->binding_ctx; - it->term_index = t->term.index; - it->terms = &t->term; - it->offset = i; - it->count = 1; - it->subjects[0] = entities[i]; - - t->callback(it); +void ecs_table_unlock( + ecs_world_t *world, + ecs_table_t *table) +{ + if (table) { + if (ecs_poly_is(world, ecs_world_t) && !world->is_readonly) { + table->lock --; + ecs_assert(table->lock >= 0, ECS_INVALID_OPERATION, NULL); } } - - it->offset = offset; - it->count = count; - it->entities = entities; - it->subjects[0] = 0; } -static -void notify_set_base_triggers( - ecs_world_t *world, - ecs_iter_t *it, - const ecs_map_t *triggers) +bool ecs_table_has_module( + ecs_table_t *table) { - ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); + return table->flags & EcsTableHasModule; +} - ecs_entity_t event_id = it->event_id; - ecs_entity_t rel = ECS_PAIR_FIRST(event_id); - ecs_entity_t obj = ecs_pair_second(world, event_id); - ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); - ecs_table_t *obj_table = ecs_get_table(world, obj); - if (!obj_table) { - return; +ecs_column_t* ecs_table_column_for_id( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_id_t id) +{ + ecs_table_t *storage_table = table->storage_table; + if (!storage_table) { + return NULL; } - ecs_map_iter_t mit = ecs_map_iter(triggers); - ecs_trigger_t *t; - while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { - if (ignore_trigger(world, t, it->table)) { - continue; - } + ecs_table_record_t *tr = flecs_get_table_record(world, storage_table, id); + if (tr) { + return &table->storage.columns[tr->column]; + } - ecs_term_t *term = &t->term; - ecs_id_t id = term->id; - int32_t column = ecs_search_relation(world, obj_table, 0, id, rel, - 0, 0, it->subjects, it->ids, 0); - - bool result = column != -1; - if (term->oper == EcsNot) { - result = !result; - } - if (!result) { - continue; - } + return NULL; +} - if (!term->subj.set.min_depth && flecs_get_table_record( - world, it->table, id) != NULL) - { - continue; - } +ecs_type_t ecs_table_get_type( + const ecs_table_t *table) +{ + if (table) { + return table->type; + } else { + return NULL; + } +} - if (!it->table_only) { - if (!it->subjects[0]) { - it->subjects[0] = obj; - } +ecs_table_t* ecs_table_get_storage_table( + const ecs_table_t *table) +{ + return table->storage_table; +} - if (column != -1) { - it->columns[0] = -(column + 1); - } else { - it->columns[0] = 0; - } - } +int32_t ecs_table_storage_count( + const ecs_table_t *table) +{ + return ecs_vector_count(table->storage_type); +} - it->is_filter = t->term.inout == EcsInOutFilter; - it->event_id = t->term.id; - it->system = t->entity; - it->self = t->self; - it->ctx = t->ctx; - it->binding_ctx = t->binding_ctx; - it->term_index = t->term.index; - it->terms = &t->term; - - t->callback(it); +int32_t ecs_table_type_to_storage_index( + const ecs_table_t *table, + int32_t index) +{ + ecs_assert(index >= 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(index < ecs_vector_count(table->type), + ECS_INVALID_PARAMETER, NULL); + int32_t *storage_map = table->storage_map; + if (storage_map) { + return storage_map[index]; } +error: + return -1; } -static -void notify_set_triggers( - ecs_world_t *world, - ecs_iter_t *it, - const ecs_map_t *triggers) +int32_t ecs_table_storage_to_type_index( + const ecs_table_t *table, + int32_t index) { - ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(it->count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_check(index < ecs_vector_count(table->storage_type), + ECS_INVALID_PARAMETER, NULL); + ecs_check(table->storage_map != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t offset = ecs_vector_count(table->type); + return table->storage_map[offset + index]; +error: + return -1; +} - if (it->table_only) { - return; +ecs_record_t* ecs_record_find( + const ecs_world_t *world, + ecs_entity_t entity) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(entity != 0, ECS_INVALID_PARAMETER, NULL); + + world = ecs_get_world(world); + + ecs_record_t *r = ecs_eis_get(world, entity); + if (r) { + return r; } +error: + return NULL; +} - ecs_map_iter_t mit = ecs_map_iter(triggers); - ecs_trigger_t *t; - while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { - if (!ecs_id_match(it->event_id, t->term.id)) { - continue; - } +void* ecs_record_get_column( + ecs_record_t *r, + int32_t column, + size_t c_size) +{ + (void)c_size; + ecs_table_t *table = r->table; - if (ignore_trigger(world, t, it->table)) { - continue; - } + ecs_check(column < ecs_vector_count(table->storage_type), + ECS_INVALID_PARAMETER, NULL); - ecs_entity_t subj = it->entities[0]; - int32_t i, count = it->count; - ecs_entity_t term_subj = t->term.subj.entity; + ecs_column_t *c = &table->storage.columns[column]; + ecs_assert(c != NULL, ECS_INTERNAL_ERROR, NULL); - /* If trigger is for a specific entity, make sure it is in the table - * being triggered for */ - if (term_subj != EcsThis) { - for (i = 0; i < count; i ++) { - if (it->entities[i] == term_subj) { - break; - } - } + ecs_check(!flecs_utosize(c_size) || + flecs_utosize(c_size) == c->size, + ECS_INVALID_PARAMETER, NULL); - if (i == count) { - continue; - } + return ecs_vector_get_t(c->data, c->size, c->alignment, + ECS_RECORD_TO_ROW(r->row)); +error: + return NULL; +} - /* If the entity matches, trigger for no other entities */ - it->entities[0] = 0; - it->count = 1; - } +#include - if (flecs_term_match_table(world, &t->term, it->table, it->type, - it->ids, it->columns, it->subjects, NULL, true)) - { - if (!it->subjects[0]) { - /* Do not match owned components */ - continue; - } +static const char* mixin_kind_str[] = { + [EcsMixinBase] = "base (should never be requested by application)", + [EcsMixinWorld] = "world", + [EcsMixinObservable] = "observable", + [EcsMixinIterable] = "iterable", + [EcsMixinMax] = "max (should never be requested by application)" +}; - it->is_filter = t->term.inout == EcsInOutFilter; - it->system = t->entity; - it->self = t->self; - it->ctx = t->ctx; - it->binding_ctx = t->binding_ctx; - it->term_index = t->term.index; - it->terms = &t->term; +ecs_mixins_t ecs_world_t_mixins = { + .type_name = "ecs_world_t", + .elems = { + [EcsMixinWorld] = offsetof(ecs_world_t, self), + [EcsMixinObservable] = offsetof(ecs_world_t, observable), + [EcsMixinIterable] = offsetof(ecs_world_t, iterable) + } +}; - /* Triggers for supersets can be instanced */ - if (it->count == 1 || t->instanced || it->is_filter || !it->sizes[0]) { - it->is_instanced = t->instanced; - t->callback(it); - it->is_instanced = false; - } else { - ecs_entity_t *entities = it->entities; - it->count = 1; - for (i = 0; i < count; i ++) { - it->entities = &entities[i]; - t->callback(it); - } - it->entities = entities; - } - } +ecs_mixins_t ecs_stage_t_mixins = { + .type_name = "ecs_stage_t", + .elems = { + [EcsMixinBase] = offsetof(ecs_stage_t, world), + [EcsMixinWorld] = offsetof(ecs_stage_t, world) + } +}; - it->entities[0] = subj; - it->count = count; +ecs_mixins_t ecs_query_t_mixins = { + .type_name = "ecs_query_t", + .elems = { + [EcsMixinWorld] = offsetof(ecs_query_t, world), + [EcsMixinIterable] = offsetof(ecs_query_t, iterable) } -} +}; + +ecs_mixins_t ecs_filter_t_mixins = { + .type_name = "ecs_filter_t", + .elems = { + [EcsMixinIterable] = offsetof(ecs_filter_t, iterable) + } +}; static -void notify_triggers_for_id( - ecs_world_t *world, - const ecs_map_t *evt, - ecs_id_t event_id, - ecs_iter_t *it, - bool *iter_set) +void* get_mixin( + const ecs_poly_t *poly, + ecs_mixin_kind_t kind) { - const ecs_event_id_record_t *idt = get_triggers_for_id(evt, event_id); - if (!idt) { - return; - } + ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(kind < EcsMixinMax, ECS_INVALID_PARAMETER, NULL); + + const ecs_header_t *hdr = poly; + ecs_assert(hdr != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); - if (ecs_map_is_initialized(&idt->triggers)) { - init_iter(it, iter_set); - notify_self_triggers(world, it, &idt->triggers); + const ecs_mixins_t *mixins = hdr->mixins; + if (!mixins) { + /* Object has no mixins */ + goto not_found; } - if (ecs_map_is_initialized(&idt->entity_triggers)) { - init_iter(it, iter_set); - notify_entity_triggers(world, it, &idt->entity_triggers); + + ecs_size_t offset = mixins->elems[kind]; + if (offset == 0) { + /* Object has mixins but not the requested one. Try to find the mixin + * in the poly's base */ + goto find_in_base; } - if (ecs_map_is_initialized(&idt->set_triggers)) { - init_iter(it, iter_set); - notify_set_base_triggers(world, it, &idt->set_triggers); + + /* Object has mixin, return its address */ + return ECS_OFFSET(hdr, offset); + +find_in_base: + if (offset) { + /* If the poly has a base, try to find the mixin in the base */ + ecs_poly_t *base = *(ecs_poly_t**)ECS_OFFSET(hdr, offset); + if (base) { + return get_mixin(base, kind); + } } + +not_found: + /* Mixin wasn't found for poly */ + return NULL; } static -void notify_set_triggers_for_id( - ecs_world_t *world, - const ecs_map_t *evt, - ecs_iter_t *it, - bool *iter_set, - ecs_id_t set_id) +void* assert_mixin( + const ecs_poly_t *poly, + ecs_mixin_kind_t kind) { - const ecs_event_id_record_t *idt = get_triggers_for_id(evt, set_id); - if (idt && ecs_map_is_initialized(&idt->set_triggers)) { - init_iter(it, iter_set); - notify_set_triggers(world, it, &idt->set_triggers); + void *ptr = get_mixin(poly, kind); + if (!ptr) { + const ecs_header_t *header = poly; + const ecs_mixins_t *mixins = header->mixins; + ecs_err("%s not available for type %s", + mixin_kind_str[kind], + mixins ? mixins->type_name : "unknown"); + ecs_os_abort(); } + + return ptr; } -static -void trigger_yield_existing( - ecs_world_t *world, - ecs_trigger_t *trigger) +void* _ecs_poly_init( + ecs_poly_t *poly, + int32_t type, + ecs_size_t size, + ecs_mixins_t *mixins) { - ecs_iter_action_t callback = trigger->callback; + ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); - /* If yield existing is enabled, trigger for each thing that matches - * the event, if the event is iterable. */ - int i, count = trigger->event_count; - for (i = 0; i < count; i ++) { - ecs_entity_t evt = trigger->events[i]; - const EcsIterable *iterable = ecs_get(world, evt, EcsIterable); - if (!iterable) { - continue; - } + ecs_header_t *hdr = poly; + ecs_os_memset(poly, 0, size); - ecs_iter_t it; - iterable->init(world, world, &it, &trigger->term); - it.system = trigger->entity; - it.ctx = trigger->ctx; - it.binding_ctx = trigger->binding_ctx; - it.event = evt; + hdr->magic = ECS_OBJECT_MAGIC; + hdr->type = type; + hdr->mixins = mixins; - ecs_iter_next_action_t next = it.next; - ecs_assert(next != NULL, ECS_INTERNAL_ERROR, NULL); - while (next(&it)) { - it.event_id = it.ids[0]; - callback(&it); - } - } + return poly; } -void flecs_triggers_notify( - ecs_iter_t *it, - ecs_observable_t *observable, - ecs_ids_t *ids, - ecs_entity_t event) +void _ecs_poly_fini( + ecs_poly_t *poly, + int32_t type) { - ecs_assert(ids != NULL && ids->count != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ids->array != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t events[2] = {event, EcsWildcard}; - int32_t e, i, ids_count = ids->count; - ecs_id_t *ids_array = ids->array; - ecs_world_t *world = it->real_world; - - for (e = 0; e < 2; e ++) { - event = events[e]; - const ecs_map_t *evt = get_triggers_for_event(observable, event); - if (!evt) { - continue; - } + ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); + (void)type; - it->event = event; + ecs_header_t *hdr = poly; - for (i = 0; i < ids_count; i ++) { - ecs_id_t id = ids_array[i]; - ecs_entity_t role = id & ECS_ROLE_MASK; - bool iter_set = false; + /* Don't deinit poly that wasn't initialized */ + ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); + ecs_assert(hdr->type == type, ECS_INVALID_PARAMETER, NULL); + hdr->magic = 0; +} - it->event_id = id; - - notify_triggers_for_id(world, evt, id, it, &iter_set); - - if (role == ECS_PAIR || role == ECS_CASE) { - ecs_entity_t pred = ECS_PAIR_FIRST(id); - ecs_entity_t obj = ECS_PAIR_SECOND(id); - - ecs_id_t tid = role | ecs_entity_t_comb(EcsWildcard, pred); - notify_triggers_for_id(world, evt, tid, it, &iter_set); - - tid = role | ecs_entity_t_comb(obj, EcsWildcard); - notify_triggers_for_id(world, evt, tid, it, &iter_set); - - tid = role | ecs_entity_t_comb(EcsWildcard, EcsWildcard); - notify_triggers_for_id(world, evt, tid, it, &iter_set); - } else { - notify_triggers_for_id(world, evt, EcsWildcard, it, &iter_set); - } - } - } -} +#define assert_object(cond, file, line)\ + _ecs_assert((cond), ECS_INVALID_PARAMETER, #cond, file, line, NULL);\ + assert(cond) -void flecs_set_triggers_notify( - ecs_iter_t *it, - ecs_observable_t *observable, - ecs_ids_t *ids, - ecs_entity_t event, - ecs_id_t set_id) +#ifndef FLECS_NDEBUG +void _ecs_poly_assert( + const ecs_poly_t *poly, + int32_t type, + const char *file, + int32_t line) { - ecs_assert(ids != NULL && ids->count != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ids->array != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t events[2] = {event, EcsWildcard}; - int32_t e, i, ids_count = ids->count; - ecs_id_t *ids_array = ids->array; - ecs_world_t *world = it->real_world; - - for (e = 0; e < 2; e ++) { - event = events[e]; - const ecs_map_t *evt = get_triggers_for_event(observable, event); - if (!evt) { - continue; - } - - it->event = event; - - for (i = 0; i < ids_count; i ++) { - ecs_id_t id = ids_array[i]; - bool iter_set = false; - - it->event_id = id; - - notify_set_triggers_for_id(world, evt, it, &iter_set, set_id); - } - } + assert_object(poly != NULL, file, line); + + const ecs_header_t *hdr = poly; + assert_object(hdr->magic == ECS_OBJECT_MAGIC, file, line); + assert_object(hdr->type == type, file, line); } +#endif -ecs_entity_t ecs_trigger_init( - ecs_world_t *world, - const ecs_trigger_desc_t *desc) +bool _ecs_poly_is( + const ecs_poly_t *poly, + int32_t type) { - char *name = NULL; - - ecs_poly_assert(world, ecs_world_t); - ecs_check(!world->is_readonly, ECS_INVALID_OPERATION, NULL); - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); - - const char *expr = desc->expr; - ecs_trigger_t *trigger = NULL; - - ecs_observable_t *observable = desc->observable; - if (!observable) { - observable = ecs_get_observable(world); - } - - /* If entity is provided, create it */ - ecs_entity_t existing = desc->entity.entity; - ecs_entity_t entity = ecs_entity_init(world, &desc->entity); - if (!existing && !desc->entity.name) { - ecs_add_pair(world, entity, EcsChildOf, EcsFlecsHidden); - } - - bool added = false; - EcsTrigger *comp = ecs_get_mut(world, entity, EcsTrigger, &added); - if (added) { - ecs_check(desc->callback != NULL, ECS_INVALID_PARAMETER, NULL); - - /* Something went wrong with the construction of the entity */ - ecs_check(entity != 0, ECS_INVALID_PARAMETER, NULL); - name = ecs_get_fullpath(world, entity); - - ecs_term_t term; - if (expr) { - #ifdef FLECS_PARSER - const char *ptr = ecs_parse_term(world, name, expr, expr, &term); - if (!ptr) { - goto error; - } - - if (!ecs_term_is_initialized(&term)) { - ecs_parser_error( - name, expr, 0, "invalid empty trigger expression"); - goto error; - } - - if (ptr[0]) { - ecs_parser_error(name, expr, 0, - "too many terms in trigger expression (expected 1)"); - goto error; - } - #else - ecs_abort(ECS_UNSUPPORTED, "parser addon is not available"); - #endif - } else { - term = ecs_term_copy(&desc->term); - } - - if (ecs_term_finalize(world, name, &term)) { - ecs_term_fini(&term); - goto error; - } - - trigger = flecs_sparse_add(world->triggers, ecs_trigger_t); - trigger->id = flecs_sparse_last_id(world->triggers); - - trigger->term = ecs_term_move(&term); - trigger->callback = desc->callback; - trigger->ctx = desc->ctx; - trigger->binding_ctx = desc->binding_ctx; - trigger->ctx_free = desc->ctx_free; - trigger->binding_ctx_free = desc->binding_ctx_free; - trigger->event_count = count_events(desc->events); - ecs_os_memcpy(trigger->events, desc->events, - trigger->event_count * ECS_SIZEOF(ecs_entity_t)); - trigger->entity = entity; - trigger->self = desc->self; - trigger->observable = observable; - trigger->match_prefab = desc->match_prefab; - trigger->match_disabled = desc->match_disabled; - trigger->instanced = desc->instanced; - trigger->last_event_id = desc->last_event_id; - - if (trigger->term.id == EcsPrefab) { - trigger->match_prefab = true; - } - if (trigger->term.id == EcsDisabled) { - trigger->match_disabled = true; - } - - comp->trigger = trigger; - - /* Trigger must have at least one event */ - ecs_check(trigger->event_count != 0, ECS_INVALID_PARAMETER, NULL); - - register_trigger(world, observable, trigger); - - ecs_term_fini(&term); - - if (desc->entity.name) { - ecs_trace("#[green]trigger#[reset] %s created", - ecs_get_name(world, entity)); - } - - if (desc->yield_existing) { - trigger_yield_existing(world, trigger); - } - } else { - ecs_assert(comp->trigger != NULL, ECS_INTERNAL_ERROR, NULL); - - /* If existing entity handle was provided, override existing params */ - if (existing) { - if (desc->callback) { - ((ecs_trigger_t*)comp->trigger)->callback = desc->callback; - } - if (desc->ctx) { - ((ecs_trigger_t*)comp->trigger)->ctx = desc->ctx; - } - if (desc->binding_ctx) { - ((ecs_trigger_t*)comp->trigger)->binding_ctx = desc->binding_ctx; - } - } - } + ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_os_free(name); - return entity; -error: - ecs_os_free(name); - ecs_delete(world, entity); - return 0; + const ecs_header_t *hdr = poly; + ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); + return hdr->type == type; } -void* ecs_get_trigger_ctx( - const ecs_world_t *world, - ecs_entity_t trigger) +ecs_iterable_t* ecs_get_iterable( + const ecs_poly_t *poly) { - const EcsTrigger *t = ecs_get(world, trigger, EcsTrigger); - if (t) { - return t->trigger->ctx; - } else { - return NULL; - } + return (ecs_iterable_t*)assert_mixin(poly, EcsMixinIterable); } -void* ecs_get_trigger_binding_ctx( - const ecs_world_t *world, - ecs_entity_t trigger) +ecs_observable_t* ecs_get_observable( + const ecs_poly_t *poly) { - const EcsTrigger *t = ecs_get(world, trigger, EcsTrigger); - if (t) { - return t->trigger->binding_ctx; - } else { - return NULL; - } + return (ecs_observable_t*)assert_mixin(poly, EcsMixinObservable); } -void flecs_trigger_fini( - ecs_world_t *world, - ecs_trigger_t *trigger) -{ - unregister_trigger(world, trigger->observable, trigger); - ecs_term_fini(&trigger->term); - - if (trigger->ctx_free) { - trigger->ctx_free(trigger->ctx); - } - - if (trigger->binding_ctx_free) { - trigger->binding_ctx_free(trigger->binding_ctx); - } - - flecs_sparse_remove(world->triggers, trigger->id); +const ecs_world_t* ecs_get_world( + const ecs_poly_t *poly) +{ + return *(ecs_world_t**)assert_mixin(poly, EcsMixinWorld); } @@ -8789,1863 +8855,1973 @@ bool flecs_defer_purge( } -#ifdef ECS_TARGET_GNU -#pragma GCC diagnostic ignored "-Wimplicit-fallthrough" -#endif - -/* See explanation below. The hashing function may read beyond the memory passed - * into the hashing function, but only at word boundaries. This should be safe, - * but trips up address sanitizers and valgrind. - * This ensures clean valgrind logs in debug mode & the best perf in release */ -#if !defined(FLECS_NDEBUG) || defined(ADDRESS_SANITIZER) -#ifndef VALGRIND -#define VALGRIND -#endif -#endif - -/* -------------------------------------------------------------------------------- -lookup3.c, by Bob Jenkins, May 2006, Public Domain. - http://burtleburtle.net/bob/c/lookup3.c -------------------------------------------------------------------------------- -*/ - -#ifdef ECS_TARGET_MSVC -//FIXME -#else -#include /* attempt to define endianness */ -#endif -#ifdef ECS_TARGET_LINUX -# include /* attempt to define endianness */ -#endif +static +ecs_defer_op_t* new_defer_op(ecs_stage_t *stage) { + ecs_defer_op_t *result = ecs_vector_add(&stage->defer_queue, ecs_defer_op_t); + ecs_os_memset(result, 0, ECS_SIZEOF(ecs_defer_op_t)); + return result; +} -/* - * My best guess at if you are big-endian or little-endian. This may - * need adjustment. - */ -#if (defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && \ - __BYTE_ORDER == __LITTLE_ENDIAN) || \ - (defined(i386) || defined(__i386__) || defined(__i486__) || \ - defined(__i586__) || defined(__i686__) || defined(vax) || defined(MIPSEL)) -# define HASH_LITTLE_ENDIAN 1 -#elif (defined(__BYTE_ORDER) && defined(__BIG_ENDIAN) && \ - __BYTE_ORDER == __BIG_ENDIAN) || \ - (defined(sparc) || defined(POWERPC) || defined(mc68000) || defined(sel)) -# define HASH_LITTLE_ENDIAN 0 -#else -# define HASH_LITTLE_ENDIAN 0 -#endif +static +bool defer_add_remove( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_defer_op_kind_t op_kind, + ecs_entity_t entity, + ecs_id_t id) +{ + if (stage->defer) { + if (!id) { + return true; + } -#define rot(x,k) (((x)<<(k)) | ((x)>>(32-(k)))) + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = op_kind; + op->id = id; + op->is._1.entity = entity; -/* -------------------------------------------------------------------------------- -mix -- mix 3 32-bit values reversibly. -This is reversible, so any information in (a,b,c) before mix() is -still in (a,b,c) after mix(). -If four pairs of (a,b,c) inputs are run through mix(), or through -mix() in reverse, there are at least 32 bits of the output that -are sometimes the same for one pair and different for another pair. -This was tested for: -* pairs that differed by one bit, by two bits, in any combination - of top bits of (a,b,c), or in any combination of bottom bits of - (a,b,c). -* "differ" is defined as +, -, ^, or ~^. For + and -, I transformed - the output delta to a Gray code (a^(a>>1)) so a string of 1's (as - is commonly produced by subtraction) look like a single 1-bit - difference. -* the base values were pseudorandom, all zero but one bit set, or - all zero plus a counter that starts at zero. -Some k values for my "a-=c; a^=rot(c,k); c+=b;" arrangement that -satisfy this are - 4 6 8 16 19 4 - 9 15 3 18 27 15 - 14 9 3 7 17 3 -Well, "9 15 3 18 27 15" didn't quite get 32 bits diffing -for "differ" defined as + with a one-bit base and a two-bit delta. I -used http://burtleburtle.net/bob/hash/avalanche.html to choose -the operations, constants, and arrangements of the variables. -This does not achieve avalanche. There are input bits of (a,b,c) -that fail to affect some output bits of (a,b,c), especially of a. The -most thoroughly mixed value is c, but it doesn't really even achieve -avalanche in c. -This allows some parallelism. Read-after-writes are good at doubling -the number of bits affected, so the goal of mixing pulls in the opposite -direction as the goal of parallelism. I did what I could. Rotates -seem to cost as much as shifts on every machine I could lay my hands -on, and rotates are much kinder to the top and bottom bits, so I used -rotates. -------------------------------------------------------------------------------- -*/ -#define mix(a,b,c) \ -{ \ - a -= c; a ^= rot(c, 4); c += b; \ - b -= a; b ^= rot(a, 6); a += c; \ - c -= b; c ^= rot(b, 8); b += a; \ - a -= c; a ^= rot(c,16); c += b; \ - b -= a; b ^= rot(a,19); a += c; \ - c -= b; c ^= rot(b, 4); b += a; \ -} + if (op_kind == EcsOpNew) { + world->new_count ++; + } else if (op_kind == EcsOpAdd) { + world->add_count ++; + } else if (op_kind == EcsOpRemove) { + world->remove_count ++; + } -/* -------------------------------------------------------------------------------- -final -- final mixing of 3 32-bit values (a,b,c) into c -Pairs of (a,b,c) values differing in only a few bits will usually -produce values of c that look totally different. This was tested for -* pairs that differed by one bit, by two bits, in any combination - of top bits of (a,b,c), or in any combination of bottom bits of - (a,b,c). -* "differ" is defined as +, -, ^, or ~^. For + and -, I transformed - the output delta to a Gray code (a^(a>>1)) so a string of 1's (as - is commonly produced by subtraction) look like a single 1-bit - difference. -* the base values were pseudorandom, all zero but one bit set, or - all zero plus a counter that starts at zero. -These constants passed: - 14 11 25 16 4 14 24 - 12 14 25 16 4 14 24 -and these came close: - 4 8 15 26 3 22 24 - 10 8 15 26 3 22 24 - 11 8 15 26 3 22 24 -------------------------------------------------------------------------------- -*/ -#define final(a,b,c) \ -{ \ - c ^= b; c -= rot(b,14); \ - a ^= c; a -= rot(c,11); \ - b ^= a; b -= rot(a,25); \ - c ^= b; c -= rot(b,16); \ - a ^= c; a -= rot(c,4); \ - b ^= a; b -= rot(a,14); \ - c ^= b; c -= rot(b,24); \ + return true; + } else { + stage->defer ++; + } + + return false; } - -/* - * hashlittle2: return 2 32-bit hash values - * - * This is identical to hashlittle(), except it returns two 32-bit hash - * values instead of just one. This is good enough for hash table - * lookup with 2^^64 buckets, or if you want a second hash if you're not - * happy with the first, or if you want a probably-unique 64-bit ID for - * the key. *pc is better mixed than *pb, so use *pc first. If you want - * a 64-bit value do something like "*pc + (((uint64_t)*pb)<<32)". - */ static -void hashlittle2( - const void *key, /* the key to hash */ - size_t length, /* length of the key */ - uint32_t *pc, /* IN: primary initval, OUT: primary hash */ - uint32_t *pb) /* IN: secondary initval, OUT: secondary hash */ +void merge_stages( + ecs_world_t *world, + bool force_merge) { - uint32_t a,b,c; /* internal state */ - union { const void *ptr; size_t i; } u; /* needed for Mac Powerbook G4 */ + bool is_stage = ecs_poly_is(world, ecs_stage_t); + ecs_stage_t *stage = flecs_stage_from_world(&world); - /* Set up the internal state */ - a = b = c = 0xdeadbeef + ((uint32_t)length) + *pc; - c += *pb; + bool measure_frame_time = world->measure_frame_time; - u.ptr = key; - if (HASH_LITTLE_ENDIAN && ((u.i & 0x3) == 0)) { - const uint32_t *k = (const uint32_t *)key; /* read 32-bit chunks */ - const uint8_t *k8; - (void)k8; + ecs_time_t t_start; + if (measure_frame_time) { + ecs_os_get_time(&t_start); + } - /*------ all but last block: aligned reads and affect 32 bits of (a,b,c) */ - while (length > 12) - { - a += k[0]; - b += k[1]; - c += k[2]; - mix(a,b,c); - length -= 12; - k += 3; + if (is_stage) { + /* Check for consistency if force_merge is enabled. In practice this + * function will never get called with force_merge disabled for just + * a single stage. */ + if (force_merge || stage->auto_merge) { + ecs_defer_end((ecs_world_t*)stage); + } + } else { + /* Merge stages. Only merge if the stage has auto_merging turned on, or + * if this is a forced merge (like when ecs_merge is called) */ + int32_t i, count = ecs_get_stage_count(world); + for (i = 0; i < count; i ++) { + ecs_stage_t *s = (ecs_stage_t*)ecs_get_stage(world, i); + ecs_poly_assert(s, ecs_stage_t); + if (force_merge || s->auto_merge) { + ecs_defer_end((ecs_world_t*)s); + } + } } - /*----------------------------- handle the last (probably partial) block */ - /* - * "k[2]&0xffffff" actually reads beyond the end of the string, but - * then masks off the part it's not allowed to read. Because the - * string is aligned, the masked-off tail is in the same word as the - * rest of the string. Every machine with memory protection I've seen - * does it on word boundaries, so is OK with this. But VALGRIND will - * still catch it and complain. The masking trick does make the hash - * noticably faster for short strings (like English words). - */ -#ifndef VALGRIND + flecs_eval_component_monitors(world); - switch(length) - { - case 12: c+=k[2]; b+=k[1]; a+=k[0]; break; - case 11: c+=k[2]&0xffffff; b+=k[1]; a+=k[0]; break; - case 10: c+=k[2]&0xffff; b+=k[1]; a+=k[0]; break; - case 9 : c+=k[2]&0xff; b+=k[1]; a+=k[0]; break; - case 8 : b+=k[1]; a+=k[0]; break; - case 7 : b+=k[1]&0xffffff; a+=k[0]; break; - case 6 : b+=k[1]&0xffff; a+=k[0]; break; - case 5 : b+=k[1]&0xff; a+=k[0]; break; - case 4 : a+=k[0]; break; - case 3 : a+=k[0]&0xffffff; break; - case 2 : a+=k[0]&0xffff; break; - case 1 : a+=k[0]&0xff; break; - case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ + if (measure_frame_time) { + world->stats.merge_time_total += (float)ecs_time_measure(&t_start); } -#else /* make valgrind happy */ + world->stats.merge_count_total ++; - k8 = (const uint8_t *)k; - switch(length) - { - case 12: c+=k[2]; b+=k[1]; a+=k[0]; break; - case 11: c+=((uint32_t)k8[10])<<16; /* fall through */ - case 10: c+=((uint32_t)k8[9])<<8; /* fall through */ - case 9 : c+=k8[8]; /* fall through */ - case 8 : b+=k[1]; a+=k[0]; break; - case 7 : b+=((uint32_t)k8[6])<<16; /* fall through */ - case 6 : b+=((uint32_t)k8[5])<<8; /* fall through */ - case 5 : b+=k8[4]; /* fall through */ - case 4 : a+=k[0]; break; - case 3 : a+=((uint32_t)k8[2])<<16; /* fall through */ - case 2 : a+=((uint32_t)k8[1])<<8; /* fall through */ - case 1 : a+=k8[0]; break; - case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ + /* If stage is asynchronous, deferring is always enabled */ + if (stage->asynchronous) { + ecs_defer_begin((ecs_world_t*)stage); } +} -#endif /* !valgrind */ +static +void do_auto_merge( + ecs_world_t *world) +{ + merge_stages(world, false); +} - } else if (HASH_LITTLE_ENDIAN && ((u.i & 0x1) == 0)) { - const uint16_t *k = (const uint16_t *)key; /* read 16-bit chunks */ - const uint8_t *k8; +static +void do_manual_merge( + ecs_world_t *world) +{ + merge_stages(world, true); +} - /*--------------- all but last block: aligned reads and different mixing */ - while (length > 12) - { - a += k[0] + (((uint32_t)k[1])<<16); - b += k[2] + (((uint32_t)k[3])<<16); - c += k[4] + (((uint32_t)k[5])<<16); - mix(a,b,c); - length -= 12; - k += 6; - } +bool flecs_defer_none( + ecs_world_t *world, + ecs_stage_t *stage) +{ + (void)world; + return (++ stage->defer) == 1; +} - /*----------------------------- handle the last (probably partial) block */ - k8 = (const uint8_t *)k; - switch(length) - { - case 12: c+=k[4]+(((uint32_t)k[5])<<16); - b+=k[2]+(((uint32_t)k[3])<<16); - a+=k[0]+(((uint32_t)k[1])<<16); - break; - case 11: c+=((uint32_t)k8[10])<<16; /* fall through */ - case 10: c+=k[4]; - b+=k[2]+(((uint32_t)k[3])<<16); - a+=k[0]+(((uint32_t)k[1])<<16); - break; - case 9 : c+=k8[8]; /* fall through */ - case 8 : b+=k[2]+(((uint32_t)k[3])<<16); - a+=k[0]+(((uint32_t)k[1])<<16); - break; - case 7 : b+=((uint32_t)k8[6])<<16; /* fall through */ - case 6 : b+=k[2]; - a+=k[0]+(((uint32_t)k[1])<<16); - break; - case 5 : b+=k8[4]; /* fall through */ - case 4 : a+=k[0]+(((uint32_t)k[1])<<16); - break; - case 3 : a+=((uint32_t)k8[2])<<16; /* fall through */ - case 2 : a+=k[0]; - break; - case 1 : a+=k8[0]; - break; - case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ +bool flecs_defer_modified( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_id_t id) +{ + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpModified; + op->id = id; + op->is._1.entity = entity; + return true; + } else { + stage->defer ++; } + + return false; +} - } else { /* need to read the key one byte at a time */ - const uint8_t *k = (const uint8_t *)key; - - /*--------------- all but the last block: affect some 32 bits of (a,b,c) */ - while (length > 12) - { - a += k[0]; - a += ((uint32_t)k[1])<<8; - a += ((uint32_t)k[2])<<16; - a += ((uint32_t)k[3])<<24; - b += k[4]; - b += ((uint32_t)k[5])<<8; - b += ((uint32_t)k[6])<<16; - b += ((uint32_t)k[7])<<24; - c += k[8]; - c += ((uint32_t)k[9])<<8; - c += ((uint32_t)k[10])<<16; - c += ((uint32_t)k[11])<<24; - mix(a,b,c); - length -= 12; - k += 12; +bool flecs_defer_clone( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_entity_t src, + bool clone_value) +{ + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpClone; + op->id = src; + op->is._1.entity = entity; + op->is._1.clone_value = clone_value; + return true; + } else { + stage->defer ++; } + + return false; +} - /*-------------------------------- last block: affect all 32 bits of (c) */ - switch(length) /* all the case statements fall through */ - { - case 12: c+=((uint32_t)k[11])<<24; - case 11: c+=((uint32_t)k[10])<<16; - case 10: c+=((uint32_t)k[9])<<8; - case 9 : c+=k[8]; - case 8 : b+=((uint32_t)k[7])<<24; - case 7 : b+=((uint32_t)k[6])<<16; - case 6 : b+=((uint32_t)k[5])<<8; - case 5 : b+=k[4]; - case 4 : a+=((uint32_t)k[3])<<24; - case 3 : a+=((uint32_t)k[2])<<16; - case 2 : a+=((uint32_t)k[1])<<8; - case 1 : a+=k[0]; - break; - case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ +bool flecs_defer_delete( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity) +{ + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpDelete; + op->is._1.entity = entity; + world->delete_count ++; + return true; + } else { + stage->defer ++; } - } - - final(a,b,c); - *pc=c; *pb=b; + return false; } -uint64_t flecs_hash( - const void *data, - ecs_size_t length) +bool flecs_defer_clear( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity) { - uint32_t h_1 = 0; - uint32_t h_2 = 0; - - hashlittle2( - data, - flecs_ito(size_t, length), - &h_1, - &h_2); - - return h_1 | ((uint64_t)h_2 << 32); + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpClear; + op->is._1.entity = entity; + world->clear_count ++; + return true; + } else { + stage->defer ++; + } + return false; } +bool flecs_defer_on_delete_action( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_id_t id, + ecs_entity_t action) +{ + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpOnDeleteAction; + op->id = id; + op->is._1.entity = action; + world->clear_count ++; + return true; + } else { + stage->defer ++; + } + return false; +} -/** The number of elements in a single chunk */ -#define CHUNK_COUNT (4096) - -/** Compute the chunk index from an id by stripping the first 12 bits */ -#define CHUNK(index) ((int32_t)((uint32_t)index >> 12)) +bool flecs_defer_enable( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_id_t id, + bool enable) +{ + (void)world; + if (stage->defer) { + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = enable ? EcsOpEnable : EcsOpDisable; + op->is._1.entity = entity; + op->id = id; + return true; + } else { + stage->defer ++; + } + return false; +} -/** This computes the offset of an index inside a chunk */ -#define OFFSET(index) ((int32_t)index & 0xFFF) +bool flecs_defer_bulk_new( + ecs_world_t *world, + ecs_stage_t *stage, + int32_t count, + ecs_id_t id, + const ecs_entity_t **ids_out) +{ + if (stage->defer) { + ecs_entity_t *ids = ecs_os_malloc(count * ECS_SIZEOF(ecs_entity_t)); + world->bulk_new_count ++; -/* Utility to get a pointer to the payload */ -#define DATA(array, size, offset) (ECS_OFFSET(array, size * offset)) + /* Use ecs_new_id as this is thread safe */ + int i; + for (i = 0; i < count; i ++) { + ids[i] = ecs_new_id(world); + } -typedef struct chunk_t { - int32_t *sparse; /* Sparse array with indices to dense array */ - void *data; /* Store data in sparse array to reduce - * indirection and provide stable pointers. */ -} chunk_t; + *ids_out = ids; -static -chunk_t* chunk_new( - ecs_sparse_t *sparse, - int32_t chunk_index) -{ - int32_t count = ecs_vector_count(sparse->chunks); - chunk_t *chunks; + /* Store data in op */ + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = EcsOpBulkNew; + op->id = id; + op->is._n.entities = ids; + op->is._n.count = count; - if (count <= chunk_index) { - ecs_vector_set_count(&sparse->chunks, chunk_t, chunk_index + 1); - chunks = ecs_vector_first(sparse->chunks, chunk_t); - ecs_os_memset(&chunks[count], 0, (1 + chunk_index - count) * ECS_SIZEOF(chunk_t)); + return true; } else { - chunks = ecs_vector_first(sparse->chunks, chunk_t); + stage->defer ++; } - ecs_assert(chunks != NULL, ECS_INTERNAL_ERROR, NULL); - - chunk_t *result = &chunks[chunk_index]; - ecs_assert(result->sparse == NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result->data == NULL, ECS_INTERNAL_ERROR, NULL); - - /* Initialize sparse array with zero's, as zero is used to indicate that the - * sparse element has not been paired with a dense element. Use zero - * as this means we can take advantage of calloc having a possibly better - * performance than malloc + memset. */ - result->sparse = ecs_os_calloc(ECS_SIZEOF(int32_t) * CHUNK_COUNT); - - /* Initialize the data array with zero's to guarantee that data is - * always initialized. When an entry is removed, data is reset back to - * zero. Initialize now, as this can take advantage of calloc. */ - result->data = ecs_os_calloc(sparse->size * CHUNK_COUNT); + return false; +} - ecs_assert(result->sparse != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result->data != NULL, ECS_INTERNAL_ERROR, NULL); +bool flecs_defer_new( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_id_t id) +{ + return defer_add_remove(world, stage, EcsOpNew, entity, id); +} - return result; +bool flecs_defer_add( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_id_t id) +{ + return defer_add_remove(world, stage, EcsOpAdd, entity, id); } -static -void chunk_free( - chunk_t *chunk) +bool flecs_defer_remove( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t entity, + ecs_id_t id) { - ecs_os_free(chunk->sparse); - ecs_os_free(chunk->data); + return defer_add_remove(world, stage, EcsOpRemove, entity, id); } -static -chunk_t* get_chunk( - const ecs_sparse_t *sparse, - int32_t chunk_index) +bool flecs_defer_set( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_defer_op_kind_t op_kind, + ecs_entity_t entity, + ecs_id_t id, + ecs_size_t size, + const void *value, + void **value_out, + bool *is_added) { - if (!sparse->chunks) { - return NULL; - } - if (chunk_index >= ecs_vector_count(sparse->chunks)) { - return NULL; - } + if (stage->defer) { + world->set_count ++; + if (!size) { + const EcsComponent *cptr = flecs_component_from_id(world, id); + ecs_check(cptr != NULL, ECS_INVALID_PARAMETER, NULL); + size = cptr->size; + } - /* If chunk_index is below zero, application used an invalid entity id */ - ecs_assert(chunk_index >= 0, ECS_INVALID_PARAMETER, NULL); - chunk_t *result = ecs_vector_get(sparse->chunks, chunk_t, chunk_index); - if (result && !result->sparse) { - return NULL; - } + ecs_defer_op_t *op = new_defer_op(stage); + op->kind = op_kind; + op->id = id; + op->is._1.entity = entity; + op->is._1.size = size; + op->is._1.value = ecs_os_malloc(size); - return result; -} + if (!value) { + value = ecs_get_id(world, entity, id); + if (is_added) { + *is_added = value == NULL; + } + } -static -chunk_t* get_or_create_chunk( - ecs_sparse_t *sparse, - int32_t chunk_index) -{ - chunk_t *chunk = get_chunk(sparse, chunk_index); - if (chunk) { - return chunk; + const ecs_type_info_t *ti = NULL; + ecs_entity_t real_id = ecs_get_typeid(world, id); + if (real_id) { + ti = flecs_get_type_info(world, real_id); + } + + if (value) { + ecs_copy_t copy; + if (ti && (copy = ti->lifecycle.copy_ctor)) { + copy(world, &entity, &entity, op->is._1.value, value, 1, ti); + } else { + ecs_os_memcpy(op->is._1.value, value, size); + } + } else { + ecs_xtor_t ctor; + if (ti && (ctor = ti->lifecycle.ctor)) { + ctor(world, &entity, op->is._1.value, 1, ti); + } + } + + if (value_out) { + *value_out = op->is._1.value; + } + + return true; + } else { + stage->defer ++; } - return chunk_new(sparse, chunk_index); +error: + return false; } -static -void grow_dense( - ecs_sparse_t *sparse) +void flecs_stage_merge_post_frame( + ecs_world_t *world, + ecs_stage_t *stage) { - ecs_vector_add(&sparse->dense, uint64_t); -} + /* Execute post frame actions */ + ecs_vector_each(stage->post_frame_actions, ecs_action_elem_t, action, { + action->action(world, action->ctx); + }); -static -uint64_t strip_generation( - uint64_t *index_out) -{ - uint64_t index = *index_out; - uint64_t gen = index & ECS_GENERATION_MASK; - /* Make sure there's no junk in the id */ - ecs_assert(gen == (index & (0xFFFFFFFFull << 32)), - ECS_INVALID_PARAMETER, NULL); - *index_out -= gen; - return gen; + ecs_vector_free(stage->post_frame_actions); + stage->post_frame_actions = NULL; } -static -void assign_index( - chunk_t * chunk, - uint64_t * dense_array, - uint64_t index, - int32_t dense) +void flecs_stage_init( + ecs_world_t *world, + ecs_stage_t *stage) { - /* Initialize sparse-dense pair. This assigns the dense index to the sparse - * array, and the sparse index to the dense array .*/ - chunk->sparse[OFFSET(index)] = dense; - dense_array[dense] = index; -} + ecs_poly_assert(world, ecs_world_t); -static -uint64_t inc_gen( - uint64_t index) -{ - /* When an index is deleted, its generation is increased so that we can do - * liveliness checking while recycling ids */ - return ECS_GENERATION_INC(index); -} + ecs_poly_init(stage, ecs_stage_t); -static -uint64_t inc_id( - ecs_sparse_t *sparse) -{ - /* Generate a new id. The last issued id could be stored in an external - * variable, such as is the case with the last issued entity id, which is - * stored on the world. */ - return ++ (sparse->max_id[0]); + stage->world = world; + stage->thread_ctx = world; + stage->auto_merge = true; + stage->asynchronous = false; } -static -uint64_t get_id( - const ecs_sparse_t *sparse) +void flecs_stage_deinit( + ecs_world_t *world, + ecs_stage_t *stage) { - return sparse->max_id[0]; + (void)world; + ecs_poly_assert(world, ecs_world_t); + ecs_poly_assert(stage, ecs_stage_t); + + /* Make sure stage has no unmerged data */ + ecs_assert(ecs_vector_count(stage->defer_queue) == 0, + ECS_INTERNAL_ERROR, NULL); + + ecs_poly_fini(stage, ecs_stage_t); + + ecs_vector_free(stage->defer_queue); } -static -void set_id( - ecs_sparse_t *sparse, - uint64_t value) +void ecs_set_stages( + ecs_world_t *world, + int32_t stage_count) { - /* Sometimes the max id needs to be assigned directly, which typically - * happens when the API calls get_or_create for an id that hasn't been - * issued before. */ - sparse->max_id[0] = value; -} + ecs_poly_assert(world, ecs_world_t); -/* Pair dense id with new sparse id */ -static -uint64_t create_id( - ecs_sparse_t *sparse, - int32_t dense) -{ - uint64_t index = inc_id(sparse); - grow_dense(sparse); - - chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); - ecs_assert(chunk->sparse[OFFSET(index)] == 0, ECS_INTERNAL_ERROR, NULL); - - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - assign_index(chunk, dense_array, index, dense); - - return index; -} + ecs_stage_t *stages; + int32_t i, count = ecs_vector_count(world->worker_stages); -/* Create new id */ -static -uint64_t new_index( - ecs_sparse_t *sparse) -{ - ecs_vector_t *dense = sparse->dense; - int32_t dense_count = ecs_vector_count(dense); - int32_t count = sparse->count ++; + if (count && count != stage_count) { + stages = ecs_vector_first(world->worker_stages, ecs_stage_t); - ecs_assert(count <= dense_count, ECS_INTERNAL_ERROR, NULL); + for (i = 0; i < count; i ++) { + /* If stage contains a thread handle, ecs_set_threads was used to + * create the stages. ecs_set_threads and ecs_set_stages should not + * be mixed. */ + ecs_poly_assert(&stages[i], ecs_stage_t); + ecs_check(stages[i].thread == 0, ECS_INVALID_OPERATION, NULL); + flecs_stage_deinit(world, &stages[i]); + } - if (count < dense_count) { - /* If there are unused elements in the dense array, return first */ - uint64_t *dense_array = ecs_vector_first(dense, uint64_t); - return dense_array[count]; - } else { - return create_id(sparse, count); + ecs_vector_free(world->worker_stages); } -} + + if (stage_count) { + world->worker_stages = ecs_vector_new(ecs_stage_t, stage_count); -/* Try obtaining a value from the sparse set, don't care about whether the - * provided index matches the current generation count. */ -static -void* try_sparse_any( - const ecs_sparse_t *sparse, - uint64_t index) -{ - strip_generation(&index); + for (i = 0; i < stage_count; i ++) { + ecs_stage_t *stage = ecs_vector_add( + &world->worker_stages, ecs_stage_t); + flecs_stage_init(world, stage); + stage->id = 1 + i; /* 0 is reserved for main/temp stage */ - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - if (!chunk) { - return NULL; + /* Set thread_ctx to stage, as this stage might be used in a + * multithreaded context */ + stage->thread_ctx = (ecs_world_t*)stage; + } + } else { + /* Set to NULL to prevent double frees */ + world->worker_stages = NULL; } - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - bool in_use = dense && (dense < sparse->count); - if (!in_use) { - return NULL; + /* Regardless of whether the stage was just initialized or not, when the + * ecs_set_stages function is called, all stages inherit the auto_merge + * property from the world */ + for (i = 0; i < stage_count; i ++) { + ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); + stage->auto_merge = world->stage.auto_merge; } - - ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); - return DATA(chunk->data, sparse->size, offset); +error: + return; } -/* Try obtaining a value from the sparse set, make sure it's alive. */ -static -void* try_sparse( - const ecs_sparse_t *sparse, - uint64_t index) +int32_t ecs_get_stage_count( + const ecs_world_t *world) { - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - if (!chunk) { - return NULL; - } + world = ecs_get_world(world); + return ecs_vector_count(world->worker_stages); +} - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - bool in_use = dense && (dense < sparse->count); - if (!in_use) { - return NULL; - } +int32_t ecs_get_stage_id( + const ecs_world_t *world) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - uint64_t gen = strip_generation(&index); - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - uint64_t cur_gen = dense_array[dense] & ECS_GENERATION_MASK; + if (ecs_poly_is(world, ecs_stage_t)) { + ecs_stage_t *stage = (ecs_stage_t*)world; - if (cur_gen != gen) { - return NULL; + /* Index 0 is reserved for main stage */ + return stage->id - 1; + } else if (ecs_poly_is(world, ecs_world_t)) { + return 0; + } else { + ecs_throw(ECS_INTERNAL_ERROR, NULL); } - - ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); - return DATA(chunk->data, sparse->size, offset); +error: + return 0; } -/* Get value from sparse set when it is guaranteed that the value exists. This - * function is used when values are obtained using a dense index */ -static -void* get_sparse( - const ecs_sparse_t *sparse, - int32_t dense, - uint64_t index) +ecs_world_t* ecs_get_stage( + const ecs_world_t *world, + int32_t stage_id) { - strip_generation(&index); - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - int32_t offset = OFFSET(index); - - ecs_assert(chunk != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); - (void)dense; + ecs_poly_assert(world, ecs_world_t); + ecs_check(ecs_vector_count(world->worker_stages) > stage_id, + ECS_INVALID_PARAMETER, NULL); - return DATA(chunk->data, sparse->size, offset); + return (ecs_world_t*)ecs_vector_get( + world->worker_stages, ecs_stage_t, stage_id); +error: + return NULL; } -/* Swap dense elements. A swap occurs when an element is removed, or when a - * removed element is recycled. */ -static -void swap_dense( - ecs_sparse_t * sparse, - chunk_t * chunk_a, - int32_t a, - int32_t b) +bool ecs_staging_begin( + ecs_world_t *world) { - ecs_assert(a != b, ECS_INTERNAL_ERROR, NULL); - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - uint64_t index_a = dense_array[a]; - uint64_t index_b = dense_array[b]; + ecs_poly_assert(world, ecs_world_t); - chunk_t *chunk_b = get_or_create_chunk(sparse, CHUNK(index_b)); - assign_index(chunk_a, dense_array, index_a, b); - assign_index(chunk_b, dense_array, index_b, a); -} + flecs_process_pending_tables(world); -void _flecs_sparse_init( - ecs_sparse_t *result, - ecs_size_t size) -{ - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - result->size = size; - result->max_id_local = UINT64_MAX; - result->max_id = &result->max_id_local; + int32_t i, count = ecs_get_stage_count(world); + for (i = 0; i < count; i ++) { + ecs_world_t *stage = ecs_get_stage(world, i); + ((ecs_stage_t*)stage)->lookup_path = world->stage.lookup_path; + ecs_defer_begin(stage); + } - /* Consume first value in dense array as 0 is used in the sparse array to - * indicate that a sparse element hasn't been paired yet. */ - uint64_t *first = ecs_vector_add(&result->dense, uint64_t); - *first = 0; + bool is_readonly = world->is_readonly; - result->count = 1; + /* From this point on, the world is "locked" for mutations, and it is only + * allowed to enqueue commands from stages */ + world->is_readonly = true; + + ecs_dbg_3("staging: begin"); + + return is_readonly; } -ecs_sparse_t* _flecs_sparse_new( - ecs_size_t size) +void ecs_staging_end( + ecs_world_t *world) { - ecs_sparse_t *result = ecs_os_calloc_t(ecs_sparse_t); + ecs_poly_assert(world, ecs_world_t); + ecs_check(world->is_readonly == true, ECS_INVALID_OPERATION, NULL); - _flecs_sparse_init(result, size); + /* After this it is safe again to mutate the world directly */ + world->is_readonly = false; - return result; + ecs_dbg_3("staging: end"); + + do_auto_merge(world); +error: + return; } -void flecs_sparse_set_id_source( - ecs_sparse_t * sparse, - uint64_t * id_source) +void ecs_merge( + ecs_world_t *world) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - sparse->max_id = id_source; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(ecs_poly_is(world, ecs_world_t) || + ecs_poly_is(world, ecs_stage_t), ECS_INVALID_PARAMETER, NULL); + do_manual_merge(world); +error: + return; } -void flecs_sparse_clear( - ecs_sparse_t *sparse) +void ecs_set_automerge( + ecs_world_t *world, + bool auto_merge) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_vector_each(sparse->chunks, chunk_t, chunk, { - chunk_free(chunk); - }); + /* If a world is provided, set auto_merge globally for the world. This + * doesn't actually do anything (the main stage never merges) but it serves + * as the default for when stages are created. */ + if (ecs_poly_is(world, ecs_world_t)) { + world->stage.auto_merge = auto_merge; - ecs_vector_free(sparse->chunks); - ecs_vector_set_count(&sparse->dense, uint64_t, 1); + /* Propagate change to all stages */ + int i, stage_count = ecs_get_stage_count(world); + for (i = 0; i < stage_count; i ++) { + ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); + stage->auto_merge = auto_merge; + } - sparse->chunks = NULL; - sparse->count = 1; - sparse->max_id_local = 0; + /* If a stage is provided, override the auto_merge value for the individual + * stage. This allows an application to control per-stage which stage should + * be automatically merged and which one shouldn't */ + } else { + ecs_poly_assert(world, ecs_stage_t); + ecs_stage_t *stage = (ecs_stage_t*)world; + stage->auto_merge = auto_merge; + } } -void _flecs_sparse_fini( - ecs_sparse_t *sparse) +bool ecs_stage_is_readonly( + const ecs_world_t *stage) { - ecs_assert(sparse != NULL, ECS_INTERNAL_ERROR, NULL); - flecs_sparse_clear(sparse); - ecs_vector_free(sparse->dense); -} + const ecs_world_t *world = ecs_get_world(stage); -void flecs_sparse_free( - ecs_sparse_t *sparse) -{ - if (sparse) { - _flecs_sparse_fini(sparse); - ecs_os_free(sparse); + if (ecs_poly_is(stage, ecs_stage_t)) { + if (((ecs_stage_t*)stage)->asynchronous) { + return false; + } } -} -uint64_t flecs_sparse_new_id( - ecs_sparse_t *sparse) -{ - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - return new_index(sparse); + if (world->is_readonly) { + if (ecs_poly_is(stage, ecs_world_t)) { + return true; + } + } else { + if (ecs_poly_is(stage, ecs_stage_t)) { + return true; + } + } + + return false; } -const uint64_t* flecs_sparse_new_ids( - ecs_sparse_t *sparse, - int32_t new_count) +ecs_world_t* ecs_async_stage_new( + ecs_world_t *world) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - int32_t dense_count = ecs_vector_count(sparse->dense); - int32_t count = sparse->count; - int32_t remaining = dense_count - count; - int32_t i, to_create = new_count - remaining; - - if (to_create > 0) { - flecs_sparse_set_size(sparse, dense_count + to_create); - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + ecs_stage_t *stage = ecs_os_calloc(sizeof(ecs_stage_t)); + flecs_stage_init(world, stage); - for (i = 0; i < to_create; i ++) { - uint64_t index = create_id(sparse, count + i); - dense_array[dense_count + i] = index; - } - } + stage->id = -1; + stage->auto_merge = false; + stage->asynchronous = true; - sparse->count += new_count; + ecs_defer_begin((ecs_world_t*)stage); - return ecs_vector_get(sparse->dense, uint64_t, count); + return (ecs_world_t*)stage; } -void* _flecs_sparse_add( - ecs_sparse_t *sparse, - ecs_size_t size) +void ecs_async_stage_free( + ecs_world_t *world) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - uint64_t index = new_index(sparse); - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - ecs_assert(chunk != NULL, ECS_INTERNAL_ERROR, NULL); - return DATA(chunk->data, size, OFFSET(index)); + ecs_poly_assert(world, ecs_stage_t); + ecs_stage_t *stage = (ecs_stage_t*)world; + ecs_check(stage->asynchronous == true, ECS_INVALID_PARAMETER, NULL); + flecs_stage_deinit(stage->world, stage); + ecs_os_free(stage); +error: + return; } -uint64_t flecs_sparse_last_id( - const ecs_sparse_t *sparse) +bool ecs_stage_is_async( + ecs_world_t *stage) { - ecs_assert(sparse != NULL, ECS_INTERNAL_ERROR, NULL); - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - return dense_array[sparse->count - 1]; + if (!stage) { + return false; + } + + if (!ecs_poly_is(stage, ecs_stage_t)) { + return false; + } + + return ((ecs_stage_t*)stage)->asynchronous; } -void* _flecs_sparse_ensure( - ecs_sparse_t *sparse, - ecs_size_t size, - uint64_t index) +bool ecs_is_deferred( + const ecs_world_t *world) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - ecs_assert(ecs_vector_count(sparse->dense) > 0, ECS_INTERNAL_ERROR, NULL); - (void)size; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); + return stage->defer != 0; +error: + return false; +} - uint64_t gen = strip_generation(&index); - chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - if (dense) { - /* Check if element is alive. If element is not alive, update indices so - * that the first unused dense element points to the sparse element. */ - int32_t count = sparse->count; - if (dense == count) { - /* If dense is the next unused element in the array, simply increase - * the count to make it part of the alive set. */ - sparse->count ++; - } else if (dense > count) { - /* If dense is not alive, swap it with the first unused element. */ - swap_dense(sparse, chunk, dense, count); +struct ecs_vector_t { + int32_t count; + int32_t size; + +#ifndef FLECS_NDEBUG + int64_t elem_size; /* Used in debug mode to validate size */ +#endif +}; - /* First unused element is now last used element */ - sparse->count ++; - } else { - /* Dense is already alive, nothing to be done */ - } +/** Resize the vector buffer */ +static +ecs_vector_t* resize( + ecs_vector_t *vector, + int16_t offset, + int32_t size) +{ + ecs_vector_t *result = ecs_os_realloc(vector, offset + size); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, 0); + return result; +} - /* Ensure provided generation matches current. Only allow mismatching - * generations if the provided generation count is 0. This allows for - * using the ensure function in combination with ids that have their - * generation stripped. */ - ecs_vector_t *dense_vector = sparse->dense; - uint64_t *dense_array = ecs_vector_first(dense_vector, uint64_t); - ecs_assert(!gen || dense_array[dense] == (index | gen), ECS_INTERNAL_ERROR, NULL); - (void)dense_vector; - (void)dense_array; - } else { - /* Element is not paired yet. Must add a new element to dense array */ - grow_dense(sparse); +/* -- Public functions -- */ - ecs_vector_t *dense_vector = sparse->dense; - uint64_t *dense_array = ecs_vector_first(dense_vector, uint64_t); - int32_t dense_count = ecs_vector_count(dense_vector) - 1; - int32_t count = sparse->count ++; +ecs_vector_t* _ecs_vector_new( + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) +{ + ecs_assert(elem_size != 0, ECS_INTERNAL_ERROR, NULL); + + ecs_vector_t *result = + ecs_os_malloc(offset + elem_size * elem_count); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - /* If index is larger than max id, update max id */ - if (index >= get_id(sparse)) { - set_id(sparse, index); - } + result->count = 0; + result->size = elem_count; +#ifndef FLECS_NDEBUG + result->elem_size = elem_size; +#endif + return result; +} - if (count < dense_count) { - /* If there are unused elements in the list, move the first unused - * element to the end of the list */ - uint64_t unused = dense_array[count]; - chunk_t *unused_chunk = get_or_create_chunk(sparse, CHUNK(unused)); - assign_index(unused_chunk, dense_array, unused, dense_count); - } +ecs_vector_t* _ecs_vector_from_array( + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count, + void *array) +{ + ecs_assert(elem_size != 0, ECS_INTERNAL_ERROR, NULL); + + ecs_vector_t *result = + ecs_os_malloc(offset + elem_size * elem_count); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - assign_index(chunk, dense_array, index, count); - dense_array[count] |= gen; - } + ecs_os_memcpy(ECS_OFFSET(result, offset), array, elem_size * elem_count); - return DATA(chunk->data, sparse->size, offset); + result->count = elem_count; + result->size = elem_count; +#ifndef FLECS_NDEBUG + result->elem_size = elem_size; +#endif + return result; } -void* _flecs_sparse_set( - ecs_sparse_t * sparse, - ecs_size_t elem_size, - uint64_t index, - void* value) +void ecs_vector_free( + ecs_vector_t *vector) { - void *ptr = _flecs_sparse_ensure(sparse, elem_size, index); - ecs_os_memcpy(ptr, value, elem_size); - return ptr; + ecs_os_free(vector); } -void* _flecs_sparse_remove_get( - ecs_sparse_t *sparse, - ecs_size_t size, - uint64_t index) +void ecs_vector_clear( + ecs_vector_t *vector) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - (void)size; + if (vector) { + vector->count = 0; + } +} - chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); - uint64_t gen = strip_generation(&index); - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - - if (dense) { - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - uint64_t cur_gen = dense_array[dense] & ECS_GENERATION_MASK; - if (gen != cur_gen) { - /* Generation doesn't match which means that the provided entity is - * already not alive. */ - return NULL; - } - - /* Increase generation */ - dense_array[dense] = index | inc_gen(cur_gen); - - int32_t count = sparse->count; - - if (dense == (count - 1)) { - /* If dense is the last used element, simply decrease count */ - sparse->count --; - } else if (dense < count) { - /* If element is alive, move it to unused elements */ - swap_dense(sparse, chunk, dense, count - 1); - sparse->count --; - } else { - /* Element is not alive, nothing to be done */ - return NULL; - } - - /* Reset memory to zero on remove */ - return DATA(chunk->data, sparse->size, offset); - } else { - /* Element is not paired and thus not alive, nothing to be done */ - return NULL; - } -} - -void flecs_sparse_remove( - ecs_sparse_t *sparse, - uint64_t index) +void _ecs_vector_zero( + ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset) { - void *ptr = _flecs_sparse_remove_get(sparse, 0, index); - if (ptr) { - ecs_os_memset(ptr, 0, sparse->size); - } + void *array = ECS_OFFSET(vector, offset); + ecs_os_memset(array, 0, elem_size * vector->count); } -void flecs_sparse_set_generation( - ecs_sparse_t *sparse, - uint64_t index) +void ecs_vector_assert_size( + ecs_vector_t *vector, + ecs_size_t elem_size) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); + (void)elem_size; - uint64_t index_w_gen = index; - strip_generation(&index); - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - - if (dense) { - /* Increase generation */ - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - dense_array[dense] = index_w_gen; - } else { - /* Element is not paired and thus not alive, nothing to be done */ + if (vector) { + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); } } -bool flecs_sparse_exists( - const ecs_sparse_t *sparse, - uint64_t index) +void* _ecs_vector_addn( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - if (!chunk) { - return false; + ecs_assert(array_inout != NULL, ECS_INTERNAL_ERROR, NULL); + + if (elem_count == 1) { + return _ecs_vector_add(array_inout, elem_size, offset); } - strip_generation(&index); - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; + ecs_vector_t *vector = *array_inout; + if (!vector) { + vector = _ecs_vector_new(elem_size, offset, 1); + *array_inout = vector; + } - return dense != 0; -} + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); -void* _flecs_sparse_get_dense( - const ecs_sparse_t *sparse, - ecs_size_t size, - int32_t dense_index) -{ - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - ecs_assert(dense_index < sparse->count, ECS_INVALID_PARAMETER, NULL); - (void)size; + int32_t max_count = vector->size; + int32_t old_count = vector->count; + int32_t new_count = old_count + elem_count; - dense_index ++; + if ((new_count - 1) >= max_count) { + if (!max_count) { + max_count = elem_count; + } else { + while (max_count < new_count) { + max_count *= 2; + } + } - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - return get_sparse(sparse, dense_index, dense_array[dense_index]); + vector = resize(vector, offset, max_count * elem_size); + vector->size = max_count; + *array_inout = vector; + } + + vector->count = new_count; + + return ECS_OFFSET(vector, offset + elem_size * old_count); } -bool flecs_sparse_is_alive( - const ecs_sparse_t *sparse, - uint64_t index) +void* _ecs_vector_add( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset) { - return try_sparse(sparse, index) != NULL; + ecs_assert(array_inout != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_vector_t *vector = *array_inout; + int32_t count, size; + + if (vector) { + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + count = vector->count; + size = vector->size; + + if (count >= size) { + size *= 2; + if (!size) { + size = 2; + } + vector = resize(vector, offset, size * elem_size); + *array_inout = vector; + vector->size = size; + } + + vector->count = count + 1; + return ECS_OFFSET(vector, offset + elem_size * count); + } + + vector = _ecs_vector_new(elem_size, offset, 2); + *array_inout = vector; + vector->count = 1; + vector->size = 2; + return ECS_OFFSET(vector, offset); } -uint64_t flecs_sparse_get_alive( - const ecs_sparse_t *sparse, - uint64_t index) +void* _ecs_vector_insert_at( + ecs_vector_t **vec, + ecs_size_t elem_size, + int16_t offset, + int32_t index) { - chunk_t *chunk = get_chunk(sparse, CHUNK(index)); - if (!chunk) { - return 0; + ecs_assert(vec != NULL, ECS_INTERNAL_ERROR, NULL); + int32_t count = vec[0]->count; + if (index == count) { + return _ecs_vector_add(vec, elem_size, offset); } + ecs_assert(index < count, ECS_INTERNAL_ERROR, NULL); + ecs_assert(index >= 0, ECS_INTERNAL_ERROR, NULL); - int32_t offset = OFFSET(index); - int32_t dense = chunk->sparse[offset]; - uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + _ecs_vector_add(vec, elem_size, offset); + void *start = _ecs_vector_get(*vec, elem_size, offset, index); + if (index < count) { + ecs_os_memmove(ECS_OFFSET(start, elem_size), start, + (count - index) * elem_size); + } - /* If dense is 0 (tombstone) this will return 0 */ - return dense_array[dense]; + return start; } -void* _flecs_sparse_get( - const ecs_sparse_t *sparse, - ecs_size_t size, - uint64_t index) +int32_t _ecs_vector_move_index( + ecs_vector_t **dst, + ecs_vector_t *src, + ecs_size_t elem_size, + int16_t offset, + int32_t index) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - (void)size; - return try_sparse(sparse, index); + if (dst && *dst) { + ecs_dbg_assert((*dst)->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + } + ecs_dbg_assert(src->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + + void *dst_elem = _ecs_vector_add(dst, elem_size, offset); + void *src_elem = _ecs_vector_get(src, elem_size, offset, index); + + ecs_os_memcpy(dst_elem, src_elem, elem_size); + return _ecs_vector_remove(src, elem_size, offset, index); } -void* _flecs_sparse_get_any( - const ecs_sparse_t *sparse, - ecs_size_t size, - uint64_t index) +void ecs_vector_remove_last( + ecs_vector_t *vector) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); - (void)size; - return try_sparse_any(sparse, index); + if (vector && vector->count) vector->count --; } -int32_t flecs_sparse_count( - const ecs_sparse_t *sparse) +bool _ecs_vector_pop( + ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset, + void *value) { - if (!sparse) { - return 0; + if (!vector) { + return false; } - return sparse->count - 1; -} + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); -int32_t flecs_sparse_size( - const ecs_sparse_t *sparse) -{ - if (!sparse) { - return 0; + int32_t count = vector->count; + if (!count) { + return false; } - - return ecs_vector_count(sparse->dense) - 1; -} -const uint64_t* flecs_sparse_ids( - const ecs_sparse_t *sparse) -{ - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - return &(ecs_vector_first(sparse->dense, uint64_t)[1]); -} + void *elem = ECS_OFFSET(vector, offset + (count - 1) * elem_size); -void flecs_sparse_set_size( - ecs_sparse_t *sparse, - int32_t elem_count) -{ - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_vector_set_size(&sparse->dense, uint64_t, elem_count); + if (value) { + ecs_os_memcpy(value, elem, elem_size); + } + + ecs_vector_remove_last(vector); + + return true; } -static -void sparse_copy( - ecs_sparse_t * dst, - const ecs_sparse_t * src) +int32_t _ecs_vector_remove( + ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset, + int32_t index) { - flecs_sparse_set_size(dst, flecs_sparse_size(src)); - const uint64_t *indices = flecs_sparse_ids(src); + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - ecs_size_t size = src->size; - int32_t i, count = src->count; + int32_t count = vector->count; + void *buffer = ECS_OFFSET(vector, offset); + void *elem = ECS_OFFSET(buffer, index * elem_size); - for (i = 0; i < count - 1; i ++) { - uint64_t index = indices[i]; - void *src_ptr = _flecs_sparse_get(src, size, index); - void *dst_ptr = _flecs_sparse_ensure(dst, size, index); - flecs_sparse_set_generation(dst, index); - ecs_os_memcpy(dst_ptr, src_ptr, size); + ecs_assert(index < count, ECS_INVALID_PARAMETER, NULL); + + count --; + if (index != count) { + void *last_elem = ECS_OFFSET(buffer, elem_size * count); + ecs_os_memcpy(elem, last_elem, elem_size); } - set_id(dst, get_id(src)); + vector->count = count; - ecs_assert(src->count == dst->count, ECS_INTERNAL_ERROR, NULL); + return count; } -ecs_sparse_t* flecs_sparse_copy( - const ecs_sparse_t *src) +void _ecs_vector_reclaim( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset) { - if (!src) { - return NULL; - } + ecs_vector_t *vector = *array_inout; - ecs_sparse_t *dst = _flecs_sparse_new(src->size); - sparse_copy(dst, src); + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + + int32_t size = vector->size; + int32_t count = vector->count; - return dst; + if (count < size) { + size = count; + vector = resize(vector, offset, size * elem_size); + vector->size = size; + *array_inout = vector; + } } -void flecs_sparse_restore( - ecs_sparse_t * dst, - const ecs_sparse_t * src) +int32_t ecs_vector_count( + const ecs_vector_t *vector) { - ecs_assert(dst != NULL, ECS_INVALID_PARAMETER, NULL); - dst->count = 1; - if (src) { - sparse_copy(dst, src); + if (!vector) { + return 0; } + return vector->count; } -void flecs_sparse_memory( - ecs_sparse_t *sparse, - int32_t *allocd, - int32_t *used) +int32_t ecs_vector_size( + const ecs_vector_t *vector) { - (void)sparse; - (void)allocd; - (void)used; + if (!vector) { + return 0; + } + return vector->size; } -ecs_sparse_t* _ecs_sparse_new( - ecs_size_t elem_size) +int32_t _ecs_vector_set_size( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) { - return _flecs_sparse_new(elem_size); + ecs_vector_t *vector = *array_inout; + + if (!vector) { + *array_inout = _ecs_vector_new(elem_size, offset, elem_count); + return elem_count; + } else { + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + + int32_t result = vector->size; + + if (elem_count < vector->count) { + elem_count = vector->count; + } + + if (result < elem_count) { + elem_count = flecs_next_pow_of_2(elem_count); + vector = resize(vector, offset, elem_count * elem_size); + vector->size = elem_count; + *array_inout = vector; + result = elem_count; + } + + return result; + } } -void* _ecs_sparse_add( - ecs_sparse_t *sparse, - ecs_size_t elem_size) +int32_t _ecs_vector_grow( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) { - return _flecs_sparse_add(sparse, elem_size); + int32_t current = ecs_vector_count(*array_inout); + return _ecs_vector_set_size(array_inout, elem_size, offset, current + elem_count); } -uint64_t ecs_sparse_last_id( - const ecs_sparse_t *sparse) +int32_t _ecs_vector_set_count( + ecs_vector_t **array_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) { - return flecs_sparse_last_id(sparse); + if (!*array_inout) { + *array_inout = _ecs_vector_new(elem_size, offset, elem_count); + } + + ecs_dbg_assert((*array_inout)->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + + (*array_inout)->count = elem_count; + ecs_size_t size = _ecs_vector_set_size(array_inout, elem_size, offset, elem_count); + return size; } -int32_t ecs_sparse_count( - const ecs_sparse_t *sparse) +void* _ecs_vector_first( + const ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset) { - return flecs_sparse_count(sparse); + (void)elem_size; + + ecs_dbg_assert(!vector || vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + if (vector && vector->size) { + return ECS_OFFSET(vector, offset); + } else { + return NULL; + } } -void* _ecs_sparse_get_dense( - const ecs_sparse_t *sparse, +void* _ecs_vector_get( + const ecs_vector_t *vector, ecs_size_t elem_size, + int16_t offset, int32_t index) { - return _flecs_sparse_get_dense(sparse, elem_size, index); + ecs_assert(vector != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + ecs_assert(index >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(index < vector->count, ECS_INTERNAL_ERROR, NULL); + + return ECS_OFFSET(vector, offset + elem_size * index); } -void* _ecs_sparse_get( - const ecs_sparse_t *sparse, +void* _ecs_vector_last( + const ecs_vector_t *vector, ecs_size_t elem_size, - uint64_t id) + int16_t offset) { - return _flecs_sparse_get(sparse, elem_size, id); + if (vector) { + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + int32_t count = vector->count; + if (!count) { + return NULL; + } else { + return ECS_OFFSET(vector, offset + elem_size * (count - 1)); + } + } else { + return NULL; + } } -ecs_sparse_iter_t _flecs_sparse_iter( - ecs_sparse_t *sparse, - ecs_size_t elem_size) +int32_t _ecs_vector_set_min_size( + ecs_vector_t **vector_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) { - ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(elem_size == sparse->size, ECS_INVALID_PARAMETER, NULL); - ecs_sparse_iter_t result; - result.sparse = sparse; - result.ids = flecs_sparse_ids(sparse); - result.size = elem_size; - result.i = 0; - result.count = sparse->count - 1; - return result; + if (!*vector_inout || (*vector_inout)->size < elem_count) { + return _ecs_vector_set_size(vector_inout, elem_size, offset, elem_count); + } else { + return (*vector_inout)->size; + } } -#include -#include +int32_t _ecs_vector_set_min_count( + ecs_vector_t **vector_inout, + ecs_size_t elem_size, + int16_t offset, + int32_t elem_count) +{ + _ecs_vector_set_min_size(vector_inout, elem_size, offset, elem_count); -/** - * stm32tpl -- STM32 C++ Template Peripheral Library - * Visit https://github.com/antongus/stm32tpl for new versions - * - * Copyright (c) 2011-2020 Anton B. Gusev aka AHTOXA - */ + ecs_vector_t *v = *vector_inout; + if (v && v->count < elem_count) { + v->count = elem_count; + } -#define MAX_PRECISION (10) -#define EXP_THRESHOLD (3) -#define INT64_MAX_F ((double)INT64_MAX) + return v->count; +} -static const double rounders[MAX_PRECISION + 1] = -{ - 0.5, // 0 - 0.05, // 1 - 0.005, // 2 - 0.0005, // 3 - 0.00005, // 4 - 0.000005, // 5 - 0.0000005, // 6 - 0.00000005, // 7 - 0.000000005, // 8 - 0.0000000005, // 9 - 0.00000000005 // 10 -}; - -static -char* strbuf_itoa( - char *buf, - int64_t v) +void _ecs_vector_sort( + ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset, + ecs_comparator_t compare_action) { - char *ptr = buf; - char * p1; - char c; + if (!vector) { + return; + } - if (!v) { - *ptr++ = '0'; - } else { - char *p = ptr; - while (v) { - *p++ = (char)('0' + v % 10); - v /= 10; - } + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - p1 = p; + int32_t count = vector->count; + void *buffer = ECS_OFFSET(vector, offset); - while (p > ptr) { - c = *--p; - *p = *ptr; - *ptr++ = c; - } - ptr = p1; - } - return ptr; + if (count > 1) { + qsort(buffer, (size_t)count, (size_t)elem_size, compare_action); + } } -static -int ecs_strbuf_ftoa( - ecs_strbuf_t *out, - double f, - int precision, - char nan_delim) +void _ecs_vector_memory( + const ecs_vector_t *vector, + ecs_size_t elem_size, + int16_t offset, + int32_t *allocd, + int32_t *used) { - char buf[64]; - char * ptr = buf; - char c; - int64_t intPart; - int64_t exp = 0; + if (!vector) { + return; + } - if (isnan(f)) { - if (nan_delim) { - ecs_strbuf_appendch(out, nan_delim); - ecs_strbuf_appendstr(out, "NaN"); - return ecs_strbuf_appendch(out, nan_delim); - } else { - return ecs_strbuf_appendstr(out, "NaN"); - } + ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + + if (allocd) { + *allocd += vector->size * elem_size + offset; } - if (isinf(f)) { - if (nan_delim) { - ecs_strbuf_appendch(out, nan_delim); - ecs_strbuf_appendstr(out, "Inf"); - return ecs_strbuf_appendch(out, nan_delim); - } else { - return ecs_strbuf_appendstr(out, "Inf"); - } + if (used) { + *used += vector->count * elem_size; } +} - if (precision > MAX_PRECISION) { - precision = MAX_PRECISION; +ecs_vector_t* _ecs_vector_copy( + const ecs_vector_t *src, + ecs_size_t elem_size, + int16_t offset) +{ + if (!src) { + return NULL; } - if (f < 0) { - f = -f; - *ptr++ = '-'; - } - - if (precision < 0) { - if (f < 1.0) precision = 6; - else if (f < 10.0) precision = 5; - else if (f < 100.0) precision = 4; - else if (f < 1000.0) precision = 3; - else if (f < 10000.0) precision = 2; - else if (f < 100000.0) precision = 1; - else precision = 0; - } + ecs_vector_t *dst = _ecs_vector_new(elem_size, offset, src->size); + ecs_os_memcpy(dst, src, offset + elem_size * src->count); + return dst; +} - if (precision) { - f += rounders[precision]; - } - /* Make sure that number can be represented as 64bit int, increase exp */ - while (f > INT64_MAX_F) { - f /= 1000 * 1000 * 1000; - exp += 9; - } +/** The number of elements in a single chunk */ +#define CHUNK_COUNT (4096) - intPart = (int64_t)f; - f -= (double)intPart; +/** Compute the chunk index from an id by stripping the first 12 bits */ +#define CHUNK(index) ((int32_t)((uint32_t)index >> 12)) - ptr = strbuf_itoa(ptr, intPart); +/** This computes the offset of an index inside a chunk */ +#define OFFSET(index) ((int32_t)index & 0xFFF) - if (precision) { - *ptr++ = '.'; - while (precision--) { - f *= 10.0; - c = (char)f; - *ptr++ = (char)('0' + c); - f -= c; - } - } - *ptr = 0; +/* Utility to get a pointer to the payload */ +#define DATA(array, size, offset) (ECS_OFFSET(array, size * offset)) - /* Remove trailing 0s */ - while ((&ptr[-1] != buf) && (ptr[-1] == '0')) { - ptr[-1] = '\0'; - ptr --; - } - if (ptr != buf && ptr[-1] == '.') { - ptr[-1] = '\0'; - ptr --; - } +typedef struct chunk_t { + int32_t *sparse; /* Sparse array with indices to dense array */ + void *data; /* Store data in sparse array to reduce + * indirection and provide stable pointers. */ +} chunk_t; - /* If 0s before . exceed threshold, convert to exponent to save space - * without losing precision. */ - char *cur = ptr; - while ((&cur[-1] != buf) && (cur[-1] == '0')) { - cur --; - } +static +chunk_t* chunk_new( + ecs_sparse_t *sparse, + int32_t chunk_index) +{ + int32_t count = ecs_vector_count(sparse->chunks); + chunk_t *chunks; - if (exp || ((ptr - cur) > EXP_THRESHOLD)) { - cur[0] = '\0'; - exp += (ptr - cur); - ptr = cur; + if (count <= chunk_index) { + ecs_vector_set_count(&sparse->chunks, chunk_t, chunk_index + 1); + chunks = ecs_vector_first(sparse->chunks, chunk_t); + ecs_os_memset(&chunks[count], 0, (1 + chunk_index - count) * ECS_SIZEOF(chunk_t)); + } else { + chunks = ecs_vector_first(sparse->chunks, chunk_t); } - if (exp) { - char *p1 = &buf[1]; - if (nan_delim) { - ecs_os_memmove(buf + 1, buf, 1 + (ptr - buf)); - buf[0] = nan_delim; - p1 ++; - } - - /* Make sure that exp starts after first character */ - c = p1[0]; - p1[0] = '.'; + ecs_assert(chunks != NULL, ECS_INTERNAL_ERROR, NULL); - do { - char t = (++p1)[0]; - p1[0] = c; - c = t; - exp ++; - } while (c); + chunk_t *result = &chunks[chunk_index]; + ecs_assert(result->sparse == NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(result->data == NULL, ECS_INTERNAL_ERROR, NULL); - ptr = p1 + 1; + /* Initialize sparse array with zero's, as zero is used to indicate that the + * sparse element has not been paired with a dense element. Use zero + * as this means we can take advantage of calloc having a possibly better + * performance than malloc + memset. */ + result->sparse = ecs_os_calloc(ECS_SIZEOF(int32_t) * CHUNK_COUNT); - ptr[0] = 'e'; - ptr = strbuf_itoa(ptr + 1, exp); + /* Initialize the data array with zero's to guarantee that data is + * always initialized. When an entry is removed, data is reset back to + * zero. Initialize now, as this can take advantage of calloc. */ + result->data = ecs_os_calloc(sparse->size * CHUNK_COUNT); - if (nan_delim) { - ptr[0] = nan_delim; - ptr ++; - } + ecs_assert(result->sparse != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(result->data != NULL, ECS_INTERNAL_ERROR, NULL); - ptr[0] = '\0'; - } - - return ecs_strbuf_appendstrn(out, buf, (int32_t)(ptr - buf)); + return result; } -/* Add an extra element to the buffer */ static -void ecs_strbuf_grow( - ecs_strbuf_t *b) +void chunk_free( + chunk_t *chunk) { - /* Allocate new element */ - ecs_strbuf_element_embedded *e = ecs_os_malloc_t(ecs_strbuf_element_embedded); - b->size += b->current->pos; - b->current->next = (ecs_strbuf_element*)e; - b->current = (ecs_strbuf_element*)e; - b->elementCount ++; - e->super.buffer_embedded = true; - e->super.buf = e->buf; - e->super.pos = 0; - e->super.next = NULL; + ecs_os_free(chunk->sparse); + ecs_os_free(chunk->data); } -/* Add an extra dynamic element */ static -void ecs_strbuf_grow_str( - ecs_strbuf_t *b, - char *str, - char *alloc_str, - int32_t size) +chunk_t* get_chunk( + const ecs_sparse_t *sparse, + int32_t chunk_index) { - /* Allocate new element */ - ecs_strbuf_element_str *e = ecs_os_malloc_t(ecs_strbuf_element_str); - b->size += b->current->pos; - b->current->next = (ecs_strbuf_element*)e; - b->current = (ecs_strbuf_element*)e; - b->elementCount ++; - e->super.buffer_embedded = false; - e->super.pos = size ? size : (int32_t)ecs_os_strlen(str); - e->super.next = NULL; - e->super.buf = str; - e->alloc_str = alloc_str; + if (!sparse->chunks) { + return NULL; + } + if (chunk_index >= ecs_vector_count(sparse->chunks)) { + return NULL; + } + + /* If chunk_index is below zero, application used an invalid entity id */ + ecs_assert(chunk_index >= 0, ECS_INVALID_PARAMETER, NULL); + chunk_t *result = ecs_vector_get(sparse->chunks, chunk_t, chunk_index); + if (result && !result->sparse) { + return NULL; + } + + return result; } static -char* ecs_strbuf_ptr( - ecs_strbuf_t *b) +chunk_t* get_or_create_chunk( + ecs_sparse_t *sparse, + int32_t chunk_index) { - if (b->buf) { - return &b->buf[b->current->pos]; - } else { - return &b->current->buf[b->current->pos]; + chunk_t *chunk = get_chunk(sparse, chunk_index); + if (chunk) { + return chunk; } + + return chunk_new(sparse, chunk_index); } -/* Compute the amount of space left in the current element */ static -int32_t ecs_strbuf_memLeftInCurrentElement( - ecs_strbuf_t *b) +void grow_dense( + ecs_sparse_t *sparse) { - if (b->current->buffer_embedded) { - return ECS_STRBUF_ELEMENT_SIZE - b->current->pos; - } else { - return 0; - } + ecs_vector_add(&sparse->dense, uint64_t); } -/* Compute the amount of space left */ static -int32_t ecs_strbuf_memLeft( - ecs_strbuf_t *b) +uint64_t strip_generation( + uint64_t *index_out) { - if (b->max) { - return b->max - b->size - b->current->pos; - } else { - return INT_MAX; - } + uint64_t index = *index_out; + uint64_t gen = index & ECS_GENERATION_MASK; + /* Make sure there's no junk in the id */ + ecs_assert(gen == (index & (0xFFFFFFFFull << 32)), + ECS_INVALID_PARAMETER, NULL); + *index_out -= gen; + return gen; } static -void ecs_strbuf_init( - ecs_strbuf_t *b) +void assign_index( + chunk_t * chunk, + uint64_t * dense_array, + uint64_t index, + int32_t dense) { - /* Initialize buffer structure only once */ - if (!b->elementCount) { - b->size = 0; - b->firstElement.super.next = NULL; - b->firstElement.super.pos = 0; - b->firstElement.super.buffer_embedded = true; - b->firstElement.super.buf = b->firstElement.buf; - b->elementCount ++; - b->current = (ecs_strbuf_element*)&b->firstElement; - } + /* Initialize sparse-dense pair. This assigns the dense index to the sparse + * array, and the sparse index to the dense array .*/ + chunk->sparse[OFFSET(index)] = dense; + dense_array[dense] = index; } -/* Append a format string to a buffer */ static -bool vappend( - ecs_strbuf_t *b, - const char* str, - va_list args) +uint64_t inc_gen( + uint64_t index) { - bool result = true; - va_list arg_cpy; - - if (!str) { - return result; - } + /* When an index is deleted, its generation is increased so that we can do + * liveliness checking while recycling ids */ + return ECS_GENERATION_INC(index); +} - ecs_strbuf_init(b); +static +uint64_t inc_id( + ecs_sparse_t *sparse) +{ + /* Generate a new id. The last issued id could be stored in an external + * variable, such as is the case with the last issued entity id, which is + * stored on the world. */ + return ++ (sparse->max_id[0]); +} - int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); - int32_t memLeft = ecs_strbuf_memLeft(b); +static +uint64_t get_id( + const ecs_sparse_t *sparse) +{ + return sparse->max_id[0]; +} - if (!memLeft) { - return false; - } +static +void set_id( + ecs_sparse_t *sparse, + uint64_t value) +{ + /* Sometimes the max id needs to be assigned directly, which typically + * happens when the API calls get_or_create for an id that hasn't been + * issued before. */ + sparse->max_id[0] = value; +} - /* Compute the memory required to add the string to the buffer. If user - * provided buffer, use space left in buffer, otherwise use space left in - * current element. */ - int32_t max_copy = b->buf ? memLeft : memLeftInElement; - int32_t memRequired; +/* Pair dense id with new sparse id */ +static +uint64_t create_id( + ecs_sparse_t *sparse, + int32_t dense) +{ + uint64_t index = inc_id(sparse); + grow_dense(sparse); - va_copy(arg_cpy, args); - memRequired = vsnprintf( - ecs_strbuf_ptr(b), (size_t)(max_copy + 1), str, args); + chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); + ecs_assert(chunk->sparse[OFFSET(index)] == 0, ECS_INTERNAL_ERROR, NULL); + + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + assign_index(chunk, dense_array, index, dense); + + return index; +} - ecs_assert(memRequired != -1, ECS_INTERNAL_ERROR, NULL); +/* Create new id */ +static +uint64_t new_index( + ecs_sparse_t *sparse) +{ + ecs_vector_t *dense = sparse->dense; + int32_t dense_count = ecs_vector_count(dense); + int32_t count = sparse->count ++; - if (memRequired <= memLeftInElement) { - /* Element was large enough to fit string */ - b->current->pos += memRequired; - } else if ((memRequired - memLeftInElement) < memLeft) { - /* If string is a format string, a new buffer of size memRequired is - * needed to re-evaluate the format string and only use the part that - * wasn't already copied to the previous element */ - if (memRequired <= ECS_STRBUF_ELEMENT_SIZE) { - /* Resulting string fits in standard-size buffer. Note that the - * entire string needs to fit, not just the remainder, as the - * format string cannot be partially evaluated */ - ecs_strbuf_grow(b); + ecs_assert(count <= dense_count, ECS_INTERNAL_ERROR, NULL); - /* Copy entire string to new buffer */ - ecs_os_vsprintf(ecs_strbuf_ptr(b), str, arg_cpy); + if (count < dense_count) { + /* If there are unused elements in the dense array, return first */ + uint64_t *dense_array = ecs_vector_first(dense, uint64_t); + return dense_array[count]; + } else { + return create_id(sparse, count); + } +} - /* Ignore the part of the string that was copied into the - * previous buffer. The string copied into the new buffer could - * be memmoved so that only the remainder is left, but that is - * most likely more expensive than just keeping the entire - * string. */ +/* Try obtaining a value from the sparse set, don't care about whether the + * provided index matches the current generation count. */ +static +void* try_sparse_any( + const ecs_sparse_t *sparse, + uint64_t index) +{ + strip_generation(&index); - /* Update position in buffer */ - b->current->pos += memRequired; - } else { - /* Resulting string does not fit in standard-size buffer. - * Allocate a new buffer that can hold the entire string. */ - char *dst = ecs_os_malloc(memRequired + 1); - ecs_os_vsprintf(dst, str, arg_cpy); - ecs_strbuf_grow_str(b, dst, dst, memRequired); - } + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + if (!chunk) { + return NULL; } - va_end(arg_cpy); + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; + bool in_use = dense && (dense < sparse->count); + if (!in_use) { + return NULL; + } - return ecs_strbuf_memLeft(b) > 0; + ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); + return DATA(chunk->data, sparse->size, offset); } +/* Try obtaining a value from the sparse set, make sure it's alive. */ static -bool appendstr( - ecs_strbuf_t *b, - const char* str, - int n) +void* try_sparse( + const ecs_sparse_t *sparse, + uint64_t index) { - ecs_strbuf_init(b); - - int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); - int32_t memLeft = ecs_strbuf_memLeft(b); - if (memLeft <= 0) { - return false; + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + if (!chunk) { + return NULL; } - /* Never write more than what the buffer can store */ - if (n > memLeft) { - n = memLeft; + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; + bool in_use = dense && (dense < sparse->count); + if (!in_use) { + return NULL; } - if (n <= memLeftInElement) { - /* Element was large enough to fit string */ - ecs_os_strncpy(ecs_strbuf_ptr(b), str, n); - b->current->pos += n; - } else if ((n - memLeftInElement) < memLeft) { - ecs_os_strncpy(ecs_strbuf_ptr(b), str, memLeftInElement); - - /* Element was not large enough, but buffer still has space */ - b->current->pos += memLeftInElement; - n -= memLeftInElement; - - /* Current element was too small, copy remainder into new element */ - if (n < ECS_STRBUF_ELEMENT_SIZE) { - /* A standard-size buffer is large enough for the new string */ - ecs_strbuf_grow(b); - - /* Copy the remainder to the new buffer */ - if (n) { - /* If a max number of characters to write is set, only a - * subset of the string should be copied to the buffer */ - ecs_os_strncpy( - ecs_strbuf_ptr(b), - str + memLeftInElement, - (size_t)n); - } else { - ecs_os_strcpy(ecs_strbuf_ptr(b), str + memLeftInElement); - } + uint64_t gen = strip_generation(&index); + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + uint64_t cur_gen = dense_array[dense] & ECS_GENERATION_MASK; - /* Update to number of characters copied to new buffer */ - b->current->pos += n; - } else { - /* String doesn't fit in a single element, strdup */ - char *remainder = ecs_os_strdup(str + memLeftInElement); - ecs_strbuf_grow_str(b, remainder, remainder, n); - } - } else { - /* Buffer max has been reached */ - return false; + if (cur_gen != gen) { + return NULL; } - return ecs_strbuf_memLeft(b) > 0; + ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); + return DATA(chunk->data, sparse->size, offset); } +/* Get value from sparse set when it is guaranteed that the value exists. This + * function is used when values are obtained using a dense index */ static -bool appendch( - ecs_strbuf_t *b, - char ch) +void* get_sparse( + const ecs_sparse_t *sparse, + int32_t dense, + uint64_t index) { - ecs_strbuf_init(b); + strip_generation(&index); + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + int32_t offset = OFFSET(index); + + ecs_assert(chunk != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(dense == chunk->sparse[offset], ECS_INTERNAL_ERROR, NULL); + (void)dense; - int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); - int32_t memLeft = ecs_strbuf_memLeft(b); - if (memLeft <= 0) { - return false; - } + return DATA(chunk->data, sparse->size, offset); +} - if (memLeftInElement) { - /* Element was large enough to fit string */ - ecs_strbuf_ptr(b)[0] = ch; - b->current->pos ++; - } else { - ecs_strbuf_grow(b); - ecs_strbuf_ptr(b)[0] = ch; - b->current->pos ++; - } +/* Swap dense elements. A swap occurs when an element is removed, or when a + * removed element is recycled. */ +static +void swap_dense( + ecs_sparse_t * sparse, + chunk_t * chunk_a, + int32_t a, + int32_t b) +{ + ecs_assert(a != b, ECS_INTERNAL_ERROR, NULL); + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + uint64_t index_a = dense_array[a]; + uint64_t index_b = dense_array[b]; - return ecs_strbuf_memLeft(b) > 0; + chunk_t *chunk_b = get_or_create_chunk(sparse, CHUNK(index_b)); + assign_index(chunk_a, dense_array, index_a, b); + assign_index(chunk_b, dense_array, index_b, a); } -bool ecs_strbuf_vappend( - ecs_strbuf_t *b, - const char* fmt, - va_list args) +void _flecs_sparse_init( + ecs_sparse_t *result, + ecs_size_t size) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); - return vappend(b, fmt, args); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); + result->size = size; + result->max_id_local = UINT64_MAX; + result->max_id = &result->max_id_local; + + /* Consume first value in dense array as 0 is used in the sparse array to + * indicate that a sparse element hasn't been paired yet. */ + uint64_t *first = ecs_vector_add(&result->dense, uint64_t); + *first = 0; + + result->count = 1; } -bool ecs_strbuf_append( - ecs_strbuf_t *b, - const char* fmt, - ...) +ecs_sparse_t* _flecs_sparse_new( + ecs_size_t size) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_sparse_t *result = ecs_os_calloc_t(ecs_sparse_t); - va_list args; - va_start(args, fmt); - bool result = vappend(b, fmt, args); - va_end(args); + _flecs_sparse_init(result, size); return result; } -bool ecs_strbuf_appendstrn( - ecs_strbuf_t *b, - const char* str, - int32_t len) +void flecs_sparse_set_id_source( + ecs_sparse_t * sparse, + uint64_t * id_source) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); - return appendstr(b, str, len); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + sparse->max_id = id_source; } -bool ecs_strbuf_appendch( - ecs_strbuf_t *b, - char ch) +void flecs_sparse_clear( + ecs_sparse_t *sparse) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - return appendch(b, ch); -} + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); -bool ecs_strbuf_appendflt( - ecs_strbuf_t *b, - double flt, - char nan_delim) -{ - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - return ecs_strbuf_ftoa(b, flt, 10, nan_delim); + ecs_vector_each(sparse->chunks, chunk_t, chunk, { + chunk_free(chunk); + }); + + ecs_vector_free(sparse->chunks); + ecs_vector_set_count(&sparse->dense, uint64_t, 1); + + sparse->chunks = NULL; + sparse->count = 1; + sparse->max_id_local = 0; } -bool ecs_strbuf_appendstr_zerocpy( - ecs_strbuf_t *b, - char* str) +void _flecs_sparse_fini( + ecs_sparse_t *sparse) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_strbuf_init(b); - ecs_strbuf_grow_str(b, str, str, 0); - return true; + ecs_assert(sparse != NULL, ECS_INTERNAL_ERROR, NULL); + flecs_sparse_clear(sparse); + ecs_vector_free(sparse->dense); } -bool ecs_strbuf_appendstr_zerocpy_const( - ecs_strbuf_t *b, - const char* str) +void flecs_sparse_free( + ecs_sparse_t *sparse) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); - /* Removes const modifier, but logic prevents changing / delete string */ - ecs_strbuf_init(b); - ecs_strbuf_grow_str(b, (char*)str, NULL, 0); - return true; + if (sparse) { + _flecs_sparse_fini(sparse); + ecs_os_free(sparse); + } } -bool ecs_strbuf_appendstr( - ecs_strbuf_t *b, - const char* str) +uint64_t flecs_sparse_new_id( + ecs_sparse_t *sparse) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); - return appendstr(b, str, ecs_os_strlen(str)); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + return new_index(sparse); } -bool ecs_strbuf_mergebuff( - ecs_strbuf_t *dst_buffer, - ecs_strbuf_t *src_buffer) +const uint64_t* flecs_sparse_new_ids( + ecs_sparse_t *sparse, + int32_t new_count) { - if (src_buffer->elementCount) { - if (src_buffer->buf) { - return ecs_strbuf_appendstr(dst_buffer, src_buffer->buf); - } else { - ecs_strbuf_element *e = (ecs_strbuf_element*)&src_buffer->firstElement; + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t dense_count = ecs_vector_count(sparse->dense); + int32_t count = sparse->count; + int32_t remaining = dense_count - count; + int32_t i, to_create = new_count - remaining; - /* Copy first element as it is inlined in the src buffer */ - ecs_strbuf_appendstrn(dst_buffer, e->buf, e->pos); + if (to_create > 0) { + flecs_sparse_set_size(sparse, dense_count + to_create); + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); - while ((e = e->next)) { - dst_buffer->current->next = ecs_os_malloc(sizeof(ecs_strbuf_element)); - *dst_buffer->current->next = *e; - } + for (i = 0; i < to_create; i ++) { + uint64_t index = create_id(sparse, count + i); + dense_array[dense_count + i] = index; } - - *src_buffer = ECS_STRBUF_INIT; } - return true; + sparse->count += new_count; + + return ecs_vector_get(sparse->dense, uint64_t, count); } -char* ecs_strbuf_get( - ecs_strbuf_t *b) +void* _flecs_sparse_add( + ecs_sparse_t *sparse, + ecs_size_t size) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + uint64_t index = new_index(sparse); + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + ecs_assert(chunk != NULL, ECS_INTERNAL_ERROR, NULL); + return DATA(chunk->data, size, OFFSET(index)); +} - char* result = NULL; - if (b->elementCount) { - if (b->buf) { - b->buf[b->current->pos] = '\0'; - result = ecs_os_strdup(b->buf); - } else { - void *next = NULL; - int32_t len = b->size + b->current->pos + 1; +uint64_t flecs_sparse_last_id( + const ecs_sparse_t *sparse) +{ + ecs_assert(sparse != NULL, ECS_INTERNAL_ERROR, NULL); + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + return dense_array[sparse->count - 1]; +} - ecs_strbuf_element *e = (ecs_strbuf_element*)&b->firstElement; +void* _flecs_sparse_ensure( + ecs_sparse_t *sparse, + ecs_size_t size, + uint64_t index) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + ecs_assert(ecs_vector_count(sparse->dense) > 0, ECS_INTERNAL_ERROR, NULL); + (void)size; - result = ecs_os_malloc(len); - char* ptr = result; + uint64_t gen = strip_generation(&index); + chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; - do { - ecs_os_memcpy(ptr, e->buf, e->pos); - ptr += e->pos; - next = e->next; - if (e != &b->firstElement.super) { - if (!e->buffer_embedded) { - ecs_os_free(((ecs_strbuf_element_str*)e)->alloc_str); - } - ecs_os_free(e); - } - } while ((e = next)); + if (dense) { + /* Check if element is alive. If element is not alive, update indices so + * that the first unused dense element points to the sparse element. */ + int32_t count = sparse->count; + if (dense == count) { + /* If dense is the next unused element in the array, simply increase + * the count to make it part of the alive set. */ + sparse->count ++; + } else if (dense > count) { + /* If dense is not alive, swap it with the first unused element. */ + swap_dense(sparse, chunk, dense, count); - result[len - 1] = '\0'; - b->length = len; + /* First unused element is now last used element */ + sparse->count ++; + } else { + /* Dense is already alive, nothing to be done */ } + + /* Ensure provided generation matches current. Only allow mismatching + * generations if the provided generation count is 0. This allows for + * using the ensure function in combination with ids that have their + * generation stripped. */ + ecs_vector_t *dense_vector = sparse->dense; + uint64_t *dense_array = ecs_vector_first(dense_vector, uint64_t); + ecs_assert(!gen || dense_array[dense] == (index | gen), ECS_INTERNAL_ERROR, NULL); + (void)dense_vector; + (void)dense_array; } else { - result = NULL; - } + /* Element is not paired yet. Must add a new element to dense array */ + grow_dense(sparse); - b->elementCount = 0; + ecs_vector_t *dense_vector = sparse->dense; + uint64_t *dense_array = ecs_vector_first(dense_vector, uint64_t); + int32_t dense_count = ecs_vector_count(dense_vector) - 1; + int32_t count = sparse->count ++; - b->content = result; + /* If index is larger than max id, update max id */ + if (index >= get_id(sparse)) { + set_id(sparse, index); + } - return result; -} + if (count < dense_count) { + /* If there are unused elements in the list, move the first unused + * element to the end of the list */ + uint64_t unused = dense_array[count]; + chunk_t *unused_chunk = get_or_create_chunk(sparse, CHUNK(unused)); + assign_index(unused_chunk, dense_array, unused, dense_count); + } -char *ecs_strbuf_get_small( - ecs_strbuf_t *b) -{ - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + assign_index(chunk, dense_array, index, count); + dense_array[count] |= gen; + } - int32_t written = ecs_strbuf_written(b); - ecs_assert(written <= ECS_STRBUF_ELEMENT_SIZE, ECS_INVALID_OPERATION, NULL); - char *buf = b->firstElement.buf; - buf[written] = '\0'; - return buf; + return DATA(chunk->data, sparse->size, offset); } -void ecs_strbuf_reset( - ecs_strbuf_t *b) +void* _flecs_sparse_set( + ecs_sparse_t * sparse, + ecs_size_t elem_size, + uint64_t index, + void* value) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - - if (b->elementCount && !b->buf) { - void *next = NULL; - ecs_strbuf_element *e = (ecs_strbuf_element*)&b->firstElement; - do { - next = e->next; - if (e != (ecs_strbuf_element*)&b->firstElement) { - ecs_os_free(e); - } - } while ((e = next)); - } - - *b = ECS_STRBUF_INIT; + void *ptr = _flecs_sparse_ensure(sparse, elem_size, index); + ecs_os_memcpy(ptr, value, elem_size); + return ptr; } -void ecs_strbuf_list_push( - ecs_strbuf_t *b, - const char *list_open, - const char *separator) +void* _flecs_sparse_remove_get( + ecs_sparse_t *sparse, + ecs_size_t size, + uint64_t index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(list_open != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(separator != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + (void)size; - b->list_sp ++; - b->list_stack[b->list_sp].count = 0; - b->list_stack[b->list_sp].separator = separator; + chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); + uint64_t gen = strip_generation(&index); + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; - if (list_open) { - ecs_strbuf_appendstr(b, list_open); + if (dense) { + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + uint64_t cur_gen = dense_array[dense] & ECS_GENERATION_MASK; + if (gen != cur_gen) { + /* Generation doesn't match which means that the provided entity is + * already not alive. */ + return NULL; + } + + /* Increase generation */ + dense_array[dense] = index | inc_gen(cur_gen); + + int32_t count = sparse->count; + + if (dense == (count - 1)) { + /* If dense is the last used element, simply decrease count */ + sparse->count --; + } else if (dense < count) { + /* If element is alive, move it to unused elements */ + swap_dense(sparse, chunk, dense, count - 1); + sparse->count --; + } else { + /* Element is not alive, nothing to be done */ + return NULL; + } + + /* Reset memory to zero on remove */ + return DATA(chunk->data, sparse->size, offset); + } else { + /* Element is not paired and thus not alive, nothing to be done */ + return NULL; } } -void ecs_strbuf_list_pop( - ecs_strbuf_t *b, - const char *list_close) +void flecs_sparse_remove( + ecs_sparse_t *sparse, + uint64_t index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(list_close != NULL, ECS_INVALID_PARAMETER, NULL); - - b->list_sp --; - - if (list_close) { - ecs_strbuf_appendstr(b, list_close); + void *ptr = _flecs_sparse_remove_get(sparse, 0, index); + if (ptr) { + ecs_os_memset(ptr, 0, sparse->size); } } -void ecs_strbuf_list_next( - ecs_strbuf_t *b) +void flecs_sparse_set_generation( + ecs_sparse_t *sparse, + uint64_t index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + chunk_t *chunk = get_or_create_chunk(sparse, CHUNK(index)); + + uint64_t index_w_gen = index; + strip_generation(&index); + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; - int32_t list_sp = b->list_sp; - if (b->list_stack[list_sp].count != 0) { - ecs_strbuf_appendstr(b, b->list_stack[list_sp].separator); + if (dense) { + /* Increase generation */ + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + dense_array[dense] = index_w_gen; + } else { + /* Element is not paired and thus not alive, nothing to be done */ } - b->list_stack[list_sp].count ++; } -bool ecs_strbuf_list_append( - ecs_strbuf_t *b, - const char *fmt, - ...) +bool flecs_sparse_exists( + const ecs_sparse_t *sparse, + uint64_t index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_strbuf_list_next(b); - - va_list args; - va_start(args, fmt); - bool result = vappend(b, fmt, args); - va_end(args); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + if (!chunk) { + return false; + } + + strip_generation(&index); + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; - return result; + return dense != 0; } -bool ecs_strbuf_list_appendstr( - ecs_strbuf_t *b, - const char *str) +void* _flecs_sparse_get_dense( + const ecs_sparse_t *sparse, + ecs_size_t size, + int32_t dense_index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + ecs_assert(dense_index < sparse->count, ECS_INVALID_PARAMETER, NULL); + (void)size; - ecs_strbuf_list_next(b); - return ecs_strbuf_appendstr(b, str); + dense_index ++; + + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + return get_sparse(sparse, dense_index, dense_array[dense_index]); } -int32_t ecs_strbuf_written( - const ecs_strbuf_t *b) +bool flecs_sparse_is_alive( + const ecs_sparse_t *sparse, + uint64_t index) { - ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - return b->size + b->current->pos; + return try_sparse(sparse, index) != NULL; +} + +uint64_t flecs_sparse_get_alive( + const ecs_sparse_t *sparse, + uint64_t index) +{ + chunk_t *chunk = get_chunk(sparse, CHUNK(index)); + if (!chunk) { + return 0; + } + + int32_t offset = OFFSET(index); + int32_t dense = chunk->sparse[offset]; + uint64_t *dense_array = ecs_vector_first(sparse->dense, uint64_t); + + /* If dense is 0 (tombstone) this will return 0 */ + return dense_array[dense]; +} + +void* _flecs_sparse_get( + const ecs_sparse_t *sparse, + ecs_size_t size, + uint64_t index) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + (void)size; + return try_sparse(sparse, index); +} + +void* _flecs_sparse_get_any( + const ecs_sparse_t *sparse, + ecs_size_t size, + uint64_t index) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!size || size == sparse->size, ECS_INVALID_PARAMETER, NULL); + (void)size; + return try_sparse_any(sparse, index); +} + +int32_t flecs_sparse_count( + const ecs_sparse_t *sparse) +{ + if (!sparse) { + return 0; + } + + return sparse->count - 1; +} + +int32_t flecs_sparse_size( + const ecs_sparse_t *sparse) +{ + if (!sparse) { + return 0; + } + + return ecs_vector_count(sparse->dense) - 1; +} + +const uint64_t* flecs_sparse_ids( + const ecs_sparse_t *sparse) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + return &(ecs_vector_first(sparse->dense, uint64_t)[1]); +} + +void flecs_sparse_set_size( + ecs_sparse_t *sparse, + int32_t elem_count) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_vector_set_size(&sparse->dense, uint64_t, elem_count); +} + +static +void sparse_copy( + ecs_sparse_t * dst, + const ecs_sparse_t * src) +{ + flecs_sparse_set_size(dst, flecs_sparse_size(src)); + const uint64_t *indices = flecs_sparse_ids(src); + + ecs_size_t size = src->size; + int32_t i, count = src->count; + + for (i = 0; i < count - 1; i ++) { + uint64_t index = indices[i]; + void *src_ptr = _flecs_sparse_get(src, size, index); + void *dst_ptr = _flecs_sparse_ensure(dst, size, index); + flecs_sparse_set_generation(dst, index); + ecs_os_memcpy(dst_ptr, src_ptr, size); + } + + set_id(dst, get_id(src)); + + ecs_assert(src->count == dst->count, ECS_INTERNAL_ERROR, NULL); +} + +ecs_sparse_t* flecs_sparse_copy( + const ecs_sparse_t *src) +{ + if (!src) { + return NULL; + } + + ecs_sparse_t *dst = _flecs_sparse_new(src->size); + sparse_copy(dst, src); + + return dst; +} + +void flecs_sparse_restore( + ecs_sparse_t * dst, + const ecs_sparse_t * src) +{ + ecs_assert(dst != NULL, ECS_INVALID_PARAMETER, NULL); + dst->count = 1; + if (src) { + sparse_copy(dst, src); + } +} + +void flecs_sparse_memory( + ecs_sparse_t *sparse, + int32_t *allocd, + int32_t *used) +{ + (void)sparse; + (void)allocd; + (void)used; +} + +ecs_sparse_t* _ecs_sparse_new( + ecs_size_t elem_size) +{ + return _flecs_sparse_new(elem_size); +} + +void* _ecs_sparse_add( + ecs_sparse_t *sparse, + ecs_size_t elem_size) +{ + return _flecs_sparse_add(sparse, elem_size); +} + +uint64_t ecs_sparse_last_id( + const ecs_sparse_t *sparse) +{ + return flecs_sparse_last_id(sparse); +} + +int32_t ecs_sparse_count( + const ecs_sparse_t *sparse) +{ + return flecs_sparse_count(sparse); +} + +void* _ecs_sparse_get_dense( + const ecs_sparse_t *sparse, + ecs_size_t elem_size, + int32_t index) +{ + return _flecs_sparse_get_dense(sparse, elem_size, index); +} + +void* _ecs_sparse_get( + const ecs_sparse_t *sparse, + ecs_size_t elem_size, + uint64_t id) +{ + return _flecs_sparse_get(sparse, elem_size, id); +} + +ecs_sparse_iter_t _flecs_sparse_iter( + ecs_sparse_t *sparse, + ecs_size_t elem_size) +{ + ecs_assert(sparse != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(elem_size == sparse->size, ECS_INVALID_PARAMETER, NULL); + ecs_sparse_iter_t result; + result.sparse = sparse; + result.ids = flecs_sparse_ids(sparse); + result.size = elem_size; + result.i = 0; + result.count = sparse->count - 1; + return result; } @@ -11030,1409 +11206,1968 @@ int32_t flecs_switch_next( } -struct ecs_vector_t { - int32_t count; - int32_t size; - -#ifndef FLECS_NDEBUG - int64_t elem_size; /* Used in debug mode to validate size */ -#endif -}; - -/** Resize the vector buffer */ static -ecs_vector_t* resize( - ecs_vector_t *vector, - int16_t offset, - int32_t size) +uint64_t name_index_hash( + const void *ptr) { - ecs_vector_t *result = ecs_os_realloc(vector, offset + size); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, 0); - return result; + const ecs_hashed_string_t *str = ptr; + ecs_assert(str->hash != 0, ECS_INTERNAL_ERROR, NULL); + return str->hash; } -/* -- Public functions -- */ - -ecs_vector_t* _ecs_vector_new( - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +static +int name_index_compare( + const void *ptr1, + const void *ptr2) { - ecs_assert(elem_size != 0, ECS_INTERNAL_ERROR, NULL); - - ecs_vector_t *result = - ecs_os_malloc(offset + elem_size * elem_count); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); + const ecs_hashed_string_t *str1 = ptr1; + const ecs_hashed_string_t *str2 = ptr2; + ecs_size_t len1 = str1->length; + ecs_size_t len2 = str2->length; + if (len1 != len2) { + return (len1 > len2) - (len1 < len2); + } - result->count = 0; - result->size = elem_count; -#ifndef FLECS_NDEBUG - result->elem_size = elem_size; -#endif - return result; + return ecs_os_memcmp(str1->value, str2->value, len1); } -ecs_vector_t* _ecs_vector_from_array( - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count, - void *array) +void flecs_name_index_init( + ecs_hashmap_t *hm) { - ecs_assert(elem_size != 0, ECS_INTERNAL_ERROR, NULL); - - ecs_vector_t *result = - ecs_os_malloc(offset + elem_size * elem_count); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - - ecs_os_memcpy(ECS_OFFSET(result, offset), array, elem_size * elem_count); - - result->count = elem_count; - result->size = elem_count; -#ifndef FLECS_NDEBUG - result->elem_size = elem_size; -#endif - return result; + _flecs_hashmap_init(hm, + ECS_SIZEOF(ecs_hashed_string_t), ECS_SIZEOF(uint64_t), + name_index_hash, + name_index_compare); } -void ecs_vector_free( - ecs_vector_t *vector) +ecs_hashmap_t* flecs_name_index_new(void) { - ecs_os_free(vector); + ecs_hashmap_t *result = ecs_os_calloc_t(ecs_hashmap_t); + flecs_name_index_init(result); + return result; } -void ecs_vector_clear( - ecs_vector_t *vector) +void flecs_name_index_fini( + ecs_hashmap_t *map) { - if (vector) { - vector->count = 0; - } + flecs_hashmap_fini(map); } -void _ecs_vector_zero( - ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset) +void flecs_name_index_free( + ecs_hashmap_t *map) { - void *array = ECS_OFFSET(vector, offset); - ecs_os_memset(array, 0, elem_size * vector->count); + if (map) { + flecs_name_index_fini(map); + ecs_os_free(map); + } } -void ecs_vector_assert_size( - ecs_vector_t *vector, - ecs_size_t elem_size) +ecs_hashed_string_t flecs_get_hashed_string( + const char *name, + ecs_size_t length, + uint64_t hash) { - (void)elem_size; - - if (vector) { - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + if (!length) { + length = ecs_os_strlen(name); + } else { + ecs_assert(length == ecs_os_strlen(name), ECS_INTERNAL_ERROR, NULL); + } + + if (!hash) { + hash = flecs_hash(name, length); + } else { + ecs_assert(hash == flecs_hash(name, length), ECS_INTERNAL_ERROR, NULL); } + + return (ecs_hashed_string_t) { + .value = (char*)name, + .length = length, + .hash = hash + }; } -void* _ecs_vector_addn( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +const uint64_t* flecs_name_index_find_ptr( + const ecs_hashmap_t *map, + const char *name, + ecs_size_t length, + uint64_t hash) { - ecs_assert(array_inout != NULL, ECS_INTERNAL_ERROR, NULL); - - if (elem_count == 1) { - return _ecs_vector_add(array_inout, elem_size, offset); - } - - ecs_vector_t *vector = *array_inout; - if (!vector) { - vector = _ecs_vector_new(elem_size, offset, 1); - *array_inout = vector; + ecs_hashed_string_t hs = flecs_get_hashed_string(name, length, hash); + + ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hs.hash); + if (!b) { + return NULL; } - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + ecs_hashed_string_t *keys = ecs_vector_first(b->keys, ecs_hashed_string_t); + int32_t i, count = ecs_vector_count(b->keys); - int32_t max_count = vector->size; - int32_t old_count = vector->count; - int32_t new_count = old_count + elem_count; + for (i = 0; i < count; i ++) { + ecs_hashed_string_t *key = &keys[i]; + ecs_assert(key->hash == hs.hash, ECS_INTERNAL_ERROR, NULL); - if ((new_count - 1) >= max_count) { - if (!max_count) { - max_count = elem_count; - } else { - while (max_count < new_count) { - max_count *= 2; - } + if (hs.length != key->length) { + continue; } - vector = resize(vector, offset, max_count * elem_size); - vector->size = max_count; - *array_inout = vector; + if (!ecs_os_strcmp(name, key->value)) { + uint64_t *e = ecs_vector_get(b->values, uint64_t, i); + ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); + return e; + } } - vector->count = new_count; + return NULL; +} - return ECS_OFFSET(vector, offset + elem_size * old_count); +uint64_t flecs_name_index_find( + const ecs_hashmap_t *map, + const char *name, + ecs_size_t length, + uint64_t hash) +{ + const uint64_t *id = flecs_name_index_find_ptr(map, name, length, hash); + if (id) { + return id[0]; + } + return 0; } -void* _ecs_vector_add( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset) +void flecs_name_index_remove( + ecs_hashmap_t *map, + uint64_t e, + uint64_t hash) { - ecs_assert(array_inout != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_vector_t *vector = *array_inout; - int32_t count, size; + ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hash); + if (!b) { + return; + } - if (vector) { - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - count = vector->count; - size = vector->size; + uint64_t *ids = ecs_vector_first(b->values, uint64_t); + int32_t i, count = ecs_vector_count(b->values); - if (count >= size) { - size *= 2; - if (!size) { - size = 2; - } - vector = resize(vector, offset, size * elem_size); - *array_inout = vector; - vector->size = size; + for (i = 0; i < count; i ++) { + if (ids[i] == e) { + flecs_hm_bucket_remove(map, b, hash, i); + break; } - - vector->count = count + 1; - return ECS_OFFSET(vector, offset + elem_size * count); } - - vector = _ecs_vector_new(elem_size, offset, 2); - *array_inout = vector; - vector->count = 1; - vector->size = 2; - return ECS_OFFSET(vector, offset); } -void* _ecs_vector_insert_at( - ecs_vector_t **vec, - ecs_size_t elem_size, - int16_t offset, - int32_t index) +void flecs_name_index_update_name( + ecs_hashmap_t *map, + uint64_t e, + uint64_t hash, + const char *name) { - ecs_assert(vec != NULL, ECS_INTERNAL_ERROR, NULL); - int32_t count = vec[0]->count; - if (index == count) { - return _ecs_vector_add(vec, elem_size, offset); + ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hash); + if (!b) { + return; } - ecs_assert(index < count, ECS_INTERNAL_ERROR, NULL); - ecs_assert(index >= 0, ECS_INTERNAL_ERROR, NULL); - _ecs_vector_add(vec, elem_size, offset); - void *start = _ecs_vector_get(*vec, elem_size, offset, index); - if (index < count) { - ecs_os_memmove(ECS_OFFSET(start, elem_size), start, - (count - index) * elem_size); + uint64_t *ids = ecs_vector_first(b->values, uint64_t); + int32_t i, count = ecs_vector_count(b->values); + + for (i = 0; i < count; i ++) { + if (ids[i] == e) { + ecs_hashed_string_t *key = ecs_vector_get( + b->keys, ecs_hashed_string_t, i); + key->value = (char*)name; + ecs_assert(ecs_os_strlen(name) == key->length, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(flecs_hash(name, key->length) == key->hash, + ECS_INTERNAL_ERROR, NULL); + return; + } } - return start; + /* Record must already have been in the index */ + ecs_abort(ECS_INTERNAL_ERROR, NULL); } -int32_t _ecs_vector_move_index( - ecs_vector_t **dst, - ecs_vector_t *src, - ecs_size_t elem_size, - int16_t offset, - int32_t index) +void flecs_name_index_ensure( + ecs_hashmap_t *map, + uint64_t id, + const char *name, + ecs_size_t length, + uint64_t hash) { - if (dst && *dst) { - ecs_dbg_assert((*dst)->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + ecs_check(name != NULL, ECS_INVALID_PARAMETER, NULL); + + ecs_hashed_string_t key = flecs_get_hashed_string(name, length, hash); + + uint64_t existing = flecs_name_index_find( + map, name, key.length, key.hash); + if (existing) { + if (existing != id) { + ecs_abort(ECS_ALREADY_DEFINED, + "conflicting id registered with name '%s'", name); + } } - ecs_dbg_assert(src->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - void *dst_elem = _ecs_vector_add(dst, elem_size, offset); - void *src_elem = _ecs_vector_get(src, elem_size, offset, index); + flecs_hashmap_result_t hmr = flecs_hashmap_ensure( + map, &key, uint64_t); - ecs_os_memcpy(dst_elem, src_elem, elem_size); - return _ecs_vector_remove(src, elem_size, offset, index); + *((uint64_t*)hmr.value) = id; +error: + return; } -void ecs_vector_remove_last( - ecs_vector_t *vector) -{ - if (vector && vector->count) vector->count --; + +#ifdef ECS_TARGET_GNU +#pragma GCC diagnostic ignored "-Wimplicit-fallthrough" +#endif + +/* See explanation below. The hashing function may read beyond the memory passed + * into the hashing function, but only at word boundaries. This should be safe, + * but trips up address sanitizers and valgrind. + * This ensures clean valgrind logs in debug mode & the best perf in release */ +#if !defined(FLECS_NDEBUG) || defined(ADDRESS_SANITIZER) +#ifndef VALGRIND +#define VALGRIND +#endif +#endif + +/* +------------------------------------------------------------------------------- +lookup3.c, by Bob Jenkins, May 2006, Public Domain. + http://burtleburtle.net/bob/c/lookup3.c +------------------------------------------------------------------------------- +*/ + +#ifdef ECS_TARGET_MSVC +//FIXME +#else +#include /* attempt to define endianness */ +#endif +#ifdef ECS_TARGET_LINUX +# include /* attempt to define endianness */ +#endif + +/* + * My best guess at if you are big-endian or little-endian. This may + * need adjustment. + */ +#if (defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && \ + __BYTE_ORDER == __LITTLE_ENDIAN) || \ + (defined(i386) || defined(__i386__) || defined(__i486__) || \ + defined(__i586__) || defined(__i686__) || defined(vax) || defined(MIPSEL)) +# define HASH_LITTLE_ENDIAN 1 +#elif (defined(__BYTE_ORDER) && defined(__BIG_ENDIAN) && \ + __BYTE_ORDER == __BIG_ENDIAN) || \ + (defined(sparc) || defined(POWERPC) || defined(mc68000) || defined(sel)) +# define HASH_LITTLE_ENDIAN 0 +#else +# define HASH_LITTLE_ENDIAN 0 +#endif + +#define rot(x,k) (((x)<<(k)) | ((x)>>(32-(k)))) + +/* +------------------------------------------------------------------------------- +mix -- mix 3 32-bit values reversibly. +This is reversible, so any information in (a,b,c) before mix() is +still in (a,b,c) after mix(). +If four pairs of (a,b,c) inputs are run through mix(), or through +mix() in reverse, there are at least 32 bits of the output that +are sometimes the same for one pair and different for another pair. +This was tested for: +* pairs that differed by one bit, by two bits, in any combination + of top bits of (a,b,c), or in any combination of bottom bits of + (a,b,c). +* "differ" is defined as +, -, ^, or ~^. For + and -, I transformed + the output delta to a Gray code (a^(a>>1)) so a string of 1's (as + is commonly produced by subtraction) look like a single 1-bit + difference. +* the base values were pseudorandom, all zero but one bit set, or + all zero plus a counter that starts at zero. +Some k values for my "a-=c; a^=rot(c,k); c+=b;" arrangement that +satisfy this are + 4 6 8 16 19 4 + 9 15 3 18 27 15 + 14 9 3 7 17 3 +Well, "9 15 3 18 27 15" didn't quite get 32 bits diffing +for "differ" defined as + with a one-bit base and a two-bit delta. I +used http://burtleburtle.net/bob/hash/avalanche.html to choose +the operations, constants, and arrangements of the variables. +This does not achieve avalanche. There are input bits of (a,b,c) +that fail to affect some output bits of (a,b,c), especially of a. The +most thoroughly mixed value is c, but it doesn't really even achieve +avalanche in c. +This allows some parallelism. Read-after-writes are good at doubling +the number of bits affected, so the goal of mixing pulls in the opposite +direction as the goal of parallelism. I did what I could. Rotates +seem to cost as much as shifts on every machine I could lay my hands +on, and rotates are much kinder to the top and bottom bits, so I used +rotates. +------------------------------------------------------------------------------- +*/ +#define mix(a,b,c) \ +{ \ + a -= c; a ^= rot(c, 4); c += b; \ + b -= a; b ^= rot(a, 6); a += c; \ + c -= b; c ^= rot(b, 8); b += a; \ + a -= c; a ^= rot(c,16); c += b; \ + b -= a; b ^= rot(a,19); a += c; \ + c -= b; c ^= rot(b, 4); b += a; \ } -bool _ecs_vector_pop( - ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset, - void *value) +/* +------------------------------------------------------------------------------- +final -- final mixing of 3 32-bit values (a,b,c) into c +Pairs of (a,b,c) values differing in only a few bits will usually +produce values of c that look totally different. This was tested for +* pairs that differed by one bit, by two bits, in any combination + of top bits of (a,b,c), or in any combination of bottom bits of + (a,b,c). +* "differ" is defined as +, -, ^, or ~^. For + and -, I transformed + the output delta to a Gray code (a^(a>>1)) so a string of 1's (as + is commonly produced by subtraction) look like a single 1-bit + difference. +* the base values were pseudorandom, all zero but one bit set, or + all zero plus a counter that starts at zero. +These constants passed: + 14 11 25 16 4 14 24 + 12 14 25 16 4 14 24 +and these came close: + 4 8 15 26 3 22 24 + 10 8 15 26 3 22 24 + 11 8 15 26 3 22 24 +------------------------------------------------------------------------------- +*/ +#define final(a,b,c) \ +{ \ + c ^= b; c -= rot(b,14); \ + a ^= c; a -= rot(c,11); \ + b ^= a; b -= rot(a,25); \ + c ^= b; c -= rot(b,16); \ + a ^= c; a -= rot(c,4); \ + b ^= a; b -= rot(a,14); \ + c ^= b; c -= rot(b,24); \ +} + + +/* + * hashlittle2: return 2 32-bit hash values + * + * This is identical to hashlittle(), except it returns two 32-bit hash + * values instead of just one. This is good enough for hash table + * lookup with 2^^64 buckets, or if you want a second hash if you're not + * happy with the first, or if you want a probably-unique 64-bit ID for + * the key. *pc is better mixed than *pb, so use *pc first. If you want + * a 64-bit value do something like "*pc + (((uint64_t)*pb)<<32)". + */ +static +void hashlittle2( + const void *key, /* the key to hash */ + size_t length, /* length of the key */ + uint32_t *pc, /* IN: primary initval, OUT: primary hash */ + uint32_t *pb) /* IN: secondary initval, OUT: secondary hash */ { - if (!vector) { - return false; + uint32_t a,b,c; /* internal state */ + union { const void *ptr; size_t i; } u; /* needed for Mac Powerbook G4 */ + + /* Set up the internal state */ + a = b = c = 0xdeadbeef + ((uint32_t)length) + *pc; + c += *pb; + + u.ptr = key; + if (HASH_LITTLE_ENDIAN && ((u.i & 0x3) == 0)) { + const uint32_t *k = (const uint32_t *)key; /* read 32-bit chunks */ + const uint8_t *k8; + (void)k8; + + /*------ all but last block: aligned reads and affect 32 bits of (a,b,c) */ + while (length > 12) + { + a += k[0]; + b += k[1]; + c += k[2]; + mix(a,b,c); + length -= 12; + k += 3; } - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + /*----------------------------- handle the last (probably partial) block */ + /* + * "k[2]&0xffffff" actually reads beyond the end of the string, but + * then masks off the part it's not allowed to read. Because the + * string is aligned, the masked-off tail is in the same word as the + * rest of the string. Every machine with memory protection I've seen + * does it on word boundaries, so is OK with this. But VALGRIND will + * still catch it and complain. The masking trick does make the hash + * noticably faster for short strings (like English words). + */ +#ifndef VALGRIND - int32_t count = vector->count; - if (!count) { - return false; + switch(length) + { + case 12: c+=k[2]; b+=k[1]; a+=k[0]; break; + case 11: c+=k[2]&0xffffff; b+=k[1]; a+=k[0]; break; + case 10: c+=k[2]&0xffff; b+=k[1]; a+=k[0]; break; + case 9 : c+=k[2]&0xff; b+=k[1]; a+=k[0]; break; + case 8 : b+=k[1]; a+=k[0]; break; + case 7 : b+=k[1]&0xffffff; a+=k[0]; break; + case 6 : b+=k[1]&0xffff; a+=k[0]; break; + case 5 : b+=k[1]&0xff; a+=k[0]; break; + case 4 : a+=k[0]; break; + case 3 : a+=k[0]&0xffffff; break; + case 2 : a+=k[0]&0xffff; break; + case 1 : a+=k[0]&0xff; break; + case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ } - void *elem = ECS_OFFSET(vector, offset + (count - 1) * elem_size); +#else /* make valgrind happy */ - if (value) { - ecs_os_memcpy(value, elem, elem_size); + k8 = (const uint8_t *)k; + switch(length) + { + case 12: c+=k[2]; b+=k[1]; a+=k[0]; break; + case 11: c+=((uint32_t)k8[10])<<16; /* fall through */ + case 10: c+=((uint32_t)k8[9])<<8; /* fall through */ + case 9 : c+=k8[8]; /* fall through */ + case 8 : b+=k[1]; a+=k[0]; break; + case 7 : b+=((uint32_t)k8[6])<<16; /* fall through */ + case 6 : b+=((uint32_t)k8[5])<<8; /* fall through */ + case 5 : b+=k8[4]; /* fall through */ + case 4 : a+=k[0]; break; + case 3 : a+=((uint32_t)k8[2])<<16; /* fall through */ + case 2 : a+=((uint32_t)k8[1])<<8; /* fall through */ + case 1 : a+=k8[0]; break; + case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ } - ecs_vector_remove_last(vector); +#endif /* !valgrind */ - return true; -} + } else if (HASH_LITTLE_ENDIAN && ((u.i & 0x1) == 0)) { + const uint16_t *k = (const uint16_t *)key; /* read 16-bit chunks */ + const uint8_t *k8; -int32_t _ecs_vector_remove( - ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset, - int32_t index) -{ - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - - int32_t count = vector->count; - void *buffer = ECS_OFFSET(vector, offset); - void *elem = ECS_OFFSET(buffer, index * elem_size); + /*--------------- all but last block: aligned reads and different mixing */ + while (length > 12) + { + a += k[0] + (((uint32_t)k[1])<<16); + b += k[2] + (((uint32_t)k[3])<<16); + c += k[4] + (((uint32_t)k[5])<<16); + mix(a,b,c); + length -= 12; + k += 6; + } - ecs_assert(index < count, ECS_INVALID_PARAMETER, NULL); + /*----------------------------- handle the last (probably partial) block */ + k8 = (const uint8_t *)k; + switch(length) + { + case 12: c+=k[4]+(((uint32_t)k[5])<<16); + b+=k[2]+(((uint32_t)k[3])<<16); + a+=k[0]+(((uint32_t)k[1])<<16); + break; + case 11: c+=((uint32_t)k8[10])<<16; /* fall through */ + case 10: c+=k[4]; + b+=k[2]+(((uint32_t)k[3])<<16); + a+=k[0]+(((uint32_t)k[1])<<16); + break; + case 9 : c+=k8[8]; /* fall through */ + case 8 : b+=k[2]+(((uint32_t)k[3])<<16); + a+=k[0]+(((uint32_t)k[1])<<16); + break; + case 7 : b+=((uint32_t)k8[6])<<16; /* fall through */ + case 6 : b+=k[2]; + a+=k[0]+(((uint32_t)k[1])<<16); + break; + case 5 : b+=k8[4]; /* fall through */ + case 4 : a+=k[0]+(((uint32_t)k[1])<<16); + break; + case 3 : a+=((uint32_t)k8[2])<<16; /* fall through */ + case 2 : a+=k[0]; + break; + case 1 : a+=k8[0]; + break; + case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ + } - count --; - if (index != count) { - void *last_elem = ECS_OFFSET(buffer, elem_size * count); - ecs_os_memcpy(elem, last_elem, elem_size); + } else { /* need to read the key one byte at a time */ + const uint8_t *k = (const uint8_t *)key; + + /*--------------- all but the last block: affect some 32 bits of (a,b,c) */ + while (length > 12) + { + a += k[0]; + a += ((uint32_t)k[1])<<8; + a += ((uint32_t)k[2])<<16; + a += ((uint32_t)k[3])<<24; + b += k[4]; + b += ((uint32_t)k[5])<<8; + b += ((uint32_t)k[6])<<16; + b += ((uint32_t)k[7])<<24; + c += k[8]; + c += ((uint32_t)k[9])<<8; + c += ((uint32_t)k[10])<<16; + c += ((uint32_t)k[11])<<24; + mix(a,b,c); + length -= 12; + k += 12; } - vector->count = count; + /*-------------------------------- last block: affect all 32 bits of (c) */ + switch(length) /* all the case statements fall through */ + { + case 12: c+=((uint32_t)k[11])<<24; + case 11: c+=((uint32_t)k[10])<<16; + case 10: c+=((uint32_t)k[9])<<8; + case 9 : c+=k[8]; + case 8 : b+=((uint32_t)k[7])<<24; + case 7 : b+=((uint32_t)k[6])<<16; + case 6 : b+=((uint32_t)k[5])<<8; + case 5 : b+=k[4]; + case 4 : a+=((uint32_t)k[3])<<24; + case 3 : a+=((uint32_t)k[2])<<16; + case 2 : a+=((uint32_t)k[1])<<8; + case 1 : a+=k[0]; + break; + case 0 : *pc=c; *pb=b; return; /* zero length strings require no mixing */ + } + } - return count; + final(a,b,c); + *pc=c; *pb=b; } -void _ecs_vector_reclaim( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset) +uint64_t flecs_hash( + const void *data, + ecs_size_t length) { - ecs_vector_t *vector = *array_inout; + uint32_t h_1 = 0; + uint32_t h_2 = 0; - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - - int32_t size = vector->size; - int32_t count = vector->count; + hashlittle2( + data, + flecs_ito(size_t, length), + &h_1, + &h_2); - if (count < size) { - size = count; - vector = resize(vector, offset, size * elem_size); - vector->size = size; - *array_inout = vector; - } + return h_1 | ((uint64_t)h_2 << 32); } -int32_t ecs_vector_count( - const ecs_vector_t *vector) -{ - if (!vector) { - return 0; - } - return vector->count; -} -int32_t ecs_vector_size( - const ecs_vector_t *vector) +void ecs_qsort( + void *base, + ecs_size_t nitems, + ecs_size_t size, + int (*compar)(const void *, const void*)) { - if (!vector) { - return 0; - } - return vector->size; -} + void *tmp = ecs_os_alloca(size); /* For swap */ -int32_t _ecs_vector_set_size( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) -{ - ecs_vector_t *vector = *array_inout; + #define LESS(i, j) \ + compar(ECS_ELEM(base, size, i), ECS_ELEM(base, size, j)) < 0 - if (!vector) { - *array_inout = _ecs_vector_new(elem_size, offset, elem_count); - return elem_count; - } else { - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + #define SWAP(i, j) \ + ecs_os_memcpy(tmp, ECS_ELEM(base, size, i), size),\ + ecs_os_memcpy(ECS_ELEM(base, size, i), ECS_ELEM(base, size, j), size),\ + ecs_os_memcpy(ECS_ELEM(base, size, j), tmp, size) - int32_t result = vector->size; + QSORT(nitems, LESS, SWAP); +} - if (elem_count < vector->count) { - elem_count = vector->count; - } - if (result < elem_count) { - elem_count = flecs_next_pow_of_2(elem_count); - vector = resize(vector, offset, elem_count * elem_size); - vector->size = elem_count; - *array_inout = vector; - result = elem_count; - } - return result; +static +void ensure( + ecs_bitset_t *bs, + ecs_size_t size) +{ + if (!bs->size) { + int32_t new_size = ((size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); + bs->size = ((size - 1) / 64 + 1) * 64; + bs->data = ecs_os_calloc(new_size); + } else if (size > bs->size) { + int32_t prev_size = ((bs->size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); + bs->size = ((size - 1) / 64 + 1) * 64; + int32_t new_size = ((size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); + bs->data = ecs_os_realloc(bs->data, new_size); + ecs_os_memset(ECS_OFFSET(bs->data, prev_size), 0, new_size - prev_size); } } -int32_t _ecs_vector_grow( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +void flecs_bitset_init( + ecs_bitset_t* bs) { - int32_t current = ecs_vector_count(*array_inout); - return _ecs_vector_set_size(array_inout, elem_size, offset, current + elem_count); + bs->size = 0; + bs->count = 0; + bs->data = NULL; } -int32_t _ecs_vector_set_count( - ecs_vector_t **array_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +void flecs_bitset_ensure( + ecs_bitset_t *bs, + int32_t count) { - if (!*array_inout) { - *array_inout = _ecs_vector_new(elem_size, offset, elem_count); + if (count > bs->count) { + bs->count = count; + ensure(bs, count); } - - ecs_dbg_assert((*array_inout)->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - - (*array_inout)->count = elem_count; - ecs_size_t size = _ecs_vector_set_size(array_inout, elem_size, offset, elem_count); - return size; } -void* _ecs_vector_first( - const ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset) +void flecs_bitset_fini( + ecs_bitset_t *bs) { - (void)elem_size; - - ecs_dbg_assert(!vector || vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - if (vector && vector->size) { - return ECS_OFFSET(vector, offset); - } else { - return NULL; - } + ecs_os_free(bs->data); + bs->data = NULL; + bs->count = 0; } -void* _ecs_vector_get( - const ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset, - int32_t index) +void flecs_bitset_addn( + ecs_bitset_t *bs, + int32_t count) { - ecs_assert(vector != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - ecs_assert(index >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(index < vector->count, ECS_INTERNAL_ERROR, NULL); - - return ECS_OFFSET(vector, offset + elem_size * index); + int32_t elem = bs->count += count; + ensure(bs, elem); } -void* _ecs_vector_last( - const ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset) +void flecs_bitset_set( + ecs_bitset_t *bs, + int32_t elem, + bool value) { - if (vector) { - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); - int32_t count = vector->count; - if (!count) { - return NULL; - } else { - return ECS_OFFSET(vector, offset + elem_size * (count - 1)); - } - } else { - return NULL; - } + ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); + int32_t hi = elem >> 6; + int32_t lo = elem & 0x3F; + uint64_t v = bs->data[hi]; + bs->data[hi] = (v & ~((uint64_t)1 << lo)) | ((uint64_t)value << lo); +error: + return; } -int32_t _ecs_vector_set_min_size( - ecs_vector_t **vector_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +bool flecs_bitset_get( + const ecs_bitset_t *bs, + int32_t elem) { - if (!*vector_inout || (*vector_inout)->size < elem_count) { - return _ecs_vector_set_size(vector_inout, elem_size, offset, elem_count); - } else { - return (*vector_inout)->size; - } + ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); + return !!(bs->data[elem >> 6] & ((uint64_t)1 << ((uint64_t)elem & 0x3F))); +error: + return false; } -int32_t _ecs_vector_set_min_count( - ecs_vector_t **vector_inout, - ecs_size_t elem_size, - int16_t offset, - int32_t elem_count) +int32_t flecs_bitset_count( + const ecs_bitset_t *bs) { - _ecs_vector_set_min_size(vector_inout, elem_size, offset, elem_count); + return bs->count; +} - ecs_vector_t *v = *vector_inout; - if (v && v->count < elem_count) { - v->count = elem_count; - } +void flecs_bitset_remove( + ecs_bitset_t *bs, + int32_t elem) +{ + ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); + int32_t last = bs->count - 1; + bool last_value = flecs_bitset_get(bs, last); + flecs_bitset_set(bs, elem, last_value); + bs->count --; +error: + return; +} - return v->count; +void flecs_bitset_swap( + ecs_bitset_t *bs, + int32_t elem_a, + int32_t elem_b) +{ + ecs_check(elem_a < bs->count, ECS_INVALID_PARAMETER, NULL); + ecs_check(elem_b < bs->count, ECS_INVALID_PARAMETER, NULL); + + bool a = flecs_bitset_get(bs, elem_a); + bool b = flecs_bitset_get(bs, elem_b); + flecs_bitset_set(bs, elem_a, b); + flecs_bitset_set(bs, elem_b, a); +error: + return; } -void _ecs_vector_sort( - ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset, - ecs_comparator_t compare_action) +#include +#include + +/** + * stm32tpl -- STM32 C++ Template Peripheral Library + * Visit https://github.com/antongus/stm32tpl for new versions + * + * Copyright (c) 2011-2020 Anton B. Gusev aka AHTOXA + */ + +#define MAX_PRECISION (10) +#define EXP_THRESHOLD (3) +#define INT64_MAX_F ((double)INT64_MAX) + +static const double rounders[MAX_PRECISION + 1] = { - if (!vector) { - return; - } + 0.5, // 0 + 0.05, // 1 + 0.005, // 2 + 0.0005, // 3 + 0.00005, // 4 + 0.000005, // 5 + 0.0000005, // 6 + 0.00000005, // 7 + 0.000000005, // 8 + 0.0000000005, // 9 + 0.00000000005 // 10 +}; - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); +static +char* strbuf_itoa( + char *buf, + int64_t v) +{ + char *ptr = buf; + char * p1; + char c; - int32_t count = vector->count; - void *buffer = ECS_OFFSET(vector, offset); + if (!v) { + *ptr++ = '0'; + } else { + char *p = ptr; + while (v) { + *p++ = (char)('0' + v % 10); + v /= 10; + } - if (count > 1) { - qsort(buffer, (size_t)count, (size_t)elem_size, compare_action); - } + p1 = p; + + while (p > ptr) { + c = *--p; + *p = *ptr; + *ptr++ = c; + } + ptr = p1; + } + return ptr; } -void _ecs_vector_memory( - const ecs_vector_t *vector, - ecs_size_t elem_size, - int16_t offset, - int32_t *allocd, - int32_t *used) +static +int ecs_strbuf_ftoa( + ecs_strbuf_t *out, + double f, + int precision, + char nan_delim) { - if (!vector) { - return; + char buf[64]; + char * ptr = buf; + char c; + int64_t intPart; + int64_t exp = 0; + + if (isnan(f)) { + if (nan_delim) { + ecs_strbuf_appendch(out, nan_delim); + ecs_strbuf_appendstr(out, "NaN"); + return ecs_strbuf_appendch(out, nan_delim); + } else { + return ecs_strbuf_appendstr(out, "NaN"); + } + } + if (isinf(f)) { + if (nan_delim) { + ecs_strbuf_appendch(out, nan_delim); + ecs_strbuf_appendstr(out, "Inf"); + return ecs_strbuf_appendch(out, nan_delim); + } else { + return ecs_strbuf_appendstr(out, "Inf"); + } } - ecs_dbg_assert(vector->elem_size == elem_size, ECS_INTERNAL_ERROR, NULL); + if (precision > MAX_PRECISION) { + precision = MAX_PRECISION; + } - if (allocd) { - *allocd += vector->size * elem_size + offset; + if (f < 0) { + f = -f; + *ptr++ = '-'; + } + + if (precision < 0) { + if (f < 1.0) precision = 6; + else if (f < 10.0) precision = 5; + else if (f < 100.0) precision = 4; + else if (f < 1000.0) precision = 3; + else if (f < 10000.0) precision = 2; + else if (f < 100000.0) precision = 1; + else precision = 0; + } + + if (precision) { + f += rounders[precision]; } - if (used) { - *used += vector->count * elem_size; + + /* Make sure that number can be represented as 64bit int, increase exp */ + while (f > INT64_MAX_F) { + f /= 1000 * 1000 * 1000; + exp += 9; } -} -ecs_vector_t* _ecs_vector_copy( - const ecs_vector_t *src, - ecs_size_t elem_size, - int16_t offset) -{ - if (!src) { - return NULL; + intPart = (int64_t)f; + f -= (double)intPart; + + ptr = strbuf_itoa(ptr, intPart); + + if (precision) { + *ptr++ = '.'; + while (precision--) { + f *= 10.0; + c = (char)f; + *ptr++ = (char)('0' + c); + f -= c; + } + } + *ptr = 0; + + /* Remove trailing 0s */ + while ((&ptr[-1] != buf) && (ptr[-1] == '0')) { + ptr[-1] = '\0'; + ptr --; + } + if (ptr != buf && ptr[-1] == '.') { + ptr[-1] = '\0'; + ptr --; } - ecs_vector_t *dst = _ecs_vector_new(elem_size, offset, src->size); - ecs_os_memcpy(dst, src, offset + elem_size * src->count); - return dst; -} + /* If 0s before . exceed threshold, convert to exponent to save space + * without losing precision. */ + char *cur = ptr; + while ((&cur[-1] != buf) && (cur[-1] == '0')) { + cur --; + } -#include + if (exp || ((ptr - cur) > EXP_THRESHOLD)) { + cur[0] = '\0'; + exp += (ptr - cur); + ptr = cur; + } -/* The ratio used to determine whether the map should rehash. If - * (element_count * LOAD_FACTOR) > bucket_count, bucket count is increased. */ -#define LOAD_FACTOR (1.5f) -#define KEY_SIZE (ECS_SIZEOF(ecs_map_key_t)) -#define GET_ELEM(array, elem_size, index) \ - ECS_OFFSET(array, (elem_size) * (index)) + if (exp) { + char *p1 = &buf[1]; + if (nan_delim) { + ecs_os_memmove(buf + 1, buf, 1 + (ptr - buf)); + buf[0] = nan_delim; + p1 ++; + } -static -uint8_t ecs_log2(uint32_t v) { - static const uint8_t log2table[32] = - {0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, - 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31}; + /* Make sure that exp starts after first character */ + c = p1[0]; + p1[0] = '.'; - v |= v >> 1; - v |= v >> 2; - v |= v >> 4; - v |= v >> 8; - v |= v >> 16; - return log2table[(uint32_t)(v * 0x07C4ACDDU) >> 27]; -} + do { + char t = (++p1)[0]; + p1[0] = c; + c = t; + exp ++; + } while (c); -/* Get bucket count for number of elements */ -static -int32_t get_bucket_count( - int32_t element_count) -{ - return flecs_next_pow_of_2((int32_t)((float)element_count * LOAD_FACTOR)); -} + ptr = p1 + 1; -/* Get bucket shift amount for a given bucket count */ -static -uint8_t get_bucket_shift ( - int32_t bucket_count) -{ - return (uint8_t)(64u - ecs_log2((uint32_t)bucket_count)); + ptr[0] = 'e'; + ptr = strbuf_itoa(ptr + 1, exp); + + if (nan_delim) { + ptr[0] = nan_delim; + ptr ++; + } + + ptr[0] = '\0'; + } + + return ecs_strbuf_appendstrn(out, buf, (int32_t)(ptr - buf)); } -/* Get bucket index for provided map key */ +/* Add an extra element to the buffer */ static -int32_t get_bucket_index( - const ecs_map_t *map, - uint16_t bucket_shift, - ecs_map_key_t key) +void ecs_strbuf_grow( + ecs_strbuf_t *b) { - ecs_assert(bucket_shift != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(map->bucket_shift == bucket_shift, ECS_INTERNAL_ERROR, NULL); - (void)map; - return (int32_t)((11400714819323198485ull * key) >> bucket_shift); + /* Allocate new element */ + ecs_strbuf_element_embedded *e = ecs_os_malloc_t(ecs_strbuf_element_embedded); + b->size += b->current->pos; + b->current->next = (ecs_strbuf_element*)e; + b->current = (ecs_strbuf_element*)e; + b->elementCount ++; + e->super.buffer_embedded = true; + e->super.buf = e->buf; + e->super.pos = 0; + e->super.next = NULL; } -/* Get bucket for key */ +/* Add an extra dynamic element */ static -ecs_bucket_t* get_bucket( - const ecs_map_t *map, - ecs_map_key_t key) +void ecs_strbuf_grow_str( + ecs_strbuf_t *b, + char *str, + char *alloc_str, + int32_t size) { - ecs_assert(map->bucket_shift == get_bucket_shift(map->bucket_count), - ECS_INTERNAL_ERROR, NULL); - int32_t bucket_id = get_bucket_index(map, map->bucket_shift, key); - ecs_assert(bucket_id < map->bucket_count, ECS_INTERNAL_ERROR, NULL); - return &map->buckets[bucket_id]; + /* Allocate new element */ + ecs_strbuf_element_str *e = ecs_os_malloc_t(ecs_strbuf_element_str); + b->size += b->current->pos; + b->current->next = (ecs_strbuf_element*)e; + b->current = (ecs_strbuf_element*)e; + b->elementCount ++; + e->super.buffer_embedded = false; + e->super.pos = size ? size : (int32_t)ecs_os_strlen(str); + e->super.next = NULL; + e->super.buf = str; + e->alloc_str = alloc_str; } -/* Ensure that map has at least new_count buckets */ static -void ensure_buckets( - ecs_map_t *map, - int32_t new_count) +char* ecs_strbuf_ptr( + ecs_strbuf_t *b) { - int32_t bucket_count = map->bucket_count; - new_count = flecs_next_pow_of_2(new_count); - if (new_count < 2) { - new_count = 2; - } - - if (new_count && new_count > bucket_count) { - map->buckets = ecs_os_realloc(map->buckets, new_count * ECS_SIZEOF(ecs_bucket_t)); - map->bucket_count = new_count; - map->bucket_shift = get_bucket_shift(new_count); - ecs_os_memset( - ECS_OFFSET(map->buckets, bucket_count * ECS_SIZEOF(ecs_bucket_t)), - 0, (new_count - bucket_count) * ECS_SIZEOF(ecs_bucket_t)); + if (b->buf) { + return &b->buf[b->current->pos]; + } else { + return &b->current->buf[b->current->pos]; } } -/* Free contents of bucket */ +/* Compute the amount of space left in the current element */ static -void clear_bucket( - ecs_bucket_t *bucket) +int32_t ecs_strbuf_memLeftInCurrentElement( + ecs_strbuf_t *b) { - ecs_os_free(bucket->keys); - ecs_os_free(bucket->payload); - bucket->keys = NULL; - bucket->payload = NULL; - bucket->count = 0; + if (b->current->buffer_embedded) { + return ECS_STRBUF_ELEMENT_SIZE - b->current->pos; + } else { + return 0; + } } -/* Clear all buckets */ +/* Compute the amount of space left */ static -void clear_buckets( - ecs_map_t *map) +int32_t ecs_strbuf_memLeft( + ecs_strbuf_t *b) { - ecs_bucket_t *buckets = map->buckets; - int32_t i, count = map->bucket_count; - for (i = 0; i < count; i ++) { - clear_bucket(&buckets[i]); + if (b->max) { + return b->max - b->size - b->current->pos; + } else { + return INT_MAX; } - ecs_os_free(buckets); - map->buckets = NULL; - map->bucket_count = 0; } -/* Find or create bucket for specified key */ static -ecs_bucket_t* ensure_bucket( - ecs_map_t *map, - ecs_map_key_t key) +void ecs_strbuf_init( + ecs_strbuf_t *b) { - ecs_assert(map->bucket_count >= 2, ECS_INTERNAL_ERROR, NULL); - int32_t bucket_id = get_bucket_index(map, map->bucket_shift, key); - ecs_assert(bucket_id >= 0, ECS_INTERNAL_ERROR, NULL); - return &map->buckets[bucket_id]; + /* Initialize buffer structure only once */ + if (!b->elementCount) { + b->size = 0; + b->firstElement.super.next = NULL; + b->firstElement.super.pos = 0; + b->firstElement.super.buffer_embedded = true; + b->firstElement.super.buf = b->firstElement.buf; + b->elementCount ++; + b->current = (ecs_strbuf_element*)&b->firstElement; + } } -/* Add element to bucket */ +/* Append a format string to a buffer */ static -int32_t add_to_bucket( - ecs_bucket_t *bucket, - ecs_size_t elem_size, - ecs_map_key_t key, - const void *payload) +bool vappend( + ecs_strbuf_t *b, + const char* str, + va_list args) { - int32_t index = bucket->count ++; - int32_t bucket_count = index + 1; - - bucket->keys = ecs_os_realloc(bucket->keys, KEY_SIZE * bucket_count); - bucket->keys[index] = key; + bool result = true; + va_list arg_cpy; - if (elem_size) { - bucket->payload = ecs_os_realloc(bucket->payload, elem_size * bucket_count); - if (payload) { - void *elem = GET_ELEM(bucket->payload, elem_size, index); - ecs_os_memcpy(elem, payload, elem_size); - } - } else { - bucket->payload = NULL; + if (!str) { + return result; } - return index; -} + ecs_strbuf_init(b); -/* Remove element from bucket */ -static -void remove_from_bucket( - ecs_bucket_t *bucket, - ecs_size_t elem_size, - ecs_map_key_t key, - int32_t index) -{ - (void)key; + int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); + int32_t memLeft = ecs_strbuf_memLeft(b); - ecs_assert(bucket->count != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(index < bucket->count, ECS_INTERNAL_ERROR, NULL); - - int32_t bucket_count = -- bucket->count; + if (!memLeft) { + return false; + } - if (index != bucket->count) { - ecs_assert(key == bucket->keys[index], ECS_INTERNAL_ERROR, NULL); - bucket->keys[index] = bucket->keys[bucket_count]; + /* Compute the memory required to add the string to the buffer. If user + * provided buffer, use space left in buffer, otherwise use space left in + * current element. */ + int32_t max_copy = b->buf ? memLeft : memLeftInElement; + int32_t memRequired; - ecs_map_key_t *elem = GET_ELEM(bucket->payload, elem_size, index); - ecs_map_key_t *last_elem = GET_ELEM(bucket->payload, elem_size, bucket->count); + va_copy(arg_cpy, args); + memRequired = vsnprintf( + ecs_strbuf_ptr(b), (size_t)(max_copy + 1), str, args); - ecs_os_memcpy(elem, last_elem, elem_size); - } -} + ecs_assert(memRequired != -1, ECS_INTERNAL_ERROR, NULL); -/* Get payload pointer for key from bucket */ -static -void* get_from_bucket( - ecs_bucket_t *bucket, - ecs_map_key_t key, - ecs_size_t elem_size) -{ - ecs_map_key_t *keys = bucket->keys; - int32_t i, count = bucket->count; + if (memRequired <= memLeftInElement) { + /* Element was large enough to fit string */ + b->current->pos += memRequired; + } else if ((memRequired - memLeftInElement) < memLeft) { + /* If string is a format string, a new buffer of size memRequired is + * needed to re-evaluate the format string and only use the part that + * wasn't already copied to the previous element */ + if (memRequired <= ECS_STRBUF_ELEMENT_SIZE) { + /* Resulting string fits in standard-size buffer. Note that the + * entire string needs to fit, not just the remainder, as the + * format string cannot be partially evaluated */ + ecs_strbuf_grow(b); - for (i = 0; i < count; i ++) { - if (keys[i] == key) { - return GET_ELEM(bucket->payload, elem_size, i); + /* Copy entire string to new buffer */ + ecs_os_vsprintf(ecs_strbuf_ptr(b), str, arg_cpy); + + /* Ignore the part of the string that was copied into the + * previous buffer. The string copied into the new buffer could + * be memmoved so that only the remainder is left, but that is + * most likely more expensive than just keeping the entire + * string. */ + + /* Update position in buffer */ + b->current->pos += memRequired; + } else { + /* Resulting string does not fit in standard-size buffer. + * Allocate a new buffer that can hold the entire string. */ + char *dst = ecs_os_malloc(memRequired + 1); + ecs_os_vsprintf(dst, str, arg_cpy); + ecs_strbuf_grow_str(b, dst, dst, memRequired); } } - return NULL; + + va_end(arg_cpy); + + return ecs_strbuf_memLeft(b) > 0; } -/* Grow number of buckets */ static -void rehash( - ecs_map_t *map, - int32_t bucket_count) +bool appendstr( + ecs_strbuf_t *b, + const char* str, + int n) { - ecs_assert(bucket_count != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(bucket_count > map->bucket_count, ECS_INTERNAL_ERROR, NULL); - - ensure_buckets(map, bucket_count); - - ecs_bucket_t *buckets = map->buckets; - ecs_assert(buckets != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_size_t elem_size = map->elem_size; - uint16_t bucket_shift = map->bucket_shift; - int32_t bucket_id; + ecs_strbuf_init(b); - /* Iterate backwards as elements could otherwise be moved to existing - * buckets which could temporarily cause the number of elements in a - * bucket to exceed BUCKET_COUNT. */ - for (bucket_id = bucket_count - 1; bucket_id >= 0; bucket_id --) { - ecs_bucket_t *bucket = &buckets[bucket_id]; + int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); + int32_t memLeft = ecs_strbuf_memLeft(b); + if (memLeft <= 0) { + return false; + } - int i, count = bucket->count; - ecs_map_key_t *key_array = bucket->keys; - void *payload_array = bucket->payload; + /* Never write more than what the buffer can store */ + if (n > memLeft) { + n = memLeft; + } - for (i = 0; i < count; i ++) { - ecs_map_key_t key = key_array[i]; - void *elem = GET_ELEM(payload_array, elem_size, i); - int32_t new_bucket_id = get_bucket_index(map, bucket_shift, key); + if (n <= memLeftInElement) { + /* Element was large enough to fit string */ + ecs_os_strncpy(ecs_strbuf_ptr(b), str, n); + b->current->pos += n; + } else if ((n - memLeftInElement) < memLeft) { + ecs_os_strncpy(ecs_strbuf_ptr(b), str, memLeftInElement); - if (new_bucket_id != bucket_id) { - ecs_bucket_t *new_bucket = &buckets[new_bucket_id]; + /* Element was not large enough, but buffer still has space */ + b->current->pos += memLeftInElement; + n -= memLeftInElement; - add_to_bucket(new_bucket, elem_size, key, elem); - remove_from_bucket(bucket, elem_size, key, i); + /* Current element was too small, copy remainder into new element */ + if (n < ECS_STRBUF_ELEMENT_SIZE) { + /* A standard-size buffer is large enough for the new string */ + ecs_strbuf_grow(b); - count --; - i --; + /* Copy the remainder to the new buffer */ + if (n) { + /* If a max number of characters to write is set, only a + * subset of the string should be copied to the buffer */ + ecs_os_strncpy( + ecs_strbuf_ptr(b), + str + memLeftInElement, + (size_t)n); + } else { + ecs_os_strcpy(ecs_strbuf_ptr(b), str + memLeftInElement); } - } - if (!bucket->count) { - clear_bucket(bucket); + /* Update to number of characters copied to new buffer */ + b->current->pos += n; + } else { + /* String doesn't fit in a single element, strdup */ + char *remainder = ecs_os_strdup(str + memLeftInElement); + ecs_strbuf_grow_str(b, remainder, remainder, n); } + } else { + /* Buffer max has been reached */ + return false; } + + return ecs_strbuf_memLeft(b) > 0; } -void _ecs_map_init( - ecs_map_t *result, - ecs_size_t elem_size, - int32_t element_count) +static +bool appendch( + ecs_strbuf_t *b, + char ch) { - ecs_assert(elem_size < INT16_MAX, ECS_INVALID_PARAMETER, NULL); + ecs_strbuf_init(b); - result->count = 0; - result->elem_size = (int16_t)elem_size; + int32_t memLeftInElement = ecs_strbuf_memLeftInCurrentElement(b); + int32_t memLeft = ecs_strbuf_memLeft(b); + if (memLeft <= 0) { + return false; + } - ensure_buckets(result, get_bucket_count(element_count)); + if (memLeftInElement) { + /* Element was large enough to fit string */ + ecs_strbuf_ptr(b)[0] = ch; + b->current->pos ++; + } else { + ecs_strbuf_grow(b); + ecs_strbuf_ptr(b)[0] = ch; + b->current->pos ++; + } + + return ecs_strbuf_memLeft(b) > 0; } -ecs_map_t* _ecs_map_new( - ecs_size_t elem_size, - int32_t element_count) +bool ecs_strbuf_vappend( + ecs_strbuf_t *b, + const char* fmt, + va_list args) { - ecs_map_t *result = ecs_os_calloc_t(ecs_map_t); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); + return vappend(b, fmt, args); +} - _ecs_map_init(result, elem_size, element_count); +bool ecs_strbuf_append( + ecs_strbuf_t *b, + const char* fmt, + ...) +{ + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); + + va_list args; + va_start(args, fmt); + bool result = vappend(b, fmt, args); + va_end(args); return result; } -bool ecs_map_is_initialized( - const ecs_map_t *result) +bool ecs_strbuf_appendstrn( + ecs_strbuf_t *b, + const char* str, + int32_t len) { - return result != NULL && result->bucket_count != 0; + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); + return appendstr(b, str, len); } -void ecs_map_fini( - ecs_map_t *map) +bool ecs_strbuf_appendch( + ecs_strbuf_t *b, + char ch) { - ecs_assert(map != NULL, ECS_INTERNAL_ERROR, NULL); - clear_buckets(map); + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + return appendch(b, ch); } -void ecs_map_free( - ecs_map_t *map) +bool ecs_strbuf_appendflt( + ecs_strbuf_t *b, + double flt, + char nan_delim) { - if (map) { - ecs_map_fini(map); - ecs_os_free(map); - } + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + return ecs_strbuf_ftoa(b, flt, 10, nan_delim); } -void* _ecs_map_get( - const ecs_map_t *map, - ecs_size_t elem_size, - ecs_map_key_t key) +bool ecs_strbuf_appendstr_zerocpy( + ecs_strbuf_t *b, + char* str) { - (void)elem_size; - - if (!ecs_map_is_initialized(map)) { - return NULL; - } - - ecs_assert(elem_size == map->elem_size, ECS_INVALID_PARAMETER, NULL); - - ecs_bucket_t * bucket = get_bucket(map, key); - if (!bucket) { - return NULL; - } - - return get_from_bucket(bucket, key, elem_size); + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_strbuf_init(b); + ecs_strbuf_grow_str(b, str, str, 0); + return true; } -void* _ecs_map_get_ptr( - const ecs_map_t *map, - ecs_map_key_t key) +bool ecs_strbuf_appendstr_zerocpy_const( + ecs_strbuf_t *b, + const char* str) { - void* ptr_ptr = _ecs_map_get(map, ECS_SIZEOF(void*), key); - - if (ptr_ptr) { - return *(void**)ptr_ptr; - } else { - return NULL; - } + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); + /* Removes const modifier, but logic prevents changing / delete string */ + ecs_strbuf_init(b); + ecs_strbuf_grow_str(b, (char*)str, NULL, 0); + return true; } -bool ecs_map_has( - const ecs_map_t *map, - ecs_map_key_t key) +bool ecs_strbuf_appendstr( + ecs_strbuf_t *b, + const char* str) { - if (!ecs_map_is_initialized(map)) { - return false; - } - - ecs_bucket_t * bucket = get_bucket(map, key); - if (!bucket) { - return false; - } - - return get_from_bucket(bucket, key, 0) != NULL; + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); + return appendstr(b, str, ecs_os_strlen(str)); } -void* _ecs_map_ensure( - ecs_map_t *map, - ecs_size_t elem_size, - ecs_map_key_t key) +bool ecs_strbuf_mergebuff( + ecs_strbuf_t *dst_buffer, + ecs_strbuf_t *src_buffer) { - void *result = _ecs_map_get(map, elem_size, key); - if (!result) { - result = _ecs_map_set(map, elem_size, key, NULL); - if (elem_size) { - ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_os_memset(result, 0, elem_size); + if (src_buffer->elementCount) { + if (src_buffer->buf) { + return ecs_strbuf_appendstr(dst_buffer, src_buffer->buf); + } else { + ecs_strbuf_element *e = (ecs_strbuf_element*)&src_buffer->firstElement; + + /* Copy first element as it is inlined in the src buffer */ + ecs_strbuf_appendstrn(dst_buffer, e->buf, e->pos); + + while ((e = e->next)) { + dst_buffer->current->next = ecs_os_malloc(sizeof(ecs_strbuf_element)); + *dst_buffer->current->next = *e; + } } + + *src_buffer = ECS_STRBUF_INIT; } - return result; + return true; } -void* _ecs_map_set( - ecs_map_t *map, - ecs_size_t elem_size, - ecs_map_key_t key, - const void *payload) +char* ecs_strbuf_get( + ecs_strbuf_t *b) { - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(elem_size == map->elem_size, ECS_INVALID_PARAMETER, NULL); - - ecs_bucket_t *bucket = ensure_bucket(map, key); - ecs_assert(bucket != NULL, ECS_INTERNAL_ERROR, NULL); - - void *elem = get_from_bucket(bucket, key, elem_size); - if (!elem) { - int32_t index = add_to_bucket(bucket, elem_size, key, payload); - int32_t map_count = ++map->count; - int32_t target_bucket_count = get_bucket_count(map_count); - int32_t map_bucket_count = map->bucket_count; + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - if (target_bucket_count > map_bucket_count) { - rehash(map, target_bucket_count); - bucket = ensure_bucket(map, key); - return get_from_bucket(bucket, key, elem_size); + char* result = NULL; + if (b->elementCount) { + if (b->buf) { + b->buf[b->current->pos] = '\0'; + result = ecs_os_strdup(b->buf); } else { - return GET_ELEM(bucket->payload, elem_size, index); - } - } else { - if (payload) { - ecs_os_memcpy(elem, payload, elem_size); - } - return elem; - } -} + void *next = NULL; + int32_t len = b->size + b->current->pos + 1; -int32_t ecs_map_remove( - ecs_map_t *map, - ecs_map_key_t key) -{ - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_strbuf_element *e = (ecs_strbuf_element*)&b->firstElement; - ecs_bucket_t * bucket = get_bucket(map, key); - if (!bucket) { - return map->count; - } + result = ecs_os_malloc(len); + char* ptr = result; - int32_t i, bucket_count = bucket->count; - for (i = 0; i < bucket_count; i ++) { - if (bucket->keys[i] == key) { - remove_from_bucket(bucket, map->elem_size, key, i); - return --map->count; + do { + ecs_os_memcpy(ptr, e->buf, e->pos); + ptr += e->pos; + next = e->next; + if (e != &b->firstElement.super) { + if (!e->buffer_embedded) { + ecs_os_free(((ecs_strbuf_element_str*)e)->alloc_str); + } + ecs_os_free(e); + } + } while ((e = next)); + + result[len - 1] = '\0'; + b->length = len; } + } else { + result = NULL; } - return map->count; -} + b->elementCount = 0; -int32_t ecs_map_count( - const ecs_map_t *map) -{ - return map ? map->count : 0; -} + b->content = result; -int32_t ecs_map_bucket_count( - const ecs_map_t *map) -{ - return map ? map->bucket_count : 0; + return result; } -void ecs_map_clear( - ecs_map_t *map) +char *ecs_strbuf_get_small( + ecs_strbuf_t *b) { - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); - clear_buckets(map); - map->count = 0; - ensure_buckets(map, 2); -} + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); -ecs_map_iter_t ecs_map_iter( - const ecs_map_t *map) -{ - return (ecs_map_iter_t){ - .map = map, - .bucket = NULL, - .bucket_index = 0, - .element_index = 0 - }; + int32_t written = ecs_strbuf_written(b); + ecs_assert(written <= ECS_STRBUF_ELEMENT_SIZE, ECS_INVALID_OPERATION, NULL); + char *buf = b->firstElement.buf; + buf[written] = '\0'; + return buf; } -void* _ecs_map_next( - ecs_map_iter_t *iter, - ecs_size_t elem_size, - ecs_map_key_t *key_out) +void ecs_strbuf_reset( + ecs_strbuf_t *b) { - const ecs_map_t *map = iter->map; - if (!ecs_map_is_initialized(map)) { - return NULL; - } - - ecs_assert(!elem_size || elem_size == map->elem_size, - ECS_INVALID_PARAMETER, NULL); - - ecs_bucket_t *bucket = iter->bucket; - int32_t element_index = iter->element_index; - elem_size = map->elem_size; - - do { - if (!bucket) { - int32_t bucket_index = iter->bucket_index; - ecs_bucket_t *buckets = map->buckets; - if (bucket_index < map->bucket_count) { - bucket = &buckets[bucket_index]; - iter->bucket = bucket; + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - element_index = 0; - iter->element_index = 0; - } else { - return NULL; + if (b->elementCount && !b->buf) { + void *next = NULL; + ecs_strbuf_element *e = (ecs_strbuf_element*)&b->firstElement; + do { + next = e->next; + if (e != (ecs_strbuf_element*)&b->firstElement) { + ecs_os_free(e); } - } - - if (element_index < bucket->count) { - iter->element_index = element_index + 1; - break; - } else { - bucket = NULL; - iter->bucket_index ++; - } - } while (true); - - if (key_out) { - *key_out = bucket->keys[element_index]; + } while ((e = next)); } - return GET_ELEM(bucket->payload, elem_size, element_index); + *b = ECS_STRBUF_INIT; } -void* _ecs_map_next_ptr( - ecs_map_iter_t *iter, - ecs_map_key_t *key_out) +void ecs_strbuf_list_push( + ecs_strbuf_t *b, + const char *list_open, + const char *separator) { - void *result = _ecs_map_next(iter, ECS_SIZEOF(void*), key_out); - if (result) { - return *(void**)result; - } else { - return NULL; + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(list_open != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(separator != NULL, ECS_INVALID_PARAMETER, NULL); + + b->list_sp ++; + b->list_stack[b->list_sp].count = 0; + b->list_stack[b->list_sp].separator = separator; + + if (list_open) { + ecs_strbuf_appendstr(b, list_open); } } -void ecs_map_grow( - ecs_map_t *map, - int32_t element_count) +void ecs_strbuf_list_pop( + ecs_strbuf_t *b, + const char *list_close) { - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); - int32_t target_count = map->count + element_count; - int32_t bucket_count = get_bucket_count(target_count); + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(list_close != NULL, ECS_INVALID_PARAMETER, NULL); - if (bucket_count > map->bucket_count) { - rehash(map, bucket_count); + b->list_sp --; + + if (list_close) { + ecs_strbuf_appendstr(b, list_close); } } -void ecs_map_set_size( - ecs_map_t *map, - int32_t element_count) -{ - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); - int32_t bucket_count = get_bucket_count(element_count); +void ecs_strbuf_list_next( + ecs_strbuf_t *b) +{ + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); - if (bucket_count) { - rehash(map, bucket_count); + int32_t list_sp = b->list_sp; + if (b->list_stack[list_sp].count != 0) { + ecs_strbuf_appendstr(b, b->list_stack[list_sp].separator); } + b->list_stack[list_sp].count ++; } -ecs_map_t* ecs_map_copy( - ecs_map_t *map) +bool ecs_strbuf_list_append( + ecs_strbuf_t *b, + const char *fmt, + ...) { - if (!ecs_map_is_initialized(map)) { - return NULL; - } + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(fmt != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_size_t elem_size = map->elem_size; - ecs_map_t *result = _ecs_map_new(map->elem_size, ecs_map_count(map)); + ecs_strbuf_list_next(b); - ecs_map_iter_t it = ecs_map_iter(map); - ecs_map_key_t key; - void *ptr; - while ((ptr = _ecs_map_next(&it, elem_size, &key))) { - _ecs_map_set(result, elem_size, key, ptr); - } + va_list args; + va_start(args, fmt); + bool result = vappend(b, fmt, args); + va_end(args); return result; } -void ecs_map_memory( - ecs_map_t *map, - int32_t *allocd, - int32_t *used) +bool ecs_strbuf_list_appendstr( + ecs_strbuf_t *b, + const char *str) { - ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(str != NULL, ECS_INVALID_PARAMETER, NULL); - if (used) { - *used = map->count * map->elem_size; - } + ecs_strbuf_list_next(b); + return ecs_strbuf_appendstr(b, str); +} - if (allocd) { - *allocd += ECS_SIZEOF(ecs_map_t); +int32_t ecs_strbuf_written( + const ecs_strbuf_t *b) +{ + ecs_assert(b != NULL, ECS_INVALID_PARAMETER, NULL); + return b->size + b->current->pos; +} - int i, bucket_count = map->bucket_count; - for (i = 0; i < bucket_count; i ++) { - ecs_bucket_t *bucket = &map->buckets[i]; - *allocd += KEY_SIZE * bucket->count; - *allocd += map->elem_size * bucket->count; - } +#include - *allocd += ECS_SIZEOF(ecs_bucket_t) * bucket_count; - } -} +/* The ratio used to determine whether the map should rehash. If + * (element_count * LOAD_FACTOR) > bucket_count, bucket count is increased. */ +#define LOAD_FACTOR (1.5f) +#define KEY_SIZE (ECS_SIZEOF(ecs_map_key_t)) +#define GET_ELEM(array, elem_size, index) \ + ECS_OFFSET(array, (elem_size) * (index)) +static +uint8_t ecs_log2(uint32_t v) { + static const uint8_t log2table[32] = + {0, 9, 1, 10, 13, 21, 2, 29, 11, 14, 16, 18, 22, 25, 3, 30, + 8, 12, 20, 28, 15, 17, 24, 7, 19, 27, 23, 6, 26, 5, 4, 31}; + v |= v >> 1; + v |= v >> 2; + v |= v >> 4; + v |= v >> 8; + v |= v >> 16; + return log2table[(uint32_t)(v * 0x07C4ACDDU) >> 27]; +} +/* Get bucket count for number of elements */ static -void ensure( - ecs_bitset_t *bs, - ecs_size_t size) +int32_t get_bucket_count( + int32_t element_count) { - if (!bs->size) { - int32_t new_size = ((size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); - bs->size = ((size - 1) / 64 + 1) * 64; - bs->data = ecs_os_calloc(new_size); - } else if (size > bs->size) { - int32_t prev_size = ((bs->size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); - bs->size = ((size - 1) / 64 + 1) * 64; - int32_t new_size = ((size - 1) / 64 + 1) * ECS_SIZEOF(uint64_t); - bs->data = ecs_os_realloc(bs->data, new_size); - ecs_os_memset(ECS_OFFSET(bs->data, prev_size), 0, new_size - prev_size); - } + return flecs_next_pow_of_2((int32_t)((float)element_count * LOAD_FACTOR)); } -void flecs_bitset_init( - ecs_bitset_t* bs) +/* Get bucket shift amount for a given bucket count */ +static +uint8_t get_bucket_shift ( + int32_t bucket_count) { - bs->size = 0; - bs->count = 0; - bs->data = NULL; + return (uint8_t)(64u - ecs_log2((uint32_t)bucket_count)); } -void flecs_bitset_ensure( - ecs_bitset_t *bs, - int32_t count) +/* Get bucket index for provided map key */ +static +int32_t get_bucket_index( + const ecs_map_t *map, + uint16_t bucket_shift, + ecs_map_key_t key) { - if (count > bs->count) { - bs->count = count; - ensure(bs, count); - } + ecs_assert(bucket_shift != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(map->bucket_shift == bucket_shift, ECS_INTERNAL_ERROR, NULL); + (void)map; + return (int32_t)((11400714819323198485ull * key) >> bucket_shift); } -void flecs_bitset_fini( - ecs_bitset_t *bs) +/* Get bucket for key */ +static +ecs_bucket_t* get_bucket( + const ecs_map_t *map, + ecs_map_key_t key) { - ecs_os_free(bs->data); - bs->data = NULL; - bs->count = 0; + ecs_assert(map->bucket_shift == get_bucket_shift(map->bucket_count), + ECS_INTERNAL_ERROR, NULL); + int32_t bucket_id = get_bucket_index(map, map->bucket_shift, key); + ecs_assert(bucket_id < map->bucket_count, ECS_INTERNAL_ERROR, NULL); + return &map->buckets[bucket_id]; } -void flecs_bitset_addn( - ecs_bitset_t *bs, - int32_t count) +/* Ensure that map has at least new_count buckets */ +static +void ensure_buckets( + ecs_map_t *map, + int32_t new_count) { - int32_t elem = bs->count += count; - ensure(bs, elem); + int32_t bucket_count = map->bucket_count; + new_count = flecs_next_pow_of_2(new_count); + if (new_count < 2) { + new_count = 2; + } + + if (new_count && new_count > bucket_count) { + map->buckets = ecs_os_realloc(map->buckets, new_count * ECS_SIZEOF(ecs_bucket_t)); + map->bucket_count = new_count; + map->bucket_shift = get_bucket_shift(new_count); + ecs_os_memset( + ECS_OFFSET(map->buckets, bucket_count * ECS_SIZEOF(ecs_bucket_t)), + 0, (new_count - bucket_count) * ECS_SIZEOF(ecs_bucket_t)); + } } -void flecs_bitset_set( - ecs_bitset_t *bs, - int32_t elem, - bool value) +/* Free contents of bucket */ +static +void clear_bucket( + ecs_bucket_t *bucket) { - ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); - int32_t hi = elem >> 6; - int32_t lo = elem & 0x3F; - uint64_t v = bs->data[hi]; - bs->data[hi] = (v & ~((uint64_t)1 << lo)) | ((uint64_t)value << lo); -error: - return; + ecs_os_free(bucket->keys); + ecs_os_free(bucket->payload); + bucket->keys = NULL; + bucket->payload = NULL; + bucket->count = 0; } -bool flecs_bitset_get( - const ecs_bitset_t *bs, - int32_t elem) +/* Clear all buckets */ +static +void clear_buckets( + ecs_map_t *map) { - ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); - return !!(bs->data[elem >> 6] & ((uint64_t)1 << ((uint64_t)elem & 0x3F))); -error: - return false; + ecs_bucket_t *buckets = map->buckets; + int32_t i, count = map->bucket_count; + for (i = 0; i < count; i ++) { + clear_bucket(&buckets[i]); + } + ecs_os_free(buckets); + map->buckets = NULL; + map->bucket_count = 0; } -int32_t flecs_bitset_count( - const ecs_bitset_t *bs) +/* Find or create bucket for specified key */ +static +ecs_bucket_t* ensure_bucket( + ecs_map_t *map, + ecs_map_key_t key) { - return bs->count; + ecs_assert(map->bucket_count >= 2, ECS_INTERNAL_ERROR, NULL); + int32_t bucket_id = get_bucket_index(map, map->bucket_shift, key); + ecs_assert(bucket_id >= 0, ECS_INTERNAL_ERROR, NULL); + return &map->buckets[bucket_id]; } -void flecs_bitset_remove( - ecs_bitset_t *bs, - int32_t elem) +/* Add element to bucket */ +static +int32_t add_to_bucket( + ecs_bucket_t *bucket, + ecs_size_t elem_size, + ecs_map_key_t key, + const void *payload) { - ecs_check(elem < bs->count, ECS_INVALID_PARAMETER, NULL); - int32_t last = bs->count - 1; - bool last_value = flecs_bitset_get(bs, last); - flecs_bitset_set(bs, elem, last_value); - bs->count --; -error: - return; + int32_t index = bucket->count ++; + int32_t bucket_count = index + 1; + + bucket->keys = ecs_os_realloc(bucket->keys, KEY_SIZE * bucket_count); + bucket->keys[index] = key; + + if (elem_size) { + bucket->payload = ecs_os_realloc(bucket->payload, elem_size * bucket_count); + if (payload) { + void *elem = GET_ELEM(bucket->payload, elem_size, index); + ecs_os_memcpy(elem, payload, elem_size); + } + } else { + bucket->payload = NULL; + } + + return index; } -void flecs_bitset_swap( - ecs_bitset_t *bs, - int32_t elem_a, - int32_t elem_b) +/* Remove element from bucket */ +static +void remove_from_bucket( + ecs_bucket_t *bucket, + ecs_size_t elem_size, + ecs_map_key_t key, + int32_t index) { - ecs_check(elem_a < bs->count, ECS_INVALID_PARAMETER, NULL); - ecs_check(elem_b < bs->count, ECS_INVALID_PARAMETER, NULL); + (void)key; - bool a = flecs_bitset_get(bs, elem_a); - bool b = flecs_bitset_get(bs, elem_b); - flecs_bitset_set(bs, elem_a, b); - flecs_bitset_set(bs, elem_b, a); -error: - return; -} + ecs_assert(bucket->count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(index < bucket->count, ECS_INTERNAL_ERROR, NULL); + + int32_t bucket_count = -- bucket->count; + if (index != bucket->count) { + ecs_assert(key == bucket->keys[index], ECS_INTERNAL_ERROR, NULL); + bucket->keys[index] = bucket->keys[bucket_count]; + + ecs_map_key_t *elem = GET_ELEM(bucket->payload, elem_size, index); + ecs_map_key_t *last_elem = GET_ELEM(bucket->payload, elem_size, bucket->count); + + ecs_os_memcpy(elem, last_elem, elem_size); + } +} +/* Get payload pointer for key from bucket */ static -uint64_t name_index_hash( - const void *ptr) +void* get_from_bucket( + ecs_bucket_t *bucket, + ecs_map_key_t key, + ecs_size_t elem_size) { - const ecs_hashed_string_t *str = ptr; - ecs_assert(str->hash != 0, ECS_INTERNAL_ERROR, NULL); - return str->hash; + ecs_map_key_t *keys = bucket->keys; + int32_t i, count = bucket->count; + + for (i = 0; i < count; i ++) { + if (keys[i] == key) { + return GET_ELEM(bucket->payload, elem_size, i); + } + } + return NULL; } +/* Grow number of buckets */ static -int name_index_compare( - const void *ptr1, - const void *ptr2) +void rehash( + ecs_map_t *map, + int32_t bucket_count) { - const ecs_hashed_string_t *str1 = ptr1; - const ecs_hashed_string_t *str2 = ptr2; - ecs_size_t len1 = str1->length; - ecs_size_t len2 = str2->length; - if (len1 != len2) { - return (len1 > len2) - (len1 < len2); - } + ecs_assert(bucket_count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(bucket_count > map->bucket_count, ECS_INTERNAL_ERROR, NULL); - return ecs_os_memcmp(str1->value, str2->value, len1); + ensure_buckets(map, bucket_count); + + ecs_bucket_t *buckets = map->buckets; + ecs_assert(buckets != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_size_t elem_size = map->elem_size; + uint16_t bucket_shift = map->bucket_shift; + int32_t bucket_id; + + /* Iterate backwards as elements could otherwise be moved to existing + * buckets which could temporarily cause the number of elements in a + * bucket to exceed BUCKET_COUNT. */ + for (bucket_id = bucket_count - 1; bucket_id >= 0; bucket_id --) { + ecs_bucket_t *bucket = &buckets[bucket_id]; + + int i, count = bucket->count; + ecs_map_key_t *key_array = bucket->keys; + void *payload_array = bucket->payload; + + for (i = 0; i < count; i ++) { + ecs_map_key_t key = key_array[i]; + void *elem = GET_ELEM(payload_array, elem_size, i); + int32_t new_bucket_id = get_bucket_index(map, bucket_shift, key); + + if (new_bucket_id != bucket_id) { + ecs_bucket_t *new_bucket = &buckets[new_bucket_id]; + + add_to_bucket(new_bucket, elem_size, key, elem); + remove_from_bucket(bucket, elem_size, key, i); + + count --; + i --; + } + } + + if (!bucket->count) { + clear_bucket(bucket); + } + } } -void flecs_name_index_init( - ecs_hashmap_t *hm) +void _ecs_map_init( + ecs_map_t *result, + ecs_size_t elem_size, + int32_t element_count) { - _flecs_hashmap_init(hm, - ECS_SIZEOF(ecs_hashed_string_t), ECS_SIZEOF(uint64_t), - name_index_hash, - name_index_compare); + ecs_assert(elem_size < INT16_MAX, ECS_INVALID_PARAMETER, NULL); + + result->count = 0; + result->elem_size = (int16_t)elem_size; + + ensure_buckets(result, get_bucket_count(element_count)); } -ecs_hashmap_t* flecs_name_index_new(void) +ecs_map_t* _ecs_map_new( + ecs_size_t elem_size, + int32_t element_count) { - ecs_hashmap_t *result = ecs_os_calloc_t(ecs_hashmap_t); - flecs_name_index_init(result); + ecs_map_t *result = ecs_os_calloc_t(ecs_map_t); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); + + _ecs_map_init(result, elem_size, element_count); + return result; } -void flecs_name_index_fini( - ecs_hashmap_t *map) +bool ecs_map_is_initialized( + const ecs_map_t *result) { - flecs_hashmap_fini(map); + return result != NULL && result->bucket_count != 0; } -void flecs_name_index_free( - ecs_hashmap_t *map) +void ecs_map_fini( + ecs_map_t *map) { - if (map) { - flecs_name_index_fini(map); - ecs_os_free(map); - } + ecs_assert(map != NULL, ECS_INTERNAL_ERROR, NULL); + clear_buckets(map); } -ecs_hashed_string_t flecs_get_hashed_string( - const char *name, - ecs_size_t length, - uint64_t hash) +void ecs_map_free( + ecs_map_t *map) { - if (!length) { - length = ecs_os_strlen(name); - } else { - ecs_assert(length == ecs_os_strlen(name), ECS_INTERNAL_ERROR, NULL); - } - - if (!hash) { - hash = flecs_hash(name, length); - } else { - ecs_assert(hash == flecs_hash(name, length), ECS_INTERNAL_ERROR, NULL); + if (map) { + ecs_map_fini(map); + ecs_os_free(map); } - - return (ecs_hashed_string_t) { - .value = (char*)name, - .length = length, - .hash = hash - }; } -const uint64_t* flecs_name_index_find_ptr( - const ecs_hashmap_t *map, - const char *name, - ecs_size_t length, - uint64_t hash) +void* _ecs_map_get( + const ecs_map_t *map, + ecs_size_t elem_size, + ecs_map_key_t key) { - ecs_hashed_string_t hs = flecs_get_hashed_string(name, length, hash); + (void)elem_size; - ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hs.hash); - if (!b) { + if (!ecs_map_is_initialized(map)) { return NULL; } - ecs_hashed_string_t *keys = ecs_vector_first(b->keys, ecs_hashed_string_t); - int32_t i, count = ecs_vector_count(b->keys); - - for (i = 0; i < count; i ++) { - ecs_hashed_string_t *key = &keys[i]; - ecs_assert(key->hash == hs.hash, ECS_INTERNAL_ERROR, NULL); - - if (hs.length != key->length) { - continue; - } + ecs_assert(elem_size == map->elem_size, ECS_INVALID_PARAMETER, NULL); - if (!ecs_os_strcmp(name, key->value)) { - uint64_t *e = ecs_vector_get(b->values, uint64_t, i); - ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); - return e; - } + ecs_bucket_t * bucket = get_bucket(map, key); + if (!bucket) { + return NULL; } - return NULL; + return get_from_bucket(bucket, key, elem_size); } -uint64_t flecs_name_index_find( - const ecs_hashmap_t *map, - const char *name, - ecs_size_t length, - uint64_t hash) +void* _ecs_map_get_ptr( + const ecs_map_t *map, + ecs_map_key_t key) { - const uint64_t *id = flecs_name_index_find_ptr(map, name, length, hash); - if (id) { - return id[0]; + void* ptr_ptr = _ecs_map_get(map, ECS_SIZEOF(void*), key); + + if (ptr_ptr) { + return *(void**)ptr_ptr; + } else { + return NULL; } - return 0; } -void flecs_name_index_remove( - ecs_hashmap_t *map, - uint64_t e, - uint64_t hash) +bool ecs_map_has( + const ecs_map_t *map, + ecs_map_key_t key) { - ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hash); - if (!b) { - return; + if (!ecs_map_is_initialized(map)) { + return false; } - uint64_t *ids = ecs_vector_first(b->values, uint64_t); - int32_t i, count = ecs_vector_count(b->values); - - for (i = 0; i < count; i ++) { - if (ids[i] == e) { - flecs_hm_bucket_remove(map, b, hash, i); - break; - } + ecs_bucket_t * bucket = get_bucket(map, key); + if (!bucket) { + return false; } + + return get_from_bucket(bucket, key, 0) != NULL; } -void flecs_name_index_update_name( - ecs_hashmap_t *map, - uint64_t e, - uint64_t hash, - const char *name) +void* _ecs_map_ensure( + ecs_map_t *map, + ecs_size_t elem_size, + ecs_map_key_t key) { - ecs_hm_bucket_t *b = flecs_hashmap_get_bucket(map, hash); - if (!b) { - return; + void *result = _ecs_map_get(map, elem_size, key); + if (!result) { + result = _ecs_map_set(map, elem_size, key, NULL); + if (elem_size) { + ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_os_memset(result, 0, elem_size); + } } - uint64_t *ids = ecs_vector_first(b->values, uint64_t); - int32_t i, count = ecs_vector_count(b->values); + return result; +} - for (i = 0; i < count; i ++) { - if (ids[i] == e) { - ecs_hashed_string_t *key = ecs_vector_get( - b->keys, ecs_hashed_string_t, i); - key->value = (char*)name; - ecs_assert(ecs_os_strlen(name) == key->length, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(flecs_hash(name, key->length) == key->hash, - ECS_INTERNAL_ERROR, NULL); - return; +void* _ecs_map_set( + ecs_map_t *map, + ecs_size_t elem_size, + ecs_map_key_t key, + const void *payload) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(elem_size == map->elem_size, ECS_INVALID_PARAMETER, NULL); + + ecs_bucket_t *bucket = ensure_bucket(map, key); + ecs_assert(bucket != NULL, ECS_INTERNAL_ERROR, NULL); + + void *elem = get_from_bucket(bucket, key, elem_size); + if (!elem) { + int32_t index = add_to_bucket(bucket, elem_size, key, payload); + int32_t map_count = ++map->count; + int32_t target_bucket_count = get_bucket_count(map_count); + int32_t map_bucket_count = map->bucket_count; + + if (target_bucket_count > map_bucket_count) { + rehash(map, target_bucket_count); + bucket = ensure_bucket(map, key); + return get_from_bucket(bucket, key, elem_size); + } else { + return GET_ELEM(bucket->payload, elem_size, index); + } + } else { + if (payload) { + ecs_os_memcpy(elem, payload, elem_size); } + return elem; } +} - /* Record must already have been in the index */ - ecs_abort(ECS_INTERNAL_ERROR, NULL); +int32_t ecs_map_remove( + ecs_map_t *map, + ecs_map_key_t key) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + + ecs_bucket_t * bucket = get_bucket(map, key); + if (!bucket) { + return map->count; + } + + int32_t i, bucket_count = bucket->count; + for (i = 0; i < bucket_count; i ++) { + if (bucket->keys[i] == key) { + remove_from_bucket(bucket, map->elem_size, key, i); + return --map->count; + } + } + + return map->count; } -void flecs_name_index_ensure( - ecs_hashmap_t *map, - uint64_t id, - const char *name, - ecs_size_t length, - uint64_t hash) +int32_t ecs_map_count( + const ecs_map_t *map) { - ecs_check(name != NULL, ECS_INVALID_PARAMETER, NULL); + return map ? map->count : 0; +} - ecs_hashed_string_t key = flecs_get_hashed_string(name, length, hash); +int32_t ecs_map_bucket_count( + const ecs_map_t *map) +{ + return map ? map->bucket_count : 0; +} + +void ecs_map_clear( + ecs_map_t *map) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + clear_buckets(map); + map->count = 0; + ensure_buckets(map, 2); +} + +ecs_map_iter_t ecs_map_iter( + const ecs_map_t *map) +{ + return (ecs_map_iter_t){ + .map = map, + .bucket = NULL, + .bucket_index = 0, + .element_index = 0 + }; +} + +void* _ecs_map_next( + ecs_map_iter_t *iter, + ecs_size_t elem_size, + ecs_map_key_t *key_out) +{ + const ecs_map_t *map = iter->map; + if (!ecs_map_is_initialized(map)) { + return NULL; + } - uint64_t existing = flecs_name_index_find( - map, name, key.length, key.hash); - if (existing) { - if (existing != id) { - ecs_abort(ECS_ALREADY_DEFINED, - "conflicting id registered with name '%s'", name); + ecs_assert(!elem_size || elem_size == map->elem_size, + ECS_INVALID_PARAMETER, NULL); + + ecs_bucket_t *bucket = iter->bucket; + int32_t element_index = iter->element_index; + elem_size = map->elem_size; + + do { + if (!bucket) { + int32_t bucket_index = iter->bucket_index; + ecs_bucket_t *buckets = map->buckets; + if (bucket_index < map->bucket_count) { + bucket = &buckets[bucket_index]; + iter->bucket = bucket; + + element_index = 0; + iter->element_index = 0; + } else { + return NULL; + } + } + + if (element_index < bucket->count) { + iter->element_index = element_index + 1; + break; + } else { + bucket = NULL; + iter->bucket_index ++; } + } while (true); + + if (key_out) { + *key_out = bucket->keys[element_index]; } - flecs_hashmap_result_t hmr = flecs_hashmap_ensure( - map, &key, uint64_t); + return GET_ELEM(bucket->payload, elem_size, element_index); +} - *((uint64_t*)hmr.value) = id; -error: - return; +void* _ecs_map_next_ptr( + ecs_map_iter_t *iter, + ecs_map_key_t *key_out) +{ + void *result = _ecs_map_next(iter, ECS_SIZEOF(void*), key_out); + if (result) { + return *(void**)result; + } else { + return NULL; + } +} + +void ecs_map_grow( + ecs_map_t *map, + int32_t element_count) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t target_count = map->count + element_count; + int32_t bucket_count = get_bucket_count(target_count); + + if (bucket_count > map->bucket_count) { + rehash(map, bucket_count); + } +} + +void ecs_map_set_size( + ecs_map_t *map, + int32_t element_count) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t bucket_count = get_bucket_count(element_count); + + if (bucket_count) { + rehash(map, bucket_count); + } +} + +ecs_map_t* ecs_map_copy( + ecs_map_t *map) +{ + if (!ecs_map_is_initialized(map)) { + return NULL; + } + + ecs_size_t elem_size = map->elem_size; + ecs_map_t *result = _ecs_map_new(map->elem_size, ecs_map_count(map)); + + ecs_map_iter_t it = ecs_map_iter(map); + ecs_map_key_t key; + void *ptr; + while ((ptr = _ecs_map_next(&it, elem_size, &key))) { + _ecs_map_set(result, elem_size, key, ptr); + } + + return result; +} + +void ecs_map_memory( + ecs_map_t *map, + int32_t *allocd, + int32_t *used) +{ + ecs_assert(map != NULL, ECS_INVALID_PARAMETER, NULL); + + if (used) { + *used = map->count * map->elem_size; + } + + if (allocd) { + *allocd += ECS_SIZEOF(ecs_map_t); + + int i, bucket_count = map->bucket_count; + for (i = 0; i < bucket_count; i ++) { + ecs_bucket_t *bucket = &map->buckets[i]; + *allocd += KEY_SIZE * bucket->count; + *allocd += map->elem_size * bucket->count; + } + + *allocd += ECS_SIZEOF(ecs_bucket_t) * bucket_count; + } } @@ -12673,35259 +13408,34498 @@ void* _flecs_hashmap_next( } -void ecs_qsort( - void *base, - ecs_size_t nitems, - ecs_size_t size, - int (*compar)(const void *, const void*)) -{ - void *tmp = ecs_os_alloca(size); /* For swap */ - - #define LESS(i, j) \ - compar(ECS_ELEM(base, size, i), ECS_ELEM(base, size, j)) < 0 - - #define SWAP(i, j) \ - ecs_os_memcpy(tmp, ECS_ELEM(base, size, i), size),\ - ecs_os_memcpy(ECS_ELEM(base, size, i), ECS_ELEM(base, size, j), size),\ - ecs_os_memcpy(ECS_ELEM(base, size, j), tmp, size) +#ifdef FLECS_LOG - QSORT(nitems, LESS, SWAP); -} +#include +#include +static +char *ecs_vasprintf( + const char *fmt, + va_list args) +{ + ecs_size_t size = 0; + char *result = NULL; + va_list tmpa; -/* Roles */ -const ecs_id_t ECS_CASE = (ECS_ROLE | (0x7Cull << 56)); -const ecs_id_t ECS_SWITCH = (ECS_ROLE | (0x7Bull << 56)); -const ecs_id_t ECS_PAIR = (ECS_ROLE | (0x7Aull << 56)); -const ecs_id_t ECS_OVERRIDE = (ECS_ROLE | (0x75ull << 56)); -const ecs_id_t ECS_DISABLED = (ECS_ROLE | (0x74ull << 56)); + va_copy(tmpa, args); -/** Builtin component ids */ -const ecs_entity_t ecs_id(EcsComponent) = 1; -const ecs_entity_t ecs_id(EcsComponentLifecycle) = 2; -const ecs_entity_t ecs_id(EcsType) = 3; -const ecs_entity_t ecs_id(EcsIdentifier) = 4; -const ecs_entity_t ecs_id(EcsTrigger) = 5; -const ecs_entity_t ecs_id(EcsQuery) = 6; -const ecs_entity_t ecs_id(EcsObserver) = 7; -const ecs_entity_t ecs_id(EcsIterable) = 8; + size = vsnprintf(result, 0, fmt, tmpa); -/* System module component ids */ -const ecs_entity_t ecs_id(EcsSystem) = 10; -const ecs_entity_t ecs_id(EcsTickSource) = 11; + va_end(tmpa); -/** Pipeline module component ids */ -const ecs_entity_t ecs_id(EcsPipelineQuery) = 12; + if ((int32_t)size < 0) { + return NULL; + } -/** Timer module component ids */ -const ecs_entity_t ecs_id(EcsTimer) = 13; -const ecs_entity_t ecs_id(EcsRateFilter) = 14; + result = (char *) ecs_os_malloc(size + 1); -/** Meta module component ids */ -const ecs_entity_t ecs_id(EcsMetaType) = 15; -const ecs_entity_t ecs_id(EcsMetaTypeSerialized) = 16; -const ecs_entity_t ecs_id(EcsPrimitive) = 17; -const ecs_entity_t ecs_id(EcsEnum) = 18; -const ecs_entity_t ecs_id(EcsBitmask) = 19; -const ecs_entity_t ecs_id(EcsMember) = 20; -const ecs_entity_t ecs_id(EcsStruct) = 21; -const ecs_entity_t ecs_id(EcsArray) = 22; -const ecs_entity_t ecs_id(EcsVector) = 23; -const ecs_entity_t ecs_id(EcsUnit) = 24; -const ecs_entity_t ecs_id(EcsUnitPrefix) = 25; + if (!result) { + return NULL; + } -/* Core scopes & entities */ -const ecs_entity_t EcsWorld = ECS_HI_COMPONENT_ID + 0; -const ecs_entity_t EcsFlecs = ECS_HI_COMPONENT_ID + 1; -const ecs_entity_t EcsFlecsCore = ECS_HI_COMPONENT_ID + 2; -const ecs_entity_t EcsFlecsHidden = ECS_HI_COMPONENT_ID + 3; -const ecs_entity_t EcsModule = ECS_HI_COMPONENT_ID + 4; -const ecs_entity_t EcsPrivate = ECS_HI_COMPONENT_ID + 5; -const ecs_entity_t EcsPrefab = ECS_HI_COMPONENT_ID + 6; -const ecs_entity_t EcsDisabled = ECS_HI_COMPONENT_ID + 7; + ecs_os_vsprintf(result, fmt, args); -/* Relation properties */ -const ecs_entity_t EcsWildcard = ECS_HI_COMPONENT_ID + 10; -const ecs_entity_t EcsAny = ECS_HI_COMPONENT_ID + 11; -const ecs_entity_t EcsThis = ECS_HI_COMPONENT_ID + 12; -const ecs_entity_t EcsTransitive = ECS_HI_COMPONENT_ID + 13; -const ecs_entity_t EcsReflexive = ECS_HI_COMPONENT_ID + 14; -const ecs_entity_t EcsSymmetric = ECS_HI_COMPONENT_ID + 15; -const ecs_entity_t EcsFinal = ECS_HI_COMPONENT_ID + 16; -const ecs_entity_t EcsDontInherit = ECS_HI_COMPONENT_ID + 17; -const ecs_entity_t EcsTag = ECS_HI_COMPONENT_ID + 18; -const ecs_entity_t EcsExclusive = ECS_HI_COMPONENT_ID + 19; -const ecs_entity_t EcsAcyclic = ECS_HI_COMPONENT_ID + 20; -const ecs_entity_t EcsWith = ECS_HI_COMPONENT_ID + 21; + return result; +} -/* Builtin relations */ -const ecs_entity_t EcsChildOf = ECS_HI_COMPONENT_ID + 25; -const ecs_entity_t EcsIsA = ECS_HI_COMPONENT_ID + 26; +static +void ecs_colorize_buf( + char *msg, + bool enable_colors, + ecs_strbuf_t *buf) +{ + char *ptr, ch, prev = '\0'; + bool isNum = false; + char isStr = '\0'; + bool isVar = false; + bool overrideColor = false; + bool autoColor = true; + bool dontAppend = false; -/* Identifier tags */ -const ecs_entity_t EcsName = ECS_HI_COMPONENT_ID + 27; -const ecs_entity_t EcsSymbol = ECS_HI_COMPONENT_ID + 28; -const ecs_entity_t EcsAlias = ECS_HI_COMPONENT_ID + 29; + for (ptr = msg; (ch = *ptr); ptr++) { + dontAppend = false; -/* Events */ -const ecs_entity_t EcsOnAdd = ECS_HI_COMPONENT_ID + 30; -const ecs_entity_t EcsOnRemove = ECS_HI_COMPONENT_ID + 31; -const ecs_entity_t EcsOnSet = ECS_HI_COMPONENT_ID + 32; -const ecs_entity_t EcsUnSet = ECS_HI_COMPONENT_ID + 33; -const ecs_entity_t EcsOnDelete = ECS_HI_COMPONENT_ID + 34; -const ecs_entity_t EcsOnCreateTable = ECS_HI_COMPONENT_ID + 35; -const ecs_entity_t EcsOnDeleteTable = ECS_HI_COMPONENT_ID + 36; -const ecs_entity_t EcsOnTableEmpty = ECS_HI_COMPONENT_ID + 37; -const ecs_entity_t EcsOnTableFill = ECS_HI_COMPONENT_ID + 38; -const ecs_entity_t EcsOnCreateTrigger = ECS_HI_COMPONENT_ID + 39; -const ecs_entity_t EcsOnDeleteTrigger = ECS_HI_COMPONENT_ID + 40; -const ecs_entity_t EcsOnDeleteObservable = ECS_HI_COMPONENT_ID + 41; -const ecs_entity_t EcsOnComponentLifecycle = ECS_HI_COMPONENT_ID + 42; -const ecs_entity_t EcsOnDeleteObject = ECS_HI_COMPONENT_ID + 43; + if (!overrideColor) { + if (isNum && !isdigit(ch) && !isalpha(ch) && (ch != '.') && (ch != '%')) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + isNum = false; + } + if (isStr && (isStr == ch) && prev != '\\') { + isStr = '\0'; + } else if (((ch == '\'') || (ch == '"')) && !isStr && + !isalpha(prev) && (prev != '\\')) + { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); + isStr = ch; + } -/* Actions */ -const ecs_entity_t EcsRemove = ECS_HI_COMPONENT_ID + 50; -const ecs_entity_t EcsDelete = ECS_HI_COMPONENT_ID + 51; -const ecs_entity_t EcsThrow = ECS_HI_COMPONENT_ID + 52; + if ((isdigit(ch) || (ch == '%' && isdigit(prev)) || + (ch == '-' && isdigit(ptr[1]))) && !isNum && !isStr && !isVar && + !isalpha(prev) && !isdigit(prev) && (prev != '_') && + (prev != '.')) + { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREEN); + isNum = true; + } -/* Misc */ -const ecs_entity_t EcsDefaultChildComponent = ECS_HI_COMPONENT_ID + 55; + if (isVar && !isalpha(ch) && !isdigit(ch) && ch != '_') { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + isVar = false; + } -/* Systems */ -const ecs_entity_t EcsMonitor = ECS_HI_COMPONENT_ID + 61; -const ecs_entity_t EcsInactive = ECS_HI_COMPONENT_ID + 63; -const ecs_entity_t EcsPipeline = ECS_HI_COMPONENT_ID + 64; -const ecs_entity_t EcsPreFrame = ECS_HI_COMPONENT_ID + 65; -const ecs_entity_t EcsOnLoad = ECS_HI_COMPONENT_ID + 66; -const ecs_entity_t EcsPostLoad = ECS_HI_COMPONENT_ID + 67; -const ecs_entity_t EcsPreUpdate = ECS_HI_COMPONENT_ID + 68; -const ecs_entity_t EcsOnUpdate = ECS_HI_COMPONENT_ID + 69; -const ecs_entity_t EcsOnValidate = ECS_HI_COMPONENT_ID + 70; -const ecs_entity_t EcsPostUpdate = ECS_HI_COMPONENT_ID + 71; -const ecs_entity_t EcsPreStore = ECS_HI_COMPONENT_ID + 72; -const ecs_entity_t EcsOnStore = ECS_HI_COMPONENT_ID + 73; -const ecs_entity_t EcsPostFrame = ECS_HI_COMPONENT_ID + 74; + if (!isStr && !isVar && ch == '$' && isalpha(ptr[1])) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); + isVar = true; + } + } -/* Meta primitive components (don't use low ids to save id space) */ -const ecs_entity_t ecs_id(ecs_bool_t) = ECS_HI_COMPONENT_ID + 80; -const ecs_entity_t ecs_id(ecs_char_t) = ECS_HI_COMPONENT_ID + 81; -const ecs_entity_t ecs_id(ecs_byte_t) = ECS_HI_COMPONENT_ID + 82; -const ecs_entity_t ecs_id(ecs_u8_t) = ECS_HI_COMPONENT_ID + 83; -const ecs_entity_t ecs_id(ecs_u16_t) = ECS_HI_COMPONENT_ID + 84; -const ecs_entity_t ecs_id(ecs_u32_t) = ECS_HI_COMPONENT_ID + 85; -const ecs_entity_t ecs_id(ecs_u64_t) = ECS_HI_COMPONENT_ID + 86; -const ecs_entity_t ecs_id(ecs_uptr_t) = ECS_HI_COMPONENT_ID + 87; -const ecs_entity_t ecs_id(ecs_i8_t) = ECS_HI_COMPONENT_ID + 88; -const ecs_entity_t ecs_id(ecs_i16_t) = ECS_HI_COMPONENT_ID + 89; -const ecs_entity_t ecs_id(ecs_i32_t) = ECS_HI_COMPONENT_ID + 90; -const ecs_entity_t ecs_id(ecs_i64_t) = ECS_HI_COMPONENT_ID + 91; -const ecs_entity_t ecs_id(ecs_iptr_t) = ECS_HI_COMPONENT_ID + 92; -const ecs_entity_t ecs_id(ecs_f32_t) = ECS_HI_COMPONENT_ID + 93; -const ecs_entity_t ecs_id(ecs_f64_t) = ECS_HI_COMPONENT_ID + 94; -const ecs_entity_t ecs_id(ecs_string_t) = ECS_HI_COMPONENT_ID + 95; -const ecs_entity_t ecs_id(ecs_entity_t) = ECS_HI_COMPONENT_ID + 96; -const ecs_entity_t EcsConstant = ECS_HI_COMPONENT_ID + 97; -const ecs_entity_t EcsQuantity = ECS_HI_COMPONENT_ID + 98; + if (!isVar && !isStr && !isNum && ch == '#' && ptr[1] == '[') { + bool isColor = true; + overrideColor = true; -/* Doc module components */ -const ecs_entity_t ecs_id(EcsDocDescription) =ECS_HI_COMPONENT_ID + 100; -const ecs_entity_t EcsDocBrief = ECS_HI_COMPONENT_ID + 101; -const ecs_entity_t EcsDocDetail = ECS_HI_COMPONENT_ID + 102; -const ecs_entity_t EcsDocLink = ECS_HI_COMPONENT_ID + 103; + /* Custom colors */ + if (!ecs_os_strncmp(&ptr[2], "]", ecs_os_strlen("]"))) { + autoColor = false; + } else if (!ecs_os_strncmp(&ptr[2], "green]", ecs_os_strlen("green]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREEN); + } else if (!ecs_os_strncmp(&ptr[2], "red]", ecs_os_strlen("red]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_RED); + } else if (!ecs_os_strncmp(&ptr[2], "blue]", ecs_os_strlen("red]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_BLUE); + } else if (!ecs_os_strncmp(&ptr[2], "magenta]", ecs_os_strlen("magenta]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_MAGENTA); + } else if (!ecs_os_strncmp(&ptr[2], "cyan]", ecs_os_strlen("cyan]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); + } else if (!ecs_os_strncmp(&ptr[2], "yellow]", ecs_os_strlen("yellow]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_YELLOW); + } else if (!ecs_os_strncmp(&ptr[2], "grey]", ecs_os_strlen("grey]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREY); + } else if (!ecs_os_strncmp(&ptr[2], "white]", ecs_os_strlen("white]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + } else if (!ecs_os_strncmp(&ptr[2], "bold]", ecs_os_strlen("bold]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_BOLD); + } else if (!ecs_os_strncmp(&ptr[2], "normal]", ecs_os_strlen("normal]"))) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + } else if (!ecs_os_strncmp(&ptr[2], "reset]", ecs_os_strlen("reset]"))) { + overrideColor = false; + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + } else { + isColor = false; + overrideColor = false; + } -/* REST module components */ -const ecs_entity_t ecs_id(EcsRest) = ECS_HI_COMPONENT_ID + 105; + if (isColor) { + ptr += 2; + while ((ch = *ptr) != ']') ptr ++; + dontAppend = true; + } + if (!autoColor) { + overrideColor = true; + } + } -/* Default lookup path */ -static ecs_entity_t ecs_default_lookup_path[2] = { 0, 0 }; + if (ch == '\n') { + if (isNum || isStr || isVar || overrideColor) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + overrideColor = false; + isNum = false; + isStr = false; + isVar = false; + } + } -/* -- Private functions -- */ + if (!dontAppend) { + ecs_strbuf_appendstrn(buf, ptr, 1); + } -const ecs_stage_t* flecs_stage_from_readonly_world( - const ecs_world_t *world) -{ - ecs_assert(ecs_poly_is(world, ecs_world_t) || - ecs_poly_is(world, ecs_stage_t), - ECS_INTERNAL_ERROR, - NULL); + if (!overrideColor) { + if (((ch == '\'') || (ch == '"')) && !isStr) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + } + } - if (ecs_poly_is(world, ecs_world_t)) { - return &world->stage; + prev = ch; + } - } else if (ecs_poly_is(world, ecs_stage_t)) { - return (ecs_stage_t*)world; + if (isNum || isStr || isVar || overrideColor) { + if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); } - - return NULL; } -ecs_stage_t *flecs_stage_from_world( - ecs_world_t **world_ptr) +void _ecs_logv( + int level, + const char *file, + int32_t line, + const char *fmt, + va_list args) { - ecs_world_t *world = *world_ptr; - - ecs_assert(ecs_poly_is(world, ecs_world_t) || - ecs_poly_is(world, ecs_stage_t), - ECS_INTERNAL_ERROR, - NULL); + (void)level; + (void)line; - if (ecs_poly_is(world, ecs_world_t)) { - ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); - return &world->stage; + ecs_strbuf_t msg_buf = ECS_STRBUF_INIT; - } else if (ecs_poly_is(world, ecs_stage_t)) { - ecs_stage_t *stage = (ecs_stage_t*)world; - *world_ptr = stage->world; - return stage; + if (level > ecs_os_api.log_level_) { + return; } + + /* Apply color. Even if we don't want color, we still need to call the + * colorize function to get rid of the color tags (e.g. #[green]) */ + char *msg_nocolor = ecs_vasprintf(fmt, args); + ecs_colorize_buf(msg_nocolor, ecs_os_api.log_with_color_, &msg_buf); + ecs_os_free(msg_nocolor); - return NULL; + char *msg = ecs_strbuf_get(&msg_buf); + ecs_os_api.log_(level, file, line, msg); + ecs_os_free(msg); } -ecs_world_t* flecs_suspend_readonly( - const ecs_world_t *stage_world, - ecs_suspend_readonly_state_t *state) +void _ecs_log( + int level, + const char *file, + int32_t line, + const char *fmt, + ...) { - ecs_assert(stage_world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(state != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_world_t *world = (ecs_world_t*)ecs_get_world(stage_world); - ecs_poly_assert(world, ecs_world_t); - - bool is_readonly = world->is_readonly; - bool is_deferred = ecs_is_deferred(world); - - if (!world->is_readonly && !is_deferred) { - state->is_readonly = false; - state->is_deferred = false; - return world; - } - - ecs_dbg_3("suspending readonly mode"); - - /* Cannot suspend when running with multiple threads */ - ecs_assert(ecs_get_stage_count(world) <= 1, - ECS_INVALID_WHILE_ITERATING, NULL); - - state->is_readonly = is_readonly; - state->is_deferred = is_deferred; - - /* Silence readonly checks */ - world->is_readonly = false; - - /* Hack around safety checks (this ought to look ugly) */ - ecs_world_t *temp_world = world; - ecs_stage_t *stage = flecs_stage_from_world(&temp_world); - state->defer_count = stage->defer; - state->defer_queue = stage->defer_queue; - state->scope = world->stage.scope; - state->with = world->stage.with; - stage->defer = 0; - stage->defer_queue = NULL; + va_list args; + va_start(args, fmt); + _ecs_logv(level, file, line, fmt, args); + va_end(args); +} - if (&world->stage != (ecs_stage_t*)stage_world) { - world->stage.scope = stage->scope; - world->stage.with = stage->with; +void _ecs_log_push( + int32_t level) +{ + if (level <= ecs_os_api.log_level_) { + ecs_os_api.log_indent_ ++; } - - return world; } -void flecs_resume_readonly( - ecs_world_t *world, - ecs_suspend_readonly_state_t *state) +void _ecs_log_pop( + int32_t level) { - ecs_poly_assert(world, ecs_world_t); - ecs_assert(state != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_world_t *temp_world = world; - ecs_stage_t *stage = flecs_stage_from_world(&temp_world); - - if (state->is_readonly || state->is_deferred) { - ecs_dbg_3("resuming readonly mode"); - - ecs_force_aperiodic(world); - - /* Restore readonly state / defer count */ - world->is_readonly = state->is_readonly; - stage->defer = state->defer_count; - stage->defer_queue = state->defer_queue; - world->stage.scope = state->scope; - world->stage.with = state->with; + if (level <= ecs_os_api.log_level_) { + ecs_os_api.log_indent_ --; } } -/* Evaluate component monitor. If a monitored entity changed it will have set a - * flag in one of the world's component monitors. Queries can register - * themselves with component monitors to determine whether they need to rematch - * with tables. */ -static -void eval_component_monitor( - ecs_world_t *world) +void _ecs_parser_errorv( + const char *name, + const char *expr, + int64_t column_arg, + const char *fmt, + va_list args) { - ecs_poly_assert(world, ecs_world_t); + int32_t column = flecs_itoi32(column_arg); - ecs_relation_monitor_t *rm = &world->monitors; + if (ecs_os_api.log_level_ >= -2) { + ecs_strbuf_t msg_buf = ECS_STRBUF_INIT; - if (!rm->is_dirty) { - return; - } + ecs_strbuf_vappend(&msg_buf, fmt, args); - ecs_map_iter_t it = ecs_map_iter(&rm->monitor_sets); - ecs_monitor_set_t *ms; + if (expr) { + ecs_strbuf_appendstr(&msg_buf, "\n"); - while ((ms = ecs_map_next(&it, ecs_monitor_set_t, NULL))) { - if (!ms->is_dirty) { - continue; - } + /* Find start of line by taking column and looking for the + * last occurring newline */ + if (column != -1) { + const char *ptr = &expr[column]; + while (ptr[0] != '\n' && ptr > expr) { + ptr --; + } - ecs_map_iter_t mit = ecs_map_iter(&ms->monitors); - ecs_monitor_t *m; - while ((m = ecs_map_next(&mit, ecs_monitor_t, NULL))) { - if (!m->is_dirty) { - continue; + if (ptr == expr) { + /* ptr is already at start of line */ + } else { + column -= (int32_t)(ptr - expr + 1); + expr = ptr + 1; + } } - ecs_vector_each(m->queries, ecs_query_t*, q_ptr, { - flecs_query_notify(world, *q_ptr, &(ecs_query_event_t) { - .kind = EcsQueryTableRematch - }); - }); + /* Strip newlines from current statement, if any */ + char *newline_ptr = strchr(expr, '\n'); + if (newline_ptr) { + /* Strip newline from expr */ + ecs_strbuf_appendstrn(&msg_buf, expr, + (int32_t)(newline_ptr - expr)); + } else { + ecs_strbuf_appendstr(&msg_buf, expr); + } - m->is_dirty = false; + ecs_strbuf_appendstr(&msg_buf, "\n"); + + if (column != -1) { + ecs_strbuf_append(&msg_buf, "%*s^", column, ""); + } } - ms->is_dirty = false; + char *msg = ecs_strbuf_get(&msg_buf); + ecs_os_err(name, 0, msg); + ecs_os_free(msg); } - - rm->is_dirty = false; } -void flecs_monitor_mark_dirty( - ecs_world_t *world, - ecs_entity_t relation, - ecs_entity_t id) +void _ecs_parser_error( + const char *name, + const char *expr, + int64_t column, + const char *fmt, + ...) { - /* Only flag if there are actually monitors registered, so that we - * don't waste cycles evaluating monitors if there's no interest */ - ecs_monitor_set_t *ms = ecs_map_get(&world->monitors.monitor_sets, - ecs_monitor_set_t, relation); - if (ms && ecs_map_is_initialized(&ms->monitors)) { - ecs_monitor_t *m = ecs_map_get(&ms->monitors, - ecs_monitor_t, id); - if (m) { - m->is_dirty = true; - ms->is_dirty = true; - world->monitors.is_dirty = true; - } + if (ecs_os_api.log_level_ >= -2) { + va_list args; + va_start(args, fmt); + _ecs_parser_errorv(name, expr, column, fmt, args); + va_end(args); } } -void flecs_monitor_register( - ecs_world_t *world, - ecs_entity_t relation, - ecs_entity_t id, - ecs_query_t *query) +void _ecs_abort( + int32_t err, + const char *file, + int32_t line, + const char *fmt, + ...) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_monitor_set_t *ms = ecs_map_ensure( - &world->monitors.monitor_sets, ecs_monitor_set_t, relation); - ecs_assert(ms != NULL, ECS_INTERNAL_ERROR, NULL); - - if (!ecs_map_is_initialized(&ms->monitors)) { - ecs_map_init(&ms->monitors, ecs_monitor_t, 1); + if (fmt) { + va_list args; + va_start(args, fmt); + char *msg = ecs_vasprintf(fmt, args); + va_end(args); + _ecs_fatal(file, line, "%s (%s)", msg, ecs_strerror(err)); + ecs_os_free(msg); + } else { + _ecs_fatal(file, line, "%s", ecs_strerror(err)); } - - ecs_monitor_t *m = ecs_map_ensure(&ms->monitors, ecs_monitor_t, id); - ecs_assert(m != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_query_t **q = ecs_vector_add(&m->queries, ecs_query_t*); - *q = query; + ecs_os_api.log_last_error_ = err; } -void flecs_monitor_unregister( - ecs_world_t *world, - ecs_entity_t relation, - ecs_entity_t id, - ecs_query_t *query) +bool _ecs_assert( + bool condition, + int32_t err, + const char *cond_str, + const char *file, + int32_t line, + const char *fmt, + ...) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_monitor_set_t *ms = ecs_map_get( - &world->monitors.monitor_sets, ecs_monitor_set_t, relation); - if (!ms) { - return; + if (!condition) { + if (fmt) { + va_list args; + va_start(args, fmt); + char *msg = ecs_vasprintf(fmt, args); + va_end(args); + _ecs_fatal(file, line, "assert: %s %s (%s)", + cond_str, msg, ecs_strerror(err)); + ecs_os_free(msg); + } else { + _ecs_fatal(file, line, "assert: %s %s", + cond_str, ecs_strerror(err)); + } + ecs_os_api.log_last_error_ = err; } - if (!ecs_map_is_initialized(&ms->monitors)) { - return; - } + return condition; +} - ecs_monitor_t *m = ecs_map_get(&ms->monitors, ecs_monitor_t, id); - if (!m) { - return; - } +void _ecs_deprecated( + const char *file, + int32_t line, + const char *msg) +{ + _ecs_err(file, line, "%s", msg); +} - int32_t i, count = ecs_vector_count(m->queries); - ecs_query_t **queries = ecs_vector_first(m->queries, ecs_query_t*); - for (i = 0; i < count; i ++) { - if (queries[i] == query) { - ecs_vector_remove(m->queries, ecs_query_t*, i); - count --; - break; - } +bool ecs_should_log(int32_t level) { +# if !defined(ECS_TRACE_3) + if (level == 3) { + return false; } - - if (!count) { - ecs_vector_free(m->queries); - ecs_map_remove(&ms->monitors, id); +# endif +# if !defined(ECS_TRACE_2) + if (level == 2) { + return false; } - - if (!ecs_map_count(&ms->monitors)) { - ecs_map_fini(&ms->monitors); - ecs_map_remove(&world->monitors.monitor_sets, relation); +# endif +# if !defined(ECS_TRACE_1) + if (level == 1) { + return false; } +# endif - if (!ecs_map_count(&world->monitors.monitor_sets)) { - ecs_map_fini(&world->monitors.monitor_sets); - } + return level <= ecs_os_api.log_level_; } -static -void monitors_init( - ecs_relation_monitor_t *rm) -{ - ecs_map_init(&rm->monitor_sets, ecs_monitor_set_t, 0); - rm->is_dirty = false; -} +#define ECS_ERR_STR(code) case code: return &(#code[4]) -static -void monitors_fini( - ecs_relation_monitor_t *rm) +const char* ecs_strerror( + int32_t error_code) { - ecs_map_iter_t it = ecs_map_iter(&rm->monitor_sets); - ecs_monitor_set_t *ms; - - while ((ms = ecs_map_next(&it, ecs_monitor_set_t, NULL))) { - ecs_map_iter_t mit = ecs_map_iter(&ms->monitors); - ecs_monitor_t *m; - while ((m = ecs_map_next(&mit, ecs_monitor_t, NULL))) { - ecs_vector_free(m->queries); - } - - ecs_map_fini(&ms->monitors); + switch (error_code) { + ECS_ERR_STR(ECS_INVALID_PARAMETER); + ECS_ERR_STR(ECS_NOT_A_COMPONENT); + ECS_ERR_STR(ECS_INTERNAL_ERROR); + ECS_ERR_STR(ECS_ALREADY_DEFINED); + ECS_ERR_STR(ECS_INVALID_COMPONENT_SIZE); + ECS_ERR_STR(ECS_INVALID_COMPONENT_ALIGNMENT); + ECS_ERR_STR(ECS_NAME_IN_USE); + ECS_ERR_STR(ECS_OUT_OF_MEMORY); + ECS_ERR_STR(ECS_OPERATION_FAILED); + ECS_ERR_STR(ECS_INVALID_CONVERSION); + ECS_ERR_STR(ECS_MODULE_UNDEFINED); + ECS_ERR_STR(ECS_MISSING_SYMBOL); + ECS_ERR_STR(ECS_ALREADY_IN_USE); + ECS_ERR_STR(ECS_COLUMN_INDEX_OUT_OF_RANGE); + ECS_ERR_STR(ECS_COLUMN_IS_NOT_SHARED); + ECS_ERR_STR(ECS_COLUMN_IS_SHARED); + ECS_ERR_STR(ECS_COLUMN_TYPE_MISMATCH); + ECS_ERR_STR(ECS_INVALID_WHILE_ITERATING); + ECS_ERR_STR(ECS_INVALID_FROM_WORKER); + ECS_ERR_STR(ECS_OUT_OF_RANGE); + ECS_ERR_STR(ECS_MISSING_OS_API); + ECS_ERR_STR(ECS_UNSUPPORTED); + ECS_ERR_STR(ECS_COLUMN_ACCESS_VIOLATION); + ECS_ERR_STR(ECS_COMPONENT_NOT_REGISTERED); + ECS_ERR_STR(ECS_INCONSISTENT_COMPONENT_ID); + ECS_ERR_STR(ECS_TYPE_INVALID_CASE); + ECS_ERR_STR(ECS_INCONSISTENT_NAME); + ECS_ERR_STR(ECS_INCONSISTENT_COMPONENT_ACTION); + ECS_ERR_STR(ECS_INVALID_OPERATION); + ECS_ERR_STR(ECS_CONSTRAINT_VIOLATED); + ECS_ERR_STR(ECS_LOCKED_STORAGE); + ECS_ERR_STR(ECS_ID_IN_USE); } - ecs_map_fini(&rm->monitor_sets); + return "unknown error code"; } -static -void init_store( - ecs_world_t *world) -{ - ecs_os_memset(&world->store, 0, ECS_SIZEOF(ecs_store_t)); - - /* Initialize entity index */ - flecs_sparse_init(&world->store.entity_index, ecs_record_t); - flecs_sparse_set_id_source(&world->store.entity_index, - &world->stats.last_id); +#else - /* Initialize root table */ - flecs_sparse_init(&world->store.tables, ecs_table_t); +/* Empty bodies for when logging is disabled */ - /* Initialize table map */ - flecs_table_hashmap_init(&world->store.table_map); +void _ecs_log( + int32_t level, + const char *file, + int32_t line, + const char *fmt, + ...) +{ + (void)level; + (void)file; + (void)line; + (void)fmt; +} - /* Initialize one root table per stage */ - flecs_init_root_table(world); +void _ecs_parser_error( + const char *name, + const char *expr, + int64_t column, + const char *fmt, + ...) +{ + (void)name; + (void)expr; + (void)column; + (void)fmt; } -static -void clean_tables( - ecs_world_t *world) +void _ecs_parser_errorv( + const char *name, + const char *expr, + int64_t column, + const char *fmt, + va_list args) { - int32_t i, count = flecs_sparse_count(&world->store.tables); + (void)name; + (void)expr; + (void)column; + (void)fmt; + (void)args; +} - /* Ensure that first table in sparse set has id 0. This is a dummy table - * that only exists so that there is no table with id 0 */ - ecs_table_t *first = flecs_sparse_get_dense(&world->store.tables, - ecs_table_t, 0); - ecs_assert(first->id == 0, ECS_INTERNAL_ERROR, NULL); - (void)first; +void _ecs_abort( + int32_t error_code, + const char *file, + int32_t line, + const char *fmt, + ...) +{ + (void)error_code; + (void)file; + (void)line; + (void)fmt; +} - for (i = 1; i < count; i ++) { - ecs_table_t *t = flecs_sparse_get_dense(&world->store.tables, - ecs_table_t, i); - flecs_table_release(world, t); - } - - /* Free table types separately so that if application destructors rely on - * a type it's still valid. */ - for (i = 1; i < count; i ++) { - ecs_table_t *t = flecs_sparse_get_dense(&world->store.tables, - ecs_table_t, i); - flecs_table_free_type(t); - } - - /* Clear the root table */ - if (count) { - flecs_table_reset(world, &world->store.root); - } +bool _ecs_assert( + bool condition, + int32_t error_code, + const char *condition_str, + const char *file, + int32_t line, + const char *fmt, + ...) +{ + (void)condition; + (void)error_code; + (void)condition_str; + (void)file; + (void)line; + (void)fmt; + return true; } -static -void fini_store(ecs_world_t *world) { - clean_tables(world); - flecs_sparse_fini(&world->store.tables); - flecs_table_release(world, &world->store.root); - flecs_sparse_clear(&world->store.entity_index); - flecs_hashmap_fini(&world->store.table_map); +#endif - ecs_graph_edge_hdr_t *cur, *next = world->store.first_free; - while ((cur = next)) { - next = cur->next; - ecs_os_free(cur); - } +int ecs_log_set_level( + int level) +{ + int prev = level; + ecs_os_api.log_level_ = level; + return prev; } -/* Implementation for iterable mixin */ -static -bool world_iter_next( - ecs_iter_t *it) +bool ecs_log_enable_colors( + bool enabled) { - if (it->is_valid) { - return it->is_valid = false; - } - - ecs_world_t *world = it->real_world; - ecs_sparse_t *entity_index = &world->store.entity_index; - it->entities = (ecs_entity_t*)flecs_sparse_ids(entity_index); - it->count = flecs_sparse_count(entity_index); - return it->is_valid = true; + bool prev = ecs_os_api.log_with_color_; + ecs_os_api.log_with_color_ = enabled; + return prev; } -static -void world_iter_init( - const ecs_world_t *world, - const ecs_poly_t *poly, - ecs_iter_t *iter, - ecs_term_t *filter) +int ecs_log_last_error(void) { - ecs_poly_assert(poly, ecs_world_t); - (void)poly; - - if (filter) { - iter[0] = ecs_term_iter(world, filter); - } else { - iter[0] = (ecs_iter_t){ - .world = (ecs_world_t*)world, - .real_world = (ecs_world_t*)ecs_get_world(world), - .next = world_iter_next - }; - } + int result = ecs_os_api.log_last_error_; + ecs_os_api.log_last_error_ = 0; + return result; } -static -void log_addons(void) { - ecs_trace("addons included in build:"); - ecs_log_push(); - #ifdef FLECS_CPP - ecs_trace("FLECS_CPP"); - #endif - #ifdef FLECS_MODULE - ecs_trace("FLECS_MODULE"); - #endif - #ifdef FLECS_PARSER - ecs_trace("FLECS_PARSER"); - #endif - #ifdef FLECS_PLECS - ecs_trace("FLECS_PLECS"); - #endif - #ifdef FLECS_RULES - ecs_trace("FLECS_RULES"); - #endif - #ifdef FLECS_SNAPSHOT - ecs_trace("FLECS_SNAPSHOT"); - #endif - #ifdef FLECS_STATS - ecs_trace("FLECS_STATS"); - #endif - #ifdef FLECS_SYSTEM - ecs_trace("FLECS_SYSTEM"); - #endif - #ifdef FLECS_PIPELINE - ecs_trace("FLECS_PIPELINE"); - #endif - #ifdef FLECS_TIMER - ecs_trace("FLECS_TIMER"); - #endif - #ifdef FLECS_META - ecs_trace("FLECS_META"); - #endif - #ifdef FLECS_META_C - ecs_trace("FLECS_META_C"); - #endif - #ifdef FLECS_UNITS - ecs_trace("FLECS_UNITS"); - #endif - #ifdef FLECS_EXPR - ecs_trace("FLECS_EXPR"); - #endif - #ifdef FLECS_JSON - ecs_trace("FLECS_JSON"); - #endif - #ifdef FLECS_DOC - ecs_trace("FLECS_DOC"); - #endif - #ifdef FLECS_COREDOC - ecs_trace("FLECS_COREDOC"); - #endif - #ifdef FLECS_LOG - ecs_trace("FLECS_LOG"); - #endif - #ifdef FLECS_APP - ecs_trace("FLECS_APP"); - #endif - #ifdef FLECS_OS_API_IMPL - ecs_trace("FLECS_OS_API_IMPL"); - #endif - #ifdef FLECS_HTTP - ecs_trace("FLECS_HTTP"); - #endif - #ifdef FLECS_REST - ecs_trace("FLECS_REST"); - #endif - ecs_log_pop(); -} +#ifndef FLECS_SYSTEM_PRIVATE_H +#define FLECS_SYSTEM_PRIVATE_H -/* -- Public functions -- */ +#ifdef FLECS_SYSTEM -ecs_world_t *ecs_mini(void) { -#ifdef FLECS_OS_API_IMPL - ecs_set_os_api_impl(); -#endif - ecs_os_init(); - ecs_trace("#[bold]bootstrapping world"); - ecs_log_push(); +typedef struct EcsSystem { + ecs_run_action_t run; /* See ecs_system_desc_t */ + ecs_iter_action_t action; /* See ecs_system_desc_t */ - ecs_trace("tracing enabled, call ecs_log_set_level(-1) to disable"); + ecs_entity_t entity; /* Entity id of system, used for ordering */ + ecs_query_t *query; /* System query */ + ecs_system_status_action_t status_action; /* Status action */ + ecs_entity_t tick_source; /* Tick source associated with system */ + + /* Schedule parameters */ + bool multi_threaded; + bool no_staging; - if (!ecs_os_has_heap()) { - ecs_abort(ECS_MISSING_OS_API, NULL); - } + int32_t invoke_count; /* Number of times system is invoked */ + float time_spent; /* Time spent on running system */ + FLECS_FLOAT time_passed; /* Time passed since last invocation */ + int32_t last_frame; /* Last frame for which the system was considered */ - if (!ecs_os_has_threading()) { - ecs_trace("threading unavailable, to use threads set OS API first (see examples)"); - } + ecs_entity_t self; /* Entity associated with system */ - if (!ecs_os_has_time()) { - ecs_trace("time management not available"); - } + void *ctx; /* Userdata for system */ + void *status_ctx; /* User data for status action */ + void *binding_ctx; /* Optional language binding context */ - log_addons(); + ecs_ctx_free_t ctx_free; + ecs_ctx_free_t status_ctx_free; + ecs_ctx_free_t binding_ctx_free; +} EcsSystem; + +/* Invoked when system becomes active / inactive */ +void ecs_system_activate( + ecs_world_t *world, + ecs_entity_t system, + bool activate, + const EcsSystem *system_data); + +/* Internal function to run a system */ +ecs_entity_t ecs_run_intern( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t system, + EcsSystem *system_data, + int32_t stage_current, + int32_t stage_count, + FLECS_FLOAT delta_time, + int32_t offset, + int32_t limit, + void *param); -#ifdef FLECS_SANITIZE - ecs_trace("sanitize build, rebuild witohut FLECS_SANITIZE for (much) " - "improved performance"); -#elif defined(FLECS_DEBUG) - ecs_trace("debug build, rebuild with NDEBUG or FLECS_NDEBUG for improved " - "performance"); -#else - ecs_trace("#[green]release#[reset] build"); #endif -#ifdef __clang__ - ecs_trace("compiled with clang %s", __clang_version__); -#elif defined(__GNUC__) - ecs_trace("compiled with gcc %d.%d", __GNUC__, __GNUC_MINOR__); -#elif defined (_MSC_VER) - ecs_trace("compiled with msvc %d", _MSC_VER); #endif - ecs_world_t *world = ecs_os_calloc_t(ecs_world_t); - ecs_assert(world != NULL, ECS_OUT_OF_MEMORY, NULL); - ecs_poly_init(world, ecs_world_t); - world->self = world; - world->type_info = flecs_sparse_new(ecs_type_info_t); - ecs_map_init(&world->id_index, ecs_id_record_t*, ECS_HI_COMPONENT_ID); - flecs_observable_init(&world->observable); - world->iterable.init = world_iter_init; +#ifdef FLECS_PIPELINE +#ifndef FLECS_PIPELINE_PRIVATE_H +#define FLECS_PIPELINE_PRIVATE_H - world->queries = flecs_sparse_new(ecs_query_t); - world->triggers = flecs_sparse_new(ecs_trigger_t); - world->observers = flecs_sparse_new(ecs_observer_t); - - world->pending_tables = flecs_sparse_new(ecs_table_t*); - world->pending_buffer = flecs_sparse_new(ecs_table_t*); - world->fini_tasks = ecs_vector_new(ecs_entity_t, 0); - flecs_name_index_init(&world->aliases); - flecs_name_index_init(&world->symbols); - ecs_map_init(&world->type_handles, ecs_entity_t, 0); +/** Instruction data for pipeline. + * This type is the element type in the "ops" vector of a pipeline and contains + * information about the set of systems that need to be ran before a merge. */ +typedef struct ecs_pipeline_op_t { + int32_t count; /* Number of systems to run before merge */ + bool multi_threaded; /* Whether systems can be ran multi threaded */ + bool no_staging; /* Whether systems are staged or not */ +} ecs_pipeline_op_t; - world->stats.time_scale = 1.0; - - monitors_init(&world->monitors); +typedef struct EcsPipelineQuery { + ecs_query_t *query; + ecs_query_t *build_query; + ecs_vector_t *ops; + int32_t match_count; + int32_t rebuild_count; + ecs_entity_t last_system; +} EcsPipelineQuery; - if (ecs_os_has_time()) { - ecs_os_get_time(&world->world_start_time); - } +//////////////////////////////////////////////////////////////////////////////// +//// Pipeline API +//////////////////////////////////////////////////////////////////////////////// - flecs_stage_init(world, &world->stage); - ecs_set_stages(world, 1); +/** Update a pipeline (internal function). + * Before running a pipeline, it must be updated. During this update phase + * all systems in the pipeline are collected, ordered and sync points are + * inserted where necessary. This operation may only be called when staging is + * disabled. + * + * Because multiple threads may run a pipeline, preparing the pipeline must + * happen synchronously, which is why this function is separate from + * ecs_run_pipeline. Not running the prepare step may cause systems to not get + * ran, or ran in the wrong order. + * + * If 0 is provided for the pipeline id, the default pipeline will be ran (this + * is either the builtin pipeline or the pipeline set with set_pipeline()). + * + * @param world The world. + * @param pipeline The pipeline to run. + * @return The number of elements in the pipeline. + */ +bool ecs_pipeline_update( + ecs_world_t *world, + ecs_entity_t pipeline, + bool start_of_frame); - ecs_default_lookup_path[0] = EcsFlecsCore; - ecs_set_lookup_path(world, ecs_default_lookup_path); +int32_t ecs_pipeline_reset_iter( + ecs_world_t *world, + const EcsPipelineQuery *pq, + ecs_iter_t *iter_out, + ecs_pipeline_op_t **op_out, + ecs_pipeline_op_t **last_op_out); - init_store(world); - ecs_trace("table store initialized"); +//////////////////////////////////////////////////////////////////////////////// +//// Worker API +//////////////////////////////////////////////////////////////////////////////// - flecs_bootstrap(world); +void ecs_worker_begin( + ecs_world_t *world); - ecs_trace("world ready!"); - ecs_log_pop(); +int32_t ecs_worker_sync( + ecs_world_t *world, + const EcsPipelineQuery *pq, + ecs_iter_t *it, + int32_t i, + ecs_pipeline_op_t **op_out, + ecs_pipeline_op_t **last_op_out); - return world; -} +void ecs_worker_end( + ecs_world_t *world); -ecs_world_t *ecs_init(void) { - ecs_world_t *world = ecs_mini(); +void ecs_workers_progress( + ecs_world_t *world, + ecs_entity_t pipeline, + FLECS_FLOAT delta_time); -#ifdef FLECS_MODULE_H - ecs_trace("#[bold]import addons"); - ecs_log_push(); - ecs_trace("use ecs_mini to create world without importing addons"); -#ifdef FLECS_SYSTEM - ECS_IMPORT(world, FlecsSystem); -#endif -#ifdef FLECS_PIPELINE - ECS_IMPORT(world, FlecsPipeline); -#endif -#ifdef FLECS_TIMER - ECS_IMPORT(world, FlecsTimer); -#endif -#ifdef FLECS_META - ECS_IMPORT(world, FlecsMeta); -#endif -#ifdef FLECS_DOC - ECS_IMPORT(world, FlecsDoc); -#endif -#ifdef FLECS_COREDOC - ECS_IMPORT(world, FlecsCoreDoc); -#endif -#ifdef FLECS_REST - ECS_IMPORT(world, FlecsRest); -#endif -#ifdef FLECS_UNITS - ecs_trace("#[green]module#[reset] flecs.units is not automatically imported"); -#endif - ecs_trace("addons imported!"); - ecs_log_pop(); #endif - return world; -} -#define ARG(short, long, action)\ - if (i < argc) {\ - if (argv[i][0] == '-') {\ - if (argv[i][1] == '-') {\ - if (long && !strcmp(&argv[i][2], long ? long : "")) {\ - action;\ - parsed = true;\ - }\ - } else {\ - if (short && argv[i][1] == short) {\ - action;\ - parsed = true;\ - }\ - }\ - }\ - } -ecs_world_t* ecs_init_w_args( - int argc, - char *argv[]) -{ - ecs_world_t *world = ecs_init(); +/* Worker thread */ +static +void* worker(void *arg) { + ecs_stage_t *stage = arg; + ecs_world_t *world = stage->world; - (void)argc; - (void) argv; + /* Start worker thread, increase counter so main thread knows how many + * workers are ready */ + ecs_os_mutex_lock(world->sync_mutex); + world->workers_running ++; -#ifdef FLECS_DOC - if (argc) { - char *app = argv[0]; - char *last_elem = strrchr(app, '/'); - if (!last_elem) { - last_elem = strrchr(app, '\\'); - } - if (last_elem) { - app = last_elem + 1; - } - ecs_set_pair(world, EcsWorld, EcsDocDescription, EcsName, {app}); + if (!world->quit_workers) { + ecs_os_cond_wait(world->worker_cond, world->sync_mutex); } -#endif - return world; -} + ecs_os_mutex_unlock(world->sync_mutex); -void ecs_quit( - ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - flecs_stage_from_world(&world); - world->should_quit = true; -error: - return; -} + while (!world->quit_workers) { + ecs_entity_t old_scope = ecs_set_scope((ecs_world_t*)stage, 0); + + ecs_run_pipeline( + (ecs_world_t*)stage, + world->pipeline, + world->stats.delta_time); -bool ecs_should_quit( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - world = ecs_get_world(world); - return world->should_quit; -error: - return true; + ecs_set_scope((ecs_world_t*)stage, old_scope); + } + + ecs_os_mutex_lock(world->sync_mutex); + world->workers_running --; + ecs_os_mutex_unlock(world->sync_mutex); + + return NULL; } -void flecs_notify_tables( +/* Start threads */ +static +void start_workers( ecs_world_t *world, - ecs_id_t id, - ecs_table_event_t *event) + int32_t threads) { - ecs_poly_assert(world, ecs_world_t); - - /* If no id is specified, broadcast to all tables */ - if (!id) { - ecs_sparse_t *tables = &world->store.tables; - int32_t i, count = flecs_sparse_count(tables); - for (i = 0; i < count; i ++) { - ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); - flecs_table_notify(world, table, event); - } - - /* If id is specified, only broadcast to tables with id */ - } else { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return; - } + ecs_set_stages(world, threads); - ecs_table_cache_iter_t it; - const ecs_table_record_t *tr; + ecs_assert(ecs_get_stage_count(world) == threads, ECS_INTERNAL_ERROR, NULL); - flecs_table_cache_iter(&idr->cache, &it); - while ((tr = flecs_table_cache_next(&it, ecs_table_record_t))) { - flecs_table_notify(world, tr->hdr.table, event); - } + int32_t i; + for (i = 0; i < threads; i ++) { + ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); + ecs_assert(stage != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_poly_assert(stage, ecs_stage_t); - flecs_table_cache_empty_iter(&idr->cache, &it); - while ((tr = flecs_table_cache_next(&it, ecs_table_record_t))) { - flecs_table_notify(world, tr->hdr.table, event); - } + ecs_vector_get(world->worker_stages, ecs_stage_t, i); + stage->thread = ecs_os_thread_new(worker, stage); + ecs_assert(stage->thread != 0, ECS_OPERATION_FAILED, NULL); } } -void ecs_default_ctor( - ecs_world_t *world, - const ecs_entity_t *entity_ptr, - void *ptr, - int32_t count, - const ecs_type_info_t *ti) -{ - (void)world; (void)entity_ptr; - ecs_os_memset(ptr, 0, ti->size * count); -} - +/* Wait until all workers are running */ static -void default_copy_ctor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, const void *src_ptr, - int32_t count, const ecs_type_info_t *ti) +void wait_for_workers( + ecs_world_t *world) { - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->ctor(world, dst_entity, dst_ptr, count, ti); - cl->copy(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); -} + int32_t stage_count = ecs_get_stage_count(world); + bool wait = true; -static -void default_move_ctor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) -{ - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->ctor(world, dst_entity, dst_ptr, count, ti); - cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); + do { + ecs_os_mutex_lock(world->sync_mutex); + if (world->workers_running == stage_count) { + wait = false; + } + ecs_os_mutex_unlock(world->sync_mutex); + } while (wait); } +/* Synchronize worker threads */ static -void default_ctor_w_move_w_dtor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) +void sync_worker( + ecs_world_t *world) { - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->ctor(world, dst_entity, dst_ptr, count, ti); - cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); - cl->dtor(world, src_entity, src_ptr, count, ti); + int32_t stage_count = ecs_get_stage_count(world); + + /* Signal that thread is waiting */ + ecs_os_mutex_lock(world->sync_mutex); + if (++ world->workers_waiting == stage_count) { + /* Only signal main thread when all threads are waiting */ + ecs_os_cond_signal(world->sync_cond); + } + + /* Wait until main thread signals that thread can continue */ + ecs_os_cond_wait(world->worker_cond, world->sync_mutex); + ecs_os_mutex_unlock(world->sync_mutex); } +/* Wait until all threads are waiting on sync point */ static -void default_move_ctor_w_dtor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) +void wait_for_sync( + ecs_world_t *world) { - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->move_ctor(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); - cl->dtor(world, src_entity, src_ptr, count, ti); + int32_t stage_count = ecs_get_stage_count(world); + + ecs_os_mutex_lock(world->sync_mutex); + if (world->workers_waiting != stage_count) { + ecs_os_cond_wait(world->sync_cond, world->sync_mutex); + } + + /* We should have been signalled unless all workers are waiting on sync */ + ecs_assert(world->workers_waiting == stage_count, + ECS_INTERNAL_ERROR, NULL); + + ecs_os_mutex_unlock(world->sync_mutex); } +/* Signal workers that they can start/resume work */ static -void default_move( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) +void signal_workers( + ecs_world_t *world) { - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); + ecs_os_mutex_lock(world->sync_mutex); + ecs_os_cond_broadcast(world->worker_cond); + ecs_os_mutex_unlock(world->sync_mutex); } +/** Stop worker threads */ static -void default_dtor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) +bool ecs_stop_threads( + ecs_world_t *world) { - (void)src_entity; + bool threads_active = false; - /* When there is no move, destruct the destination component & memcpy the - * component to dst. The src component does not have to be destructed when - * a component has a trivial move. */ - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->dtor(world, dst_entity, dst_ptr, count, ti); - ecs_os_memcpy(dst_ptr, src_ptr, flecs_uto(ecs_size_t, ti->size) * count); -} + /* Test if threads are created. Cannot use workers_running, since this is + * a potential race if threads haven't spun up yet. */ + ecs_vector_each(world->worker_stages, ecs_stage_t, stage, { + if (stage->thread) { + threads_active = true; + break; + } + stage->thread = 0; + }); -static -void default_move_w_dtor( - ecs_world_t *world, const ecs_entity_t *dst_entity, - const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, - int32_t count, const ecs_type_info_t *ti) -{ - /* If a component has a move, the move will take care of memcpying the data - * and destroying any data in dst. Because this is not a trivial move, the - * src component must also be destructed. */ - const EcsComponentLifecycle *cl = &ti->lifecycle; - cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); - cl->dtor(world, src_entity, src_ptr, count, ti); + /* If no threads are active, just return */ + if (!threads_active) { + return false; + } + + /* Make sure all threads are running, to ensure they catch the signal */ + wait_for_workers(world); + + /* Signal threads should quit */ + world->quit_workers = true; + signal_workers(world); + + /* Join all threads with main */ + ecs_stage_t *stages = ecs_vector_first(world->worker_stages, ecs_stage_t); + int32_t i, count = ecs_vector_count(world->worker_stages); + for (i = 0; i < count; i ++) { + ecs_os_thread_join(stages[i].thread); + stages[i].thread = 0; + } + + world->quit_workers = false; + ecs_assert(world->workers_running == 0, ECS_INTERNAL_ERROR, NULL); + + /* Deinitialize stages */ + ecs_set_stages(world, 0); + + return true; } -void ecs_set_component_actions_w_id( - ecs_world_t *world, - ecs_entity_t component, - EcsComponentLifecycle *lifecycle) +/* -- Private functions -- */ + +void ecs_worker_begin( + ecs_world_t *world) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); flecs_stage_from_world(&world); + int32_t stage_count = ecs_get_stage_count(world); + ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); + + if (stage_count == 1) { + ecs_entity_t pipeline = world->pipeline; + const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); + ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_type_info_t *ti = flecs_ensure_type_info(world, component); - ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_pipeline_op_t *op = ecs_vector_first(pq->ops, ecs_pipeline_op_t); + if (!op || !op->no_staging) { + ecs_staging_begin(world); + } + } +} - ecs_size_t size = ti->size; - ecs_size_t alignment = ti->alignment; +int32_t ecs_worker_sync( + ecs_world_t *world, + const EcsPipelineQuery *pq, + ecs_iter_t *it, + int32_t i, + ecs_pipeline_op_t **op_out, + ecs_pipeline_op_t **last_op_out) +{ + int32_t stage_count = ecs_get_stage_count(world); + ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); + int32_t build_count = world->stats.pipeline_build_count_total; - if (!size) { - const EcsComponent *component_ptr = ecs_get( - world, component, EcsComponent); + /* If there are no threads, merge in place */ + if (stage_count == 1) { + if (!op_out[0]->no_staging) { + ecs_staging_end(world); + } - /* Cannot register lifecycle actions for things that aren't a component */ - ecs_check(component_ptr != NULL, ECS_INVALID_PARAMETER, NULL); - /* Cannot register lifecycle actions for components with size 0 */ - ecs_check(component_ptr->size != 0, ECS_INVALID_PARAMETER, NULL); + ecs_pipeline_update(world, world->pipeline, false); - size = component_ptr->size; - alignment = component_ptr->alignment; + /* Synchronize all workers. The last worker to reach the sync point will + * signal the main thread, which will perform the merge. */ + } else { + sync_worker(world); } - if (ti->lifecycle_set) { - ecs_assert(ti->component == component, ECS_INTERNAL_ERROR, NULL); - ecs_check(!lifecycle->ctor || ti->lifecycle.ctor == lifecycle->ctor, - ECS_INCONSISTENT_COMPONENT_ACTION, NULL); - ecs_check(!lifecycle->dtor || ti->lifecycle.dtor == lifecycle->dtor, - ECS_INCONSISTENT_COMPONENT_ACTION, NULL); - ecs_check(!lifecycle->copy || ti->lifecycle.copy == lifecycle->copy, - ECS_INCONSISTENT_COMPONENT_ACTION, NULL); - ecs_check(!lifecycle->move || ti->lifecycle.move == lifecycle->move, - ECS_INCONSISTENT_COMPONENT_ACTION, NULL); - - if (!ti->lifecycle.on_set) { - ti->lifecycle.on_set = lifecycle->on_set; - } - if (!ti->lifecycle.on_remove) { - ti->lifecycle.on_remove = lifecycle->on_remove; - } + if (build_count != world->stats.pipeline_build_count_total) { + i = ecs_pipeline_reset_iter(world, pq, it, op_out, last_op_out); } else { - ti->component = component; - ti->lifecycle = *lifecycle; - ti->lifecycle_set = true; - ti->size = size; - ti->alignment = alignment; + op_out[0] ++; + } - /* If no constructor is set, invoking any of the other lifecycle actions - * is not safe as they will potentially access uninitialized memory. For - * ease of use, if no constructor is specified, set a default one that - * initializes the component to 0. */ - if (!lifecycle->ctor && - (lifecycle->dtor || lifecycle->copy || lifecycle->move)) - { - ti->lifecycle.ctor = ecs_default_ctor; + if (stage_count == 1) { + if (!op_out[0]->no_staging) { + ecs_staging_begin(world); } + } - /* Set default copy ctor, move ctor and merge */ - if (lifecycle->copy && !lifecycle->copy_ctor) { - ti->lifecycle.copy_ctor = default_copy_ctor; - } + return i; +} - if (lifecycle->move && !lifecycle->move_ctor) { - ti->lifecycle.move_ctor = default_move_ctor; - } +void ecs_worker_end( + ecs_world_t *world) +{ + flecs_stage_from_world(&world); - if (!lifecycle->ctor_move_dtor) { - if (lifecycle->move) { - if (lifecycle->dtor) { - if (lifecycle->move_ctor) { - /* If an explicit move ctor has been set, use callback - * that uses the move ctor vs. using a ctor+move */ - ti->lifecycle.ctor_move_dtor = - default_move_ctor_w_dtor; - } else { - /* If no explicit move_ctor has been set, use - * combination of ctor + move + dtor */ - ti->lifecycle.ctor_move_dtor = - default_ctor_w_move_w_dtor; - } - } else { - /* If no dtor has been set, this is just a move ctor */ - ti->lifecycle.ctor_move_dtor = - ti->lifecycle.move_ctor; - } - } - } + int32_t stage_count = ecs_get_stage_count(world); + ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); - if (!lifecycle->move_dtor) { - if (lifecycle->move) { - if (lifecycle->dtor) { - ti->lifecycle.move_dtor = default_move_w_dtor; - } else { - ti->lifecycle.move_dtor = default_move; - } - } else { - if (lifecycle->dtor) { - ti->lifecycle.move_dtor = default_dtor; - } - } + /* If there are no threads, merge in place */ + if (stage_count == 1) { + if (ecs_stage_is_readonly(world)) { + ecs_staging_end(world); } - /* Ensure that no tables have yet been created for the component */ - ecs_assert( flecs_id_existst(world, component) == false, - ECS_ALREADY_IN_USE, ecs_get_name(world, component)); - ecs_assert( flecs_id_existst(world, - ecs_pair(component, EcsWildcard)) == false, - ECS_ALREADY_IN_USE, ecs_get_name(world, component)); + /* Synchronize all workers. The last worker to reach the sync point will + * signal the main thread, which will perform the merge. */ + } else { + sync_worker(world); } -error: - return; -} - -bool ecs_component_has_actions( - const ecs_world_t *world, - ecs_entity_t component) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(component != 0, ECS_INVALID_PARAMETER, NULL); - - world = ecs_get_world(world); - const ecs_type_info_t *ti = flecs_get_type_info(world, component); - return (ti != NULL) && ti->lifecycle_set; -error: - return false; } -void ecs_atfini( +void ecs_workers_progress( ecs_world_t *world, - ecs_fini_action_t action, - void *ctx) + ecs_entity_t pipeline, + FLECS_FLOAT delta_time) { ecs_poly_assert(world, ecs_world_t); - ecs_check(action != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t stage_count = ecs_get_stage_count(world); - ecs_action_elem_t *elem = ecs_vector_add(&world->fini_actions, - ecs_action_elem_t); - ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_time_t start = {0}; + if (world->measure_frame_time) { + ecs_time_measure(&start); + } - elem->action = action; - elem->ctx = ctx; -error: - return; -} + if (stage_count == 1) { + ecs_pipeline_update(world, pipeline, true); + ecs_entity_t old_scope = ecs_set_scope(world, 0); + ecs_world_t *stage = ecs_get_stage(world, 0); + ecs_run_pipeline(stage, pipeline, delta_time); + ecs_set_scope(world, old_scope); + } else { + ecs_pipeline_update(world, pipeline, true); -void ecs_run_post_frame( - ecs_world_t *world, - ecs_fini_action_t action, - void *ctx) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(action != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_stage_t *stage = flecs_stage_from_world(&world); - ecs_action_elem_t *elem = ecs_vector_add(&stage->post_frame_actions, - ecs_action_elem_t); - ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); + const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); + ecs_vector_t *ops = pq->ops; + ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); + ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); - elem->action = action; - elem->ctx = ctx; -error: - return; -} + /* Make sure workers are running and ready */ + wait_for_workers(world); -/* Unset data in tables */ -static -void fini_unset_tables( - ecs_world_t *world) -{ - ecs_sparse_t *tables = &world->store.tables; - int32_t i, count = flecs_sparse_count(tables); + /* Synchronize n times for each op in the pipeline */ + for (; op <= op_last; op ++) { + if (!op->no_staging) { + ecs_staging_begin(world); + } - for (i = 0; i < count; i ++) { - ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); - flecs_table_remove_actions(world, table); + /* Signal workers that they should start running systems */ + world->workers_waiting = 0; + signal_workers(world); + + /* Wait until all workers are waiting on sync point */ + wait_for_sync(world); + + /* Merge */ + if (!op->no_staging) { + ecs_staging_end(world); + } + + if (ecs_pipeline_update(world, pipeline, false)) { + /* Refetch, in case pipeline itself has moved */ + pq = ecs_get(world, pipeline, EcsPipelineQuery); + + /* Pipeline has changed, reset position in pipeline */ + ecs_iter_t it; + ecs_pipeline_reset_iter(world, pq, &it, &op, &op_last); + op --; + } + } } + + if (world->measure_frame_time) { + world->stats.system_time_total += (float)ecs_time_measure(&start); + } } -/* Invoke fini actions */ -static -void fini_actions( - ecs_world_t *world) +/* -- Public functions -- */ + +void ecs_set_threads( + ecs_world_t *world, + int32_t threads) { - ecs_vector_each(world->fini_actions, ecs_action_elem_t, elem, { - elem->action(world, elem->ctx); - }); + ecs_assert(threads <= 1 || ecs_os_has_threading(), ECS_MISSING_OS_API, NULL); - ecs_vector_free(world->fini_actions); -} + int32_t stage_count = ecs_get_stage_count(world); -/* Cleanup component lifecycle callbacks & systems */ -static -void fini_component_lifecycle( - ecs_world_t *world) -{ - flecs_sparse_free(world->type_info); -} + if (stage_count != threads) { + /* Stop existing threads */ + if (stage_count > 1) { + if (ecs_stop_threads(world)) { + ecs_os_cond_free(world->worker_cond); + ecs_os_cond_free(world->sync_cond); + ecs_os_mutex_free(world->sync_mutex); + } + } -/* Cleanup queries */ -static -void fini_queries( - ecs_world_t *world) -{ - monitors_fini(&world->monitors); - - int32_t i, count = flecs_sparse_count(world->queries); - for (i = 0; i < count; i ++) { - ecs_query_t *query = flecs_sparse_get_dense(world->queries, ecs_query_t, 0); - ecs_query_fini(query); + /* Start threads if number of threads > 1 */ + if (threads > 1) { + world->worker_cond = ecs_os_cond_new(); + world->sync_cond = ecs_os_cond_new(); + world->sync_mutex = ecs_os_mutex_new(); + start_workers(world, threads); + } } - flecs_sparse_free(world->queries); } -static -void fini_observers( - ecs_world_t *world) -{ - flecs_sparse_free(world->observers); -} +#endif + + +#ifdef FLECS_PIPELINE + +static ECS_DTOR(EcsPipelineQuery, ptr, { + ecs_vector_free(ptr->ops); +}) -/* Cleanup stages */ static -void fini_stages( - ecs_world_t *world) +int compare_entity( + ecs_entity_t e1, + const void *ptr1, + ecs_entity_t e2, + const void *ptr2) { - flecs_stage_deinit(world, &world->stage); - ecs_set_stages(world, 0); + (void)ptr1; + (void)ptr2; + return (e1 > e2) - (e1 < e2); } static -ecs_id_record_t* new_id_record( +uint64_t group_by_phase( ecs_world_t *world, - ecs_id_t id) + ecs_type_t type, + ecs_entity_t pipeline, + void *ctx) { - ecs_id_record_t *idr = ecs_os_calloc_t(ecs_id_record_t); - ecs_table_cache_init(&idr->cache); + (void)ctx; + + const EcsType *pt = ecs_get(world, pipeline, EcsType); + ecs_assert(pt != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t rel = 0, obj = 0; - if (ECS_HAS_ROLE(id, PAIR)) { - rel = ecs_pair_first(world, id); - ecs_assert(rel != 0, ECS_INTERNAL_ERROR, NULL); + /* Find tag in system that belongs to pipeline */ + ecs_entity_t *sys_comps = ecs_vector_first(type, ecs_entity_t); + int32_t c, t, count = ecs_vector_count(type); + + ecs_type_t pipeline_type = NULL; + if (pt->normalized) { + pipeline_type = pt->normalized->type; + } - /* Relation object can be 0, as tables without a ChildOf relation are - * added to the (ChildOf, 0) id record */ - obj = ECS_PAIR_SECOND(id); - if (obj) { - obj = ecs_get_alive(world, obj); - ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); - } - - /* If id is a pair, inherit flags from relation id record */ - ecs_id_record_t *idr_r = flecs_get_id_record( - world, ECS_PAIR_FIRST(id)); - if (idr_r) { - idr->flags = idr_r->flags; - } - } else { - rel = id & ECS_COMPONENT_MASK; - rel = ecs_get_alive(world, rel); - ecs_assert(rel != 0, ECS_INTERNAL_ERROR, NULL); + if (!pipeline_type) { + return 0; } - /* Mark entities that are used as component/pair ids. When a tracked - * entity is deleted, cleanup policies are applied so that the store - * won't contain any tables with deleted ids. */ + ecs_entity_t *tags = ecs_vector_first(pipeline_type, ecs_entity_t); + int32_t tag_count = ecs_vector_count(pipeline_type); - /* Flag for OnDelete policies */ - flecs_add_flag(world, rel, ECS_FLAG_OBSERVED_ID); - if (obj) { - /* Flag for OnDeleteObject policies */ - flecs_add_flag(world, obj, ECS_FLAG_OBSERVED_OBJECT); - if (ecs_has_id(world, rel, EcsAcyclic)) { - /* Flag used to determine if object should be traversed when - * propagating events or with super/subset queries */ - flecs_add_flag(world, obj, ECS_FLAG_OBSERVED_ACYCLIC); + ecs_entity_t result = 0; + + for (c = 0; c < count; c ++) { + ecs_entity_t comp = sys_comps[c]; + for (t = 0; t < tag_count; t ++) { + if (comp == tags[t]) { + result = comp; + break; + } + } + if (result) { + break; } } - if (ecs_should_log_1()) { - char *id_str = ecs_id_str(world, id); - ecs_dbg_1("#[green]id#[normal] %s #[green]created", id_str); - ecs_os_free(id_str); - } + ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(result < INT_MAX, ECS_INTERNAL_ERROR, NULL); - return idr; + return result; } +typedef enum ComponentWriteState { + NotWritten = 0, + WriteToMain, + WriteToStage +} ComponentWriteState; + +typedef struct write_state_t { + ecs_map_t *components; + bool wildcard; +} write_state_t; -/* Cleanup id index */ static -bool free_id_record( - ecs_world_t *world, - ecs_id_t id, - ecs_id_record_t *idr) +int32_t get_write_state( + ecs_map_t *write_state, + ecs_entity_t component) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_poly_assert(world, ecs_world_t); - (void)id; - - /* Force the empty table administration to be consistent if the non-empty - * list of the id record has elements */ - if (ecs_table_cache_count(&idr->cache)) { - ecs_force_aperiodic(world); + int32_t *ptr = ecs_map_get(write_state, int32_t, component); + if (ptr) { + return *ptr; + } else { + return 0; } +} - /* If there are still tables in the non-empty list they're really not empty. - * We can't free the record yet. */ - if (ecs_table_cache_count(&idr->cache)) { - return false; +static +void set_write_state( + write_state_t *write_state, + ecs_entity_t component, + int32_t value) +{ + if (component == EcsWildcard) { + ecs_assert(value == WriteToStage, ECS_INTERNAL_ERROR, NULL); + write_state->wildcard = true; + } else { + ecs_map_set(write_state->components, component, &value); } +} - /* If id record contains no more empty tables, free it */ - if (ecs_table_cache_empty_count(&idr->cache) == 0) { - if (ecs_should_log_1()) { - char *id_str = ecs_id_str(world, id); - ecs_dbg_1("#[green]id#[normal] %s #[red]deleted", id_str); - ecs_os_free(id_str); - } +static +void reset_write_state( + write_state_t *write_state) +{ + ecs_map_clear(write_state->components); + write_state->wildcard = false; +} - ecs_table_cache_fini(&idr->cache); - flecs_name_index_free(idr->name_index); - ecs_os_free(idr); - return true; +static +int32_t get_any_write_state( + write_state_t *write_state) +{ + if (write_state->wildcard) { + return WriteToStage; } - /* Delete empty tables */ - ecs_table_cache_iter_t cache_it; - flecs_table_cache_empty_iter(&idr->cache, &cache_it); - - const ecs_table_record_t *tr; - while ((tr = flecs_table_cache_next(&cache_it, ecs_table_record_t))) { - if (!flecs_table_release(world, tr->hdr.table)) { - /* Releasing the table did not free it, which means that something - * is keeping the table alive. Cleanup of the id record will happen - * when the last reference(s) to the table are released */ - return false; + ecs_map_iter_t it = ecs_map_iter(write_state->components); + int32_t *elem; + while ((elem = ecs_map_next(&it, int32_t, NULL))) { + if (*elem == WriteToStage) { + return WriteToStage; } } - /* If all tables were deleted for this id record, the last deleted table - * should have removed the record from the world. */ - ecs_assert(flecs_get_id_record(world, id) == NULL, - ECS_INTERNAL_ERROR, NULL); - - return true; + return 0; } static -void fini_id_index( - ecs_world_t *world) +bool check_term_component( + ecs_term_t *term, + bool is_active, + ecs_entity_t component, + write_state_t *write_state) { - ecs_map_iter_t it = ecs_map_iter(&world->id_index); - ecs_id_record_t *idr; - ecs_map_key_t key; - while ((idr = ecs_map_next_ptr(&it, ecs_id_record_t*, &key))) { - free_id_record(world, key, idr); + int32_t state = get_write_state(write_state->components, component); + + ecs_term_id_t *subj = &term->subj; + + if ((subj->set.mask & EcsSelf) && subj->entity == EcsThis && term->oper != EcsNot) { + switch(term->inout) { + case EcsInOutFilter: + /* Ignore terms that aren't read/written */ + break; + case EcsInOutDefault: + case EcsInOut: + case EcsIn: + if (state == WriteToStage || write_state->wildcard) { + return true; + } + // fall through + case EcsOut: + if (is_active && term->inout != EcsIn) { + set_write_state(write_state, component, WriteToMain); + } + }; + + } else if (!subj->entity || term->oper == EcsNot) { + bool needs_merge = false; + + switch(term->inout) { + case EcsInOutDefault: + case EcsIn: + case EcsInOut: + if (state == WriteToStage) { + needs_merge = true; + } + if (component == EcsWildcard) { + if (get_any_write_state(write_state) == WriteToStage) { + needs_merge = true; + } + } + break; + default: + break; + }; + + switch(term->inout) { + case EcsInOutDefault: + if ((!(subj->set.mask & EcsSelf) || (subj->entity != EcsThis)) && (subj->set.mask != EcsNothing)) { + /* Default inout behavior is [inout] for This terms, and [in] + * for terms that match other entities */ + break; + } + // fall through + case EcsInOut: + case EcsOut: + if (is_active) { + set_write_state(write_state, component, WriteToStage); + } + break; + default: + break; + }; + + if (needs_merge) { + return true; + } } - ecs_map_fini(&world->id_index); - flecs_sparse_free(world->pending_tables); - flecs_sparse_free(world->pending_buffer); + return false; } -/* Cleanup misc structures */ static -void fini_misc( - ecs_world_t *world) +bool check_term( + ecs_term_t *term, + bool is_active, + write_state_t *write_state) { - ecs_map_fini(&world->type_handles); - ecs_vector_free(world->fini_tasks); + if (term->oper != EcsOr) { + return check_term_component( + term, is_active, term->id, write_state); + } + + return false; } -/* The destroyer of worlds */ -int ecs_fini( - ecs_world_t *world) +static +bool check_terms( + ecs_filter_t *filter, + bool is_active, + write_state_t *ws) { - ecs_poly_assert(world, ecs_world_t); - ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); - ecs_assert(!world->is_fini, ECS_INVALID_OPERATION, NULL); + bool needs_merge = false; + ecs_term_t *terms = filter->terms; + int32_t t, term_count = filter->term_count; - ecs_trace("#[bold]shutting down world"); - ecs_log_push(); + /* Check This terms first. This way if a term indicating writing to a stage + * was added before the term, it won't cause merging. */ + for (t = 0; t < term_count; t ++) { + ecs_term_t *term = &terms[t]; + if (term->subj.entity == EcsThis) { + needs_merge |= check_term(term, is_active, ws); + } + } - world->is_fini = true; + /* Now check staged terms */ + for (t = 0; t < term_count; t ++) { + ecs_term_t *term = &terms[t]; + if (term->subj.entity != EcsThis) { + needs_merge |= check_term(term, is_active, ws); + } + } - /* Operations invoked during UnSet/OnRemove/destructors are deferred and - * will be discarded after world cleanup */ - ecs_defer_begin(world); + return needs_merge; +} - /* Run UnSet/OnRemove actions for components while the store is still - * unmodified by cleanup. */ - fini_unset_tables(world); - - /* Run fini actions (simple callbacks ran when world is deleted) before - * destroying the storage */ - fini_actions(world); +static +bool build_pipeline( + ecs_world_t *world, + ecs_entity_t pipeline, + EcsPipelineQuery *pq) +{ + (void)pipeline; - /* This will destroy all entities and components. After this point no more - * user code is executed. */ - fini_store(world); + ecs_query_iter(world, pq->query); - /* Purge deferred operations from the queue. This discards operations but - * makes sure that any resources in the queue are freed */ - flecs_defer_purge(world, &world->stage); + if (pq->match_count == pq->query->match_count) { + /* No need to rebuild the pipeline */ + return false; + } - /* Entity index is kept alive until this point so that user code can do - * validity checks on entity ids, even though after store cleanup the index - * will be empty, so all entity ids are invalid. */ - flecs_sparse_fini(&world->store.entity_index); - - if (world->locking_enabled) { - ecs_os_mutex_free(world->mutex); + world->stats.pipeline_build_count_total ++; + pq->rebuild_count ++; + + write_state_t ws = { + .components = ecs_map_new(int32_t, ECS_HI_COMPONENT_ID), + .wildcard = false + }; + + ecs_pipeline_op_t *op = NULL; + ecs_vector_t *ops = NULL; + ecs_query_t *query = pq->build_query; + + if (pq->ops) { + ecs_vector_free(pq->ops); } - ecs_trace("table store deinitialized"); + bool multi_threaded = false; + bool no_staging = false; + bool first = true; - fini_stages(world); + /* Iterate systems in pipeline, add ops for running / merging */ + ecs_iter_t it = ecs_query_iter(world, query); + while (ecs_query_next(&it)) { + EcsSystem *sys = ecs_term(&it, EcsSystem, 1); - fini_component_lifecycle(world); + int i; + for (i = 0; i < it.count; i ++) { + ecs_query_t *q = sys[i].query; + if (!q) { + continue; + } - fini_queries(world); + bool needs_merge = false; + bool is_active = !ecs_has_id( + world, it.entities[i], EcsInactive); + needs_merge = check_terms(&q->filter, is_active, &ws); - fini_observers(world); + if (is_active) { + if (first) { + multi_threaded = sys[i].multi_threaded; + no_staging = sys[i].no_staging; + first = false; + } - fini_id_index(world); + if (sys[i].multi_threaded != multi_threaded) { + needs_merge = true; + multi_threaded = sys[i].multi_threaded; + } + if (sys[i].no_staging != no_staging) { + needs_merge = true; + no_staging = sys[i].no_staging; + } + } - flecs_observable_fini(&world->observable); + if (needs_merge) { + /* After merge all components will be merged, so reset state */ + reset_write_state(&ws); + op = NULL; - flecs_sparse_free(world->triggers); + /* Re-evaluate columns to set write flags if system is active. + * If system is inactive, it can't write anything and so it + * should not insert unnecessary merges. */ + needs_merge = false; + if (is_active) { + needs_merge = check_terms(&q->filter, true, &ws); + } - flecs_name_index_fini(&world->aliases); - flecs_name_index_fini(&world->symbols); - - fini_misc(world); + /* The component states were just reset, so if we conclude that + * another merge is needed something is wrong. */ + ecs_assert(needs_merge == false, ECS_INTERNAL_ERROR, NULL); + } - ecs_os_enable_high_timer_resolution(false); + if (!op) { + op = ecs_vector_add(&ops, ecs_pipeline_op_t); + op->count = 0; + op->multi_threaded = false; + op->no_staging = false; + } - /* End of the world */ - ecs_poly_free(world, ecs_world_t); + /* Don't increase count for inactive systems, as they are ignored by + * the query used to run the pipeline. */ + if (is_active) { + if (!op->count) { + op->multi_threaded = multi_threaded; + op->no_staging = no_staging; + } + op->count ++; + } + } + } - ecs_os_fini(); + ecs_map_free(ws.components); - ecs_trace("world destroyed, bye!"); - ecs_log_pop(); + /* Find the system ran last this frame (helps workers reset iter) */ + ecs_entity_t last_system = 0; + op = ecs_vector_first(ops, ecs_pipeline_op_t); + int32_t i, ran_since_merge = 0, op_index = 0; - return 0; -} + ecs_assert(op != NULL, ECS_INTERNAL_ERROR, NULL); -bool ecs_is_fini( - const ecs_world_t *world) -{ - ecs_assert(world != NULL, ECS_INVALID_PARAMETER, NULL); - world = ecs_get_world(world); - return world->is_fini; -} + /* Add schedule to debug tracing */ + ecs_dbg("#[green]pipeline#[reset] rebuild:"); + ecs_log_push_1(); -void ecs_dim( - ecs_world_t *world, - int32_t entity_count) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_eis_set_size(world, entity_count + ECS_HI_COMPONENT_ID); -} + ecs_dbg("#[green]schedule#[reset]: threading: %d, staging: %d:", + op->multi_threaded, !op->no_staging); + ecs_log_push_1(); + + it = ecs_query_iter(world, pq->query); + while (ecs_query_next(&it)) { + EcsSystem *sys = ecs_term(&it, EcsSystem, 1); + for (i = 0; i < it.count; i ++) { + if (ecs_should_log_1()) { + char *path = ecs_get_fullpath(world, it.entities[i]); + ecs_dbg("#[green]system#[reset] %s", path); + ecs_os_free(path); + } -void flecs_eval_component_monitors( - ecs_world_t *world) -{ - ecs_poly_assert(world, ecs_world_t); - flecs_process_pending_tables(world); - eval_component_monitor(world); -} + ran_since_merge ++; + if (ran_since_merge == op[op_index].count) { + ecs_dbg("#[magenta]merge#[reset]"); + ecs_log_pop_1(); + ran_since_merge = 0; + op_index ++; + if (op_index < ecs_vector_count(ops)) { + ecs_dbg("#[green]schedule#[reset]: threading: %d, staging: %d:", + op[op_index].multi_threaded, !op[op_index].no_staging); + } + ecs_log_push_1(); + } -void ecs_measure_frame_time( - ecs_world_t *world, - bool enable) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); + if (sys[i].last_frame == (world->stats.frame_count_total + 1)) { + last_system = it.entities[i]; - if (world->stats.target_fps == 0.0f || enable) { - world->measure_frame_time = enable; + /* Can't break from loop yet. It's possible that previously + * inactive systems that ran before the last ran system are now + * active. */ + } + } } -error: - return; + + ecs_log_pop_1(); + ecs_log_pop_1(); + + /* Force sort of query as this could increase the match_count */ + pq->match_count = pq->query->match_count; + pq->ops = ops; + pq->last_system = last_system; + + return true; } -void ecs_measure_system_time( +int32_t ecs_pipeline_reset_iter( ecs_world_t *world, - bool enable) + const EcsPipelineQuery *pq, + ecs_iter_t *iter_out, + ecs_pipeline_op_t **op_out, + ecs_pipeline_op_t **last_op_out) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); - world->measure_system_time = enable; -error: - return; -} + ecs_pipeline_op_t *op = ecs_vector_first(pq->ops, ecs_pipeline_op_t); + int32_t i, ran_since_merge = 0, op_index = 0; -void ecs_set_target_fps( - ecs_world_t *world, - FLECS_FLOAT fps) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); + if (!pq->last_system) { + /* It's possible that all systems that were ran were removed entirely + * from the pipeline (they could have been deleted or disabled). In that + * case (which should be very rare) the pipeline can't make assumptions + * about where to continue, so end frame. */ + return -1; + } - ecs_measure_frame_time(world, true); - world->stats.target_fps = fps; - ecs_os_enable_high_timer_resolution(fps >= 60.0f); -error: - return; -} + /* Move iterator to last ran system */ + *iter_out = ecs_query_iter(world, pq->query); + while (ecs_query_next(iter_out)) { + for (i = 0; i < iter_out->count; i ++) { + ran_since_merge ++; + if (ran_since_merge == op[op_index].count) { + ran_since_merge = 0; + op_index ++; + } -void* ecs_get_context( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - world = ecs_get_world(world); - return world->context; -error: - return NULL; -} + if (iter_out->entities[i] == pq->last_system) { + *op_out = &op[op_index]; + *last_op_out = ecs_vector_last(pq->ops, ecs_pipeline_op_t); + return i; + } + } + } -void ecs_set_context( - ecs_world_t *world, - void *context) -{ - ecs_poly_assert(world, ecs_world_t); - world->context = context; + ecs_abort(ECS_INTERNAL_ERROR, NULL); + + return -1; } -void ecs_set_entity_range( +bool ecs_pipeline_update( ecs_world_t *world, - ecs_entity_t id_start, - ecs_entity_t id_end) + ecs_entity_t pipeline, + bool start_of_frame) { ecs_poly_assert(world, ecs_world_t); - ecs_check(!id_end || id_end > id_start, ECS_INVALID_PARAMETER, NULL); - ecs_check(!id_end || id_end > world->stats.last_id, - ECS_INVALID_PARAMETER, NULL); + ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); + ecs_assert(pipeline != 0, ECS_INTERNAL_ERROR, NULL); - if (world->stats.last_id < id_start) { - world->stats.last_id = id_start - 1; + /* If any entity mutations happened that could have affected query matching + * notify appropriate queries so caches are up to date. This includes the + * pipeline query. */ + if (start_of_frame) { + ecs_force_aperiodic(world); } - world->stats.min_id = id_start; - world->stats.max_id = id_end; -error: - return; -} + bool added = false; + EcsPipelineQuery *pq = ecs_get_mut(world, pipeline, EcsPipelineQuery, &added); + ecs_assert(added == false, ECS_INTERNAL_ERROR, NULL); + ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(pq->query != NULL, ECS_INTERNAL_ERROR, NULL); -bool ecs_enable_range_check( - ecs_world_t *world, - bool enable) -{ - ecs_poly_assert(world, ecs_world_t); - bool old_value = world->range_check_enabled; - world->range_check_enabled = enable; - return old_value; + return build_pipeline(world, pipeline, pq); } -void ecs_set_entity_generation( +void ecs_run_pipeline( ecs_world_t *world, - ecs_entity_t entity_with_generation) + ecs_entity_t pipeline, + FLECS_FLOAT delta_time) { - flecs_sparse_set_generation( - &world->store.entity_index, entity_with_generation); -} + ecs_assert(world != NULL, ECS_INVALID_OPERATION, NULL); -int32_t ecs_get_threads( - ecs_world_t *world) -{ - return ecs_vector_count(world->worker_stages); -} + if (!pipeline) { + pipeline = world->pipeline; + } -bool ecs_enable_locking( - ecs_world_t *world, - bool enable) -{ - ecs_poly_assert(world, ecs_world_t); + ecs_assert(pipeline != 0, ECS_INVALID_PARAMETER, NULL); - if (enable) { - if (!world->locking_enabled) { - world->mutex = ecs_os_mutex_new(); - world->thr_sync = ecs_os_mutex_new(); - world->thr_cond = ecs_os_cond_new(); - } + /* If the world is passed to ecs_run_pipeline, the function will take care + * of staging, so the world should not be in staged mode when called. */ + if (ecs_poly_is(world, ecs_world_t)) { + ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); + + /* Forward to worker_progress. This function handles staging, threading + * and synchronization across workers. */ + ecs_workers_progress(world, pipeline, delta_time); + return; + + /* If a stage is passed, the function could be ran from a worker thread. In + * that case the main thread should manage staging, and staging should be + * enabled. */ } else { - if (world->locking_enabled) { - ecs_os_mutex_free(world->mutex); - ecs_os_mutex_free(world->thr_sync); - ecs_os_cond_free(world->thr_cond); - } + ecs_poly_assert(world, ecs_stage_t); } - bool old = world->locking_enabled; - world->locking_enabled = enable; - return old; -} + ecs_stage_t *stage = flecs_stage_from_world(&world); + + const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); + ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(pq->query != NULL, ECS_INTERNAL_ERROR, NULL); -void ecs_lock( - ecs_world_t *world) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); - ecs_os_mutex_lock(world->mutex); -} + ecs_vector_t *ops = pq->ops; + ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); + ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); + int32_t ran_since_merge = 0; -void ecs_unlock( - ecs_world_t *world) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); - ecs_os_mutex_unlock(world->mutex); -} + int32_t stage_index = ecs_get_stage_id(stage->thread_ctx); + int32_t stage_count = ecs_get_stage_count(world); -void ecs_begin_wait( - ecs_world_t *world) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); - ecs_os_mutex_lock(world->thr_sync); - ecs_os_cond_wait(world->thr_cond, world->thr_sync); -} + ecs_worker_begin(stage->thread_ctx); -void ecs_end_wait( - ecs_world_t *world) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); - ecs_os_mutex_unlock(world->thr_sync); -} + ecs_iter_t it = ecs_query_iter(world, pq->query); + while (ecs_query_next(&it)) { + EcsSystem *sys = ecs_term(&it, EcsSystem, 1); -const ecs_type_info_t* flecs_get_type_info( - const ecs_world_t *world, - ecs_entity_t component) -{ - ecs_poly_assert(world, ecs_world_t); + int32_t i; + for(i = 0; i < it.count; i ++) { + ecs_entity_t e = it.entities[i]; - ecs_assert(component != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!(component & ECS_ROLE_MASK), ECS_INTERNAL_ERROR, NULL); + if (!stage_index) { + ecs_dbg_3("pipeline: run system %s", ecs_get_name(world, e)); + } - return flecs_sparse_get(world->type_info, ecs_type_info_t, component); -} + if (!stage_index || op->multi_threaded) { + ecs_stage_t *s = NULL; + if (!op->no_staging) { + s = stage; + } -ecs_type_info_t* flecs_ensure_type_info( - ecs_world_t *world, - ecs_entity_t component) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(component != 0, ECS_INTERNAL_ERROR, NULL); + ecs_run_intern(world, s, e, &sys[i], stage_index, + stage_count, delta_time, 0, 0, NULL); + } - const ecs_type_info_t *ti = flecs_get_type_info(world, component); - ecs_type_info_t *ti_mut = NULL; - if (!ti) { - ti_mut = flecs_sparse_ensure( - world->type_info, ecs_type_info_t, component); - ecs_assert(ti_mut != NULL, ECS_INTERNAL_ERROR, NULL); - } else { - ti_mut = (ecs_type_info_t*)ti; + sys[i].last_frame = world->stats.frame_count_total + 1; + + ran_since_merge ++; + world->stats.systems_ran_frame ++; + + if (op != op_last && ran_since_merge == op->count) { + ran_since_merge = 0; + + if (!stage_index) { + ecs_dbg_3("merge"); + } + + /* If the set of matched systems changed as a result of the + * merge, we have to reset the iterator and move it to our + * current position (system). If there are a lot of systems + * in the pipeline this can be an expensive operation, but + * should happen infrequently. */ + i = ecs_worker_sync(world, pq, &it, i, &op, &op_last); + sys = ecs_term(&it, EcsSystem, 1); + } + } } - return ti_mut; + ecs_worker_end(stage->thread_ctx); } -void flecs_init_type_info( +static +void add_pipeline_tags_to_sig( ecs_world_t *world, - ecs_entity_t component, - ecs_size_t size, - ecs_size_t alignment) + ecs_term_t *terms, + ecs_type_t type) { - ecs_type_info_t *ti = flecs_ensure_type_info(world, component); - ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ti->size == 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ti->alignment == 0, ECS_INTERNAL_ERROR, NULL); - ti->size = size; - ti->alignment = alignment; + (void)world; + + int32_t i, count = ecs_vector_count(type); + ecs_entity_t *entities = ecs_vector_first(type, ecs_entity_t); + + for (i = 0; i < count; i ++) { + terms[i] = (ecs_term_t){ + .inout = EcsIn, + .oper = EcsOr, + .pred.entity = entities[i], + .subj = { + .entity = EcsThis, + .set.mask = EcsSelf | EcsSuperSet + } + }; + } } static -FLECS_FLOAT insert_sleep( +ecs_query_t* build_pipeline_query( ecs_world_t *world, - ecs_time_t *stop) + ecs_entity_t pipeline, + const char *name, + bool not_inactive) { - ecs_poly_assert(world, ecs_world_t); + const EcsType *type_ptr = ecs_get(world, pipeline, EcsType); + ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_type_t type = NULL; + if (type_ptr->normalized) { + type = type_ptr->normalized->type; + } - ecs_time_t start = *stop; - FLECS_FLOAT delta_time = (FLECS_FLOAT)ecs_time_measure(stop); + int32_t type_count = ecs_vector_count(type); + int32_t term_count = 1; - if (world->stats.target_fps == (FLECS_FLOAT)0.0) { - return delta_time; + if (not_inactive) { + term_count ++; } - FLECS_FLOAT target_delta_time = - ((FLECS_FLOAT)1.0 / (FLECS_FLOAT)world->stats.target_fps); + ecs_term_t *terms = ecs_os_malloc( + (type_count + term_count) * ECS_SIZEOF(ecs_term_t)); - /* Calculate the time we need to sleep by taking the measured delta from the - * previous frame, and subtracting it from target_delta_time. */ - FLECS_FLOAT sleep = target_delta_time - delta_time; + terms[0] = (ecs_term_t){ + .inout = EcsIn, + .oper = EcsAnd, + .pred.entity = ecs_id(EcsSystem), + .subj = { + .entity = EcsThis, + .set.mask = EcsSelf | EcsSuperSet + } + }; - /* Pick a sleep interval that is 4 times smaller than the time one frame - * should take. */ - FLECS_FLOAT sleep_time = sleep / (FLECS_FLOAT)4.0; + if (not_inactive) { + terms[1] = (ecs_term_t){ + .inout = EcsIn, + .oper = EcsNot, + .pred.entity = EcsInactive, + .subj = { + .entity = EcsThis, + .set.mask = EcsSelf | EcsSuperSet + } + }; + } - do { - /* Only call sleep when sleep_time is not 0. On some platforms, even - * a sleep with a timeout of 0 can cause stutter. */ - if (sleep_time != 0) { - ecs_sleepf((double)sleep_time); - } + add_pipeline_tags_to_sig(world, &terms[term_count], type); - ecs_time_t now = start; - delta_time = (FLECS_FLOAT)ecs_time_measure(&now); - } while ((target_delta_time - delta_time) > - (sleep_time / (FLECS_FLOAT)2.0)); + ecs_query_t *result = ecs_query_init(world, &(ecs_query_desc_t){ + .filter = { + .name = name, + .terms_buffer = terms, + .terms_buffer_count = term_count + type_count + }, + .order_by = compare_entity, + .group_by = group_by_phase, + .group_by_id = pipeline + }); - return delta_time; + ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_os_free(terms); + + return result; } -static -FLECS_FLOAT start_measure_frame( - ecs_world_t *world, - FLECS_FLOAT user_delta_time) +static +void OnUpdatePipeline( + ecs_iter_t *it) { - ecs_poly_assert(world, ecs_world_t); + ecs_world_t *world = it->world; + ecs_entity_t *entities = it->entities; - FLECS_FLOAT delta_time = 0; + int32_t i; + for (i = it->count - 1; i >= 0; i --) { + ecs_entity_t pipeline = entities[i]; + + ecs_trace("#[green]pipeline#[reset] %s created", + ecs_get_name(world, pipeline)); + ecs_log_push(); - if (world->measure_frame_time || (user_delta_time == 0)) { - ecs_time_t t = world->frame_start_time; - do { - if (world->frame_start_time.nanosec || world->frame_start_time.sec){ - delta_time = insert_sleep(world, &t); + /* Build signature for pipeline query that matches EcsSystems, has the + * pipeline phases as OR columns, and ignores systems with EcsInactive. + * Note that EcsDisabled is automatically ignored + * by the regular query matching */ + ecs_query_t *query = build_pipeline_query( + world, pipeline, "BuiltinPipelineQuery", true); + ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_time_measure(&t); - } else { - ecs_time_measure(&t); - if (world->stats.target_fps != 0) { - delta_time = (FLECS_FLOAT)1.0 / world->stats.target_fps; - } else { - /* Best guess */ - delta_time = (FLECS_FLOAT)1.0 / (FLECS_FLOAT)60.0; - } - } - - /* Keep trying while delta_time is zero */ - } while (delta_time == 0); + /* Build signature for pipeline build query. The build query includes + * systems that are inactive, as an inactive system may become active as + * a result of another system, and as a result the correct merge + * operations need to be put in place. */ + ecs_query_t *build_query = build_pipeline_query( + world, pipeline, "BuiltinPipelineBuildQuery", false); + ecs_assert(build_query != NULL, ECS_INTERNAL_ERROR, NULL); - world->frame_start_time = t; + bool added = false; + EcsPipelineQuery *pq = ecs_get_mut( + world, pipeline, EcsPipelineQuery, &added); + ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); - /* Keep track of total time passed in world */ - world->stats.world_time_total_raw += (FLECS_FLOAT)delta_time; - } + if (added) { + /* Should not modify pipeline after it has been used */ + ecs_assert(pq->ops == NULL, ECS_INVALID_OPERATION, NULL); - return (FLECS_FLOAT)delta_time; -} + if (pq->query) { + ecs_query_fini(pq->query); + } + if (pq->build_query) { + ecs_query_fini(pq->build_query); + } + } -static -void stop_measure_frame( - ecs_world_t* world) -{ - ecs_poly_assert(world, ecs_world_t); + pq->query = query; + pq->build_query = build_query; + pq->match_count = -1; + pq->ops = NULL; + pq->last_system = 0; - if (world->measure_frame_time) { - ecs_time_t t = world->frame_start_time; - world->stats.frame_time_total += (FLECS_FLOAT)ecs_time_measure(&t); + ecs_log_pop(); } } -FLECS_FLOAT ecs_frame_begin( +/* -- Public API -- */ + +bool ecs_progress( ecs_world_t *world, FLECS_FLOAT user_delta_time) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(world->is_readonly == false, ECS_INVALID_OPERATION, NULL); - ecs_check(user_delta_time != 0 || ecs_os_has_time(), - ECS_MISSING_OS_API, "get_time"); + float delta_time = ecs_frame_begin(world, user_delta_time); - if (world->locking_enabled) { - ecs_lock(world); - } + ecs_dbg_3("#[normal]begin progress(dt = %.2f)", (double)delta_time); - /* Start measuring total frame time */ - FLECS_FLOAT delta_time = start_measure_frame(world, user_delta_time); - if (user_delta_time == 0) { - user_delta_time = delta_time; - } + ecs_run_pipeline(world, 0, delta_time); - world->stats.delta_time_raw = user_delta_time; - world->stats.delta_time = user_delta_time * world->stats.time_scale; + ecs_dbg_3("#[normal]end progress"); - /* Keep track of total scaled time passed in world */ - world->stats.world_time_total += world->stats.delta_time; + ecs_frame_end(world); - ecs_force_aperiodic(world); + return !world->should_quit; +} - return world->stats.delta_time; -error: - return (FLECS_FLOAT)0; +void ecs_set_time_scale( + ecs_world_t *world, + FLECS_FLOAT scale) +{ + world->stats.time_scale = scale; } -void ecs_frame_end( +void ecs_reset_clock( ecs_world_t *world) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(world->is_readonly == false, ECS_INVALID_OPERATION, NULL); + world->stats.world_time_total = 0; + world->stats.world_time_total_raw = 0; +} - world->stats.frame_count_total ++; +void ecs_deactivate_systems( + ecs_world_t *world) +{ + ecs_assert(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); - ecs_vector_each(world->worker_stages, ecs_stage_t, stage, { - flecs_stage_merge_post_frame(world, stage); - }); + ecs_entity_t pipeline = world->pipeline; + const EcsPipelineQuery *pq = ecs_get( world, pipeline, EcsPipelineQuery); + ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); - if (world->locking_enabled) { - ecs_unlock(world); + /* Iterate over all systems, add EcsInvalid tag if queries aren't matched + * with any tables */ + ecs_iter_t it = ecs_query_iter(world, pq->build_query); - ecs_os_mutex_lock(world->thr_sync); - ecs_os_cond_broadcast(world->thr_cond); - ecs_os_mutex_unlock(world->thr_sync); - } + /* Make sure that we defer adding the inactive tags until after iterating + * the query */ + flecs_defer_none(world, &world->stage); - stop_measure_frame(world); + while( ecs_query_next(&it)) { + EcsSystem *sys = ecs_term(&it, EcsSystem, 1); + + int32_t i; + for (i = 0; i < it.count; i ++) { + ecs_query_t *query = sys[i].query; + if (query) { + if (!ecs_query_table_count(query)) { + ecs_add_id(world, it.entities[i], EcsInactive); + } + } + } + } + + flecs_defer_flush(world, &world->stage); +} + +void ecs_set_pipeline( + ecs_world_t *world, + ecs_entity_t pipeline) +{ + ecs_poly_assert(world, ecs_world_t); + ecs_check( ecs_get(world, pipeline, EcsPipelineQuery) != NULL, + ECS_INVALID_PARAMETER, "not a pipeline"); + + world->pipeline = pipeline; error: return; } -const ecs_world_info_t* ecs_get_world_info( +ecs_entity_t ecs_get_pipeline( const ecs_world_t *world) { + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); world = ecs_get_world(world); - return &world->stats; + return world->pipeline; +error: + return 0; } -void flecs_notify_queries( +/* -- Module implementation -- */ + +static +void FlecsPipelineFini( ecs_world_t *world, - ecs_query_event_t *event) + void *ctx) { - ecs_poly_assert(world, ecs_world_t); - - int32_t i, count = flecs_sparse_count(world->queries); - for (i = 0; i < count; i ++) { - ecs_query_t *query = flecs_sparse_get_dense( - world->queries, ecs_query_t, i); - if (query->flags & EcsQueryIsSubquery) { - continue; - } - - flecs_query_notify(world, query, event); - } + (void)ctx; + if (ecs_get_stage_count(world)) { + ecs_set_threads(world, 0); + } } -void flecs_delete_table( - ecs_world_t *world, - ecs_table_t *table) +void FlecsPipelineImport( + ecs_world_t *world) { - ecs_poly_assert(world, ecs_world_t); - flecs_table_release(world, table); + ECS_MODULE(world, FlecsPipeline); + + ECS_IMPORT(world, FlecsSystem); + + ecs_set_name_prefix(world, "Ecs"); + + flecs_bootstrap_tag(world, EcsPipeline); + flecs_bootstrap_component(world, EcsPipelineQuery); + + /* Phases of the builtin pipeline are regular entities. Names are set so + * they can be resolved by type expressions. */ + flecs_bootstrap_tag(world, EcsPreFrame); + flecs_bootstrap_tag(world, EcsOnLoad); + flecs_bootstrap_tag(world, EcsPostLoad); + flecs_bootstrap_tag(world, EcsPreUpdate); + flecs_bootstrap_tag(world, EcsOnUpdate); + flecs_bootstrap_tag(world, EcsOnValidate); + flecs_bootstrap_tag(world, EcsPostUpdate); + flecs_bootstrap_tag(world, EcsPreStore); + flecs_bootstrap_tag(world, EcsOnStore); + flecs_bootstrap_tag(world, EcsPostFrame); + + /* Set ctor and dtor for PipelineQuery */ + ecs_set(world, ecs_id(EcsPipelineQuery), EcsComponentLifecycle, { + .ctor = ecs_default_ctor, + .dtor = ecs_dtor(EcsPipelineQuery) + }); + + /* When the Pipeline tag is added a pipeline will be created */ + ecs_observer_init(world, &(ecs_observer_desc_t) { + .entity.name = "OnUpdatePipeline", + .filter.terms = { + { .id = EcsPipeline }, + { .id = ecs_id(EcsType) } + }, + .events = { EcsOnSet }, + .callback = OnUpdatePipeline + }); + + /* Create the builtin pipeline */ + world->pipeline = ecs_type_init(world, &(ecs_type_desc_t){ + .entity = { + .name = "BuiltinPipeline", + .add = {EcsPipeline} + }, + .ids = { + EcsPreFrame, EcsOnLoad, EcsPostLoad, EcsPreUpdate, EcsOnUpdate, + EcsOnValidate, EcsPostUpdate, EcsPreStore, EcsOnStore, EcsPostFrame + } + }); + + /* Cleanup thread administration when world is destroyed */ + ecs_atfini(world, FlecsPipelineFini, NULL); } -/** Walk over tables that had a state change which requires bookkeeping */ -void flecs_process_pending_tables( - const ecs_world_t *world_r) -{ - ecs_poly_assert(world_r, ecs_world_t); +#endif - /* We can't update the administration while in readonly mode, but we can - * ensure that when this function is called there are no pending events. */ - if (world_r->is_readonly) { - ecs_assert(flecs_sparse_count(world_r->pending_tables) == 0, - ECS_INTERNAL_ERROR, NULL); - return; - } - /* Safe to cast, world is not readonly */ - ecs_world_t *world = (ecs_world_t*)world_r; - - /* If pending buffer is NULL there already is a stackframe that's iterating - * the table list. This can happen when a trigger for a table event results - * in a mutation that causes another table to change state. A typical - * example of this is a system that becomes active/inactive as the result of - * a query (and as a result, its matched tables) becoming empty/non empty */ - if (!world->pending_buffer) { - return; - } +#ifdef FLECS_TIMER - /* Swap buffer. The logic could in theory have been implemented with a - * single sparse set, but that would've complicated (and slowed down) the - * iteration. Additionally, by using a double buffer approach we can still - * keep most of the original ordering of events intact, which is desirable - * as it means that the ordering of tables in the internal datastructures is - * more predictable. */ - int32_t i, count = flecs_sparse_count(world->pending_tables); - if (!count) { - return; +static +void AddTickSource(ecs_iter_t *it) { + int32_t i; + for (i = 0; i < it->count; i ++) { + ecs_set(it->world, it->entities[i], EcsTickSource, {0}); } +} - do { - ecs_sparse_t *pending_tables = world->pending_tables; - world->pending_tables = world->pending_buffer; - world->pending_buffer = NULL; +static +void ProgressTimers(ecs_iter_t *it) { + EcsTimer *timer = ecs_term(it, EcsTimer, 1); + EcsTickSource *tick_source = ecs_term(it, EcsTickSource, 2); - for (i = 0; i < count; i ++) { - ecs_table_t *table = flecs_sparse_get_dense( - pending_tables, ecs_table_t*, i)[0]; - if (!table->id) { - /* Table is being deleted, ignore empty events */ - continue; - } + ecs_assert(timer != NULL, ECS_INTERNAL_ERROR, NULL); - /* For each id in the table, add it to the empty/non empty list - * based on its current state */ - if (flecs_table_records_update_empty(table)) { - /* Only emit an event when there was a change in the - * administration. It is possible that a table ended up in the - * pending_tables list by going from empty->non-empty, but then - * became empty again. By the time we run this code, no changes - * in the administration would actually be made. */ - ecs_ids_t ids = { - .array = ecs_vector_first(table->type, ecs_id_t), - .count = ecs_vector_count(table->type) - }; + int i; + for (i = 0; i < it->count; i ++) { + tick_source[i].tick = false; - ecs_emit(world, &(ecs_event_desc_t) { - .event = ecs_table_count(table) - ? EcsOnTableFill - : EcsOnTableEmpty - , - .table = table, - .ids = &ids, - .observable = world, - .table_event = true - }); - } + if (!timer[i].active) { + continue; } - flecs_sparse_clear(pending_tables); - world->pending_buffer = pending_tables; - } while ((count = flecs_sparse_count(world->pending_tables))); -} + const ecs_world_info_t *info = ecs_get_world_info(it->world); + FLECS_FLOAT time_elapsed = timer[i].time + info->delta_time_raw; + FLECS_FLOAT timeout = timer[i].timeout; + + if (time_elapsed >= timeout) { + FLECS_FLOAT t = time_elapsed - timeout; + if (t > timeout) { + t = 0; + } -void flecs_table_set_empty( - ecs_world_t *world, - ecs_table_t *table) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); + timer[i].time = t; /* Initialize with remainder */ + tick_source[i].tick = true; + tick_source[i].time_elapsed = time_elapsed; - flecs_sparse_set_generation(world->pending_tables, (uint32_t)table->id); - flecs_sparse_ensure(world->pending_tables, ecs_table_t*, - (uint32_t)table->id)[0] = table; + if (timer[i].single_shot) { + timer[i].active = false; + } + } else { + timer[i].time = time_elapsed; + } + } } -ecs_id_record_t* flecs_ensure_id_record( - ecs_world_t *world, - ecs_id_t id) -{ - ecs_id_record_t **idr_ptr = ecs_map_ensure(&world->id_index, - ecs_id_record_t*, ecs_strip_generation(id)); - ecs_id_record_t *idr = idr_ptr[0]; - if (!idr) { - idr_ptr[0] = idr = new_id_record(world, id); - } +static +void ProgressRateFilters(ecs_iter_t *it) { + EcsRateFilter *filter = ecs_term(it, EcsRateFilter, 1); + EcsTickSource *tick_dst = ecs_term(it, EcsTickSource, 2); - return idr; -} + int i; + for (i = 0; i < it->count; i ++) { + ecs_entity_t src = filter[i].src; + bool inc = false; -ecs_id_record_t* flecs_get_id_record( - const ecs_world_t *world, - ecs_id_t id) -{ - return ecs_map_get_ptr(&world->id_index, ecs_id_record_t*, - ecs_strip_generation(id)); -} + filter[i].time_elapsed += it->delta_time; -ecs_hashmap_t* flecs_ensure_id_name_index( - ecs_world_t *world, - ecs_id_t id) -{ - ecs_id_record_t *idr = flecs_get_id_record(world, id); - ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); + if (src) { + const EcsTickSource *tick_src = ecs_get(it->world, src, EcsTickSource); + if (tick_src) { + inc = tick_src->tick; + } else { + inc = true; + } + } else { + inc = true; + } - ecs_hashmap_t *map = idr->name_index; - if (!map) { - map = idr->name_index = flecs_name_index_new(); + if (inc) { + filter[i].tick_count ++; + bool triggered = !(filter[i].tick_count % filter[i].rate); + tick_dst[i].tick = triggered; + tick_dst[i].time_elapsed = filter[i].time_elapsed; + + if (triggered) { + filter[i].time_elapsed = 0; + } + } else { + tick_dst[i].tick = false; + } } +} - return map; +static +void ProgressTickSource(ecs_iter_t *it) { + EcsTickSource *tick_src = ecs_term(it, EcsTickSource, 1); + + /* If tick source has no filters, tick unconditionally */ + int i; + for (i = 0; i < it->count; i ++) { + tick_src[i].tick = true; + tick_src[i].time_elapsed = it->delta_time; + } } -ecs_hashmap_t* flecs_get_id_name_index( - const ecs_world_t *world, - ecs_id_t id) +ecs_entity_t ecs_set_timeout( + ecs_world_t *world, + ecs_entity_t timer, + FLECS_FLOAT timeout) { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return NULL; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + + timer = ecs_set(world, timer, EcsTimer, { + .timeout = timeout, + .single_shot = true, + .active = true + }); + + EcsSystem *system_data = ecs_get_mut(world, timer, EcsSystem, NULL); + if (system_data) { + system_data->tick_source = timer; } - return idr->name_index; +error: + return timer; } -ecs_table_record_t* flecs_get_table_record( +FLECS_FLOAT ecs_get_timeout( const ecs_world_t *world, - const ecs_table_t *table, - ecs_id_t id) + ecs_entity_t timer) { - ecs_id_record_t* idr = flecs_get_id_record(world, id); - if (!idr) { - return NULL; - } + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(timer != 0, ECS_INVALID_PARAMETER, NULL); - return (ecs_table_record_t*)ecs_table_cache_get(&idr->cache, table); + const EcsTimer *value = ecs_get(world, timer, EcsTimer); + if (value) { + return value->timeout; + } +error: + return 0; } -void flecs_remove_id_record( +ecs_entity_t ecs_set_interval( ecs_world_t *world, - ecs_id_t id, - ecs_id_record_t *idr) + ecs_entity_t timer, + FLECS_FLOAT interval) { - /* Free id record resources */ - if (free_id_record(world, id, idr)) { - /* Remove record from world index */ - ecs_map_remove(&world->id_index, ecs_strip_generation(id)); + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + + timer = ecs_set(world, timer, EcsTimer, { + .timeout = interval, + .active = true + }); + + EcsSystem *system_data = ecs_get_mut(world, timer, EcsSystem, NULL); + if (system_data) { + system_data->tick_source = timer; } +error: + return timer; } -void flecs_clear_id_record( - ecs_world_t *world, - ecs_id_t id, - ecs_id_record_t *idr) +FLECS_FLOAT ecs_get_interval( + const ecs_world_t *world, + ecs_entity_t timer) { - if (world->is_fini) { - return; - } + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_table_cache_fini_delete_all(world, &idr->cache); + if (!timer) { + return 0; + } - flecs_remove_id_record(world, id, idr); + const EcsTimer *value = ecs_get(world, timer, EcsTimer); + if (value) { + return value->timeout; + } +error: + return 0; } -bool flecs_id_existst( +void ecs_start_timer( ecs_world_t *world, - ecs_id_t id) + ecs_entity_t timer) { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return false; - } - return (ecs_table_cache_count(&idr->cache) != 0) || - (ecs_table_cache_empty_count(&idr->cache) != 0); + EcsTimer *ptr = ecs_get_mut(world, timer, EcsTimer, NULL); + ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ptr->active = true; + ptr->time = 0; +error: + return; } -const ecs_table_record_t* flecs_id_record_table( - ecs_id_record_t *idr, - ecs_table_t *table) +void ecs_stop_timer( + ecs_world_t *world, + ecs_entity_t timer) { - if (!idr) { - return NULL; - } - return (ecs_table_record_t*)ecs_table_cache_get(&idr->cache, table); + EcsTimer *ptr = ecs_get_mut(world, timer, EcsTimer, NULL); + ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ptr->active = false; +error: + return; } -ecs_id_record_t* flecs_table_iter( +ecs_entity_t ecs_set_rate( ecs_world_t *world, - ecs_id_t id, - ecs_table_cache_iter_t *out) + ecs_entity_t filter, + int32_t rate, + ecs_entity_t source) { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return NULL; - } + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - flecs_process_pending_tables(world); - ecs_assert( flecs_sparse_count(world->pending_tables) == 0, - ECS_INTERNAL_ERROR, NULL); + filter = ecs_set(world, filter, EcsRateFilter, { + .rate = rate, + .src = source + }); - flecs_table_cache_iter(&idr->cache, out); - return idr; + EcsSystem *system_data = ecs_get_mut(world, filter, EcsSystem, NULL); + if (system_data) { + system_data->tick_source = filter; + } + +error: + return filter; } -ecs_id_record_t* flecs_empty_table_iter( +void ecs_set_tick_source( ecs_world_t *world, - ecs_id_t id, - ecs_table_cache_iter_t *out) + ecs_entity_t system, + ecs_entity_t tick_source) { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return NULL; - } + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(tick_source != 0, ECS_INVALID_PARAMETER, NULL); - flecs_process_pending_tables(world); - ecs_assert( flecs_sparse_count(world->pending_tables) == 0, - ECS_INTERNAL_ERROR, NULL); + EcsSystem *system_data = ecs_get_mut(world, system, EcsSystem, NULL); + ecs_check(system_data != NULL, ECS_INVALID_PARAMETER, NULL); - flecs_table_cache_empty_iter(&idr->cache, out); - return idr; + system_data->tick_source = tick_source; +error: + return; } -void ecs_force_aperiodic( +void FlecsTimerImport( ecs_world_t *world) -{ - flecs_process_pending_tables(world); - flecs_eval_component_monitors(world); -} +{ + ECS_MODULE(world, FlecsTimer); + ECS_IMPORT(world, FlecsPipeline); -static -bool observer_run(ecs_iter_t *it) { - ecs_observer_t *o = it->ctx; - ecs_world_t *world = it->world; + ecs_set_name_prefix(world, "Ecs"); - ecs_assert(o->callback != NULL, ECS_INVALID_PARAMETER, NULL); + flecs_bootstrap_component(world, EcsTimer); + flecs_bootstrap_component(world, EcsRateFilter); - if (o->last_event_id == world->event_id) { - /* Already handled this event */ - return false; - } + /* Add EcsTickSource to timers and rate filters */ + ecs_system_init(world, &(ecs_system_desc_t) { + .entity = { .name = "AddTickSource", .add = { EcsPreFrame } }, + .query.filter.terms = { + { .id = ecs_id(EcsTimer), .oper = EcsOr, .inout = EcsIn }, + { .id = ecs_id(EcsRateFilter), .oper = EcsOr, .inout = EcsIn }, + { .id = ecs_id(EcsTickSource), .oper = EcsNot, .inout = EcsOut} + }, + .callback = AddTickSource + }); - o->last_event_id = world->event_id; + /* Timer handling */ + ecs_system_init(world, &(ecs_system_desc_t) { + .entity = { .name = "ProgressTimers", .add = { EcsPreFrame } }, + .query.filter.terms = { + { .id = ecs_id(EcsTimer) }, + { .id = ecs_id(EcsTickSource) } + }, + .callback = ProgressTimers + }); - ecs_iter_t user_it = *it; - user_it.term_count = o->filter.term_count_actual; - user_it.terms = o->filter.terms; - user_it.is_filter = o->filter.filter; - user_it.ids = NULL; - user_it.columns = NULL; - user_it.subjects = NULL; - user_it.sizes = NULL; - user_it.ptrs = NULL; + /* Rate filter handling */ + ecs_system_init(world, &(ecs_system_desc_t) { + .entity = { .name = "ProgressRateFilters", .add = { EcsPreFrame } }, + .query.filter.terms = { + { .id = ecs_id(EcsRateFilter), .inout = EcsIn }, + { .id = ecs_id(EcsTickSource), .inout = EcsOut } + }, + .callback = ProgressRateFilters + }); - flecs_iter_init(&user_it); + /* TickSource without a timer or rate filter just increases each frame */ + ecs_system_init(world, &(ecs_system_desc_t) { + .entity = { .name = "ProgressTickSource", .add = { EcsPreFrame } }, + .query.filter.terms = { + { .id = ecs_id(EcsTickSource), .inout = EcsOut }, + { .id = ecs_id(EcsRateFilter), .oper = EcsNot }, + { .id = ecs_id(EcsTimer), .oper = EcsNot } + }, + .callback = ProgressTickSource + }); +} - ecs_table_t *table = it->table; - ecs_table_t *prev_table = it->other_table; - int32_t pivot_term = it->term_index; - ecs_term_t *term = &o->filter.terms[pivot_term]; +#endif - if (term->oper == EcsNot) { - table = it->other_table; - prev_table = it->table; - } +#include - if (!table) { - table = &world->store.root; - } - if (!prev_table) { - prev_table = &world->store.root; - } +/* Utilities for C++ API */ - static int obs_count = 0; - obs_count ++; +#ifdef FLECS_CPP - /* Populate the column for the term that triggered. This will allow the - * matching algorithm to pick the right column in case the term is a - * wildcard matching multiple columns. */ - user_it.columns[0] = 0; - user_it.columns[pivot_term] = it->columns[0]; +/* Convert compiler-specific typenames extracted from __PRETTY_FUNCTION__ to + * a uniform identifier */ - if (flecs_filter_match_table(world, &o->filter, table, - user_it.ids, user_it.columns, user_it.subjects, NULL, NULL, false, -1)) - { - /* Monitor observers only trigger when the filter matches for the first - * time with an entity */ - if (o->is_monitor) { - if (flecs_filter_match_table(world, &o->filter, prev_table, - NULL, NULL, NULL, NULL, NULL, true, -1)) - { - goto done; - } +#define ECS_CONST_PREFIX "const " +#define ECS_STRUCT_PREFIX "struct " +#define ECS_CLASS_PREFIX "class " +#define ECS_ENUM_PREFIX "enum " - if (term->oper == EcsNot) { - /* Flip event if this is a Not, so OnAdd and OnRemove can be - * reliably used to check if we're entering or leaving the - * monitor */ - if (it->event == EcsOnAdd) { - user_it.event = EcsOnRemove; - } else if (it->event == EcsOnRemove) { - user_it.event = EcsOnAdd; - } - } - } +#define ECS_CONST_LEN (-1 + (ecs_size_t)sizeof(ECS_CONST_PREFIX)) +#define ECS_STRUCT_LEN (-1 + (ecs_size_t)sizeof(ECS_STRUCT_PREFIX)) +#define ECS_CLASS_LEN (-1 + (ecs_size_t)sizeof(ECS_CLASS_PREFIX)) +#define ECS_ENUM_LEN (-1 + (ecs_size_t)sizeof(ECS_ENUM_PREFIX)) - flecs_iter_populate_data(world, &user_it, - it->table, it->offset, it->count, user_it.ptrs, user_it.sizes); +static +ecs_size_t ecs_cpp_strip_prefix( + char *typeName, + ecs_size_t len, + const char *prefix, + ecs_size_t prefix_len) +{ + if ((len > prefix_len) && !ecs_os_strncmp(typeName, prefix, prefix_len)) { + ecs_os_memmove(typeName, typeName + prefix_len, len - prefix_len); + typeName[len - prefix_len] = '\0'; + len -= prefix_len; + } + return len; +} - user_it.ids[it->term_index] = it->event_id; - user_it.system = o->entity; - user_it.term_index = it->term_index; - user_it.self = o->self; - user_it.ctx = o->ctx; - user_it.term_count = o->filter.term_count_actual; +static +void ecs_cpp_trim_type_name( + char *typeName) +{ + ecs_size_t len = ecs_os_strlen(typeName); - o->callback(&user_it); + len = ecs_cpp_strip_prefix(typeName, len, ECS_CONST_PREFIX, ECS_CONST_LEN); + len = ecs_cpp_strip_prefix(typeName, len, ECS_STRUCT_PREFIX, ECS_STRUCT_LEN); + len = ecs_cpp_strip_prefix(typeName, len, ECS_CLASS_PREFIX, ECS_CLASS_LEN); + len = ecs_cpp_strip_prefix(typeName, len, ECS_ENUM_PREFIX, ECS_ENUM_LEN); - ecs_iter_fini(&user_it); - return true; + while (typeName[len - 1] == ' ' || + typeName[len - 1] == '&' || + typeName[len - 1] == '*') + { + len --; + typeName[len] = '\0'; } -done: - ecs_iter_fini(&user_it); - return false; -} + /* Remove const at end of string */ + if (len > ECS_CONST_LEN) { + if (!ecs_os_strncmp(&typeName[len - ECS_CONST_LEN], " const", ECS_CONST_LEN)) { + typeName[len - ECS_CONST_LEN] = '\0'; + } + len -= ECS_CONST_LEN; + } -bool ecs_observer_default_run_action(ecs_iter_t *it) { - return observer_run(it); + /* Check if there are any remaining "struct " strings, which can happen + * if this is a template type on msvc. */ + if (len > ECS_STRUCT_LEN) { + char *ptr = typeName; + while ((ptr = strstr(ptr + 1, ECS_STRUCT_PREFIX)) != 0) { + /* Make sure we're not matched with part of a longer identifier + * that contains 'struct' */ + if (ptr[-1] == '<' || ptr[-1] == ',' || isspace(ptr[-1])) { + ecs_os_memmove(ptr, ptr + ECS_STRUCT_LEN, + ecs_os_strlen(ptr + ECS_STRUCT_LEN) + 1); + len -= ECS_STRUCT_LEN; + } + } + } } -static -void default_observer_run_callback(ecs_iter_t *it) { - observer_run(it); +char* ecs_cpp_get_type_name( + char *type_name, + const char *func_name, + size_t len) +{ + memcpy(type_name, func_name + ECS_FUNC_NAME_FRONT(const char*, type_name), len); + type_name[len] = '\0'; + ecs_cpp_trim_type_name(type_name); + return type_name; } -/* For convenience, so applications can (in theory) use a single run callback - * that uses ecs_iter_next to iterate results */ -static -bool default_observer_next_callback(ecs_iter_t *it) { - if (it->interrupted_by) { - return false; - } else { - it->interrupted_by = it->system; - return true; +char* ecs_cpp_get_symbol_name( + char *symbol_name, + const char *type_name, + size_t len) +{ + // Symbol is same as name, but with '::' replaced with '.' + ecs_os_strcpy(symbol_name, type_name); + + char *ptr; + size_t i; + for (i = 0, ptr = symbol_name; i < len && *ptr; i ++, ptr ++) { + if (*ptr == ':') { + symbol_name[i] = '.'; + ptr ++; + } else { + symbol_name[i] = *ptr; + } } -} -static -void observer_run_callback(ecs_iter_t *it) { - ecs_observer_t *o = it->ctx; - ecs_run_action_t run = o->run; + symbol_name[i] = '\0'; - if (run) { - it->next = default_observer_next_callback; - it->callback = default_observer_run_callback; - it->interrupted_by = 0; - run(it); - } else { - observer_run(it); - } + return symbol_name; } static -void observer_yield_existing( - ecs_world_t *world, - ecs_observer_t *observer) +const char* cpp_func_rchr( + const char *func_name, + ecs_size_t func_name_len, + char ch) { - ecs_run_action_t run = observer->run; - if (!run) { - run = default_observer_run_callback; + const char *r = strrchr(func_name, ch); + if ((r - func_name) >= (func_name_len - flecs_uto(ecs_size_t, ECS_FUNC_NAME_BACK))) { + return NULL; } + return r; +} - int32_t pivot_term = ecs_filter_pivot_term(world, &observer->filter); - if (pivot_term < 0) { - return; - } +static +const char* cpp_func_max( + const char *a, + const char *b) +{ + if (a > b) return a; + return b; +} - /* If yield existing is enabled, trigger for each thing that matches - * the event, if the event is iterable. */ - int i, count = observer->event_count; - for (i = 0; i < count; i ++) { - ecs_entity_t evt = observer->events[i]; - const EcsIterable *iterable = ecs_get(world, evt, EcsIterable); - if (!iterable) { - continue; - } +char* ecs_cpp_get_constant_name( + char *constant_name, + const char *func_name, + size_t func_name_len) +{ + ecs_size_t f_len = flecs_uto(ecs_size_t, func_name_len); + const char *start = cpp_func_rchr(func_name, f_len, ' '); + start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ')')); + start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ':')); + start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ',')); + ecs_assert(start != NULL, ECS_INVALID_PARAMETER, func_name); + start ++; + + ecs_size_t len = flecs_uto(ecs_size_t, + (f_len - (start - func_name) - flecs_uto(ecs_size_t, ECS_FUNC_NAME_BACK))); + ecs_os_memcpy_n(constant_name, start, char, len); + constant_name[len] = '\0'; + return constant_name; +} - ecs_iter_t it; - iterable->init(world, world, &it, &observer->filter.terms[pivot_term]); - it.terms = observer->filter.terms; - it.term_count = 1; - it.term_index = pivot_term; - it.system = observer->entity; - it.ctx = observer; - it.binding_ctx = observer->binding_ctx; - it.event = evt; +// Names returned from the name_helper class do not start with :: +// but are relative to the root. If the namespace of the type +// overlaps with the namespace of the current module, strip it from +// the implicit identifier. +// This allows for registration of component types that are not in the +// module namespace to still be registered under the module scope. +const char* ecs_cpp_trim_module( + ecs_world_t *world, + const char *type_name) +{ + ecs_entity_t scope = ecs_get_scope(world); + if (!scope) { + return type_name; + } - ecs_iter_next_action_t next = it.next; - ecs_assert(next != NULL, ECS_INTERNAL_ERROR, NULL); - while (next(&it)) { - run(&it); - world->event_id ++; + char *path = ecs_get_path_w_sep(world, 0, scope, "::", NULL); + if (path) { + const char *ptr = strrchr(type_name, ':'); + ecs_assert(ptr != type_name, ECS_INTERNAL_ERROR, NULL); + if (ptr) { + ptr --; + ecs_assert(ptr[0] == ':', ECS_INTERNAL_ERROR, NULL); + ecs_size_t name_path_len = (ecs_size_t)(ptr - type_name); + if (name_path_len <= ecs_os_strlen(path)) { + if (!ecs_os_strncmp(type_name, path, name_path_len)) { + type_name = &type_name[name_path_len + 2]; + } + } } } + ecs_os_free(path); + + return type_name; } -ecs_entity_t ecs_observer_init( +// Validate registered component +void ecs_cpp_component_validate( ecs_world_t *world, - const ecs_observer_desc_t *desc) + ecs_entity_t id, + const char *name, + size_t size, + size_t alignment, + bool implicit_name) { - ecs_entity_t entity = 0; - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); - ecs_check(desc->callback != NULL || desc->run != NULL, - ECS_INVALID_OPERATION, NULL); + /* If entity has a name check if it matches */ + if (ecs_is_valid(world, id) && ecs_get_name(world, id) != NULL) { + if (!implicit_name && id >= EcsFirstUserComponentId) { +# ifndef FLECS_NDEBUG + char *path = ecs_get_path_w_sep( + world, 0, id, "::", NULL); + if (ecs_os_strcmp(path, name)) { + ecs_err( + "component '%s' already registered with name '%s'", + name, path); + ecs_abort(ECS_INCONSISTENT_NAME, NULL); + } + ecs_os_free(path); +# endif + } + } else { + /* Ensure that the entity id valid */ + if (!ecs_is_alive(world, id)) { + ecs_ensure(world, id); + } - /* If entity is provided, create it */ - ecs_entity_t existing = desc->entity.entity; - entity = ecs_entity_init(world, &desc->entity); - if (!existing && !desc->entity.name) { - ecs_add_pair(world, entity, EcsChildOf, EcsFlecsHidden); + /* Register name with entity, so that when the entity is created the + * correct id will be resolved from the name. Only do this when the + * entity is empty. */ + ecs_add_path_w_sep(world, id, 0, name, "::", "::"); } - bool added = false; - EcsObserver *comp = ecs_get_mut(world, entity, EcsObserver, &added); - if (added) { - ecs_observer_t *observer = flecs_sparse_add( - world->observers, ecs_observer_t); - ecs_assert(observer != NULL, ECS_INTERNAL_ERROR, NULL); - observer->id = flecs_sparse_last_id(world->observers); - comp->observer = observer; + /* If a component was already registered with this id but with a + * different size, the ecs_component_init function will fail. */ - /* Make writeable copy of filter desc so that we can set name. This will - * make debugging easier, as any error messages related to creating the - * filter will have the name of the observer. */ - ecs_filter_desc_t filter_desc = desc->filter; - filter_desc.name = desc->entity.name; + /* We need to explicitly call ecs_component_init here again. Even though + * the component was already registered, it may have been registered + * with a different world. This ensures that the component is registered + * with the same id for the current world. + * If the component was registered already, nothing will change. */ + ecs_entity_t ent = ecs_component_init(world, &(ecs_component_desc_t) { + .entity.entity = id, + .size = size, + .alignment = alignment + }); + (void)ent; + ecs_assert(ent == id, ECS_INTERNAL_ERROR, NULL); +} - /* Parse filter */ - ecs_filter_t *filter = &observer->filter; - if (ecs_filter_init(world, filter, &filter_desc)) { - flecs_observer_fini(world, observer); - return 0; - } +ecs_entity_t ecs_cpp_component_register( + ecs_world_t *world, + ecs_entity_t id, + const char *name, + const char *symbol, + ecs_size_t size, + ecs_size_t alignment) +{ + (void)size; + (void)alignment; - /* Creating an observer with no terms has no effect */ - ecs_assert(observer->filter.term_count != 0, - ECS_INVALID_PARAMETER, NULL); + /* If the component is not yet registered, ensure no other component + * or entity has been registered with this name. Ensure component is + * looked up from root. */ + ecs_entity_t prev_scope = ecs_set_scope(world, 0); + ecs_entity_t ent; + if (id) { + ent = id; + } else { + ent = ecs_lookup_path_w_sep(world, 0, name, "::", "::", false); + } + ecs_set_scope(world, prev_scope); - int i, e; - for (i = 0; i < ECS_TRIGGER_DESC_EVENT_COUNT_MAX; i ++) { - ecs_entity_t event = desc->events[i]; - if (!event) { - break; - } + /* If entity exists, compare symbol name to ensure that the component + * we are trying to register under this name is the same */ + if (ent) { + if (!id && ecs_has(world, ent, EcsComponent)) { + const char *sym = ecs_get_symbol(world, ent); + ecs_assert(sym != NULL, ECS_MISSING_SYMBOL, + ecs_get_name(world, ent)); + (void)sym; - if (event == EcsMonitor) { - /* Monitor event must be first and last event */ - ecs_check(i == 0, ECS_INVALID_PARAMETER, NULL); +# ifndef FLECS_NDEBUG + if (ecs_os_strcmp(sym, symbol)) { + ecs_err( + "component with name '%s' is already registered for"\ + " type '%s' (trying to register for type '%s')", + name, sym, symbol); + ecs_abort(ECS_NAME_IN_USE, NULL); + } +# endif - observer->events[0] = EcsOnAdd; - observer->events[1] = EcsOnRemove; - observer->event_count ++; - observer->is_monitor = true; + /* If an existing id was provided, it's possible that this id was + * registered with another type. Make sure that in this case at + * least the component size/alignment matches. + * This allows applications to alias two different types to the same + * id, which enables things like redefining a C type in C++ by + * inheriting from it & adding utility functions etc. */ + } else { + const EcsComponent *comp = ecs_get(world, ent, EcsComponent); + if (comp) { + ecs_assert(comp->size == size, + ECS_INVALID_COMPONENT_SIZE, NULL); + ecs_assert(comp->alignment == alignment, + ECS_INVALID_COMPONENT_ALIGNMENT, NULL); } else { - observer->events[i] = event; + /* If the existing id is not a component, no checking is + * needed. */ } - - observer->event_count ++; } - /* Observer must have at least one event */ - ecs_check(observer->event_count != 0, ECS_INVALID_PARAMETER, NULL); + /* If no entity is found, lookup symbol to check if the component was + * registered under a different name. */ + } else { + ent = ecs_lookup_symbol(world, symbol, false); + ecs_assert(ent == 0, ECS_INCONSISTENT_COMPONENT_ID, symbol); + } - observer->callback = desc->callback; - observer->run = desc->run; - observer->self = desc->self; - observer->ctx = desc->ctx; - observer->binding_ctx = desc->binding_ctx; - observer->ctx_free = desc->ctx_free; - observer->binding_ctx_free = desc->binding_ctx_free; - observer->entity = entity; - comp->observer = observer; + return id; +} - /* Create a trigger for each term in the filter */ - ecs_trigger_desc_t tdesc = { - .callback = observer_run_callback, - .ctx = observer, - .binding_ctx = desc->binding_ctx, - .match_prefab = observer->filter.match_prefab, - .match_disabled = observer->filter.match_disabled, - .last_event_id = &observer->last_event_id - }; +ecs_entity_t ecs_cpp_component_register_explicit( + ecs_world_t *world, + ecs_entity_t s_id, + ecs_entity_t id, + const char *name, + const char *type_name, + const char *symbol, + size_t size, + size_t alignment, + bool is_component) +{ + // If an explicit id is provided, it is possible that the symbol and + // name differ from the actual type, as the application may alias + // one type to another. + if (!id) { + if (!name) { + // If no name was provided, retrieve the name implicitly from + // the name_helper class. + name = ecs_cpp_trim_module(world, type_name); + } + } else { + // If an explicit id is provided but it has no name, inherit + // the name from the type. + if (!ecs_is_valid(world, id) || !ecs_get_name(world, id)) { + name = ecs_cpp_trim_module(world, type_name); + } + } - for (i = 0; i < filter->term_count; i ++) { - tdesc.term = filter->terms[i]; - ecs_oper_kind_t oper = tdesc.term.oper; - ecs_id_t id = tdesc.term.id; - - bool is_tag = ecs_id_is_tag(world, id); + ecs_entity_t entity; + if (is_component || size != 0) { + entity = ecs_component_init(world, &(ecs_component_desc_t){ + .entity.entity = s_id, + .entity.name = name, + .entity.sep = "::", + .entity.root_sep = "::", + .entity.symbol = symbol, + .size = size, + .alignment = alignment + }); + } else { + entity = ecs_entity_init(world, &(ecs_entity_desc_t){ + .entity = s_id, + .name = name, + .sep = "::", + .root_sep = "::", + .symbol = symbol + }); + } - if (is_tag) { - /* If id is a tag, convert OnSet/UnSet to OnAdd/OnRemove. This - * allows for creating OnSet observers with both components and - * tags that only fire when the entity has all ids */ - for (e = 0; e < observer->event_count; e ++) { - if (observer->events[e] == EcsOnSet) { - tdesc.events[e] = EcsOnAdd; - } else - if (observer->events[e] == EcsUnSet) { - tdesc.events[e] = EcsOnRemove; - } else { - tdesc.events[e] = observer->events[e]; - } - } - } else { - ecs_os_memcpy_n(tdesc.events, observer->events, ecs_entity_t, - observer->event_count); - } + ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!s_id || s_id == entity, ECS_INTERNAL_ERROR, NULL); - /* AndFrom & OrFrom terms insert multiple triggers */ - if (oper == EcsAndFrom || oper == EcsOrFrom) { - const EcsType *type = ecs_get(world, id, EcsType); - int32_t ti, ti_count = ecs_vector_count(type->normalized->type); - ecs_id_t *ti_ids = ecs_vector_first( - type->normalized->type, ecs_id_t); + return entity; +} - /* Correct operator will be applied when a trigger occurs, and - * the observer is evaluated on the trigger source */ - tdesc.term.oper = EcsAnd; - for (ti = 0; ti < ti_count; ti ++) { - tdesc.term.pred.name = NULL; - tdesc.term.pred.entity = ti_ids[ti]; - tdesc.term.id = ti_ids[ti]; - ecs_entity_t t = ecs_vector_add(&observer->triggers, - ecs_entity_t)[0] = ecs_trigger_init(world, &tdesc); - if (!t) { - goto error; - } - } - continue; - } +ecs_entity_t ecs_cpp_enum_constant_register( + ecs_world_t *world, + ecs_entity_t parent, + ecs_entity_t id, + const char *name, + int value) +{ + ecs_suspend_readonly_state_t readonly_state; + world = flecs_suspend_readonly(world, &readonly_state); - ecs_entity_t t = ecs_vector_add(&observer->triggers, ecs_entity_t) - [0] = ecs_trigger_init(world, &tdesc); - if (!t) { - goto error; - } + const char *parent_name = ecs_get_name(world, parent); + ecs_size_t parent_name_len = ecs_os_strlen(parent_name); + if (!ecs_os_strncmp(name, parent_name, parent_name_len)) { + name += parent_name_len; + if (name[0] == '_') { + name ++; } + } - if (desc->entity.name) { - ecs_trace("#[green]observer#[reset] %s created", - ecs_get_name(world, entity)); - } + ecs_entity_t prev = ecs_set_scope(world, parent); + id = ecs_entity_init(world, &(ecs_entity_desc_t) { + .entity = id, + .name = name + }); + ecs_assert(id != 0, ECS_INVALID_OPERATION, name); + ecs_set_scope(world, prev); - if (desc->yield_existing) { - observer_yield_existing(world, observer); - } - } else { - ecs_assert(comp->observer != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_set_id(world, id, parent, sizeof(int), &value); - /* If existing entity handle was provided, override existing params */ - if (existing) { - if (desc->callback) { - ((ecs_observer_t*)comp->observer)->callback = desc->callback; - } - if (desc->ctx) { - ((ecs_observer_t*)comp->observer)->ctx = desc->ctx; - } - if (desc->binding_ctx) { - ((ecs_observer_t*)comp->observer)->binding_ctx = - desc->binding_ctx; - } - } - } + flecs_resume_readonly(world, &readonly_state); - return entity; -error: - if (entity) { - ecs_delete(world, entity); - } - return 0; + ecs_trace("#[green]constant#[reset] %s.%s created with value %d", + ecs_get_name(world, parent), name, value); + + return id; } -void flecs_observer_fini( - ecs_world_t *world, - ecs_observer_t *observer) -{ - /* Cleanup triggers */ - int i, count = ecs_vector_count(observer->triggers); - ecs_entity_t *triggers = ecs_vector_first(observer->triggers, ecs_entity_t); - for (i = 0; i < count; i ++) { - ecs_entity_t t = triggers[i]; - if (!t) continue; - ecs_delete(world, triggers[i]); - } - ecs_vector_free(observer->triggers); +static int32_t flecs_reset_count = 0; - /* Cleanup filters */ - ecs_filter_fini(&observer->filter); +int32_t ecs_cpp_reset_count_get(void) { + return flecs_reset_count; +} - /* Cleanup context */ - if (observer->ctx_free) { - observer->ctx_free(observer->ctx); - } +int32_t ecs_cpp_reset_count_inc(void) { + return ++flecs_reset_count; +} - if (observer->binding_ctx_free) { - observer->binding_ctx_free(observer->binding_ctx); - } +#endif - /* Cleanup observer storage */ - flecs_sparse_remove(world->observers, observer->id); -} -void* ecs_get_observer_ctx( - const ecs_world_t *world, - ecs_entity_t observer) +#ifdef FLECS_DEPRECATED + + +#endif + + +#ifdef FLECS_OS_API_IMPL +#ifdef ECS_TARGET_MSVC +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include +#include + +static +ecs_os_thread_t win_thread_new( + ecs_os_thread_callback_t callback, + void *arg) { - const EcsObserver *o = ecs_get(world, observer, EcsObserver); - if (o) { - return o->observer->ctx; - } else { - return NULL; - } + HANDLE *thread = ecs_os_malloc_t(HANDLE); + *thread = CreateThread( + NULL, 0, (LPTHREAD_START_ROUTINE)callback, arg, 0, NULL); + return (ecs_os_thread_t)(uintptr_t)thread; } -void* ecs_get_observer_binding_ctx( - const ecs_world_t *world, - ecs_entity_t observer) +static +void* win_thread_join( + ecs_os_thread_t thr) { - const EcsObserver *o = ecs_get(world, observer, EcsObserver); - if (o) { - return o->observer->binding_ctx; - } else { - return NULL; - } + HANDLE *thread = (HANDLE*)(uintptr_t)thr; + DWORD r = WaitForSingleObject(*thread, INFINITE); + if (r == WAIT_FAILED) { + ecs_err("win_thread_join: WaitForSingleObject failed"); + } + ecs_os_free(thread); + return NULL; } - -void flecs_observable_init( - ecs_observable_t *observable) +static +int32_t win_ainc( + int32_t *count) { - observable->events = ecs_sparse_new(ecs_event_record_t); + return InterlockedIncrement(count); } -void flecs_observable_fini( - ecs_observable_t *observable) +static +int32_t win_adec( + int32_t *count) { - ecs_sparse_t *triggers = observable->events; - int32_t i, count = flecs_sparse_count(triggers); + return InterlockedDecrement(count); +} - for (i = 0; i < count; i ++) { - ecs_event_record_t *et = - ecs_sparse_get_dense(triggers, ecs_event_record_t, i); - ecs_assert(et != NULL, ECS_INTERNAL_ERROR, NULL); +static +ecs_os_mutex_t win_mutex_new(void) { + CRITICAL_SECTION *mutex = ecs_os_malloc_t(CRITICAL_SECTION); + InitializeCriticalSection(mutex); + return (ecs_os_mutex_t)(uintptr_t)mutex; +} - ecs_map_iter_t it = ecs_map_iter(&et->event_ids); - ecs_event_id_record_t *idt; - while ((idt = ecs_map_next(&it, ecs_event_id_record_t, NULL))) { - ecs_map_fini(&idt->triggers); - ecs_map_fini(&idt->set_triggers); - } - ecs_map_fini(&et->event_ids); - } +static +void win_mutex_free( + ecs_os_mutex_t m) +{ + CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; + DeleteCriticalSection(mutex); + ecs_os_free(mutex); +} - flecs_sparse_free(observable->events); +static +void win_mutex_lock( + ecs_os_mutex_t m) +{ + CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; + EnterCriticalSection(mutex); } static -void notify_subset( - ecs_world_t *world, - ecs_iter_t *it, - ecs_observable_t *observable, - ecs_entity_t entity, - ecs_entity_t event, - ecs_ids_t *ids) +void win_mutex_unlock( + ecs_os_mutex_t m) { - ecs_id_t pair = ecs_pair(EcsWildcard, entity); - ecs_table_cache_iter_t idt; - ecs_id_record_t *idr = flecs_table_iter(world, pair, &idt); - if (!idr) { - return; - } + CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; + LeaveCriticalSection(mutex); +} - const ecs_table_record_t *tr; - while ((tr = flecs_table_cache_next(&idt, ecs_table_record_t))) { - ecs_table_t *table = tr->hdr.table; - ecs_id_t id = ecs_vector_get(table->type, ecs_id_t, tr->column)[0]; - ecs_entity_t rel = ECS_PAIR_FIRST(id); +static +ecs_os_cond_t win_cond_new(void) { + CONDITION_VARIABLE *cond = ecs_os_malloc_t(CONDITION_VARIABLE); + InitializeConditionVariable(cond); + return (ecs_os_cond_t)(uintptr_t)cond; +} - if (ecs_is_valid(world, rel) && !ecs_has_id(world, rel, EcsAcyclic)) { - /* Only notify for acyclic relations */ - continue; - } +static +void win_cond_free( + ecs_os_cond_t c) +{ + (void)c; +} - int32_t e, entity_count = ecs_table_count(table); - it->table = table; - it->type = table->type; - it->other_table = NULL; - it->offset = 0; - it->count = entity_count; +static +void win_cond_signal( + ecs_os_cond_t c) +{ + CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; + WakeConditionVariable(cond); +} - /* Treat as new event as this could trigger observers again for - * different tables. */ - world->event_id ++; +static +void win_cond_broadcast( + ecs_os_cond_t c) +{ + CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; + WakeAllConditionVariable(cond); +} - flecs_set_triggers_notify(it, observable, ids, event, - ecs_pair(rel, EcsWildcard)); +static +void win_cond_wait( + ecs_os_cond_t c, + ecs_os_mutex_t m) +{ + CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; + CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; + SleepConditionVariableCS(cond, mutex, INFINITE); +} - ecs_entity_t *entities = ecs_vector_first( - table->storage.entities, ecs_entity_t); - ecs_record_t **records = ecs_vector_first( - table->storage.record_ptrs, ecs_record_t*); +static bool win_time_initialized; +static double win_time_freq; +static LARGE_INTEGER win_time_start; - for (e = 0; e < entity_count; e ++) { - uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(records[e]->row); - if (flags & ECS_FLAG_OBSERVED_ACYCLIC) { - /* Only notify for entities that are used in pairs with - * acyclic relations */ - notify_subset(world, it, observable, entities[e], event, ids); - } - } +static +void win_time_setup(void) { + if ( win_time_initialized) { + return; } + + win_time_initialized = true; + + LARGE_INTEGER freq; + QueryPerformanceFrequency(&freq); + QueryPerformanceCounter(&win_time_start); + win_time_freq = (double)freq.QuadPart / 1000000000.0; } -void ecs_emit( - ecs_world_t *world, - ecs_event_desc_t *desc) +static +void win_sleep( + int32_t sec, + int32_t nanosec) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->event != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->event != EcsWildcard, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->ids != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->ids->count != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->table != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->observable != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_ids_t *ids = desc->ids; - ecs_entity_t event = desc->event; - ecs_table_t *table = desc->table; - int32_t row = desc->offset; - int32_t i, count = desc->count; - ecs_entity_t relation = desc->relation; - - if (!count) { - count = ecs_table_count(table) - row; - } + HANDLE timer; + LARGE_INTEGER ft; - ecs_iter_t it = { - .world = world, - .real_world = world, - .table = table, - .type = table->type, - .term_count = 1, - .other_table = desc->other_table, - .offset = row, - .count = count, - .param = (void*)desc->param, - .table_only = desc->table_event - }; + ft.QuadPart = -((int64_t)sec * 10000000 + (int64_t)nanosec / 100); - world->event_id ++; + timer = CreateWaitableTimer(NULL, TRUE, NULL); + SetWaitableTimer(timer, &ft, 0, NULL, NULL, 0); + WaitForSingleObject(timer, INFINITE); + CloseHandle(timer); +} - ecs_observable_t *observable = ecs_get_observable(desc->observable); - ecs_check(observable != NULL, ECS_INVALID_PARAMETER, NULL); +static double win_time_freq; +static ULONG win_current_resolution; - if (!desc->relation) { - flecs_triggers_notify(&it, observable, ids, event); - } else { - flecs_set_triggers_notify(&it, observable, ids, event, - ecs_pair(relation, EcsWildcard)); +static +void win_enable_high_timer_resolution(bool enable) +{ + HMODULE hntdll = GetModuleHandle((LPCTSTR)"ntdll.dll"); + if (!hntdll) { + return; } - if (count && !desc->table_event) { - ecs_record_t **recs = ecs_vector_get( - table->storage.record_ptrs, ecs_record_t*, row); + LONG (__stdcall *pNtSetTimerResolution)( + ULONG desired, BOOLEAN set, ULONG * current); - for (i = 0; i < count; i ++) { - ecs_record_t *r = recs[i]; - if (!r) { - /* If the event is emitted after a bulk operation, it's possible - * that it hasn't been populate with entities yet. */ - continue; - } + pNtSetTimerResolution = (LONG(__stdcall*)(ULONG, BOOLEAN, ULONG*)) + GetProcAddress(hntdll, "NtSetTimerResolution"); - uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(recs[i]->row); - if (flags & ECS_FLAG_OBSERVED_ACYCLIC) { - notify_subset(world, &it, observable, ecs_vector_first( - table->storage.entities, ecs_entity_t)[row + i], - event, ids); - } - } + if(!pNtSetTimerResolution) { + return; } - -error: - return; -} + ULONG current, resolution = 10000; /* 1 ms */ -#ifdef FLECS_SYSTEM -#ifndef FLECS_SYSTEM_PRIVATE_H -#define FLECS_SYSTEM_PRIVATE_H + if (!enable && win_current_resolution) { + pNtSetTimerResolution(win_current_resolution, 0, ¤t); + win_current_resolution = 0; + return; + } else if (!enable) { + return; + } -#ifdef FLECS_SYSTEM + if (resolution == win_current_resolution) { + return; + } + if (win_current_resolution) { + pNtSetTimerResolution(win_current_resolution, 0, ¤t); + } -typedef struct EcsSystem { - ecs_run_action_t run; /* See ecs_system_desc_t */ - ecs_iter_action_t action; /* See ecs_system_desc_t */ + if (pNtSetTimerResolution(resolution, 1, ¤t)) { + /* Try setting a lower resolution */ + resolution *= 2; + if(pNtSetTimerResolution(resolution, 1, ¤t)) return; + } - ecs_entity_t entity; /* Entity id of system, used for ordering */ - ecs_query_t *query; /* System query */ - ecs_system_status_action_t status_action; /* Status action */ - ecs_entity_t tick_source; /* Tick source associated with system */ - - /* Schedule parameters */ - bool multi_threaded; - bool no_staging; + win_current_resolution = resolution; +} - int32_t invoke_count; /* Number of times system is invoked */ - float time_spent; /* Time spent on running system */ - FLECS_FLOAT time_passed; /* Time passed since last invocation */ - int32_t last_frame; /* Last frame for which the system was considered */ +static +uint64_t win_time_now(void) { + uint64_t now; - ecs_entity_t self; /* Entity associated with system */ + LARGE_INTEGER qpc_t; + QueryPerformanceCounter(&qpc_t); + now = (uint64_t)(qpc_t.QuadPart / win_time_freq); - void *ctx; /* Userdata for system */ - void *status_ctx; /* User data for status action */ - void *binding_ctx; /* Optional language binding context */ + return now; +} - ecs_ctx_free_t ctx_free; - ecs_ctx_free_t status_ctx_free; - ecs_ctx_free_t binding_ctx_free; -} EcsSystem; +void ecs_set_os_api_impl(void) { + ecs_os_set_api_defaults(); -/* Invoked when system becomes active / inactive */ -void ecs_system_activate( - ecs_world_t *world, - ecs_entity_t system, - bool activate, - const EcsSystem *system_data); + ecs_os_api_t api = ecs_os_api; -/* Internal function to run a system */ -ecs_entity_t ecs_run_intern( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t system, - EcsSystem *system_data, - int32_t stage_current, - int32_t stage_count, - FLECS_FLOAT delta_time, - int32_t offset, - int32_t limit, - void *param); + api.thread_new_ = win_thread_new; + api.thread_join_ = win_thread_join; + api.ainc_ = win_ainc; + api.adec_ = win_adec; + api.mutex_new_ = win_mutex_new; + api.mutex_free_ = win_mutex_free; + api.mutex_lock_ = win_mutex_lock; + api.mutex_unlock_ = win_mutex_unlock; + api.cond_new_ = win_cond_new; + api.cond_free_ = win_cond_free; + api.cond_signal_ = win_cond_signal; + api.cond_broadcast_ = win_cond_broadcast; + api.cond_wait_ = win_cond_wait; + api.sleep_ = win_sleep; + api.now_ = win_time_now; + api.enable_high_timer_resolution_ = win_enable_high_timer_resolution; -#endif + win_time_setup(); -#endif + ecs_os_set_api(&api); +} + +#else +#include "pthread.h" +#if defined(__APPLE__) && defined(__MACH__) +#include +#elif defined(__EMSCRIPTEN__) +#include +#else +#include #endif static -void compute_group_id( - ecs_query_t *query, - ecs_query_table_match_t *match) +ecs_os_thread_t posix_thread_new( + ecs_os_thread_callback_t callback, + void *arg) { - ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - - if (query->group_by) { - ecs_table_t *table = match->table; - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + pthread_t *thread = ecs_os_malloc(sizeof(pthread_t)); - match->group_id = query->group_by(query->world, table->type, - query->group_by_id, query->group_by_ctx); - } else { - match->group_id = 0; + if (pthread_create (thread, NULL, callback, arg) != 0) { + ecs_os_abort(); } + + return (ecs_os_thread_t)(uintptr_t)thread; } static -ecs_query_table_list_t* get_group( - ecs_query_t *query, - uint64_t group_id) +void* posix_thread_join( + ecs_os_thread_t thread) { - return ecs_map_get(&query->groups, ecs_query_table_list_t, group_id); + void *arg; + pthread_t *thr = (pthread_t*)(uintptr_t)thread; + pthread_join(*thr, &arg); + ecs_os_free(thr); + return arg; } static -ecs_query_table_list_t* ensure_group( - ecs_query_t *query, - uint64_t group_id) +int32_t posix_ainc( + int32_t *count) { - return ecs_map_ensure(&query->groups, ecs_query_table_list_t, group_id); + int value; +#ifdef __GNUC__ + value = __sync_add_and_fetch (count, 1); + return value; +#else + /* Unsupported */ + abort(); +#endif } -/* Find the last node of the group after which this group should be inserted */ static -ecs_query_table_node_t* find_group_insertion_node( - ecs_query_t *query, - uint64_t group_id) +int32_t posix_adec( + int32_t *count) { - /* Grouping must be enabled */ - ecs_assert(query->group_by != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_map_iter_t it = ecs_map_iter(&query->groups); - ecs_query_table_list_t *list, *closest_list = NULL; - uint64_t id, closest_id = 0; - - /* Find closest smaller group id */ - while ((list = ecs_map_next(&it, ecs_query_table_list_t, &id))) { - if (id >= group_id) { - continue; - } - - if (!list->last) { - ecs_assert(list->first == NULL, ECS_INTERNAL_ERROR, NULL); - continue; - } - - if (!closest_list || ((group_id - id) < (group_id - closest_id))) { - closest_id = id; - closest_list = list; - } - } + int value; +#ifdef __GNUC__ + value = __sync_sub_and_fetch (count, 1); + return value; +#else + /* Unsupported */ + abort(); +#endif +} - if (closest_list) { - return closest_list->last; - } else { - return NULL; /* Group should be first in query */ +static +ecs_os_mutex_t posix_mutex_new(void) { + pthread_mutex_t *mutex = ecs_os_malloc(sizeof(pthread_mutex_t)); + if (pthread_mutex_init(mutex, NULL)) { + abort(); } + return (ecs_os_mutex_t)(uintptr_t)mutex; } -/* Initialize group with first node */ static -void create_group( - ecs_query_t *query, - ecs_query_table_node_t *node) +void posix_mutex_free( + ecs_os_mutex_t m) { - ecs_query_table_match_t *match = node->match; - uint64_t group_id = match->group_id; - - /* If query has grouping enabled & this is a new/empty group, find - * the insertion point for the group */ - ecs_query_table_node_t *insert_after = find_group_insertion_node( - query, group_id); - - if (!insert_after) { - /* This group should appear first in the query list */ - ecs_query_table_node_t *query_first = query->list.first; - if (query_first) { - /* If this is not the first match for the query, insert before it */ - node->next = query_first; - query_first->prev = node; - query->list.first = node; - } else { - /* If this is the first match of the query, initialize its list */ - ecs_assert(query->list.last == NULL, ECS_INTERNAL_ERROR, NULL); - query->list.first = node; - query->list.last = node; - } - } else { - ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); + pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; + pthread_mutex_destroy(mutex); + ecs_os_free(mutex); +} - /* This group should appear after another group */ - ecs_query_table_node_t *insert_before = insert_after->next; - node->prev = insert_after; - insert_after->next = node; - node->next = insert_before; - if (insert_before) { - insert_before->prev = node; - } else { - ecs_assert(query->list.last == insert_after, - ECS_INTERNAL_ERROR, NULL); - - /* This group should appear last in the query list */ - query->list.last = node; - } +static +void posix_mutex_lock( + ecs_os_mutex_t m) +{ + pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; + if (pthread_mutex_lock(mutex)) { + abort(); } } static -void remove_group( - ecs_query_t *query, - uint64_t group_id) +void posix_mutex_unlock( + ecs_os_mutex_t m) { - ecs_map_remove(&query->groups, group_id); + pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; + if (pthread_mutex_unlock(mutex)) { + abort(); + } } -/* Find the list the node should be part of */ static -ecs_query_table_list_t* get_node_list( - ecs_query_t *query, - ecs_query_table_node_t *node) +ecs_os_cond_t posix_cond_new(void) { + pthread_cond_t *cond = ecs_os_malloc(sizeof(pthread_cond_t)); + if (pthread_cond_init(cond, NULL)) { + abort(); + } + return (ecs_os_cond_t)(uintptr_t)cond; +} + +static +void posix_cond_free( + ecs_os_cond_t c) { - ecs_query_table_match_t *match = node->match; - if (query->group_by) { - return get_group(query, match->group_id); - } else { - return &query->list; + pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; + if (pthread_cond_destroy(cond)) { + abort(); } + ecs_os_free(cond); } -/* Find or create the list the node should be part of */ -static -ecs_query_table_list_t* ensure_node_list( - ecs_query_t *query, - ecs_query_table_node_t *node) +static +void posix_cond_signal( + ecs_os_cond_t c) { - ecs_query_table_match_t *match = node->match; - if (query->group_by) { - return ensure_group(query, match->group_id); - } else { - return &query->list; + pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; + if (pthread_cond_signal(cond)) { + abort(); } } -/* Remove node from list */ -static -void remove_table_node( - ecs_query_t *query, - ecs_query_table_node_t *node) +static +void posix_cond_broadcast( + ecs_os_cond_t c) { - ecs_query_table_node_t *prev = node->prev; - ecs_query_table_node_t *next = node->next; + pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; + if (pthread_cond_broadcast(cond)) { + abort(); + } +} - ecs_assert(prev != node, ECS_INTERNAL_ERROR, NULL); - ecs_assert(next != node, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!prev || prev != next, ECS_INTERNAL_ERROR, NULL); +static +void posix_cond_wait( + ecs_os_cond_t c, + ecs_os_mutex_t m) +{ + pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; + pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; + if (pthread_cond_wait(cond, mutex)) { + abort(); + } +} - ecs_query_table_list_t *list = get_node_list(query, node); +static bool posix_time_initialized; - if (!list || !list->first) { - /* If list contains no nodes, the node must be empty */ - ecs_assert(!list || list->last == NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(prev == NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(next == NULL, ECS_INTERNAL_ERROR, NULL); +#if defined(__APPLE__) && defined(__MACH__) +static mach_timebase_info_data_t posix_osx_timebase; +static uint64_t posix_time_start; +#else +static uint64_t posix_time_start; +#endif + +static +void posix_time_setup(void) { + if (posix_time_initialized) { return; } + + posix_time_initialized = true; - ecs_assert(prev != NULL || query->list.first == node, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(next != NULL || query->list.last == node, - ECS_INTERNAL_ERROR, NULL); + #if defined(__APPLE__) && defined(__MACH__) + mach_timebase_info(&posix_osx_timebase); + posix_time_start = mach_absolute_time(); + #else + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + posix_time_start = (uint64_t)ts.tv_sec*1000000000 + (uint64_t)ts.tv_nsec; + #endif +} - if (prev) { - prev->next = next; - } - if (next) { - next->prev = prev; +static +void posix_sleep( + int32_t sec, + int32_t nanosec) +{ + struct timespec sleepTime; + ecs_assert(sec >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(nanosec >= 0, ECS_INTERNAL_ERROR, NULL); + + sleepTime.tv_sec = sec; + sleepTime.tv_nsec = nanosec; + if (nanosleep(&sleepTime, NULL)) { + ecs_err("nanosleep failed"); } +} - ecs_assert(list->count > 0, ECS_INTERNAL_ERROR, NULL); - list->count --; +static +void posix_enable_high_timer_resolution(bool enable) { + (void)enable; +} - if (query->group_by) { - ecs_query_table_match_t *match = node->match; - uint64_t group_id = match->group_id; +/* prevent 64-bit overflow when computing relative timestamp + see https://gist.github.com/jspohr/3dc4f00033d79ec5bdaf67bc46c813e3 +*/ +#if defined(ECS_TARGET_DARWIN) +static +int64_t posix_int64_muldiv(int64_t value, int64_t numer, int64_t denom) { + int64_t q = value / denom; + int64_t r = value % denom; + return q * numer + r * numer / denom; +} +#endif - /* Make sure query.list is updated if this is the first or last group */ - if (query->list.first == node) { - ecs_assert(prev == NULL, ECS_INTERNAL_ERROR, NULL); - query->list.first = next; - prev = next; - } - if (query->list.last == node) { - ecs_assert(next == NULL, ECS_INTERNAL_ERROR, NULL); - query->list.last = prev; - next = prev; - } +static +uint64_t posix_time_now(void) { + ecs_assert(posix_time_initialized != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.count > 0, ECS_INTERNAL_ERROR, NULL); - query->list.count --; + uint64_t now; - /* Make sure group list only contains nodes that belong to the group */ - if (prev && prev->match->group_id != group_id) { - /* The previous node belonged to another group */ - prev = next; - } - if (next && next->match->group_id != group_id) { - /* The next node belonged to another group */ - next = prev; - } + #if defined(ECS_TARGET_DARWIN) + now = (uint64_t) posix_int64_muldiv( + (int64_t)mach_absolute_time(), + (int64_t)posix_osx_timebase.numer, + (int64_t)posix_osx_timebase.denom); + #elif defined(__EMSCRIPTEN__) + now = (long long)(emscripten_get_now() * 1000.0 * 1000); + #else + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + now = ((uint64_t)ts.tv_sec * 1000 * 1000 * 1000 + (uint64_t)ts.tv_nsec); + #endif - /* Do check again, in case both prev & next belonged to another group */ - if (prev && prev->match->group_id != group_id) { - /* There are no more matches left in this group */ - remove_group(query, group_id); - list = NULL; - } - } + return now; +} - if (list) { - if (list->first == node) { - list->first = next; - } - if (list->last == node) { - list->last = prev; - } - } +void ecs_set_os_api_impl(void) { + ecs_os_set_api_defaults(); - node->prev = NULL; - node->next = NULL; + ecs_os_api_t api = ecs_os_api; -#ifdef FLECS_SYSTEM - if (query->list.first == NULL && query->system && !query->world->is_fini) { - ecs_system_activate(query->world, query->system, false, NULL); - } -#endif + api.thread_new_ = posix_thread_new; + api.thread_join_ = posix_thread_join; + api.ainc_ = posix_ainc; + api.adec_ = posix_adec; + api.mutex_new_ = posix_mutex_new; + api.mutex_free_ = posix_mutex_free; + api.mutex_lock_ = posix_mutex_lock; + api.mutex_unlock_ = posix_mutex_unlock; + api.cond_new_ = posix_cond_new; + api.cond_free_ = posix_cond_free; + api.cond_signal_ = posix_cond_signal; + api.cond_broadcast_ = posix_cond_broadcast; + api.cond_wait_ = posix_cond_wait; + api.sleep_ = posix_sleep; + api.now_ = posix_time_now; + api.enable_high_timer_resolution_ = posix_enable_high_timer_resolution; - query->match_count ++; -} + posix_time_setup(); -/* Add node to list */ -static -void insert_table_node( - ecs_query_t *query, - ecs_query_table_node_t *node) -{ - /* Node should not be part of an existing list */ - ecs_assert(node->prev == NULL && node->next == NULL, - ECS_INTERNAL_ERROR, NULL); + ecs_os_set_api(&api); +} - /* If this is the first match, activate system */ -#ifdef FLECS_SYSTEM - if (!query->list.first && query->system) { - ecs_system_activate(query->world, query->system, true, NULL); - } +#endif #endif - compute_group_id(query, node->match); - - ecs_query_table_list_t *list = ensure_node_list(query, node); - if (list->last) { - ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(list->first != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_query_table_node_t *last = list->last; - ecs_query_table_node_t *last_next = last->next; - node->prev = last; - node->next = last_next; - last->next = node; +#ifdef FLECS_PLECS - if (last_next) { - last_next->prev = node; - } +#include +#include - list->last = node; +#define TOK_NEWLINE '\n' +#define TOK_WITH "with" +#define TOK_USING "using" - if (query->group_by) { - /* Make sure to update query list if this is the last group */ - if (query->list.last == last) { - query->list.last = node; - } - } - } else { - ecs_assert(list->first == NULL, ECS_INTERNAL_ERROR, NULL); +#define STACK_MAX_SIZE (64) - list->first = node; - list->last = node; +typedef struct { + const char *name; + const char *code; - if (query->group_by) { - /* Initialize group with its first node */ - create_group(query, node); - } - } + ecs_entity_t last_predicate; + ecs_entity_t last_subject; + ecs_entity_t last_object; - if (query->group_by) { - query->list.count ++; - } + ecs_id_t last_assign_id; + ecs_entity_t assign_to; - list->count ++; - query->match_count ++; + ecs_entity_t scope[STACK_MAX_SIZE]; + ecs_entity_t default_scope_type[STACK_MAX_SIZE]; + ecs_entity_t with[STACK_MAX_SIZE]; + ecs_entity_t using[STACK_MAX_SIZE]; + int32_t with_frames[STACK_MAX_SIZE]; + int32_t using_frames[STACK_MAX_SIZE]; + int32_t sp; + int32_t with_frame; + int32_t using_frame; - ecs_assert(node->prev != node, ECS_INTERNAL_ERROR, NULL); - ecs_assert(node->next != node, ECS_INTERNAL_ERROR, NULL); + char *comment; - ecs_assert(list->first != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(list->last != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(list->last == node, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.first->prev == NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(query->list.last->next == NULL, ECS_INTERNAL_ERROR, NULL); -} + bool with_stmt; + bool scope_assign_stmt; + bool using_stmt; + bool assign_stmt; + bool isa_stmt; + + int32_t errors; +} plecs_state_t; static -ecs_query_table_match_t* cache_add( - ecs_query_table_t *elem) +ecs_entity_t plecs_lookup( + const ecs_world_t *world, + const char *path, + plecs_state_t *state, + bool is_subject) { - ecs_query_table_match_t *result = ecs_os_calloc_t(ecs_query_table_match_t); - ecs_query_table_node_t *node = &result->node; + ecs_entity_t e = 0; - node->match = result; - if (!elem->first) { - elem->first = result; - elem->last = result; - } else { - ecs_assert(elem->last != NULL, ECS_INTERNAL_ERROR, NULL); - elem->last->next_match = result; - elem->last = result; + if (!is_subject) { + int using_scope = state->using_frame - 1; + for (; using_scope >= 0; using_scope--) { + e = ecs_lookup_path_w_sep( + world, state->using[using_scope], path, NULL, NULL, false); + if (e) { + break; + } + } } - return result; -} + if (!e) { + e = ecs_lookup_path_w_sep(world, 0, path, NULL, NULL, !is_subject); + } -typedef struct { - ecs_table_t *table; - int32_t *dirty_state; - int32_t column; -} table_dirty_state_t; + return e; +} +/* Lookup action used for deserializing entity refs in component values */ +#ifdef FLECS_EXPR static -void get_dirty_state( - ecs_query_t *query, - ecs_query_table_match_t *match, - int32_t term, - table_dirty_state_t *out) +ecs_entity_t plecs_lookup_action( + const ecs_world_t *world, + const char *path, + void *ctx) { - ecs_world_t *world = query->world; - ecs_entity_t subject = match->subjects[term]; - int32_t column; - - if (!subject) { - out->table = match->table; - column = match->columns[term]; - if (column == -1) { - column = 0; - } - } else { - out->table = ecs_get_table(world, subject); - column = -match->columns[term]; - } + return plecs_lookup(world, path, ctx, false); +} +#endif - out->dirty_state = flecs_table_get_dirty_state(out->table); +static +void clear_comment( + const char *expr, + const char *ptr, + plecs_state_t *state) +{ + if (state->comment) { + ecs_parser_error(state->name, expr, ptr - expr, "unused doc comment"); + ecs_os_free(state->comment); + state->comment = NULL; - if (column) { - out->column = ecs_table_type_to_storage_index(out->table, column - 1); - } else { - out->column = -1; + state->errors ++; /* Non-fatal error */ } } -/* Get match monitor. Monitors are used to keep track of whether components - * matched by the query in a table have changed. */ static -bool get_match_monitor( - ecs_query_t *query, - ecs_query_table_match_t *match) +const char* parse_fluff( + const char *expr, + const char *ptr, + plecs_state_t *state) { - if (match->monitor) { - return false; - } - - int32_t *monitor = ecs_os_calloc_n(int32_t, query->filter.term_count + 1); + char *comment; + const char *next = ecs_parse_fluff(ptr, &comment); - /* Mark terms that don't need to be monitored. This saves time when reading - * and/or updating the monitor. */ - const ecs_filter_t *f = &query->filter; - int32_t i, t = -1, term_count = f->term_count_actual; - table_dirty_state_t cur_dirty_state; + if (comment && comment[0] == '/') { + comment = (char*)ecs_parse_fluff(comment + 1, NULL); + int32_t len = (ecs_size_t)(next - comment); + int32_t newline_count = 0; - for (i = 0; i < term_count; i ++) { - if (t == f->terms[i].index) { - if (monitor[t + 1] != -1) { - continue; + /* Trim trailing whitespaces */ + while (len >= 0 && (isspace(comment[len - 1]))) { + if (comment[len - 1] == '\n') { + newline_count ++; + if (newline_count > 1) { + /* If newline separates comment from statement, discard */ + len = -1; + break; + } } + len --; } - t = f->terms[i].index; - monitor[t + 1] = -1; - - if (f->terms[i].inout != EcsIn && - f->terms[i].inout != EcsInOut && - f->terms[i].inout != EcsInOutDefault) { - continue; /* If term isn't read, don't monitor */ - } - - int32_t column = match->columns[t]; - if (column == 0) { - continue; /* Don't track terms that aren't matched */ + if (len > 0) { + clear_comment(expr, ptr, state); + state->comment = ecs_os_calloc_n(char, len + 1); + ecs_os_strncpy(state->comment, comment, len); + } else { + ecs_parser_error(state->name, expr, ptr - expr, + "unused doc comment"); + state->errors ++; } - - get_dirty_state(query, match, t, &cur_dirty_state); - if (cur_dirty_state.column == -1) { - continue; /* Don't track terms that aren't stored */ + } else { + if (ptr != next && state->comment) { + clear_comment(expr, ptr, state); } - - monitor[t + 1] = 0; } - match->monitor = monitor; - - query->flags |= EcsQueryHasMonitor; - - return true; + return next; } -/* Synchronize match monitor with table dirty state */ static -void sync_match_monitor( - ecs_query_t *query, - ecs_query_table_match_t *match) +ecs_entity_t ensure_entity( + ecs_world_t *world, + plecs_state_t *state, + const char *path, + bool is_subject) { - ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - if (!match->monitor) { - if (query->flags & EcsQueryHasMonitor) { - get_match_monitor(query, match); - } else { - return; - } + if (!path) { + return 0; } - int32_t *monitor = match->monitor; - ecs_table_t *table = match->table; - int32_t *dirty_state = flecs_table_get_dirty_state(table); - ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - table_dirty_state_t cur; + ecs_entity_t e = plecs_lookup(world, path, state, is_subject); + if (!e) { + if (!is_subject) { + /* If this is not a subject create an existing empty id, which + * ensures that scope & with are not applied */ + e = ecs_new_id(world); + } - monitor[0] = dirty_state[0]; /* Did table gain/lose entities */ + e = ecs_add_path(world, e, 0, path); + ecs_assert(e != 0, ECS_INTERNAL_ERROR, NULL); + } else { + /* If entity exists, make sure it gets the right scope and with */ + if (is_subject) { + ecs_entity_t scope = ecs_get_scope(world); + if (scope) { + ecs_add_pair(world, e, EcsChildOf, scope); + } - int32_t i, term_count = query->filter.term_count_actual; - for (i = 0; i < term_count; i ++) { - int32_t t = query->filter.terms[i].index; - if (monitor[t + 1] == -1) { - continue; + ecs_entity_t with = ecs_get_with(world); + if (with) { + ecs_add_id(world, e, with); + } } - - get_dirty_state(query, match, t, &cur); - ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); - monitor[t + 1] = cur.dirty_state[cur.column + 1]; } + + return e; } -/* Check if single match term has changed */ static -bool check_match_monitor_term( - ecs_query_t *query, - ecs_query_table_match_t *match, - int32_t term) +bool pred_is_subj( + ecs_term_t *term, + plecs_state_t *state) { - ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - - if (get_match_monitor(query, match)) { - return true; + if (term->subj.name != NULL) { + return false; } - - int32_t *monitor = match->monitor; - ecs_table_t *table = match->table; - int32_t *dirty_state = flecs_table_get_dirty_state(table); - ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - table_dirty_state_t cur; - - int32_t state = monitor[term]; - if (state == -1) { + if (term->obj.name != NULL) { return false; } - - if (!term) { - return monitor[0] != dirty_state[0]; + if (term->subj.set.mask == EcsNothing) { + return false; + } + if (state->with_stmt) { + return false; + } + if (state->assign_stmt) { + return false; + } + if (state->isa_stmt) { + return false; + } + if (state->using_stmt) { + return false; } - get_dirty_state(query, match, term - 1, &cur); - ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); + return true; +} - return monitor[term] != cur.dirty_state[cur.column + 1]; +/* Set masks aren't useful in plecs, so translate them back to entity names */ +static +const char* set_mask_to_name( + ecs_flags32_t flags) +{ + if (flags == EcsSelf) { + return "self"; + } else if (flags == EcsAll) { + return "all"; + } else if (flags == EcsSuperSet) { + return "super"; + } else if (flags == EcsSubSet) { + return "sub"; + } else if (flags == EcsCascade || flags == (EcsSuperSet|EcsCascade)) { + return "cascade"; + } else if (flags == EcsParent) { + return "parent"; + } + return NULL; } -/* Check if any term for match has changed */ static -bool check_match_monitor( - ecs_query_t *query, - ecs_query_table_match_t *match) +int create_term( + ecs_world_t *world, + ecs_term_t *term, + const char *name, + const char *expr, + int64_t column, + plecs_state_t *state) { - ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); + state->last_subject = 0; + state->last_predicate = 0; + state->last_object = 0; + state->last_assign_id = 0; - if (get_match_monitor(query, match)) { - return true; + const char *pred_name = term->pred.name; + const char *subj_name = term->subj.name; + const char *obj_name = term->obj.name; + + if (!subj_name) { + subj_name = set_mask_to_name(term->subj.set.mask); + } + if (!obj_name) { + obj_name = set_mask_to_name(term->obj.set.mask); } - int32_t *monitor = match->monitor; - ecs_table_t *table = match->table; - int32_t *dirty_state = flecs_table_get_dirty_state(table); - ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - table_dirty_state_t cur; + if (!ecs_term_id_is_set(&term->pred)) { + ecs_parser_error(name, expr, column, "missing predicate in expression"); + return -1; + } - if (monitor[0] != dirty_state[0]) { - return true; + if (state->assign_stmt && term->subj.entity != EcsThis) { + ecs_parser_error(name, expr, column, + "invalid statement in assign statement"); + return -1; } - ecs_filter_t *f = &query->filter; - int32_t i, term_count = f->term_count_actual; - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &f->terms[i]; - int32_t t = term->index; - if (monitor[t + 1] == -1) { - continue; - } + bool pred_as_subj = pred_is_subj(term, state); - get_dirty_state(query, match, t, &cur); - ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t pred = ensure_entity(world, state, pred_name, pred_as_subj); + ecs_entity_t subj = ensure_entity(world, state, subj_name, true); + ecs_entity_t obj = 0; - if (monitor[t + 1] != cur.dirty_state[cur.column + 1]) { - return true; - } + if (ecs_term_id_is_set(&term->obj)) { + obj = ensure_entity(world, state, obj_name, + state->assign_stmt == false); } - return false; -} + if (state->assign_stmt || state->isa_stmt) { + subj = state->assign_to; + } -/* Check if any term for matched table has changed */ -static -bool check_table_monitor( - ecs_query_t *query, - ecs_query_table_t *table, - int32_t term) -{ - ecs_query_table_node_t *cur, *end = table->last->node.next; + if (state->isa_stmt && obj) { + ecs_parser_error(name, expr, column, + "invalid object in inheritance statement"); + return -1; + } - for (cur = &table->first->node; cur != end; cur = cur->next) { - ecs_query_table_match_t *match = (ecs_query_table_match_t*)cur; - if (term == -1) { - if (check_match_monitor(query, match)) { - return true; + if (state->using_stmt && (obj || subj)) { + ecs_parser_error(name, expr, column, + "invalid predicate/object in using statement"); + return -1; + } + + if (state->isa_stmt) { + pred = ecs_pair(EcsIsA, pred); + } + + if (subj) { + if (!obj) { + ecs_add_id(world, subj, pred); + state->last_assign_id = pred; + } else { + ecs_add_pair(world, subj, pred, obj); + state->last_object = obj; + state->last_assign_id = ecs_pair(pred, obj); + } + state->last_predicate = pred; + state->last_subject = subj; + + pred_as_subj = false; + } else { + if (!obj) { + /* If no subject or object were provided, use predicate as subj + * unless the expression explictly excluded the subject */ + if (pred_as_subj) { + state->last_subject = pred; + subj = pred; + } else { + state->last_predicate = pred; + pred_as_subj = false; } } else { - if (check_match_monitor_term(query, match, term)) { - return true; - } + state->last_predicate = pred; + state->last_object = obj; + pred_as_subj = false; } } - return false; -} + /* If this is a with clause (the list of entities between 'with' and scope + * open), add subject to the array of with frames */ + if (state->with_stmt) { + ecs_assert(pred != 0, ECS_INTERNAL_ERROR, NULL); + ecs_id_t id; -static -bool check_query_monitor( - ecs_query_t *query) -{ - ecs_table_cache_iter_t it; - if (flecs_table_cache_iter(&query->cache, &it)) { - ecs_query_table_t *qt; - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - if (check_table_monitor(query, qt, -1)) { - return true; + if (obj) { + id = ecs_pair(pred, obj); + } else { + id = pred; + } + + state->with[state->with_frame ++] = id; + + } else if (state->using_stmt) { + ecs_assert(pred != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(obj == 0, ECS_INTERNAL_ERROR, NULL); + + state->using[state->using_frame ++] = pred; + state->using_frames[state->sp] = state->using_frame; + + /* If this is not a with/using clause, add with frames to subject */ + } else { + if (subj) { + int32_t i, frame_count = state->with_frames[state->sp]; + for (i = 0; i < frame_count; i ++) { + ecs_add_id(world, subj, state->with[i]); } } } - return false; + /* If an id was provided by itself, add default scope type to it */ + ecs_entity_t default_scope_type = state->default_scope_type[state->sp]; + if (pred_as_subj && default_scope_type) { + ecs_add_id(world, subj, default_scope_type); + } + + /* If a comment preceded the statement, add it as a brief description */ +#ifdef FLECS_DOC + if (subj && state->comment) { + ecs_doc_set_brief(world, subj, state->comment); + ecs_os_free(state->comment); + state->comment = NULL; + } +#endif + + return 0; } static -void init_query_monitors( - ecs_query_t *query) +const char* parse_inherit_stmt( + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) { - ecs_query_table_node_t *cur = query->list.first; + if (state->isa_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "cannot nest inheritance"); + return NULL; + } - /* Ensure each match has a monitor */ - for (; cur != NULL; cur = cur->next) { - ecs_query_table_match_t *match = (ecs_query_table_match_t*)cur; - get_match_monitor(query, match); + if (!state->last_subject) { + ecs_parser_error(name, expr, ptr - expr, + "missing entity to assign inheritance to"); + return NULL; } + + state->isa_stmt = true; + state->assign_to = state->last_subject; + + return ptr; } -/* Builtin group_by callback for Cascade terms. - * This function traces the hierarchy depth of an entity type by following a - * relation upwards (to its 'parents') for as long as those parents have the - * specified component id. - * The result of the function is the number of parents with the provided - * component for a given relation. */ static -uint64_t group_by_cascade( +const char* parse_assign_expr( ecs_world_t *world, - ecs_type_t type, - ecs_entity_t component, - void *ctx) -{ - uint64_t result = 0; - int32_t i, count = ecs_vector_count(type); - ecs_entity_t *array = ecs_vector_first(type, ecs_entity_t); - ecs_term_t *term = ctx; - ecs_entity_t relation = term->subj.set.relation; - - /* Cascade needs a relation to calculate depth from */ - ecs_check(relation != 0, ECS_INVALID_PARAMETER, NULL); + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) +{ + (void)world; + + if (!state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "unexpected value outside of assignment statement"); + return NULL; + } - /* Should only be used with cascade terms */ - ecs_check(term->subj.set.mask & EcsCascade, ECS_INVALID_PARAMETER, NULL); + ecs_id_t assign_id = state->last_assign_id; + if (!assign_id) { + ecs_parser_error(name, expr, ptr - expr, + "missing type for assignment statement"); + return NULL; + } - /* Iterate back to front as relations are more likely to occur near the - * end of a type. */ - for (i = count - 1; i >= 0; i --) { - /* Find relation & relation object in entity type */ - if (ECS_HAS_RELATION(array[i], relation)) { - ecs_type_t obj_type = ecs_get_type(world, - ecs_pair_second(world, array[i])); - int32_t j, c_count = ecs_vector_count(obj_type); - ecs_entity_t *c_array = ecs_vector_first(obj_type, ecs_entity_t); +#ifndef FLECS_EXPR + ecs_parser_error(name, expr, ptr - expr, + "cannot parse value, missing FLECS_EXPR addon"); + return NULL; +#else + ecs_entity_t assign_to = state->assign_to; + if (!assign_to) { + assign_to = state->last_subject; + } - /* Iterate object type, check if it has the specified component */ - for (j = 0; j < c_count; j ++) { - /* If it has the component, it is part of the tree matched by - * the query, increase depth */ - if (c_array[j] == component) { - result ++; + if (!assign_to) { + ecs_parser_error(name, expr, ptr - expr, + "missing entity to assign to"); + return NULL; + } - /* Recurse to test if the object has matching parents */ - result += group_by_cascade(world, obj_type, component, ctx); - break; - } - } + ecs_entity_t type = ecs_get_typeid(world, assign_id); + if (!type) { + char *id_str = ecs_id_str(world, assign_id); + ecs_parser_error(name, expr, ptr - expr, + "invalid assignment, '%s' is not a type", id_str); + ecs_os_free(id_str); + return NULL; + } - if (j != c_count) { - break; - } + void *value_ptr = ecs_get_mut_id( + world, assign_to, assign_id, NULL); - /* If the id doesn't have a role set, we'll find no more relations */ - } else if (!(array[i] & ECS_ROLE_MASK)) { - break; - } + ptr = ecs_parse_expr(world, ptr, type, value_ptr, + &(ecs_parse_expr_desc_t) { + .name = name, + .expr = expr, + .lookup_action = plecs_lookup_action, + .lookup_ctx = state + }); + if (!ptr) { + return NULL; } - return result; -error: - return 0; + ecs_modified_id(world, assign_to, assign_id); +#endif + + return ptr; } static -int get_comp_and_src( +const char* parse_assign_stmt( ecs_world_t *world, - ecs_query_t *query, - int32_t t, - ecs_table_t *table_arg, - ecs_entity_t *component_out, - ecs_entity_t *entity_out, - bool *match_out) + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) { - ecs_entity_t component = 0, entity = 0; - - ecs_term_t *terms = query->filter.terms; - int32_t term_count = query->filter.term_count; - ecs_term_t *term = &terms[t]; - ecs_term_id_t *subj = &term->subj; - ecs_oper_kind_t op = term->oper; + (void)world; - *match_out = true; + state->isa_stmt = false; - if (op == EcsNot) { - entity = subj->entity; + /* Component scope (add components to entity) */ + if (!state->last_subject) { + ecs_parser_error(name, expr, ptr - expr, + "missing entity to assign to"); + return NULL; } - if (!subj->entity) { - component = term->id; - } else { - ecs_table_t *table = table_arg; - if (subj->entity != EcsThis) { - table = ecs_get_table(world, subj->entity); - } - - if (op == EcsOr) { - for (; t < term_count; t ++) { - term = &terms[t]; - - /* Keep iterating until the next non-OR expression */ - if (term->oper != EcsOr) { - t --; - break; - } - - if (!component) { - ecs_entity_t source = 0; - int32_t result = ecs_search_relation(world, table, - 0, term->id, subj->set.relation, subj->set.min_depth, - subj->set.max_depth, &source, NULL, NULL); - - if (result != -1) { - component = term->id; - } - - if (source) { - entity = source; - } - } - } - } else { - component = term->id; + if (state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid assign statement in assign statement"); + return NULL; + } - ecs_entity_t source = 0; - bool result = ecs_search_relation(world, table, 0, component, - subj->set.relation, subj->set.min_depth, subj->set.max_depth, - &source, NULL, NULL) != -1; + if (!state->scope_assign_stmt) { + state->assign_to = state->last_subject; + } - *match_out = result; + state->assign_stmt = true; + + /* Assignment without a preceding component */ + if (ptr[0] == '{') { + ecs_entity_t type = 0; - if (op == EcsNot) { - result = !result; - } + if (state->scope_assign_stmt) { + ecs_assert(state->assign_to == ecs_get_scope(world), + ECS_INTERNAL_ERROR, NULL); + } - /* Optional terms may not have the component. *From terms contain - * the id of a type of which the contents must match, but the type - * itself does not need to match. */ - if (op == EcsOptional || op == EcsAndFrom || op == EcsOrFrom || - op == EcsNotFrom) - { - result = true; + /* If we're in a scope & last_subject is a type, assign to scope */ + if (ecs_get_scope(world) != 0) { + type = ecs_get_typeid(world, state->last_subject); + if (type != 0) { + type = state->last_subject; } + } - /* Table has already been matched, so unless column is optional - * any components matched from the table must be available. */ - if (table == table_arg) { - ecs_assert(result == true, ECS_INTERNAL_ERROR, NULL); - } + /* If type hasn't been set yet, check if scope has default type */ + if (!type && !state->scope_assign_stmt) { + type = state->default_scope_type[state->sp]; + } - if (source) { - entity = source; + /* If no type has been found still, check if last with id is a type */ + if (!type && !state->scope_assign_stmt) { + int32_t with_frame_count = state->with_frames[state->sp]; + if (with_frame_count) { + type = state->with[with_frame_count - 1]; } } - if (subj->entity != EcsThis) { - entity = subj->entity; + if (!type) { + ecs_parser_error(name, expr, ptr - expr, + "missing type for assignment"); + return NULL; } + + state->last_assign_id = type; } - if (entity == EcsThis) { - entity = 0; + return ptr; +} + +static +const char* parse_using_stmt( + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) +{ + if (state->isa_stmt || state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid usage of using keyword"); + return NULL; } - *component_out = component; - *entity_out = entity; + /* Add following expressions to using list */ + state->using_stmt = true; - return t; + return ptr + 5; } -typedef struct pair_offset_t { - int32_t index; - int32_t count; -} pair_offset_t; - -/* Get index for specified pair. Take into account that a pair can be matched - * multiple times per table, by keeping an offset of the last found index */ static -int32_t get_pair_index( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_id_t pair, - int32_t column_index, - pair_offset_t *pair_offsets, - int32_t count) +const char* parse_with_stmt( + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) { - int32_t result; + if (state->isa_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid with after inheritance"); + return NULL; + } - /* The count variable keeps track of the number of times a pair has been - * matched with the current table. Compare the count to check if the index - * was already resolved for this iteration */ - if (pair_offsets[column_index].count == count) { - /* If it was resolved, return the last stored index. Subtract one as the - * index is offset by one, to ensure we're not getting stuck on the same - * index. */ - result = pair_offsets[column_index].index - 1; - } else { - /* First time for this iteration that the pair index is resolved, look - * it up in the type. */ - result = ecs_search_offset(world, table, - pair_offsets[column_index].index, pair, 0); - pair_offsets[column_index].index = result + 1; - pair_offsets[column_index].count = count; + if (state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid with in assign_stmt"); + return NULL; } - return result; + /* Add following expressions to with list */ + state->with_stmt = true; + return ptr + 5; } static -int32_t get_component_index( +const char* parse_scope_open( ecs_world_t *world, - ecs_table_t *table, - ecs_type_t table_type, - ecs_entity_t *component_out, - int32_t column_index, - ecs_oper_kind_t op, - pair_offset_t *pair_offsets, - int32_t count) -{ - int32_t result = 0; - ecs_entity_t component = *component_out; + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) +{ + state->isa_stmt = false; - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + if (state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid scope in assign_stmt"); + return NULL; + } - if (component) { - /* If requested component is a case, find the corresponding switch to - * lookup in the table */ - if (ECS_HAS_ROLE(component, CASE)) { - ecs_entity_t sw = ECS_PAIR_FIRST(component); - result = ecs_search(world, table, ECS_SWITCH | sw, 0); - ecs_assert(result != -1, ECS_INTERNAL_ERROR, NULL); - } else - if (ECS_HAS_ROLE(component, PAIR)) { - ecs_entity_t rel = ECS_PAIR_FIRST(component); - ecs_entity_t obj = ECS_PAIR_SECOND(component); + state->sp ++; - /* Both the relationship and the object of the pair must be set */ - ecs_assert(rel != 0, ECS_INVALID_PARAMETER, NULL); - ecs_assert(obj != 0, ECS_INVALID_PARAMETER, NULL); + ecs_entity_t scope = 0; + ecs_entity_t default_scope_type = 0; - if (rel == EcsWildcard || obj == EcsWildcard) { - ecs_assert(pair_offsets != NULL, ECS_INTERNAL_ERROR, NULL); + if (!state->with_stmt) { + if (state->last_subject) { + scope = state->last_subject; + ecs_set_scope(world, state->last_subject); - /* Get index of pair. Start looking from the last pair index - * as this may not be the first instance of the pair. */ - result = get_pair_index(world, table, component, column_index, - pair_offsets, count); - - if (result != -1) { - /* If component of current column is a pair, get the actual - * pair type for the table, so the system can see which - * component the pair was applied to */ - ecs_entity_t *pair = ecs_vector_get( - table_type, ecs_entity_t, result); - *component_out = *pair; + /* Check if scope has a default child component */ + ecs_entity_t def_type_src = ecs_get_object_for_id(world, scope, + 0, ecs_pair(EcsDefaultChildComponent, EcsWildcard)); - /* Check if the pair is a tag or whether it has data */ - if (ecs_get(world, rel, EcsComponent) == NULL) { - /* If pair has no data associated with it, use the - * component to which the pair has been added */ - component = ECS_PAIR_SECOND(*pair); - } else { - component = rel; - } - } - } else { - /* If the low part is a regular entity (component), then - * this query exactly matches a single pair instance. In - * this case we can simply do a lookup of the pair - * identifier in the table type. */ - result = ecs_search(world, table, component, 0); + if (def_type_src) { + default_scope_type = ecs_get_object( + world, def_type_src, EcsDefaultChildComponent, 0); } } else { - /* Get column index for component */ - result = ecs_search(world, table, component, 0); + if (state->last_object) { + scope = ecs_pair( + state->last_predicate, state->last_object); + ecs_set_with(world, scope); + } else { + if (state->last_predicate) { + scope = ecs_pair(EcsChildOf, state->last_predicate); + } + ecs_set_scope(world, state->last_predicate); + } } - /* If column is found, add one to the index, as column zero in - * a table is reserved for entity id's */ - if (result != -1) { - result ++; - } - - /* ecs_table_column_offset may return -1 if the component comes - * from a prefab. If so, the component will be resolved as a - * reference (see below) */ + state->scope[state->sp] = scope; + state->default_scope_type[state->sp] = default_scope_type; + } else { + state->scope[state->sp] = state->scope[state->sp - 1]; + state->default_scope_type[state->sp] = + state->default_scope_type[state->sp - 1]; } - if (op == EcsAndFrom || op == EcsOrFrom || op == EcsNotFrom) { - result = 0; - } else if (op == EcsOptional) { - /* If table doesn't have the field, mark it as no data */ - if (-1 == ecs_search_relation(world, table, 0, component, EcsIsA, - 0, 0, 0, 0, 0)) - { - result = 0; - } - } + state->using_frames[state->sp] = state->using_frame; + state->with_frames[state->sp] = state->with_frame; + state->with_stmt = false; - return result; + return ptr; } static -ecs_vector_t* add_ref( +const char* parse_scope_close( ecs_world_t *world, - ecs_query_t *query, - ecs_vector_t *references, - ecs_term_t *term, - ecs_entity_t component, - ecs_entity_t entity) -{ - ecs_ref_t *ref = ecs_vector_add(&references, ecs_ref_t); - ecs_term_id_t *subj = &term->subj; + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) +{ + if (state->isa_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "invalid '}' after inheritance statement"); + return NULL; + } - if (!(subj->set.mask & EcsCascade)) { - ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); + if (state->assign_stmt) { + ecs_parser_error(name, expr, ptr - expr, + "unfinished assignment before }"); + return NULL; } - - *ref = (ecs_ref_t){0}; - ref->entity = entity; - ref->component = component; - const EcsComponent *c_info = flecs_component_from_id(world, component); - if (c_info) { - if (c_info->size && subj->entity != 0) { - if (entity) { - ecs_get_ref_id(world, ref, entity, component); - } + state->scope[state->sp] = 0; + state->default_scope_type[state->sp] = 0; + state->sp --; - query->flags |= EcsQueryHasRefs; - } + if (state->sp < 0) { + ecs_parser_error(name, expr, ptr - expr, "invalid } without a {"); + return NULL; } - return references; -} + ecs_id_t id = state->scope[state->sp]; -static -int32_t get_pair_count( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_entity_t pair) -{ - int32_t i = -1, result = 0; - while (-1 != (i = ecs_search_offset(world, table, i + 1, pair, 0))) { - result ++; + if (!id || ECS_HAS_ROLE(id, PAIR)) { + ecs_set_with(world, id); } - return result; + if (!id || !ECS_HAS_ROLE(id, PAIR)) { + ecs_set_scope(world, id); + } + + state->with_frame = state->with_frames[state->sp]; + state->using_frame = state->using_frames[state->sp]; + state->last_subject = 0; + state->assign_stmt = false; + + return ptr; } -/* For each pair that the query subscribes for, count the occurrences in the - * table. Cardinality of subscribed for pairs must be the same as in the table - * or else the table won't match. */ static -int32_t count_pairs( - const ecs_world_t *world, - const ecs_query_t *query, - const ecs_table_t *table) +const char *parse_plecs_term( + ecs_world_t *world, + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count; - int32_t first_count = 0, pair_count = 0; - - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; + ecs_term_t term = {0}; + ecs_entity_t scope = ecs_get_scope(world); - if (!ECS_HAS_ROLE(term->id, PAIR)) { - continue; - } + /* If first character is a (, this should be interpreted as an id assigned + * to the current scope if: + * - this is not already an assignment: "Foo = (Hello, World)" + * - this is in a scope + */ + bool scope_assignment = (ptr[0] == '(') && !state->assign_stmt && scope != 0; - if (term->subj.entity != EcsThis) { - continue; - } + ptr = ecs_parse_term(world, name, expr, ptr, &term); + if (!ptr) { + return NULL; + } - if (ecs_id_is_wildcard(term->id)) { - pair_count = get_pair_count(world, table, term->id); - if (!first_count) { - first_count = pair_count; - } else { - if (first_count != pair_count) { - /* The pairs that this query subscribed for occur in the - * table but don't have the same cardinality. Ignore the - * table. This could typically happen for empty tables along - * a path in the table graph. */ - return -1; - } + if (!ecs_term_is_initialized(&term)) { + ecs_parser_error(name, expr, ptr - expr, "expected identifier"); + return NULL; /* No term found */ + } + + /* Lookahead to check if this is an implicit scope assignment (no parens) */ + if (ptr[0] == '=') { + const char *tptr = ecs_parse_fluff(ptr + 1, NULL); + if (tptr[0] == '{') { + ecs_entity_t pred = plecs_lookup( + world, term.pred.name, state, false); + ecs_entity_t obj = plecs_lookup( + world, term.obj.name, state, false); + ecs_id_t id = 0; + if (pred && obj) { + id = ecs_pair(pred, obj); + } else if (pred) { + id = pred; } - } + + if (id && (ecs_get_typeid(world, id) != 0)) { + scope_assignment = true; + } + } } - return first_count; -} + bool prev = state->assign_stmt; + if (scope_assignment) { + state->assign_stmt = true; + state->assign_to = scope; + } + if (create_term(world, &term, name, expr, (ptr - expr), state)) { + ecs_term_fini(&term); + return NULL; /* Failed to create term */ + } + if (scope_assignment) { + state->last_subject = state->last_assign_id; + state->scope_assign_stmt = true; + } + state->assign_stmt = prev; -static -ecs_type_t get_term_type( - ecs_world_t *world, - ecs_term_t *term, - ecs_entity_t component) -{ - ecs_oper_kind_t oper = term->oper; - ecs_assert(oper == EcsAndFrom || oper == EcsOrFrom || oper == EcsNotFrom, - ECS_INTERNAL_ERROR, NULL); - (void)oper; + ecs_term_fini(&term); - const EcsType *type = ecs_get(world, component, EcsType); - if (type) { - return type->normalized->type; - } else { - return ecs_get_type(world, component); - } + return ptr; } -/** Add table to system, compute offsets for system components in table it */ static -void add_table( +const char* parse_stmt( ecs_world_t *world, - ecs_query_t *query, - ecs_table_t *table) + const char *name, + const char *expr, + const char *ptr, + plecs_state_t *state) { - ecs_type_t table_type = NULL; - ecs_term_t *terms = query->filter.terms; - int32_t t, c, term_count = query->filter.term_count; - - if (table) { - table_type = table->type; - } - - int32_t pair_cur = 0, pair_count = count_pairs(world, query, table); - - /* If the query has pairs, we need to account for the fact that a table may - * have multiple components to which the pair is applied, which means the - * table has to be registered with the query multiple times, with different - * table columns. If so, allocate a small array for each pair in which the - * last added table index of the pair is stored, so that in the next - * iteration we can start the search from the correct offset type. */ - pair_offset_t *pair_offsets = NULL; - if (pair_count) { - pair_offsets = ecs_os_calloc( - ECS_SIZEOF(pair_offset_t) * term_count); - } + state->assign_stmt = false; + state->scope_assign_stmt = false; + state->isa_stmt = false; + state->with_stmt = false; + state->using_stmt = false; + state->last_subject = 0; + state->last_predicate = 0; + state->last_object = 0; - ecs_query_table_match_t *table_data; - ecs_vector_t *references = NULL; + ptr = parse_fluff(expr, ptr, state); - ecs_query_table_t *qt = ecs_os_calloc_t(ecs_query_table_t); - ecs_table_cache_insert(&query->cache, table, &qt->hdr); + char ch = ptr[0]; -add_pair: - table_data = cache_add(qt); - table_data->table = table; - if (table) { - table_type = table->type; + if (!ch) { + goto done; + } else if (ch == '{') { + ptr = parse_fluff(expr, ptr + 1, state); + goto scope_open; + } else if (ch == '}') { + ptr = parse_fluff(expr, ptr + 1, state); + goto scope_close; + } else if (ch == '(') { + goto term_expr; + } else if (!ecs_os_strncmp(ptr, TOK_USING " ", 5)) { + ptr = parse_using_stmt(name, expr, ptr, state); + if (!ptr) goto error; + goto term_expr; + } else if (!ecs_os_strncmp(ptr, TOK_WITH " ", 5)) { + ptr = parse_with_stmt(name, expr, ptr, state); + if (!ptr) goto error; + goto term_expr; + } else { + goto term_expr; } - if (term_count) { - /* Array that contains the system column to table column mapping */ - table_data->columns = ecs_os_calloc_n(int32_t, query->filter.term_count_actual); - ecs_assert(table_data->columns != NULL, ECS_OUT_OF_MEMORY, NULL); +term_expr: + if (!ptr[0]) { + goto done; + } - /* Store the components of the matched table. In the case of OR expressions, - * components may differ per matched table. */ - table_data->ids = ecs_os_calloc_n(ecs_entity_t, query->filter.term_count_actual); - ecs_assert(table_data->ids != NULL, ECS_OUT_OF_MEMORY, NULL); + if (!(ptr = parse_plecs_term(world, name, ptr, ptr, state))) { + goto error; + } - /* Cache subject (source) entity ids for components */ - table_data->subjects = ecs_os_calloc_n(ecs_entity_t, query->filter.term_count_actual); - ecs_assert(table_data->subjects != NULL, ECS_OUT_OF_MEMORY, NULL); + ptr = parse_fluff(expr, ptr, state); - /* Cache subject (source) entity ids for components */ - table_data->sizes = ecs_os_calloc_n(ecs_size_t, query->filter.term_count_actual); - ecs_assert(table_data->sizes != NULL, ECS_OUT_OF_MEMORY, NULL); + if (ptr[0] == '{' && !isspace(ptr[-1])) { + /* A '{' directly after an identifier (no whitespace) is a literal */ + goto assign_expr; } - /* Walk columns parsed from the system signature */ - c = 0; - for (t = 0; t < term_count; t ++) { - ecs_term_t *term = &terms[t]; - ecs_term_id_t subj = term->subj; - ecs_entity_t entity = 0, component = 0; - ecs_oper_kind_t op = term->oper; - - if (op == EcsNot) { - subj.entity = 0; + if (!state->using_stmt) { + if (ptr[0] == ':') { + ptr = parse_fluff(expr, ptr + 1, state); + goto inherit_stmt; + } else if (ptr[0] == '=') { + ptr = parse_fluff(expr, ptr + 1, state); + goto assign_stmt; + } else if (ptr[0] == ',') { + ptr = parse_fluff(expr, ptr + 1, state); + goto term_expr; + } else if (ptr[0] == '{') { + state->assign_stmt = false; + ptr = parse_fluff(expr, ptr + 1, state); + goto scope_open; } + } - /* Get actual component and component source for current column */ - bool match; - t = get_comp_and_src(world, query, t, table, &component, &entity, &match); - - /* This column does not retrieve data from a static entity */ - if (!entity && subj.entity) { - int32_t index = get_component_index(world, table, table_type, - &component, c, op, pair_offsets, pair_cur + 1); - - if (index == -1) { - if (op == EcsOptional && subj.set.mask == EcsSelf) { - index = 0; - } - } else { - if (op == EcsOptional && !(subj.set.mask & EcsSelf)) { - index = 0; - } - } + state->assign_stmt = false; + goto done; - table_data->columns[c] = index; +inherit_stmt: + ptr = parse_inherit_stmt(name, expr, ptr, state); + if (!ptr) goto error; - /* If the column is a case, we should only iterate the entities in - * the column for this specific case. Add a sparse column with the - * case id so we can find the correct entities when iterating */ - if (ECS_HAS_ROLE(component, CASE)) { - flecs_sparse_column_t *sc = ecs_vector_add( - &table_data->sparse_columns, flecs_sparse_column_t); - sc->signature_column_index = t; - sc->sw_case = ECS_PAIR_SECOND(component); - sc->sw_column = NULL; - } + /* Expect base identifier */ + goto term_expr; - /* If table has a disabled bitmask for components, check if there is - * a disabled column for the queried for component. If so, cache it - * in a vector as the iterator will need to skip the entity when the - * component is disabled. */ - if (index && (table && table->flags & EcsTableHasDisabled)) { - ecs_entity_t bs_id = - (component & ECS_COMPONENT_MASK) | ECS_DISABLED; - int32_t bs_index = ecs_search(world, table, bs_id, 0); - if (bs_index != -1) { - flecs_bitset_column_t *elem = ecs_vector_add( - &table_data->bitset_columns, flecs_bitset_column_t); - elem->column_index = bs_index; - elem->bs_column = NULL; - } - } - } +assign_stmt: + ptr = parse_assign_stmt(world, name, expr, ptr, state); + if (!ptr) goto error; - ecs_entity_t type_id = ecs_get_typeid(world, component); - if (!type_id && !(ECS_ROLE_MASK & component)) { - type_id = component; - } + ptr = parse_fluff(expr, ptr, state); - if (entity || table_data->columns[c] == -1 || subj.set.mask & EcsCascade) { - if (type_id) { - references = add_ref(world, query, references, term, - component, entity); - table_data->columns[c] = -ecs_vector_count(references); - } + /* Assignment without a preceding component */ + if (ptr[0] == '{') { + goto assign_expr; + } - table_data->subjects[c] = entity; - flecs_add_flag(world, entity, ECS_FLAG_OBSERVED); + /* Expect component identifiers */ + goto term_expr; - if (!match) { - ecs_ref_t *ref = ecs_vector_last(references, ecs_ref_t); - ref->entity = 0; - } - } +assign_expr: + ptr = parse_assign_expr(world, name, expr, ptr, state); + if (!ptr) goto error; - if (type_id) { - const EcsComponent *cptr = ecs_get(world, type_id, EcsComponent); - if (!cptr || !cptr->size) { - int32_t column = table_data->columns[c]; - if (column < 0) { - ecs_ref_t *r = ecs_vector_get( - references, ecs_ref_t, -column - 1); - r->component = 0; - } - } + ptr = parse_fluff(expr, ptr, state); + if (ptr[0] == ',') { + ptr ++; + goto term_expr; + } else if (ptr[0] == '{') { + state->assign_stmt = false; + ptr ++; + goto scope_open; + } else { + state->assign_stmt = false; + goto done; + } - if (cptr) { - table_data->sizes[c] = cptr->size; - } else { - table_data->sizes[c] = 0; - } - } else { - table_data->sizes[c] = 0; - } +scope_open: + ptr = parse_scope_open(world, name, expr, ptr, state); + if (!ptr) goto error; + goto done; +scope_close: + ptr = parse_scope_close(world, name, expr, ptr, state); + if (!ptr) goto error; + goto done; - if (ECS_HAS_ROLE(component, SWITCH)) { - table_data->sizes[c] = ECS_SIZEOF(ecs_entity_t); - } else if (ECS_HAS_ROLE(component, CASE)) { - table_data->sizes[c] = ECS_SIZEOF(ecs_entity_t); - } +done: + return ptr; +error: + return NULL; +} - table_data->ids[c] = component; +int ecs_plecs_from_str( + ecs_world_t *world, + const char *name, + const char *expr) +{ + const char *ptr = expr; + ecs_term_t term = {0}; + plecs_state_t state = {0}; - c ++; + if (!expr) { + return 0; } - if (references) { - ecs_size_t ref_size = ECS_SIZEOF(ecs_ref_t) * ecs_vector_count(references); - table_data->references = ecs_os_malloc(ref_size); - ecs_os_memcpy(table_data->references, - ecs_vector_first(references, ecs_ref_t), ref_size); - ecs_vector_free(references); - references = NULL; - } + state.scope[0] = 0; + ecs_entity_t prev_scope = ecs_set_scope(world, 0); + ecs_entity_t prev_with = ecs_set_with(world, 0); - /* Insert match to iteration list if table is not empty */ - if (!table || ecs_table_count(table) != 0) { - ecs_assert(table == qt->hdr.table, ECS_INTERNAL_ERROR, NULL); - insert_table_node(query, &table_data->node); - } + do { + expr = ptr = parse_stmt(world, name, expr, ptr, &state); + if (!ptr) { + goto error; + } - /* Use tail recursion when adding table for multiple pairs */ - pair_cur ++; - if (pair_cur < pair_count) { - goto add_pair; - } + if (!ptr[0]) { + break; /* End of expression */ + } + } while (true); - if (pair_offsets) { - ecs_os_free(pair_offsets); - } -} + ecs_set_scope(world, prev_scope); + ecs_set_with(world, prev_with); + + clear_comment(expr, ptr, &state); -static -bool match_term( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_term_t *term) -{ - ecs_term_id_t *subj = &term->subj; + if (state.sp != 0) { + ecs_parser_error(name, expr, 0, "missing end of scope"); + goto error; + } - /* If term has no subject, there's nothing to match */ - if (!subj->entity) { - return true; + if (state.assign_stmt) { + ecs_parser_error(name, expr, 0, "unfinished assignment"); + goto error; } - if (term->subj.entity != EcsThis) { - table = ecs_get_table(world, subj->entity); + if (state.errors) { + goto error; } - return ecs_search_relation( - world, table, 0, term->id, subj->set.relation, - subj->set.min_depth, subj->set.max_depth, NULL, NULL, NULL) != -1; + return 0; +error: + ecs_set_scope(world, state.scope[0]); + ecs_set_with(world, prev_with); + ecs_term_fini(&term); + return -1; } -/* Match table with query */ -bool flecs_query_match( - const ecs_world_t *world, - const ecs_table_t *table, - const ecs_query_t *query) +int ecs_plecs_from_file( + ecs_world_t *world, + const char *filename) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - if (!table->type) { - return false; - } - - if (!(query->flags & EcsQueryNeedsTables)) { - return false; - } + FILE* file; + char* content = NULL; + int32_t bytes; + size_t size; - /* Don't match disabled entities */ - if (!(query->flags & EcsQueryMatchDisabled) && ecs_search( - world, table, EcsDisabled, 0) != -1) - { - return false; + /* Open file for reading */ + ecs_os_fopen(&file, filename, "r"); + if (!file) { + ecs_err("%s (%s)", ecs_os_strerror(errno), filename); + goto error; } - /* Don't match prefab entities */ - if (!(query->flags & EcsQueryMatchPrefab) && ecs_search( - world, table, EcsPrefab, 0) != -1) - { - return false; + /* Determine file size */ + fseek(file, 0 , SEEK_END); + bytes = (int32_t)ftell(file); + if (bytes == -1) { + goto error; } + rewind(file); - /* Check if pair cardinality matches pairs in query, if any */ - if (count_pairs(world, query, table) == -1) { - return false; + /* Load contents in memory */ + content = ecs_os_malloc(bytes + 1); + size = (size_t)bytes; + if (!(size = fread(content, 1, size, file)) && bytes) { + ecs_err("%s: read zero bytes instead of %d", filename, size); + ecs_os_free(content); + content = NULL; + goto error; + } else { + content[size] = '\0'; } - ecs_term_t *terms = query->filter.terms; - int32_t i, term_count = query->filter.term_count; - - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_oper_kind_t oper = term->oper; - - if (term->subj.var != EcsVarIsVariable || term->subj.entity != EcsThis){ - /* If term is matched on entity instead of This variable, it does - * not affect whether the table is matched */ - continue; - } - - if (oper == EcsAnd) { - if (!match_term(world, table, term)) { - return false; - } + fclose(file); - } else if (oper == EcsNot) { - if (match_term(world, table, term)) { - return false; - } + int result = ecs_plecs_from_str(world, filename, content); + ecs_os_free(content); + return result; +error: + ecs_os_free(content); + return -1; +} - } else if (oper == EcsOr) { - bool match = false; +#endif - for (; i < term_count; i ++) { - term = &terms[i]; - if (term->oper != EcsOr) { - i --; - break; - } - if (!match && match_term( world, table, term)) { - match = true; - } - } +#ifdef FLECS_RULES - if (!match) { - return false; - } - - } else if (oper == EcsAndFrom || oper == EcsOrFrom || oper == EcsNotFrom) { - ecs_type_t type = get_term_type((ecs_world_t*)world, term, term->id); - int32_t match_count = 0, j, count = ecs_vector_count(type); - ecs_entity_t *ids = ecs_vector_first(type, ecs_entity_t); +#include - for (j = 0; j < count; j ++) { - ecs_term_t tmp_term = *term; - tmp_term.oper = EcsAnd; - tmp_term.id = ids[j]; - tmp_term.pred.entity = ids[j]; +/** Implementation of the rule query engine. + * + * A rule (terminology borrowed from prolog) is a list of constraints that + * specify which conditions must be met for an entity to match the rule. While + * this description matches any kind of ECS query, the rule engine has features + * that go beyond regular (flecs) ECS queries: + * + * - query for all components of an entity (vs. all entities for a component) + * - query for all relationship pairs of an entity + * - support for query variables that are resolved at evaluation time + * - automatic traversal of transitive relationships + * + * Query terms can have the following forms: + * + * - Component(Subject) + * - Relation(Subject, Object) + * + * Additionally the query parser supports the following shorthand notations: + * + * - Component // short for Component(This) + * - (Relation, Object) // short for Relation(This, Object) + * + * The subject, or first arugment of a term represents the entity on which the + * component or relation is matched. By default the subject is set to a builtin + * This variable, which causes the behavior to match a regular ECS query: + * + * - Position, Velocity + * + * Is equivalent to + * + * - Position(This), Velocity(This) + * + * The function of the variable is to ensure that all components are matched on + * the same entity. Conceptually the query first populates the This variable + * with all entities that have Position. When the query evaluates the Velocity + * term, the variable is populated and the entity it contains will be checked + * for whether it has Velocity. + * + * The actual implementation is more efficient and does not check per-entity. + * + * Custom variables can be used to join parts of different terms. For example, + * the following query can be used to find entities with a parent that has a + * Position component (note that variable names start with a _): + * + * - ChildOf(This, _Parent), Component(_Parent) + * + * The rule engine uses a backtracking algorithm to find the set of entities + * and variables that match all terms. As soon as the engine finds a term that + * does not match with the currently evaluated entity, the entity is discarded. + * When an entity is found for which all terms match, the entity is yielded to + * the iterator. + * + * While a rule is being evaluated, a variable can either contain a single + * entity or a table. The engine will attempt to work with tables as much as + * possible so entities can be eliminated/yielded in bulk. A rule may store + * both the table and entity version of a variable and only switch from table to + * entity when necessary. + * + * The rule engine has an algorithm for computing which variables should be + * resolved first. This algorithm works by finding a "root" variable, which is + * the subject variable that occurs in the term with the least dependencies. The + * remaining variables are then resolved based on their "distance" from the root + * with the closest variables being resolved first. + * + * This generally results in an ordering that resolves the variables with the + * least dependencies first and the most dependencies last, which is beneficial + * for two reasons: + * + * - it improves the average performance of all queries + * - it makes performance less dependent on how an application orders the terms + * + * A possible improvement would be for the query engine to also consider + * the number of tables that need to be evaluated for each term, as starting + * with the smallest term reduces the amount of work. Other than static variable + * analysis however, this can only be determined when the query is executed. + * + * Rules are "compiled" into a set of instructions that encode the operations + * the query needs to perform in order to find the right set of entities. + * Operations can either yield data, which progresses the program, or signal + * that there is no (more) matching data, which discards the current variables. + * + * An operation can yield multiple times, if there are multiple matches for its + * inputs. Operations are called with a redo flag, which can be either true or + * false. When redo is true the operation will yield the next result. When redo + * is false, the operation will reset its state and start from the first result. + * + * Operations can have an input, output and a filter. Most commonly an operation + * either matches the filter against an input and yields if it matches, or uses + * the filter to find all matching results and store the result in the output. + * + * Variables are resolved by matching a filter against the output of an + * operation. When a term contains variables, they are encoded as register ids + * in the filter. When the filter is evaluated, the most recent values of the + * register are used to match/lookup the output. + * + * For example, a filter could be (ChildOf, _Parent). When the program starts, + * the _Parent register is initialized with *, so that when this filter is first + * evaluated, the operation will find all tables with (ChildOf, *). The _Parent + * register is then populated by taking the actual value of the table. If the + * table has type [(ChildOf, Sun)], _Parent will be initialized with Sun. + * + * It is possible that a filter matches multiple times. Consider the filter + * (Likes, _Food), and a table [(Likes, Apples), (Likes, Pears)]. In this case + * an operation will yield the table twice, once with _Food=Apples, and once + * with _Food=Pears. + * + * If a rule contains a term with a transitive relation, it will automatically + * substitute the parts of the term to find a fact that matches. The following + * examples illustrate how transitivity is resolved: + * + * Query: + * LocatedIn(Bob, SanFrancisco) + * + * Expands to: + * LocatedIn(Bob, SanFrancisco:self|subset) + * + * Explanation: + * "Is Bob located in San Francisco" - This term is true if Bob is either + * located in San Francisco, or is located in anything that is itself located + * in (a subset of) San Francisco. + * + * + * Query: + * LocatedIn(Bob, X) + * + * Expands to: + * LocatedIn(Bob, X:self|superset) + * + * Explanation: + * "Where is Bob located?" - This term recursively returns all places that + * Bob is located in, which includes his location and the supersets of his + * location. When Bob is located in San Francisco, he is also located in + * the United States, North America etc. + * + * + * Query: + * LocatedIn(X, NorthAmerica) + * + * Expands to: + * LocatedIn(X, NorthAmerica:self|subset) + * + * Explanation: + * "What is located in North America?" - This term returns everything located + * in North America and its subsets, as something located in San Francisco is + * located in UnitedStates, which is located in NorthAmerica. + * + * + * Query: + * LocatedIn(X, Y) + * + * Expands to: + * LocatedIn(X, Y) + * + * Explanation: + * "Where is everything located" - This term returns everything that is + * located somewhere. No substitution is performed as this would explode the + * results while not yielding new information. + * + * + * In the above terms, the variable indicates the part of the term that is + * unknown at evaluation time. In an actual rule the picked strategy depends on + * whether the variable is known when the term is evaluated. For example, if + * variable X has been resolved by the time Located(X, Y) is evaluated, the + * strategy from the LocatedIn(Bob, X) example will be used. + */ - if (match_term(world, table, &tmp_term)) { - match_count ++; - } - } +#define ECS_RULE_MAX_VAR_COUNT (32) - if (oper == EcsAndFrom && match_count != count) { - return false; - } - if (oper == EcsOrFrom && match_count == 0) { - return false; - } - if (oper == EcsNotFrom && match_count != 0) { - return false; - } - } - } +#define RULE_PAIR_PREDICATE (1) +#define RULE_PAIR_OBJECT (2) - return true; -} +/* A rule pair contains a predicate and object that can be stored in a register. */ +typedef struct ecs_rule_pair_t { + union { + int32_t reg; + ecs_entity_t ent; + } pred; + union { + int32_t reg; + ecs_entity_t ent; + } obj; + int32_t reg_mask; /* bit 1 = predicate, bit 2 = object */ -/** Match existing tables against system (table is created before system) */ -static -void match_tables( - ecs_world_t *world, - ecs_query_t *query) -{ - int32_t i, count = flecs_sparse_count(&world->store.tables); + bool transitive; /* Is predicate transitive */ + bool final; /* Is predicate final */ + bool reflexive; /* Is predicate reflexive */ + bool acyclic; /* Is predicate acyclic */ + bool obj_0; +} ecs_rule_pair_t; - for (i = 0; i < count; i ++) { - ecs_table_t *table = flecs_sparse_get_dense( - &world->store.tables, ecs_table_t, i); +/* Filter for evaluating & reifing types and variables. Filters are created ad- + * hoc from pairs, and take into account all variables that had been resolved + * up to that point. */ +typedef struct ecs_rule_filter_t { + ecs_id_t mask; /* Mask with wildcard in place of variables */ - if (flecs_query_match(world, table, query)) { - add_table(world, query, table); - } - } -} + bool wildcard; /* Does the filter contain wildcards */ + bool pred_wildcard; /* Is predicate a wildcard */ + bool obj_wildcard; /* Is object a wildcard */ + bool same_var; /* True if pred & obj are both the same variable */ -static -int32_t qsort_partition( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - ecs_entity_t *entities, - void *ptr, - int32_t elem_size, - int32_t lo, - int32_t hi, - ecs_order_by_action_t compare) -{ - int32_t p = (hi + lo) / 2; - void *pivot = ECS_ELEM(ptr, elem_size, p); - ecs_entity_t pivot_e = entities[p]; - int32_t i = lo - 1, j = hi + 1; - void *el; + int32_t hi_var; /* If hi part should be stored in var, this is the var id */ + int32_t lo_var; /* If lo part should be stored in var, this is the var id */ +} ecs_rule_filter_t; -repeat: - { - do { - i ++; - el = ECS_ELEM(ptr, elem_size, i); - } while ( compare(entities[i], el, pivot_e, pivot) < 0); +/* A rule register stores temporary values for rule variables */ +typedef enum ecs_rule_var_kind_t { + EcsRuleVarKindTable, /* Used for sorting, must be smallest */ + EcsRuleVarKindEntity, + EcsRuleVarKindUnknown +} ecs_rule_var_kind_t; - do { - j --; - el = ECS_ELEM(ptr, elem_size, j); - } while ( compare(entities[j], el, pivot_e, pivot) > 0); +typedef struct ecs_table_slice_t { + ecs_table_t *table; + int32_t offset; + int32_t count; +} ecs_table_slice_t; - if (i >= j) { - return j; - } +typedef struct ecs_rule_reg_t { + /* Used for table variable */ + ecs_table_slice_t table; - flecs_table_swap(world, table, data, i, j); + /* Used for entity variable. May also be set for table variable if it needs + * to store an empty entity. */ + ecs_entity_t entity; +} ecs_rule_reg_t; + +/* Operations describe how the rule should be evaluated */ +typedef enum ecs_rule_op_kind_t { + EcsRuleInput, /* Input placeholder, first instruction in every rule */ + EcsRuleSelect, /* Selects all ables for a given predicate */ + EcsRuleWith, /* Applies a filter to a table or entity */ + EcsRuleSubSet, /* Finds all subsets for transitive relationship */ + EcsRuleSuperSet, /* Finds all supersets for a transitive relationship */ + EcsRuleStore, /* Store entity in table or entity variable */ + EcsRuleEach, /* Forwards each entity in a table */ + EcsRuleSetJmp, /* Set label for jump operation to one of two values */ + EcsRuleJump, /* Jump to an operation label */ + EcsRuleNot, /* Invert result of an operation */ + EcsRuleInTable, /* Test if entity (subject) is in table (r_in) */ + EcsRuleEq, /* Test if entity in (subject) and (r_in) are equal */ + EcsRuleYield /* Yield result */ +} ecs_rule_op_kind_t; - if (p == i) { - pivot = ECS_ELEM(ptr, elem_size, j); - pivot_e = entities[j]; - } else if (p == j) { - pivot = ECS_ELEM(ptr, elem_size, i); - pivot_e = entities[i]; - } +/* Single operation */ +typedef struct ecs_rule_op_t { + ecs_rule_op_kind_t kind; /* What kind of operation is it */ + ecs_rule_pair_t filter; /* Parameter that contains optional filter */ + ecs_entity_t subject; /* If set, operation has a constant subject */ - goto repeat; - } -} + int32_t on_pass; /* Jump location when match succeeds */ + int32_t on_fail; /* Jump location when match fails */ + int32_t frame; /* Register frame */ -static -void qsort_array( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - ecs_entity_t *entities, - void *ptr, - int32_t size, - int32_t lo, - int32_t hi, - ecs_order_by_action_t compare) -{ - if ((hi - lo) < 1) { - return; - } + int32_t term; /* Corresponding term index in signature */ + int32_t r_in; /* Optional In/Out registers */ + int32_t r_out; - int32_t p = qsort_partition( - world, table, data, entities, ptr, size, lo, hi, compare); + bool has_in, has_out; /* Keep track of whether operation uses input + * and/or output registers. This helps with + * debugging rule programs. */ +} ecs_rule_op_t; - qsort_array(world, table, data, entities, ptr, size, lo, p, compare); +/* With context. Shared with select. */ +typedef struct ecs_rule_with_ctx_t { + ecs_id_record_t *idr; /* Currently evaluated table set */ + ecs_table_cache_iter_t it; + int32_t column; +} ecs_rule_with_ctx_t; - qsort_array(world, table, data, entities, ptr, size, p + 1, hi, compare); -} +/* Subset context */ +typedef struct ecs_rule_subset_frame_t { + ecs_rule_with_ctx_t with_ctx; + ecs_table_t *table; + int32_t row; + int32_t column; +} ecs_rule_subset_frame_t; -static -void sort_table( - ecs_world_t *world, - ecs_table_t *table, - int32_t column_index, - ecs_order_by_action_t compare) -{ - ecs_data_t *data = &table->storage; - if (!data->entities) { - /* Nothing to sort */ - return; - } +typedef struct ecs_rule_subset_ctx_t { + ecs_rule_subset_frame_t storage[16]; /* Alloc-free array for small trees */ + ecs_rule_subset_frame_t *stack; + int32_t sp; +} ecs_rule_subset_ctx_t; - int32_t count = flecs_table_data_count(data); - if (count < 2) { - return; - } +/* Superset context */ +typedef struct ecs_rule_superset_frame_t { + ecs_table_t *table; + int32_t column; +} ecs_rule_superset_frame_t; - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); +typedef struct ecs_rule_superset_ctx_t { + ecs_rule_superset_frame_t storage[16]; /* Alloc-free array for small trees */ + ecs_rule_superset_frame_t *stack; + ecs_id_record_t *idr; + int32_t sp; +} ecs_rule_superset_ctx_t; - void *ptr = NULL; - int32_t size = 0; - if (column_index != -1) { - ecs_column_t *column = &data->columns[column_index]; - size = column->size; - ptr = ecs_vector_first_t(column->data, size, column->alignment); - } +/* Each context */ +typedef struct ecs_rule_each_ctx_t { + int32_t row; /* Currently evaluated row in evaluated table */ +} ecs_rule_each_ctx_t; - qsort_array(world, table, data, entities, ptr, size, 0, count - 1, compare); -} +/* Jump context */ +typedef struct ecs_rule_setjmp_ctx_t { + int32_t label; /* Operation label to jump to */ +} ecs_rule_setjmp_ctx_t; -/* Helper struct for building sorted table ranges */ -typedef struct sort_helper_t { - ecs_query_table_match_t *match; - ecs_entity_t *entities; - const void *ptr; - int32_t row; - int32_t elem_size; - int32_t count; - bool shared; -} sort_helper_t; +/* Operation context. This is a per-operation, per-iterator structure that + * stores information for stateful operations. */ +typedef struct ecs_rule_op_ctx_t { + union { + ecs_rule_subset_ctx_t subset; + ecs_rule_superset_ctx_t superset; + ecs_rule_with_ctx_t with; + ecs_rule_each_ctx_t each; + ecs_rule_setjmp_ctx_t setjmp; + } is; +} ecs_rule_op_ctx_t; + +/* Rule variables allow for the rule to be parameterized */ +typedef struct ecs_rule_var_t { + ecs_rule_var_kind_t kind; + char *name; /* Variable name */ + int32_t id; /* Unique variable id */ + int32_t other; /* Id to table variable (-1 if none exists) */ + int32_t occurs; /* Number of occurrences (used for operation ordering) */ + int32_t depth; /* Depth in dependency tree (used for operation ordering) */ + bool marked; /* Used for cycle detection */ +} ecs_rule_var_t; + +/* Variable ids per term */ +typedef struct ecs_rule_term_vars_t { + int32_t pred; + int32_t subj; + int32_t obj; +} ecs_rule_term_vars_t; + +/* Top-level rule datastructure */ +struct ecs_rule_t { + ecs_header_t hdr; + + ecs_world_t *world; /* Ref to world so rule can be used by itself */ + ecs_rule_op_t *operations; /* Operations array */ + ecs_filter_t filter; /* Filter of rule */ + + /* Passed to iterator */ + char *var_names[ECS_RULE_MAX_VAR_COUNT]; + + /* Variable ids used in terms */ + ecs_rule_term_vars_t term_vars[ECS_RULE_MAX_VAR_COUNT]; + + /* Variable array */ + ecs_rule_var_t vars[ECS_RULE_MAX_VAR_COUNT]; + + int32_t var_count; /* Number of variables in signature */ + int32_t subj_var_count; + int32_t frame_count; /* Number of register frames */ + int32_t operation_count; /* Number of operations in rule */ + + ecs_iterable_t iterable; /* Iterable mixin */ +}; + +/* ecs_rule_t mixins */ +ecs_mixins_t ecs_rule_t_mixins = { + .type_name = "ecs_rule_t", + .elems = { + [EcsMixinWorld] = offsetof(ecs_rule_t, world), + [EcsMixinIterable] = offsetof(ecs_rule_t, iterable) + } +}; static -const void* ptr_from_helper( - sort_helper_t *helper) +void rule_error( + const ecs_rule_t *rule, + const char *fmt, + ...) { - ecs_assert(helper->row < helper->count, ECS_INTERNAL_ERROR, NULL); - ecs_assert(helper->elem_size >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(helper->row >= 0, ECS_INTERNAL_ERROR, NULL); - if (helper->shared) { - return helper->ptr; - } else { - return ECS_ELEM(helper->ptr, helper->elem_size, helper->row); - } + va_list valist; + va_start(valist, fmt); + ecs_parser_errorv(rule->filter.name, rule->filter.expr, -1, fmt, valist); + va_end(valist); } static -ecs_entity_t e_from_helper( - sort_helper_t *helper) +bool subj_is_set( + ecs_term_t *term) { - if (helper->row < helper->count) { - return helper->entities[helper->row]; - } else { - return 0; - } + return ecs_term_id_is_set(&term->subj); } static -void build_sorted_table_range( - ecs_query_t *query, - ecs_query_table_list_t *list) +bool obj_is_set( + ecs_term_t *term) { - ecs_world_t *world = query->world; - ecs_entity_t id = query->order_by_component; - ecs_order_by_action_t compare = query->order_by; - - if (!list->count) { - return; - } - - int to_sort = 0; - - sort_helper_t *helper = ecs_os_malloc_n(sort_helper_t, list->count); - ecs_query_table_node_t *cur, *end = list->last->next; - for (cur = list->first; cur != end; cur = cur->next) { - ecs_query_table_match_t *match = cur->match; - ecs_table_t *table = match->table; - ecs_data_t *data = &table->storage; - ecs_vector_t *entities; - - if (!(entities = data->entities) || !ecs_table_count(table)) { - continue; - } - - int32_t index = -1; - if (id) { - index = ecs_search(world, table->storage_table, id, 0); - } - - if (index != -1) { - ecs_column_t *column = &data->columns[index]; - int16_t size = column->size; - int16_t align = column->alignment; - helper[to_sort].ptr = ecs_vector_first_t(column->data, size, align); - helper[to_sort].elem_size = size; - helper[to_sort].shared = false; - } else if (id) { - /* Find component in prefab */ - ecs_entity_t base = 0; - ecs_search_relation(world, table, 0, id, - EcsIsA, 1, 0, &base, NULL, NULL); + return ecs_term_id_is_set(&term->obj) || term->role == ECS_PAIR; +} - /* If a base was not found, the query should not have allowed using - * the component for sorting */ - ecs_assert(base != 0, ECS_INTERNAL_ERROR, NULL); +static +ecs_rule_op_t* create_operation( + ecs_rule_t *rule) +{ + int32_t cur = rule->operation_count ++; + rule->operations = ecs_os_realloc( + rule->operations, (cur + 1) * ECS_SIZEOF(ecs_rule_op_t)); - const EcsComponent *cptr = ecs_get(world, id, EcsComponent); - ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_rule_op_t *result = &rule->operations[cur]; + ecs_os_memset_t(result, 0, ecs_rule_op_t); - helper[to_sort].ptr = ecs_get_id(world, base, id); - helper[to_sort].elem_size = cptr->size; - helper[to_sort].shared = true; - } else { - helper[to_sort].ptr = NULL; - helper[to_sort].elem_size = 0; - helper[to_sort].shared = false; - } + return result; +} - helper[to_sort].match = match; - helper[to_sort].entities = ecs_vector_first(entities, ecs_entity_t); - helper[to_sort].row = 0; - helper[to_sort].count = ecs_table_count(table); - to_sort ++; +static +const char* get_var_name(const char *name) { + if (name && !ecs_os_strcmp(name, "This")) { + /* Make sure that both This and . resolve to the same variable */ + name = "."; } - ecs_assert(to_sort != 0, ECS_INTERNAL_ERROR, NULL); - - bool proceed; - do { - int32_t j, min = 0; - proceed = true; - - ecs_entity_t e1; - while (!(e1 = e_from_helper(&helper[min]))) { - min ++; - if (min == to_sort) { - proceed = false; - break; - } - } - - if (!proceed) { - break; - } - - for (j = min + 1; j < to_sort; j++) { - ecs_entity_t e2 = e_from_helper(&helper[j]); - if (!e2) { - continue; - } - - const void *ptr1 = ptr_from_helper(&helper[min]); - const void *ptr2 = ptr_from_helper(&helper[j]); + return name; +} - if (compare(e1, ptr1, e2, ptr2) > 0) { - min = j; - e1 = e_from_helper(&helper[min]); - } - } +static +ecs_rule_var_t* create_variable( + ecs_rule_t *rule, + ecs_rule_var_kind_t kind, + const char *name) +{ + int32_t cur = ++ rule->var_count; + + name = get_var_name(name); + if (name && !ecs_os_strcmp(name, "*")) { + /* Wildcards are treated as anonymous variables */ + name = NULL; + } - sort_helper_t *cur_helper = &helper[min]; - if (!cur || cur->match != cur_helper->match) { - cur = ecs_vector_add(&query->table_slices, ecs_query_table_node_t); - ecs_assert(cur != NULL, ECS_INTERNAL_ERROR, NULL); - cur->match = cur_helper->match; - cur->offset = cur_helper->row; - cur->count = 1; - } else { - cur->count ++; - } + ecs_rule_var_t *var = &rule->vars[cur - 1]; + if (name) { + var->name = ecs_os_strdup(name); + } else { + /* Anonymous register */ + char name_buff[32]; + ecs_os_sprintf(name_buff, "_%u", cur - 1); + var->name = ecs_os_strdup(name_buff); + } - cur_helper->row ++; - } while (proceed); + var->kind = kind; - /* Iterate through the vector of slices to set the prev/next ptrs. This - * can't be done while building the vector, as reallocs may occur */ - int32_t i, count = ecs_vector_count(query->table_slices); - ecs_query_table_node_t *nodes = ecs_vector_first( - query->table_slices, ecs_query_table_node_t); - for (i = 0; i < count; i ++) { - nodes[i].prev = &nodes[i - 1]; - nodes[i].next = &nodes[i + 1]; - } + /* The variable id is the location in the variable array and also points to + * the register element that corresponds with the variable. */ + var->id = cur - 1; - nodes[0].prev = NULL; - nodes[i - 1].next = NULL; + /* Depth is used to calculate how far the variable is from the root, where + * the root is the variable with 0 dependencies. */ + var->depth = UINT8_MAX; + var->marked = false; + var->occurs = 0; - ecs_os_free(helper); + return var; } static -void build_sorted_tables( - ecs_query_t *query) +ecs_rule_var_t* create_anonymous_variable( + ecs_rule_t *rule, + ecs_rule_var_kind_t kind) { - ecs_vector_clear(query->table_slices); - - if (query->group_by) { - /* Populate sorted node list in grouping order */ - ecs_query_table_node_t *cur = query->list.first; - if (cur) { - do { - /* Find list for current group */ - ecs_query_table_match_t *match = cur->match; - ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - uint64_t group_id = match->group_id; - ecs_query_table_list_t *list = ecs_map_get(&query->groups, - ecs_query_table_list_t, group_id); - ecs_assert(list != NULL, ECS_INTERNAL_ERROR, NULL); - - /* Sort tables in current group */ - build_sorted_table_range(query, list); - - /* Find next group to sort */ - cur = list->last->next; - } while (cur); - } - } else { - build_sorted_table_range(query, &query->list); - } + return create_variable(rule, kind, NULL); } +/* Find variable with specified name and type. If Unknown is provided as type, + * the function will return any variable with the provided name. The root + * variable can occur both as a table and entity variable, as some rules + * require that each entity in a table is iterated. In this case, there are two + * variables, one for the table and one for the entities in the table, that both + * have the same name. */ static -void sort_tables( - ecs_world_t *world, - ecs_query_t *query) +ecs_rule_var_t* find_variable( + const ecs_rule_t *rule, + ecs_rule_var_kind_t kind, + const char *name) { - ecs_order_by_action_t compare = query->order_by; - if (!compare) { - return; - } - - ecs_entity_t order_by_component = query->order_by_component; - int32_t i, order_by_term = -1; + ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(name != NULL, ECS_INTERNAL_ERROR, NULL); - /* Find term that iterates over component (must be at least one) */ - if (order_by_component) { - const ecs_filter_t *f = &query->filter; - int32_t term_count = f->term_count_actual; - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &f->terms[i]; - if (term->subj.entity != EcsThis) { - continue; - } + name = get_var_name(name); - if (term->id == order_by_component) { - order_by_term = i; - break; + const ecs_rule_var_t *variables = rule->vars; + int32_t i, count = rule->var_count; + + for (i = 0; i < count; i ++) { + const ecs_rule_var_t *variable = &variables[i]; + if (!ecs_os_strcmp(name, variable->name)) { + if (kind == EcsRuleVarKindUnknown || kind == variable->kind) { + return (ecs_rule_var_t*)variable; } } - - ecs_assert(order_by_term != -1, ECS_INTERNAL_ERROR, NULL); } - /* Iterate over non-empty tables. Don't bother with empty tables as they - * have nothing to sort */ - - bool tables_sorted = false; - - ecs_table_cache_iter_t it; - ecs_query_table_t *qt; - flecs_table_cache_iter(&query->cache, &it); - - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - ecs_table_t *table = qt->hdr.table; - bool dirty = false; + return NULL; +} - if (check_table_monitor(query, qt, 0)) { - dirty = true; +/* Ensure variable with specified name and type exists. If an existing variable + * is found with an unknown type, its type will be overwritten with the + * specified type. During the variable ordering phase it is not yet clear which + * variable is the root. Which variable is the root determines its type, which + * is why during this phase variables are still untyped. */ +static +ecs_rule_var_t* ensure_variable( + ecs_rule_t *rule, + ecs_rule_var_kind_t kind, + const char *name) +{ + ecs_rule_var_t *var = find_variable(rule, kind, name); + if (!var) { + var = create_variable(rule, kind, name); + } else { + if (var->kind == EcsRuleVarKindUnknown) { + var->kind = kind; } + } - int32_t column = -1; - if (order_by_component) { - if (check_table_monitor(query, qt, order_by_term + 1)) { - dirty = true; - } - - if (dirty) { - column = -1; - - ecs_table_t *storage_table = table->storage_table; - if (storage_table) { - column = ecs_search(world, storage_table, - order_by_component, NULL); - } + return var; +} - if (column == -1) { - /* Component is shared, no sorting is needed */ - dirty = false; - } - } +static +const char *term_id_var_name( + ecs_term_id_t *term_id) +{ + if (term_id->var == EcsVarIsVariable) { + if (term_id->name) { + return term_id->name; + } else if (term_id->entity == EcsThis) { + return "."; + } else if (term_id->entity == EcsWildcard) { + return "*"; + } else if (term_id->entity == EcsAny) { + return "_"; + } else { + ecs_check(term_id->name != NULL, ECS_INVALID_PARAMETER, NULL); } + } + +error: + return NULL; +} - if (!dirty) { - continue; +static +ecs_rule_var_t* ensure_term_id_variable( + ecs_rule_t *rule, + ecs_term_id_t *term_id) +{ + if (term_id->var == EcsVarIsVariable) { + if (term_id->entity == EcsAny) { + /* Any variables aren't translated to rule variables since their + * result isn't stored. */ + return NULL; } - /* Something has changed, sort the table */ - sort_table(world, table, column, compare); - tables_sorted = true; - } - - if (tables_sorted || query->match_count != query->prev_match_count) { - build_sorted_tables(query); - query->match_count ++; /* Increase version if tables changed */ + const char *name = term_id_var_name(term_id); + ecs_rule_var_t *var = ensure_variable(rule, EcsRuleVarKindEntity, name); + ecs_os_strset(&term_id->name, var->name); + return var; } + return NULL; } static -bool has_refs( - ecs_query_t *query) +bool term_id_is_variable( + ecs_term_id_t *term_id) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count; - - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_term_id_t *subj = &term->subj; + return term_id->var == EcsVarIsVariable; +} - if (term->oper == EcsNot && !subj->entity) { - /* Special case: if oper kind is Not and the query contained a - * shared expression, the expression is translated to FromEmpty to - * prevent resolving the ref */ - return true; - } else if (subj->entity && (subj->entity != EcsThis || subj->set.mask != EcsSelf)) { - /* If entity is not this, or if it can be substituted by other - * entities, the query can have references. */ - return true; - } +/* Get variable from a term identifier */ +static +ecs_rule_var_t* term_id_to_var( + ecs_rule_t *rule, + ecs_term_id_t *id) +{ + if (id->var == EcsVarIsVariable) {; + return find_variable(rule, EcsRuleVarKindUnknown, term_id_var_name(id)); } + return NULL; +} - return false; +/* Get variable from a term predicate */ +static +ecs_rule_var_t* term_pred( + ecs_rule_t *rule, + ecs_term_t *term) +{ + return term_id_to_var(rule, &term->pred); } +/* Get variable from a term subject */ static -bool has_pairs( - ecs_query_t *query) +ecs_rule_var_t* term_subj( + ecs_rule_t *rule, + ecs_term_t *term) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count; + return term_id_to_var(rule, &term->subj); +} - for (i = 0; i < count; i ++) { - if (ecs_id_is_wildcard(terms[i].id)) { - return true; - } +/* Get variable from a term object */ +static +ecs_rule_var_t* term_obj( + ecs_rule_t *rule, + ecs_term_t *term) +{ + if (obj_is_set(term)) { + return term_id_to_var(rule, &term->obj); + } else { + return NULL; } - - return false; } +/* Return predicate variable from pair */ static -void for_each_component_monitor( - ecs_world_t *world, - ecs_query_t *query, - void(*callback)( - ecs_world_t* world, - ecs_entity_t relation, - ecs_id_t id, - ecs_query_t *query)) +ecs_rule_var_t* pair_pred( + ecs_rule_t *rule, + const ecs_rule_pair_t *pair) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count; - - for (i = 0; i < count; i++) { - ecs_term_t *term = &terms[i]; - ecs_term_id_t *subj = &term->subj; - - /* If component is requested with EcsCascade register component as a - * parent monitor. Parent monitors keep track of whether an entity moved - * in the hierarchy, which potentially requires the query to reorder its - * tables. - * Also register a regular component monitor for EcsCascade columns. - * This ensures that when the component used in the EcsCascade column - * is added or removed tables are updated accordingly*/ - if (subj->set.mask & EcsSuperSet && subj->set.mask & EcsCascade && - subj->set.relation != EcsIsA) - { - if (term->oper != EcsOr) { - if (term->subj.set.relation != EcsIsA) { - callback( - world, term->subj.set.relation, term->id, query); - } - callback(world, 0, term->id, query); - } - - /* FromAny also requires registering a monitor, as FromAny columns can - * be matched with prefabs. The only term kinds that do not require - * registering a monitor are FromOwned and FromEmpty. */ - } else if ((subj->set.mask & EcsSuperSet) || (subj->entity != EcsThis)){ - if (term->oper != EcsOr) { - callback(world, 0, term->id, query); - } - } + if (pair->reg_mask & RULE_PAIR_PREDICATE) { + return &rule->vars[pair->pred.reg]; + } else { + return NULL; } } +/* Return object variable from pair */ static -void register_monitors( - ecs_world_t *world, - ecs_query_t *query) +ecs_rule_var_t* pair_obj( + ecs_rule_t *rule, + const ecs_rule_pair_t *pair) { - for_each_component_monitor(world, query, flecs_monitor_register); + if (pair->reg_mask & RULE_PAIR_OBJECT) { + return &rule->vars[pair->obj.reg]; + } else { + return NULL; + } } +/* Create new frame for storing register values. Each operation that yields data + * gets its own register frame, which contains all variables reified up to that + * point. The preceding frame always contains the reified variables from the + * previous operation. Operations that do not yield data (such as control flow) + * do not have their own frames. */ static -void unregister_monitors( - ecs_world_t *world, - ecs_query_t *query) +int32_t push_frame( + ecs_rule_t *rule) { - for_each_component_monitor(world, query, flecs_monitor_unregister); + return rule->frame_count ++; } +/* Get register array for current stack frame. The stack frame is determined by + * the current operation that is evaluated. The register array contains the + * values for the reified variables. If a variable hasn't been reified yet, its + * register will store a wildcard. */ static -bool is_term_id_supported( - ecs_term_id_t *term_id) +ecs_rule_reg_t* get_register_frame( + const ecs_rule_iter_t *it, + int32_t frame) { - if (term_id->var != EcsVarIsVariable) { - return true; - } - if (term_id->entity == EcsWildcard) { - return true; + if (it->registers) { + return &it->registers[frame * it->rule->var_count]; + } else { + return NULL; } - return false; } +/* Get register array for current stack frame. The stack frame is determined by + * the current operation that is evaluated. The register array contains the + * values for the reified variables. If a variable hasn't been reified yet, its + * register will store a wildcard. */ static -void process_signature( - ecs_world_t *world, - ecs_query_t *query) +ecs_rule_reg_t* get_registers( + const ecs_rule_iter_t *it, + ecs_rule_op_t *op) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count; - - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_term_id_t *pred = &term->pred; - ecs_term_id_t *subj = &term->subj; - ecs_term_id_t *obj = &term->obj; - ecs_oper_kind_t op = term->oper; - ecs_inout_kind_t inout = term->inout; - - bool is_pred_supported = is_term_id_supported(pred); - bool is_subj_supported = is_term_id_supported(subj); - bool is_obj_supported = is_term_id_supported(obj); - - (void)pred; - (void)obj; - (void)is_pred_supported; - (void)is_subj_supported; - (void)is_obj_supported; - - /* Queries do not support named variables */ - ecs_check(is_pred_supported, ECS_UNSUPPORTED, NULL); - ecs_check(is_obj_supported, ECS_UNSUPPORTED, NULL); - ecs_check(is_subj_supported || subj->entity == EcsThis, - ECS_UNSUPPORTED, NULL); - - /* If self is not included in set, always start from depth 1 */ - if (!subj->set.min_depth && !(subj->set.mask & EcsSelf)) { - subj->set.min_depth = 1; - } - - if (inout != EcsIn) { - query->flags |= EcsQueryHasOutColumns; - } - - if (op == EcsOptional) { - query->flags |= EcsQueryHasOptional; - } - - if (!(query->flags & EcsQueryMatchDisabled)) { - if (op == EcsAnd || op == EcsOr || op == EcsOptional) { - if (term->id == EcsDisabled) { - query->flags |= EcsQueryMatchDisabled; - } - } - } - - if (!(query->flags & EcsQueryMatchPrefab)) { - if (op == EcsAnd || op == EcsOr || op == EcsOptional) { - if (term->id == EcsPrefab) { - query->flags |= EcsQueryMatchPrefab; - } - } - } - - if (subj->entity == EcsThis) { - query->flags |= EcsQueryNeedsTables; - } - - if (subj->set.mask & EcsCascade && term->oper == EcsOptional) { - /* Query can only have one cascade column */ - ecs_assert(query->cascade_by == 0, ECS_INVALID_PARAMETER, NULL); - query->cascade_by = i + 1; - } - - if (subj->entity && subj->entity != EcsThis && - subj->set.mask == EcsSelf) - { - flecs_add_flag(world, term->subj.entity, ECS_FLAG_OBSERVED); - } - } - - query->flags |= (ecs_flags32_t)(has_refs(query) * EcsQueryHasRefs); - query->flags |= (ecs_flags32_t)(has_pairs(query) * EcsQueryHasTraits); - - if (!(query->flags & EcsQueryIsSubquery)) { - register_monitors(world, query); - } -error: - return; + return get_register_frame(it, op->frame); } +/* Get columns array. Columns store, for each matched column in a table, the + * index at which it occurs. This reduces the amount of searching that + * operations need to do in a type, since select/with already provide it. */ static -bool match_table( - ecs_world_t *world, - ecs_query_t *query, - ecs_table_t *table) +int32_t* rule_get_columns_frame( + ecs_rule_iter_t *it, + int32_t frame) { - if (flecs_query_match(world, table, query)) { - add_table(world, query, table); - return true; - } - return false; + return &it->columns[frame * it->rule->filter.term_count]; } -/** When a table becomes empty remove it from the query list, or vice versa. */ static -void update_table( - ecs_query_t *query, - ecs_table_t *table, - bool empty) +int32_t* rule_get_columns( + ecs_rule_iter_t *it, + ecs_rule_op_t *op) { - int32_t prev_count = ecs_query_table_count(query); - ecs_table_cache_set_empty(&query->cache, table, empty); - int32_t cur_count = ecs_query_table_count(query); - - if (prev_count != cur_count) { - ecs_query_table_t *qt = ecs_table_cache_get(&query->cache, table); - ecs_assert(qt != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_query_table_match_t *cur, *next; - - for (cur = qt->first; cur != NULL; cur = next) { - next = cur->next_match; - - if (empty) { - ecs_assert(ecs_table_count(table) == 0, - ECS_INTERNAL_ERROR, NULL); - - remove_table_node(query, &cur->node); - } else { - ecs_assert(ecs_table_count(table) != 0, - ECS_INTERNAL_ERROR, NULL); - insert_table_node(query, &cur->node); - } - } - } + return rule_get_columns_frame(it, op->frame); +} - ecs_assert(cur_count || query->list.first == NULL, +static +void entity_reg_set( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r, + ecs_entity_t entity) +{ + (void)rule; + ecs_assert(rule->vars[r].kind == EcsRuleVarKindEntity, ECS_INTERNAL_ERROR, NULL); + ecs_check(ecs_is_valid(rule->world, entity), ECS_INVALID_PARAMETER, NULL); + regs[r].entity = entity; +error: + return; } static -void add_subquery( - ecs_world_t *world, - ecs_query_t *parent, - ecs_query_t *subquery) +ecs_entity_t entity_reg_get( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r) { - ecs_query_t **elem = ecs_vector_add(&parent->subqueries, ecs_query_t*); - *elem = subquery; - - ecs_table_cache_t *cache = &parent->cache; - ecs_table_cache_iter_t it; - ecs_query_table_t *qt; - flecs_table_cache_iter(cache, &it); - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - match_table(world, subquery, qt->hdr.table); + (void)rule; + ecs_entity_t e = regs[r].entity; + if (!e) { + return EcsWildcard; } - flecs_table_cache_empty_iter(cache, &it); - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - match_table(world, subquery, qt->hdr.table); - } + ecs_check(ecs_is_valid(rule->world, e), ECS_INVALID_PARAMETER, NULL); + return e; +error: + return 0; } static -void notify_subqueries( - ecs_world_t *world, - ecs_query_t *query, - ecs_query_event_t *event) +void table_reg_set( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r, + ecs_table_t *table) { - if (query->subqueries) { - ecs_query_t **queries = ecs_vector_first(query->subqueries, ecs_query_t*); - int32_t i, count = ecs_vector_count(query->subqueries); + (void)rule; + ecs_assert(rule->vars[r].kind == EcsRuleVarKindTable, + ECS_INTERNAL_ERROR, NULL); - ecs_query_event_t sub_event = *event; - sub_event.parent_query = query; + regs[r].table.table = table; + regs[r].table.offset = 0; + regs[r].table.count = 0; + regs[r].entity = 0; +} - for (i = 0; i < count; i ++) { - ecs_query_t *sub = queries[i]; - flecs_query_notify(world, sub, &sub_event); - } - } +static +ecs_table_slice_t table_reg_get( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r) +{ + (void)rule; + ecs_assert(rule->vars[r].kind == EcsRuleVarKindTable, + ECS_INTERNAL_ERROR, NULL); + + return regs[r].table; } static -void resolve_cascade_subject_for_table( - ecs_world_t *world, - ecs_query_t *query, - const ecs_table_t *table, - ecs_query_table_match_t *table_data) +ecs_entity_t reg_get_entity( + const ecs_rule_t *rule, + ecs_rule_op_t *op, + ecs_rule_reg_t *regs, + int32_t r) { - int32_t term_index = query->cascade_by - 1; - ecs_term_t *term = &query->filter.terms[term_index]; + if (r == UINT8_MAX) { + ecs_assert(op->subject != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table_data->references != 0, ECS_INTERNAL_ERROR, NULL); + /* The subject is referenced from the query string by string identifier. + * If subject entity is not valid, it could have been deletd by the + * application after the rule was created */ + ecs_check(ecs_is_valid(rule->world, op->subject), + ECS_INVALID_PARAMETER, NULL); - /* Obtain reference index */ - int32_t *column_indices = table_data->columns; - int32_t ref_index = -column_indices[term_index] - 1; + return op->subject; + } + if (rule->vars[r].kind == EcsRuleVarKindTable) { + int32_t offset = regs[r].table.offset; - /* Obtain pointer to the reference data */ - ecs_ref_t *references = table_data->references; + ecs_assert(regs[r].table.count == 1, ECS_INTERNAL_ERROR, NULL); + ecs_data_t *data = &table_reg_get(rule, regs, r).table->storage; + ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(offset < ecs_vector_count(data->entities), + ECS_INTERNAL_ERROR, NULL); + ecs_check(ecs_is_valid(rule->world, entities[offset]), + ECS_INVALID_PARAMETER, NULL); + + return entities[offset]; + } + if (rule->vars[r].kind == EcsRuleVarKindEntity) { + return entity_reg_get(rule, regs, r); + } - /* Find source for component */ - ecs_entity_t subject = 0; - ecs_search_relation(world, table, 0, term->id, - term->subj.set.relation, 1, 0, &subject, NULL, NULL); + /* Must return an entity */ + ecs_assert(false, ECS_INTERNAL_ERROR, NULL); - /* If container was found, update the reference */ - if (subject) { - ecs_ref_t *ref = &references[ref_index]; - ecs_assert(ref->component == term->id, ECS_INTERNAL_ERROR, NULL); +error: + return 0; +} - references[ref_index].entity = ecs_get_alive(world, subject); - table_data->subjects[term_index] = subject; - ecs_get_ref_id(world, ref, subject, term->id); - } else { - references[ref_index].entity = 0; - table_data->subjects[term_index] = 0; +static +ecs_table_slice_t table_from_entity( + const ecs_world_t *world, + ecs_entity_t entity) +{ + ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); + + ecs_table_slice_t slice = {0}; + ecs_record_t *record = ecs_eis_get(world, entity); + if (record) { + slice.table = record->table; + slice.offset = ECS_RECORD_TO_ROW(record->row); + slice.count = 1; } - if (ecs_table_count(table)) { - /* The subject (or depth of the subject) may have changed, so reinsert - * the node to make sure it's in the right group */ - remove_table_node(query, &table_data->node); - insert_table_node(query, &table_data->node); - } + return slice; } static -void resolve_cascade_subject( - ecs_world_t *world, - ecs_query_t *query, - ecs_query_table_t *elem, - const ecs_table_t *table) +ecs_table_slice_t reg_get_table( + const ecs_rule_t *rule, + ecs_rule_op_t *op, + ecs_rule_reg_t *regs, + int32_t r) { - ecs_query_table_match_t *cur; - for (cur = elem->first; cur != NULL; cur = cur->next_match) { - resolve_cascade_subject_for_table(world, query, table, cur); + if (r == UINT8_MAX) { + ecs_check(ecs_is_valid(rule->world, op->subject), + ECS_INVALID_PARAMETER, NULL); + return table_from_entity(rule->world, op->subject); } + if (rule->vars[r].kind == EcsRuleVarKindTable) { + return table_reg_get(rule, regs, r); + } + if (rule->vars[r].kind == EcsRuleVarKindEntity) { + return table_from_entity(rule->world, entity_reg_get(rule, regs, r)); + } +error: + return (ecs_table_slice_t){0}; } -/* Remove table */ static -void query_table_free( - ecs_query_t *query, - ecs_query_table_t *elem) +void reg_set_entity( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r, + ecs_entity_t entity) { - ecs_query_table_match_t *cur, *next; - - for (cur = elem->first; cur != NULL; cur = next) { - ecs_os_free(cur->columns); - ecs_os_free(cur->ids); - ecs_os_free(cur->subjects); - ecs_os_free(cur->sizes); - ecs_os_free(cur->references); - ecs_os_free(cur->sparse_columns); - ecs_os_free(cur->bitset_columns); - ecs_os_free(cur->monitor); - - if (!elem->hdr.empty) { - remove_table_node(query, &cur->node); - } - - next = cur->next_match; - - ecs_os_free(cur); + if (rule->vars[r].kind == EcsRuleVarKindTable) { + ecs_world_t *world = rule->world; + ecs_check(ecs_is_valid(world, entity), ECS_INVALID_PARAMETER, NULL); + regs[r].table = table_from_entity(world, entity); + regs[r].entity = entity; + } else { + entity_reg_set(rule, regs, r, entity); } - - ecs_os_free(elem); +error: + return; } static -void unmatch_table( - ecs_query_t *query, - ecs_table_t *table) +void reg_set_table( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t r, + ecs_table_slice_t table) { - ecs_query_table_t *qt = ecs_table_cache_remove( - &query->cache, table, NULL); - if (qt) { - query_table_free(query, qt); + if (rule->vars[r].kind == EcsRuleVarKindEntity) { + ecs_check(table.count == 1, ECS_INTERNAL_ERROR, NULL); + regs[r].table = table; + regs[r].entity = ecs_vector_get(table.table->storage.entities, + ecs_entity_t, table.offset)[0]; + } else { + regs[r].table = table; + regs[r].entity = 0; } +error: + return; } +/* This encodes a column expression into a pair. A pair stores information about + * the variable(s) associated with the column. Pairs are used by operations to + * apply filters, and when there is a match, to reify variables. */ static -void rematch_table( - ecs_world_t *world, - ecs_query_t *query, - ecs_table_t *table) +ecs_rule_pair_t term_to_pair( + ecs_rule_t *rule, + ecs_term_t *term) { - ecs_query_table_t *match = ecs_table_cache_get(&query->cache, table); - - if (flecs_query_match(world, table, query)) { - /* If the table matches, and it is not currently matched, add */ - if (match == NULL) { - add_table(world, query, table); - - /* If table still matches and has cascade column, reevaluate the - * sources of references. This may have changed in case - * components were added/removed to container entities */ - } else if (query->cascade_by) { - resolve_cascade_subject(world, query, match, table); + ecs_rule_pair_t result = {0}; - /* If query has optional columns, it is possible that a column that - * previously had data no longer has data, or vice versa. Do a - * rematch to make sure data is consistent. */ - } else if (query->flags & EcsQueryHasOptional) { - /* Check if optional terms that weren't matched before are matched - * now & vice versa */ - ecs_query_table_match_t *qt = match->first; + /* Terms must always have at least one argument (the subject) */ + ecs_assert(subj_is_set(term), ECS_INTERNAL_ERROR, NULL); - bool rematch = false; - int32_t i, count = query->filter.term_count_actual; - for (i = 0; i < count; i ++) { - ecs_term_t *term = &query->filter.terms[i]; + /* If the predicate id is a variable, find the variable and encode its id + * in the pair so the operation can find it later. */ + if (term->pred.var == EcsVarIsVariable) { + if (term->pred.entity != EcsAny) { + /* Always lookup var as an entity, as pairs never refer to tables */ + const ecs_rule_var_t *var = find_variable( + rule, EcsRuleVarKindEntity, term_id_var_name(&term->pred)); - if (term->oper == EcsOptional) { - int32_t t = term->index; - int32_t column = 0; - flecs_term_match_table(world, term, table, - table->type, 0, &column, 0, 0, true); - if (column && (qt->columns[t] == 0)) { - rematch = true; - } else if (!column && (qt->columns[t] != 0)) { - rematch = true; - } - } - } + /* Variables should have been declared */ + ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(var->kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); + result.pred.reg = var->id; - if (rematch) { - unmatch_table(query, table); - add_table(world, query, table); - } + /* Set flag so the operation can see the predicate is a variable */ + result.reg_mask |= RULE_PAIR_PREDICATE; + result.final = true; + } else { + result.pred.ent = EcsWildcard; + result.final = true; } } else { - /* Table no longer matches, remove */ - if (match != NULL) { - unmatch_table(query, table); - notify_subqueries(world, query, &(ecs_query_event_t){ - .kind = EcsQueryTableUnmatch, - .table = table - }); - } - } -} - -static -bool satisfy_constraints( - ecs_world_t *world, - const ecs_filter_t *filter) -{ - ecs_term_t *terms = filter->terms; - int32_t i, count = filter->term_count; + /* If the predicate is not a variable, simply store its id. */ + ecs_entity_t pred_id = term->pred.entity; + result.pred.ent = pred_id; - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_term_id_t *subj = &term->subj; - ecs_oper_kind_t oper = term->oper; + /* Test if predicate is transitive. When evaluating the predicate, this + * will also take into account transitive relationships */ + if (ecs_has_id(rule->world, pred_id, EcsTransitive)) { + /* Transitive queries must have an object */ + if (obj_is_set(term)) { + result.transitive = true; + } + } - if (oper == EcsOptional) { - continue; + if (ecs_has_id(rule->world, pred_id, EcsFinal)) { + result.final = true; } - if (subj->entity != EcsThis && subj->entity) { - ecs_table_t *table = ecs_get_table(world, subj->entity); - if (!table) { - goto no_match; - } + if (ecs_has_id(rule->world, pred_id, EcsReflexive)) { + result.reflexive = true; + } - if (!flecs_term_match_table(world, term, table, table->type, NULL, - NULL, NULL, NULL, true)) - { - goto no_match; - } + if (ecs_has_id(rule->world, pred_id, EcsAcyclic)) { + result.acyclic = true; } } - return true; -no_match: - return false; -} - -/* Rematch system with tables after a change happened to a watched entity */ -static -void rematch_tables( - ecs_world_t *world, - ecs_query_t *query, - ecs_query_t *parent_query) -{ - if (parent_query) { - ecs_table_cache_iter_t it; - if (flecs_table_cache_iter(&parent_query->cache, &it)) { - ecs_query_table_t *qt; - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - rematch_table(world, query, qt->hdr.table); - } - } + /* The pair doesn't do anything with the subject (subjects are the things that + * are matched against pairs) so if the column does not have a object, + * there is nothing left to do. */ + if (!obj_is_set(term)) { + return result; + } - if (flecs_table_cache_empty_iter(&parent_query->cache, &it)) { - ecs_query_table_t *qt; - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - rematch_table(world, query, qt->hdr.table); - } - } - } else { - ecs_sparse_t *tables = &world->store.tables; - int32_t i, count = flecs_sparse_count(tables); + /* If arguments is higher than 2 this is not a pair but a nested rule */ + ecs_assert(obj_is_set(term), ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < count; i ++) { - /* Is the system currently matched with the table? */ - ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); - rematch_table(world, query, table); + /* Same as above, if the object is a variable, store it and flag it */ + if (term->obj.var == EcsVarIsVariable) { + if (term->obj.entity != EcsAny) { + const ecs_rule_var_t *var = find_variable( + rule, EcsRuleVarKindEntity, term_id_var_name(&term->obj)); + + /* Variables should have been declared */ + ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(var->kind == EcsRuleVarKindEntity, ECS_INTERNAL_ERROR, + NULL); + + result.obj.reg = var->id; + result.reg_mask |= RULE_PAIR_OBJECT; + } else { + result.obj.ent = EcsWildcard; + } + } else { + /* If the object is not a variable, simply store its id */ + result.obj.ent = term->obj.entity; + if (!result.obj.ent) { + result.obj_0 = true; } } - /* Enable/disable system if constraints are (not) met. If the system is - * already dis/enabled this operation has no side effects. */ - query->constraints_satisfied = satisfy_constraints(world, &query->filter); + return result; } +/* When an operation has a pair, it is used to filter its input. This function + * translates a pair back into an entity id, and in the process substitutes the + * variables that have already been filled out. It's one of the most important + * functions, as a lot of the filtering logic depends on having an entity that + * has all of the reified variables correctly filled out. */ static -void remove_subquery( - ecs_query_t *parent, - ecs_query_t *sub) +ecs_rule_filter_t pair_to_filter( + ecs_rule_iter_t *it, + ecs_rule_op_t *op, + ecs_rule_pair_t pair) { - ecs_assert(parent != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(sub != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(parent->subqueries != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t pred = pair.pred.ent; + ecs_entity_t obj = pair.obj.ent; + ecs_rule_filter_t result = { + .lo_var = -1, + .hi_var = -1 + }; - int32_t i, count = ecs_vector_count(parent->subqueries); - ecs_query_t **sq = ecs_vector_first(parent->subqueries, ecs_query_t*); + /* Get registers in case we need to resolve ids from registers. Get them + * from the previous, not the current stack frame as the current operation + * hasn't reified its variables yet. */ + ecs_rule_reg_t *regs = get_register_frame(it, op->frame - 1); - for (i = 0; i < count; i ++) { - if (sq[i] == sub) { - break; + if (pair.reg_mask & RULE_PAIR_OBJECT) { + obj = entity_reg_get(it->rule, regs, pair.obj.reg); + obj = ecs_entity_t_lo(obj); /* Filters don't have generations */ + + if (obj == EcsWildcard) { + result.wildcard = true; + result.obj_wildcard = true; + result.lo_var = pair.obj.reg; } } - ecs_vector_remove(parent->subqueries, ecs_query_t*, i); -} + if (pair.reg_mask & RULE_PAIR_PREDICATE) { + pred = entity_reg_get(it->rule, regs, pair.pred.reg); + pred = ecs_entity_t_lo(pred); /* Filters don't have generations */ -/* -- Private API -- */ + if (pred == EcsWildcard) { + if (result.wildcard) { + result.same_var = pair.pred.reg == pair.obj.reg; + } -void flecs_query_notify( - ecs_world_t *world, - ecs_query_t *query, - ecs_query_event_t *event) -{ - bool notify = true; + result.wildcard = true; + result.pred_wildcard = true; - switch(event->kind) { - case EcsQueryTableMatch: - /* Creation of new table */ - if (match_table(world, query, event->table)) { - if (query->subqueries) { - notify_subqueries(world, query, event); + if (obj) { + result.hi_var = pair.pred.reg; + } else { + result.lo_var = pair.pred.reg; } } - notify = false; - break; - case EcsQueryTableUnmatch: - /* Deletion of table */ - unmatch_table(query, event->table); - break; - case EcsQueryTableRematch: - /* Rematch tables of query */ - rematch_tables(world, query, event->parent_query); - break; - case EcsQueryOrphan: - ecs_assert(query->flags & EcsQueryIsSubquery, ECS_INTERNAL_ERROR, NULL); - query->flags |= EcsQueryIsOrphaned; - query->parent = NULL; - break; } - if (notify) { - notify_subqueries(world, query, event); + if (!obj && !pair.obj_0) { + result.mask = pred; + } else { + result.mask = ecs_pair(pred, obj); } + + return result; } +/* This function is responsible for reifying the variables (filling them out + * with their actual values as soon as they are known). It uses the pair + * expression returned by pair_get_most_specific_var, and attempts to fill out each of the + * wildcards in the pair. If a variable isn't reified yet, the pair expression + * will still contain one or more wildcards, which is harmless as the respective + * registers will also point to a wildcard. */ static -void query_order_by( - ecs_world_t *world, - ecs_query_t *query, - ecs_entity_t order_by_component, - ecs_order_by_action_t order_by) +void reify_variables( + ecs_rule_iter_t *it, + ecs_rule_op_t *op, + ecs_rule_filter_t *filter, + ecs_type_t type, + int32_t column) { - ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(!(query->flags & EcsQueryIsOrphaned), ECS_INVALID_PARAMETER, NULL); - ecs_check(query->flags & EcsQueryNeedsTables, ECS_INVALID_PARAMETER, NULL); + const ecs_rule_t *rule = it->rule; + const ecs_rule_var_t *vars = rule->vars; + (void)vars; - query->order_by_component = order_by_component; - query->order_by = order_by; + ecs_rule_reg_t *regs = get_registers(it, op); + ecs_entity_t *elem = ecs_vector_get(type, ecs_entity_t, column); + ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_vector_free(query->table_slices); - query->table_slices = NULL; + int32_t obj_var = filter->lo_var; + int32_t pred_var = filter->hi_var; - sort_tables(world, query); + if (obj_var != -1) { + ecs_assert(vars[obj_var].kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); - if (!query->table_slices) { - build_sorted_tables(query); + entity_reg_set(rule, regs, obj_var, + ecs_get_alive(rule->world, ECS_PAIR_SECOND(*elem))); } -error: - return; -} -static -void query_group_by( - ecs_query_t *query, - ecs_entity_t sort_component, - ecs_group_by_action_t group_by) -{ - /* Cannot change grouping once a query has been created */ - ecs_check(query->group_by_id == 0, ECS_INVALID_OPERATION, NULL); - ecs_check(query->group_by == 0, ECS_INVALID_OPERATION, NULL); + if (pred_var != -1) { + ecs_assert(vars[pred_var].kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); - query->group_by_id = sort_component; - query->group_by = group_by; - ecs_map_init(&query->groups, ecs_query_table_list_t, 16); -error: - return; + entity_reg_set(rule, regs, pred_var, + ecs_get_alive(rule->world, + ECS_PAIR_FIRST(*elem))); + } } -/* Implementation for iterable mixin */ +/* Returns whether variable is a subject */ static -void query_iter_init( - const ecs_world_t *world, - const ecs_poly_t *poly, - ecs_iter_t *iter, - ecs_term_t *filter) +bool is_subject( + ecs_rule_t *rule, + ecs_rule_var_t *var) { - ecs_poly_assert(poly, ecs_query_t); + ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); - if (filter) { - iter[1] = ecs_query_iter(world, (ecs_query_t*)poly); - iter[0] = ecs_term_chain_iter(&iter[1], filter); - } else { - iter[0] = ecs_query_iter(world, (ecs_query_t*)poly); + if (!var) { + return false; } -} -static -void query_on_event( - ecs_iter_t *it) -{ - /* Because this is the observer::run callback, checking if this is event is - * already handled is not done for us. */ - ecs_world_t *world = it->world; - ecs_observer_t *o = it->ctx; - if (o->last_event_id == world->event_id) { - return; + if (var->id < rule->subj_var_count) { + return true; } - o->last_event_id = world->event_id; - - ecs_query_t *query = o->ctx; - ecs_table_t *table = it->table; - ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); + return false; +} - /* The observer isn't doing the matching because the query can do it more - * efficiently by checking the table with the query cache. */ - if (ecs_table_cache_get(&query->cache, table) == NULL) { - return; +static +bool skip_term(ecs_term_t *term) { + if (term->subj.set.mask & EcsNothing) { + return true; } - - ecs_entity_t event = it->event; - if (event == EcsOnTableEmpty) { - update_table(query, table, true); - } else - if (event == EcsOnTableFill) { - update_table(query, table, false); + if (term->oper == EcsNot) { + return true; } -} + return false; +} -/* -- Public API -- */ +static +int32_t get_variable_depth( + ecs_rule_t *rule, + ecs_rule_var_t *var, + ecs_rule_var_t *root, + int recur); -ecs_query_t* ecs_query_init( - ecs_world_t *world, - const ecs_query_desc_t *desc) +static +int32_t crawl_variable( + ecs_rule_t *rule, + ecs_rule_var_t *var, + ecs_rule_var_t *root, + int recur) { - ecs_query_t *result = NULL; - ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); - - /* Ensure that while initially populating the query with tables, they are - * in the right empty/non-empty list. This ensures the query won't miss - * empty/non-empty events for tables that are currently out of sync, but - * change back to being in sync before processing pending events. */ - ecs_force_aperiodic(world); - - result = flecs_sparse_add(world->queries, ecs_query_t); - ecs_poly_init(result, ecs_query_t); - result->id = flecs_sparse_last_id(world->queries); + ecs_term_t *terms = rule->filter.terms; + int32_t i, count = rule->filter.term_count; - ecs_observer_desc_t observer_desc = { .filter = desc->filter }; - observer_desc.filter.match_empty_tables = true; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + if (skip_term(term)) { + continue; + } + + ecs_rule_var_t + *pred = term_pred(rule, term), + *subj = term_subj(rule, term), + *obj = term_obj(rule, term); - if (ecs_filter_init(world, &result->filter, &observer_desc.filter)) { - goto error; - } + /* Variable must at least appear once in term */ + if (var != pred && var != subj && var != obj) { + continue; + } - if (result->filter.term_count) { - observer_desc.run = query_on_event; - observer_desc.ctx = result; - observer_desc.events[0] = EcsOnTableEmpty; - observer_desc.events[1] = EcsOnTableFill; - observer_desc.filter.filter = true; + if (pred && pred != var && !pred->marked) { + get_variable_depth(rule, pred, root, recur + 1); + } - /* ecs_filter_init could have moved away resources from the terms array - * in the descriptor, so use the terms array from the filter. */ - observer_desc.filter.terms_buffer = result->filter.terms; - observer_desc.filter.terms_buffer_count = result->filter.term_count; - observer_desc.filter.expr = NULL; /* Already parsed */ + if (subj && subj != var && !subj->marked) { + get_variable_depth(rule, subj, root, recur + 1); + } - result->observer = ecs_observer_init(world, &observer_desc); - if (!result->observer) { - goto error; + if (obj && obj != var && !obj->marked) { + get_variable_depth(rule, obj, root, recur + 1); } } - ecs_table_cache_init(&result->cache); - - result->world = world; - result->iterable.init = query_iter_init; - result->system = desc->system; - result->prev_match_count = -1; - - process_signature(world, result); + return 0; +} - /* Group before matching so we won't have to move tables around later */ - int32_t cascade_by = result->cascade_by; - if (cascade_by) { - query_group_by(result, result->filter.terms[cascade_by - 1].id, - group_by_cascade); - result->group_by_ctx = &result->filter.terms[cascade_by - 1]; +static +int32_t get_depth_from_var( + ecs_rule_t *rule, + ecs_rule_var_t *var, + ecs_rule_var_t *root, + int recur) +{ + /* If variable is the root or if depth has been set, return depth + 1 */ + if (var == root || var->depth != UINT8_MAX) { + return var->depth + 1; } - if (desc->group_by) { - /* Can't have a cascade term and group by at the same time, as cascade - * uses the group_by mechanism */ - ecs_check(!result->cascade_by, ECS_INVALID_PARAMETER, NULL); - query_group_by(result, desc->group_by_id, desc->group_by); - result->group_by_ctx = desc->group_by_ctx; - result->group_by_ctx_free = desc->group_by_ctx_free; + /* Variable is already being evaluated, so this indicates a cycle. Stop */ + if (var->marked) { + return 0; } - - if (desc->parent != NULL) { - result->flags |= EcsQueryIsSubquery; + + /* Variable is not yet being evaluated and depth has not yet been set. + * Calculate depth. */ + int32_t depth = get_variable_depth(rule, var, root, recur + 1); + if (depth == UINT8_MAX) { + return depth; + } else { + return depth + 1; } +} - /* If a system is specified, ensure that if there are any subjects in the - * filter that refer to the system, the component is added */ - if (desc->system) { - int32_t t, term_count = result->filter.term_count; - ecs_term_t *terms = result->filter.terms; +static +int32_t get_depth_from_term( + ecs_rule_t *rule, + ecs_rule_var_t *cur, + ecs_rule_var_t *pred, + ecs_rule_var_t *obj, + ecs_rule_var_t *root, + int recur) +{ + int32_t result = UINT8_MAX; - for (t = 0; t < term_count; t ++) { - ecs_term_t *term = &terms[t]; - if (term->subj.entity == desc->system) { - ecs_add_id(world, desc->system, term->id); + /* If neither of the other parts of the terms are variables, this + * variable is guaranteed to have no dependencies. */ + if (!pred && !obj) { + result = 0; + } else { + /* If this is a variable that is not the same as the current, + * we can use it to determine dependency depth. */ + if (pred && cur != pred) { + int32_t depth = get_depth_from_var(rule, pred, root, recur); + if (depth == UINT8_MAX) { + return UINT8_MAX; } - } - } - if (ecs_should_log_1()) { - char *filter_expr = ecs_filter_str(world, &result->filter); - ecs_dbg_1("#[green]query#[normal] [%s] created", filter_expr); - ecs_os_free(filter_expr); - } + /* If the found depth is lower than the depth found, overwrite it */ + if (depth < result) { + result = depth; + } + } - ecs_log_push_1(); + /* Same for obj */ + if (obj && cur != obj) { + int32_t depth = get_depth_from_var(rule, obj, root, recur); + if (depth == UINT8_MAX) { + return UINT8_MAX; + } - if (!desc->parent) { - if (result->flags & EcsQueryNeedsTables) { - match_tables(world, result); - } else { - /* Add stub table that resolves references (if any) so everything is - * preprocessed when the query is evaluated. */ - add_table(world, result, NULL); + if (depth < result) { + result = depth; + } } - } else { - add_subquery(world, desc->parent, result); - result->parent = desc->parent; - } - - if (desc->order_by) { - query_order_by( - world, result, desc->order_by_component, desc->order_by); } - result->constraints_satisfied = satisfy_constraints(world, &result->filter); - - ecs_log_pop_1(); - return result; -error: - if (result) { - ecs_filter_fini(&result->filter); - if (result->observer) { - ecs_delete(world, result->observer); - } - flecs_sparse_remove(world->queries, result->id); - } - return NULL; } +/* Find the depth of the dependency tree from the variable to the root */ static -void table_cache_free( - ecs_query_t *query) +int32_t get_variable_depth( + ecs_rule_t *rule, + ecs_rule_var_t *var, + ecs_rule_var_t *root, + int recur) { - ecs_table_cache_iter_t it; - ecs_query_table_t *qt; + var->marked = true; - if (flecs_table_cache_iter(&query->cache, &it)) { - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - query_table_free(query, qt); - } - } + /* Iterate columns, find all instances where 'var' is not used as subject. + * If the subject of that column is either the root or a variable for which + * the depth is known, the depth for this variable can be determined. */ + ecs_term_t *terms = rule->filter.terms; - if (flecs_table_cache_empty_iter(&query->cache, &it)) { - while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { - query_table_free(query, qt); + int32_t i, count = rule->filter.term_count; + int32_t result = UINT8_MAX; + + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + if (skip_term(term)) { + continue; } - } - ecs_table_cache_fini(&query->cache); -} + ecs_rule_var_t + *pred = term_pred(rule, term), + *subj = term_subj(rule, term), + *obj = term_obj(rule, term); -void ecs_query_fini( - ecs_query_t *query) -{ - ecs_poly_assert(query, ecs_query_t); - ecs_world_t *world = query->world; - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + if (subj != var) { + continue; + } - if (!world->is_fini) { - ecs_delete(world, query->observer); - } + if (!is_subject(rule, pred)) { + pred = NULL; + } - if (query->group_by_ctx_free) { - if (query->group_by_ctx) { - query->group_by_ctx_free(query->group_by_ctx); + if (!is_subject(rule, obj)) { + obj = NULL; + } + + int32_t depth = get_depth_from_term(rule, var, pred, obj, root, recur); + if (depth < result) { + result = depth; } } - if ((query->flags & EcsQueryIsSubquery) && - !(query->flags & EcsQueryIsOrphaned)) - { - remove_subquery(query->parent, query); + if (result == UINT8_MAX) { + result = 0; } - notify_subqueries(world, query, &(ecs_query_event_t){ - .kind = EcsQueryOrphan - }); + var->depth = result; - unregister_monitors(world, query); + /* Dependencies are calculated from subject to (pred, obj). If there were + * subjects that are only related by object (like (X, Y), (Z, Y)) it is + * possible that those have not yet been found yet. To make sure those + * variables are found, loop again & follow predicate & object links */ + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + if (skip_term(term)) { + continue; + } - table_cache_free(query); + ecs_rule_var_t + *subj = term_subj(rule, term), + *pred = term_pred(rule, term), + *obj = term_obj(rule, term); - ecs_map_fini(&query->groups); + /* Only evaluate pred & obj for current subject. This ensures that we + * won't evaluate variables that are unreachable from the root. This + * must be detected as unconstrained variables are not allowed. */ + if (subj != var) { + continue; + } - ecs_vector_free(query->subqueries); - ecs_vector_free(query->table_slices); - ecs_filter_fini(&query->filter); + crawl_variable(rule, subj, root, recur); - ecs_poly_fini(query, ecs_query_t); - - /* Remove query from storage */ - flecs_sparse_remove(world->queries, query->id); -error: - return; -} + if (pred && pred != var) { + crawl_variable(rule, pred, root, recur); + } -const ecs_filter_t* ecs_query_get_filter( - ecs_query_t *query) -{ - ecs_poly_assert(query, ecs_query_t); - return &query->filter; + if (obj && obj != var) { + crawl_variable(rule, obj, root, recur); + } + } + + return var->depth; } -/* Create query iterator */ -ecs_iter_t ecs_query_iter( - const ecs_world_t *stage, - ecs_query_t *query) +/* Compare function used for qsort. It ensures that variables are first ordered + * by depth, followed by how often they occur. */ +static +int compare_variable( + const void* ptr1, + const void *ptr2) { - ecs_poly_assert(query, ecs_query_t); - ecs_check(!(query->flags & EcsQueryIsOrphaned), - ECS_INVALID_PARAMETER, NULL); - - query->constraints_satisfied = satisfy_constraints(query->world, &query->filter); - - ecs_world_t *world = (ecs_world_t*)ecs_get_world(stage); - - flecs_process_pending_tables(world); - - sort_tables(world, query); + const ecs_rule_var_t *v1 = ptr1; + const ecs_rule_var_t *v2 = ptr2; - if (!world->is_readonly && query->flags & EcsQueryHasRefs) { - flecs_eval_component_monitors(world); + if (v1->kind < v2->kind) { + return -1; + } else if (v1->kind > v2->kind) { + return 1; } - query->prev_match_count = query->match_count; - - int32_t table_count; - if (query->table_slices) { - table_count = ecs_vector_count(query->table_slices); - } else { - table_count = ecs_query_table_count(query); + if (v1->depth < v2->depth) { + return -1; + } else if (v1->depth > v2->depth) { + return 1; } - ecs_query_iter_t it = { - .query = query, - .node = query->list.first - }; - - if (query->order_by && query->list.count) { - it.node = ecs_vector_first(query->table_slices, ecs_query_table_node_t); + if (v1->occurs < v2->occurs) { + return 1; + } else { + return -1; } - return (ecs_iter_t){ - .real_world = world, - .world = (ecs_world_t*)stage, - .terms = query->filter.terms, - .term_count = query->filter.term_count_actual, - .table_count = table_count, - .is_filter = query->filter.filter, - .is_instanced = query->filter.instanced, - .priv.iter.query = it, - .next = ecs_query_next, - }; -error: - return (ecs_iter_t){ 0 }; + return (v1->id < v2->id) - (v1->id > v2->id); } +/* After all subject variables have been found, inserted and sorted, the + * remaining variables (predicate & object) still need to be inserted. This + * function serves two purposes. The first purpose is to ensure that all + * variables are known before operations are emitted. This ensures that the + * variables array won't be reallocated while emitting, which simplifies code. + * The second purpose of the function is to ensure that if the root variable + * (which, if it exists has now been created with a table type) is also inserted + * with an entity type if required. This is used later to decide whether the + * rule needs to insert an each instruction. */ static -int find_smallest_column( - ecs_table_t *table, - ecs_query_table_match_t *table_data, - ecs_vector_t *sparse_columns) +void ensure_all_variables( + ecs_rule_t *rule) { - flecs_sparse_column_t *sparse_column_array = - ecs_vector_first(sparse_columns, flecs_sparse_column_t); - int32_t i, count = ecs_vector_count(sparse_columns); - int32_t min = INT_MAX, index = 0; + ecs_term_t *terms = rule->filter.terms; + int32_t i, count = rule->filter.term_count; for (i = 0; i < count; i ++) { - /* The array with sparse queries for the matched table */ - flecs_sparse_column_t *sparse_column = &sparse_column_array[i]; - - /* Pointer to the switch column struct of the table */ - ecs_sw_column_t *sc = sparse_column->sw_column; - - /* If the sparse column pointer hadn't been retrieved yet, do it now */ - if (!sc) { - /* Get the table column index from the signature column index */ - int32_t table_column_index = table_data->columns[ - sparse_column->signature_column_index]; - - /* Translate the table column index to switch column index */ - table_column_index -= table->sw_column_offset; - ecs_assert(table_column_index >= 1, ECS_INTERNAL_ERROR, NULL); + ecs_term_t *term = &terms[i]; + if (skip_term(term)) { + continue; + } - /* Get the sparse column */ - ecs_data_t *data = &table->storage; - sc = sparse_column->sw_column = - &data->sw_columns[table_column_index - 1]; + /* If predicate is a variable, make sure it has been registered */ + if (term->pred.var == EcsVarIsVariable) { + ensure_term_id_variable(rule, &term->pred); } - /* Find the smallest column */ - ecs_switch_t *sw = sc->data; - int32_t case_count = flecs_switch_case_count(sw, sparse_column->sw_case); - if (case_count < min) { - min = case_count; - index = i + 1; + /* If subject is a variable and it is not This, make sure it is + * registered as an entity variable. This ensures that the program will + * correctly return all permutations */ + if (term->subj.var == EcsVarIsVariable) { + if (term->subj.entity != EcsThis) { + ensure_term_id_variable(rule, &term->subj); + } } - } - return index; + /* If object is a variable, make sure it has been registered */ + if (obj_is_set(term) && (term->obj.var == EcsVarIsVariable)) { + ensure_term_id_variable(rule, &term->obj); + } + } } -typedef struct { - int32_t first; - int32_t count; -} query_iter_cursor_t; - +/* Scan for variables, put them in optimal dependency order. */ static -int sparse_column_next( - ecs_table_t *table, - ecs_query_table_match_t *matched_table, - ecs_vector_t *sparse_columns, - ecs_query_iter_t *iter, - query_iter_cursor_t *cur, - bool filter) +int scan_variables( + ecs_rule_t *rule) { - bool first_iteration = false; - int32_t sparse_smallest; - - if (!(sparse_smallest = iter->sparse_smallest)) { - sparse_smallest = iter->sparse_smallest = find_smallest_column( - table, matched_table, sparse_columns); - first_iteration = true; - } + /* Objects found in rule. One will be elected root */ + int32_t subject_count = 0; - sparse_smallest -= 1; + /* If this (.) is found, it always takes precedence in root election */ + int32_t this_var = UINT8_MAX; - flecs_sparse_column_t *columns = ecs_vector_first( - sparse_columns, flecs_sparse_column_t); - flecs_sparse_column_t *column = &columns[sparse_smallest]; - ecs_switch_t *sw, *sw_smallest = column->sw_column->data; - ecs_entity_t case_smallest = column->sw_case; + /* Keep track of the subject variable that occurs the most. In the absence of + * this (.) the variable with the most occurrences will be elected root. */ + int32_t max_occur = 0; + int32_t max_occur_var = UINT8_MAX; - /* Find next entity to iterate in sparse column */ - int32_t first, sparse_first = iter->sparse_first; + /* Step 1: find all possible roots */ + ecs_term_t *terms = rule->filter.terms; + int32_t i, term_count = rule->filter.term_count; - if (!filter) { - if (first_iteration) { - first = flecs_switch_first(sw_smallest, case_smallest); - } else { - first = flecs_switch_next(sw_smallest, sparse_first); - } - } else { - int32_t cur_first = cur->first, cur_count = cur->count; - first = cur_first; - while (flecs_switch_get(sw_smallest, first) != case_smallest) { - first ++; - if (first >= (cur_first + cur_count)) { - first = -1; - break; - } - } - } + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; - if (first == -1) { - goto done; - } + /* Evaluate the subject. The predicate and object are not evaluated, + * since they never can be elected as root. */ + if (term_id_is_variable(&term->subj)) { + const char *subj_name = term_id_var_name(&term->subj); + + ecs_rule_var_t *subj = find_variable( + rule, EcsRuleVarKindTable, subj_name); + if (!subj) { + subj = create_variable(rule, EcsRuleVarKindTable, subj_name); + if (subject_count >= ECS_RULE_MAX_VAR_COUNT) { + rule_error(rule, "too many variables in rule"); + goto error; + } - /* Check if entity matches with other sparse columns, if any */ - int32_t i, count = ecs_vector_count(sparse_columns); - do { - for (i = 0; i < count; i ++) { - if (i == sparse_smallest) { - /* Already validated this one */ - continue; + /* Make sure that variable name in term array matches with the + * rule name. */ + ecs_os_strset(&term->subj.name, subj->name); } - column = &columns[i]; - sw = column->sw_column->data; - - if (flecs_switch_get(sw, first) != column->sw_case) { - first = flecs_switch_next(sw_smallest, first); - if (first == -1) { - goto done; - } + if (++ subj->occurs > max_occur) { + max_occur = subj->occurs; + max_occur_var = subj->id; } } - } while (i != count); - - cur->first = iter->sparse_first = first; - cur->count = 1; - - return 0; -done: - /* Iterated all elements in the sparse list, we should move to the - * next matched table. */ - iter->sparse_smallest = 0; - iter->sparse_first = 0; - - return -1; -} - -#define BS_MAX ((uint64_t)0xFFFFFFFFFFFFFFFF) - -static -int bitset_column_next( - ecs_table_t *table, - ecs_vector_t *bitset_columns, - ecs_query_iter_t *iter, - query_iter_cursor_t *cur) -{ - /* Precomputed single-bit test */ - static const uint64_t bitmask[64] = { - (uint64_t)1 << 0, (uint64_t)1 << 1, (uint64_t)1 << 2, (uint64_t)1 << 3, - (uint64_t)1 << 4, (uint64_t)1 << 5, (uint64_t)1 << 6, (uint64_t)1 << 7, - (uint64_t)1 << 8, (uint64_t)1 << 9, (uint64_t)1 << 10, (uint64_t)1 << 11, - (uint64_t)1 << 12, (uint64_t)1 << 13, (uint64_t)1 << 14, (uint64_t)1 << 15, - (uint64_t)1 << 16, (uint64_t)1 << 17, (uint64_t)1 << 18, (uint64_t)1 << 19, - (uint64_t)1 << 20, (uint64_t)1 << 21, (uint64_t)1 << 22, (uint64_t)1 << 23, - (uint64_t)1 << 24, (uint64_t)1 << 25, (uint64_t)1 << 26, (uint64_t)1 << 27, - (uint64_t)1 << 28, (uint64_t)1 << 29, (uint64_t)1 << 30, (uint64_t)1 << 31, - (uint64_t)1 << 32, (uint64_t)1 << 33, (uint64_t)1 << 34, (uint64_t)1 << 35, - (uint64_t)1 << 36, (uint64_t)1 << 37, (uint64_t)1 << 38, (uint64_t)1 << 39, - (uint64_t)1 << 40, (uint64_t)1 << 41, (uint64_t)1 << 42, (uint64_t)1 << 43, - (uint64_t)1 << 44, (uint64_t)1 << 45, (uint64_t)1 << 46, (uint64_t)1 << 47, - (uint64_t)1 << 48, (uint64_t)1 << 49, (uint64_t)1 << 50, (uint64_t)1 << 51, - (uint64_t)1 << 52, (uint64_t)1 << 53, (uint64_t)1 << 54, (uint64_t)1 << 55, - (uint64_t)1 << 56, (uint64_t)1 << 57, (uint64_t)1 << 58, (uint64_t)1 << 59, - (uint64_t)1 << 60, (uint64_t)1 << 61, (uint64_t)1 << 62, (uint64_t)1 << 63 - }; + } - /* Precomputed test to verify if remainder of block is set (or not) */ - static const uint64_t bitmask_remain[64] = { - BS_MAX, BS_MAX - (BS_MAX >> 63), BS_MAX - (BS_MAX >> 62), - BS_MAX - (BS_MAX >> 61), BS_MAX - (BS_MAX >> 60), BS_MAX - (BS_MAX >> 59), - BS_MAX - (BS_MAX >> 58), BS_MAX - (BS_MAX >> 57), BS_MAX - (BS_MAX >> 56), - BS_MAX - (BS_MAX >> 55), BS_MAX - (BS_MAX >> 54), BS_MAX - (BS_MAX >> 53), - BS_MAX - (BS_MAX >> 52), BS_MAX - (BS_MAX >> 51), BS_MAX - (BS_MAX >> 50), - BS_MAX - (BS_MAX >> 49), BS_MAX - (BS_MAX >> 48), BS_MAX - (BS_MAX >> 47), - BS_MAX - (BS_MAX >> 46), BS_MAX - (BS_MAX >> 45), BS_MAX - (BS_MAX >> 44), - BS_MAX - (BS_MAX >> 43), BS_MAX - (BS_MAX >> 42), BS_MAX - (BS_MAX >> 41), - BS_MAX - (BS_MAX >> 40), BS_MAX - (BS_MAX >> 39), BS_MAX - (BS_MAX >> 38), - BS_MAX - (BS_MAX >> 37), BS_MAX - (BS_MAX >> 36), BS_MAX - (BS_MAX >> 35), - BS_MAX - (BS_MAX >> 34), BS_MAX - (BS_MAX >> 33), BS_MAX - (BS_MAX >> 32), - BS_MAX - (BS_MAX >> 31), BS_MAX - (BS_MAX >> 30), BS_MAX - (BS_MAX >> 29), - BS_MAX - (BS_MAX >> 28), BS_MAX - (BS_MAX >> 27), BS_MAX - (BS_MAX >> 26), - BS_MAX - (BS_MAX >> 25), BS_MAX - (BS_MAX >> 24), BS_MAX - (BS_MAX >> 23), - BS_MAX - (BS_MAX >> 22), BS_MAX - (BS_MAX >> 21), BS_MAX - (BS_MAX >> 20), - BS_MAX - (BS_MAX >> 19), BS_MAX - (BS_MAX >> 18), BS_MAX - (BS_MAX >> 17), - BS_MAX - (BS_MAX >> 16), BS_MAX - (BS_MAX >> 15), BS_MAX - (BS_MAX >> 14), - BS_MAX - (BS_MAX >> 13), BS_MAX - (BS_MAX >> 12), BS_MAX - (BS_MAX >> 11), - BS_MAX - (BS_MAX >> 10), BS_MAX - (BS_MAX >> 9), BS_MAX - (BS_MAX >> 8), - BS_MAX - (BS_MAX >> 7), BS_MAX - (BS_MAX >> 6), BS_MAX - (BS_MAX >> 5), - BS_MAX - (BS_MAX >> 4), BS_MAX - (BS_MAX >> 3), BS_MAX - (BS_MAX >> 2), - BS_MAX - (BS_MAX >> 1) - }; + rule->subj_var_count = rule->var_count; - int32_t i, count = ecs_vector_count(bitset_columns); - flecs_bitset_column_t *columns = ecs_vector_first( - bitset_columns, flecs_bitset_column_t); - int32_t bs_offset = table->bs_column_offset; + ensure_all_variables(rule); - int32_t first = iter->bitset_first; - int32_t last = 0; + /* Variables in a term with a literal subject have depth 0 */ + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; - for (i = 0; i < count; i ++) { - flecs_bitset_column_t *column = &columns[i]; - ecs_bs_column_t *bs_column = columns[i].bs_column; + if (term->subj.var == EcsVarIsEntity) { + ecs_rule_var_t + *pred = term_pred(rule, term), + *obj = term_obj(rule, term); - if (!bs_column) { - int32_t index = column->column_index; - ecs_assert((index - bs_offset >= 0), ECS_INTERNAL_ERROR, NULL); - bs_column = &table->storage.bs_columns[index - bs_offset]; - columns[i].bs_column = bs_column; + if (pred) { + pred->depth = 0; + } + if (obj) { + obj->depth = 0; + } } - - ecs_bitset_t *bs = &bs_column->data; - int32_t bs_elem_count = bs->count; - int32_t bs_block = first >> 6; - int32_t bs_block_count = ((bs_elem_count - 1) >> 6) + 1; + } - if (bs_block >= bs_block_count) { + /* Elect a root. This is either this (.) or the variable with the most + * occurrences. */ + int32_t root_var = this_var; + if (root_var == UINT8_MAX) { + root_var = max_occur_var; + if (root_var == UINT8_MAX) { + /* If no subject variables have been found, the rule expression only + * operates on a fixed set of entities, in which case no root + * election is required. */ goto done; } + } - uint64_t *data = bs->data; - int32_t bs_start = first & 0x3F; + ecs_rule_var_t *root = &rule->vars[root_var]; + root->depth = get_variable_depth(rule, root, root, 0); - /* Step 1: find the first non-empty block */ - uint64_t v = data[bs_block]; - uint64_t remain = bitmask_remain[bs_start]; - while (!(v & remain)) { - /* If no elements are remaining, move to next block */ - if ((++bs_block) >= bs_block_count) { - /* No non-empty blocks left */ - goto done; - } + /* Verify that there are no unconstrained variables. Unconstrained variables + * are variables that are unreachable from the root. */ + for (i = 0; i < rule->subj_var_count; i ++) { + if (rule->vars[i].depth == UINT8_MAX) { + rule_error(rule, "unconstrained variable '%s'", + rule->vars[i].name); + goto error; + } + } - bs_start = 0; - remain = BS_MAX; /* Test the full block */ - v = data[bs_block]; + /* For each Not term, verify that variables are known */ + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; + if (term->oper != EcsNot) { + continue; } - /* Step 2: find the first non-empty element in the block */ - while (!(v & bitmask[bs_start])) { - bs_start ++; + ecs_rule_var_t + *pred = term_pred(rule, term), + *obj = term_obj(rule, term); - /* Block was not empty, so bs_start must be smaller than 64 */ - ecs_assert(bs_start < 64, ECS_INTERNAL_ERROR, NULL); + if (!pred && term_id_is_variable(&term->pred)) { + rule_error(rule, "missing predicate variable '%s'", + term_id_var_name(&term->pred)); + goto error; } - - /* Step 3: Find number of contiguous enabled elements after start */ - int32_t bs_end = bs_start, bs_block_end = bs_block; - - remain = bitmask_remain[bs_end]; - while ((v & remain) == remain) { - bs_end = 0; - bs_block_end ++; - - if (bs_block_end == bs_block_count) { - break; - } - - v = data[bs_block_end]; - remain = BS_MAX; /* Test the full block */ + if (!obj && term_id_is_variable(&term->obj)) { + rule_error(rule, "missing object variable '%s'", + term_id_var_name(&term->obj)); + goto error; } + } - /* Step 4: find remainder of enabled elements in current block */ - if (bs_block_end != bs_block_count) { - while ((v & bitmask[bs_end])) { - bs_end ++; - } - } + /* Order variables by depth, followed by occurrence. The variable + * array will later be used to lead the iteration over the terms, and + * determine which operations get inserted first. */ + int32_t var_count = rule->var_count; + ecs_qsort_t(rule->vars, var_count, ecs_rule_var_t, compare_variable); - /* Block was not 100% occupied, so bs_start must be smaller than 64 */ - ecs_assert(bs_end < 64, ECS_INTERNAL_ERROR, NULL); + /* Iterate variables to correct ids after sort */ + for (i = 0; i < rule->var_count; i ++) { + rule->vars[i].id = i; + } + +done: + return 0; +error: + return -1; +} - /* Step 5: translate to element start/end and make sure that each column - * range is a subset of the previous one. */ - first = bs_block * 64 + bs_start; - int32_t cur_last = bs_block_end * 64 + bs_end; - - /* No enabled elements found in table */ - if (first == cur_last) { - goto done; - } - - /* If multiple bitsets are evaluated, make sure each subsequent range - * is equal or a subset of the previous range */ - if (i) { - /* If the first element of a subsequent bitset is larger than the - * previous last value, start over. */ - if (first >= last) { - i = -1; - continue; - } - - /* Make sure the last element of the range doesn't exceed the last - * element of the previous range. */ - if (cur_last > last) { - cur_last = last; - } - } - - last = cur_last; - int32_t elem_count = last - first; +/* Get entity variable from table variable */ +static +ecs_rule_var_t* to_entity( + ecs_rule_t *rule, + ecs_rule_var_t *var) +{ + if (!var) { + return NULL; + } - /* Make sure last element doesn't exceed total number of elements in - * the table */ - if (elem_count > (bs_elem_count - first)) { - elem_count = (bs_elem_count - first); - if (!elem_count) { - iter->bitset_first = 0; - goto done; - } - } - - cur->first = first; - cur->count = elem_count; - iter->bitset_first = first; + ecs_rule_var_t *evar = NULL; + if (var->kind == EcsRuleVarKindTable) { + evar = find_variable(rule, EcsRuleVarKindEntity, var->name); + } else { + evar = var; } - - /* Keep track of last processed element for iteration */ - iter->bitset_first = last; - return 0; -done: - iter->sparse_smallest = 0; - iter->sparse_first = 0; - return -1; + return evar; } +/* Ensure that if a table variable has been written, the corresponding entity + * variable is populated. The function will return the most specific, populated + * variable. */ static -void mark_columns_dirty( - ecs_query_t *query, - ecs_query_table_match_t *table_data) +ecs_rule_var_t* most_specific_var( + ecs_rule_t *rule, + ecs_rule_var_t *var, + bool *written, + bool create) { - ecs_table_t *table = table_data->table; + if (!var) { + return NULL; + } - if (table && table->dirty_state) { - ecs_term_t *terms = query->filter.terms; - int32_t i, count = query->filter.term_count_actual; - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - int32_t ti = term->index; + ecs_rule_var_t *tvar, *evar = to_entity(rule, var); + if (!evar) { + return var; + } - if (term->inout == EcsIn || term->inout == EcsInOutFilter) { - /* Don't mark readonly terms dirty */ - continue; - } + if (var->kind == EcsRuleVarKindTable) { + tvar = var; + } else { + tvar = find_variable(rule, EcsRuleVarKindTable, var->name); + } - if (table_data->subjects[ti] != 0) { - /* Don't mark table dirty if term is not from the table */ - continue; - } + /* If variable is used as predicate or object, it should have been + * registered as an entity. */ + ecs_assert(evar != NULL, ECS_INTERNAL_ERROR, NULL); - int32_t index = table_data->columns[ti]; - if (index <= 0) { - /* If term is not set, there's nothing to mark dirty */ - continue; - } + /* Usually table variables are resolved before they are used as a predicate + * or object, but in the case of cyclic dependencies this is not guaranteed. + * Only insert an each instruction of the table variable has been written */ + if (tvar && written[tvar->id]) { + /* If the variable has been written as a table but not yet + * as an entity, insert an each operation that yields each + * entity in the table. */ + if (evar) { + if (written[evar->id]) { + return evar; + } else if (create) { + ecs_rule_op_t *op = create_operation(rule); + op->kind = EcsRuleEach; + op->on_pass = rule->operation_count; + op->on_fail = rule->operation_count - 2; + op->frame = rule->frame_count; + op->has_in = true; + op->has_out = true; + op->r_in = tvar->id; + op->r_out = evar->id; - /* Potential candidate for marking table dirty, if a component */ - int32_t storage_index = ecs_table_type_to_storage_index( - table, index - 1); - if (storage_index >= 0) { - table->dirty_state[storage_index + 1] ++; + /* Entity will either be written or has been written */ + written[evar->id] = true; + + push_frame(rule); + + return evar; + } else { + return tvar; } } + } else if (evar && written[evar->id]) { + return evar; } + + return var; } -bool ecs_query_next( - ecs_iter_t *it) +/* Get most specific known variable */ +static +ecs_rule_var_t *get_most_specific_var( + ecs_rule_t *rule, + ecs_rule_var_t *var, + bool *written) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); - - if (flecs_iter_next_row(it)) { - return true; - } - - return flecs_iter_next_instanced(it, ecs_query_next_instanced(it)); -error: - return false; + return most_specific_var(rule, var, written, false); } -bool ecs_query_next_instanced( - ecs_iter_t *it) +/* Get or create most specific known variable. This will populate an entity + * variable if a table variable is known but the entity variable isn't. */ +static +ecs_rule_var_t *ensure_most_specific_var( + ecs_rule_t *rule, + ecs_rule_var_t *var, + bool *written) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); + return most_specific_var(rule, var, written, true); +} - ecs_query_iter_t *iter = &it->priv.iter.query; - ecs_query_t *query = iter->query; - ecs_world_t *world = query->world; - ecs_flags32_t flags = query->flags; - (void)world; - it->is_valid = true; +/* Ensure that an entity variable is written before using it */ +static +ecs_rule_var_t* ensure_entity_written( + ecs_rule_t *rule, + ecs_rule_var_t *var, + bool *written) +{ + if (!var) { + return NULL; + } - ecs_poly_assert(world, ecs_world_t); + /* Ensure we're working with the most specific version of subj we can get */ + ecs_rule_var_t *evar = ensure_most_specific_var(rule, var, written); - if (!query->constraints_satisfied) { - goto done; - } + /* The post condition of this function is that there is an entity variable, + * and that it is written. Make sure that the result is an entity */ + ecs_assert(evar != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(evar->kind == EcsRuleVarKindEntity, ECS_INTERNAL_ERROR, NULL); - query_iter_cursor_t cur; - ecs_query_table_node_t *node, *next, *prev; - if ((prev = iter->prev)) { - /* Match has been iterated, update monitor for change tracking */ - if (flags & EcsQueryHasMonitor) { - sync_match_monitor(query, prev->match); - } - if (flags & EcsQueryHasOutColumns) { - mark_columns_dirty(query, prev->match); - } - } + /* Make sure the variable has been written */ + ecs_assert(written[evar->id] == true, ECS_INTERNAL_ERROR, NULL); + + return evar; +} - iter->skip_count = 0; +static +ecs_rule_op_t* insert_operation( + ecs_rule_t *rule, + int32_t term_index, + bool *written) +{ + ecs_rule_pair_t pair = {0}; - for (node = iter->node; node != NULL; node = next) { - ecs_query_table_match_t *match = node->match; - ecs_table_t *table = match->table; + /* Parse the term's type into a pair. A pair extracts the ids from + * the term, and replaces variables with wildcards which can then + * be matched against actual relationships. A pair retains the + * information about the variables, so that when a match happens, + * the pair can be used to reify the variable. */ + if (term_index != -1) { + ecs_term_t *term = &rule->filter.terms[term_index]; - next = node->next; + pair = term_to_pair(rule, term); - if (table) { - cur.first = node->offset; - cur.count = node->count; - if (!cur.count) { - cur.count = ecs_table_count(table); + /* If the pair contains entity variables that have not yet been written, + * insert each instructions in case their tables are known. Variables in + * a pair that are truly unknown will be populated by the operation, + * but an operation should never overwrite an entity variable if the + * corresponding table variable has already been resolved. */ + if (pair.reg_mask & RULE_PAIR_PREDICATE) { + ecs_rule_var_t *pred = &rule->vars[pair.pred.reg]; + pred = get_most_specific_var(rule, pred, written); + pair.pred.reg = pred->id; + } - /* List should never contain empty tables */ - ecs_assert(cur.count != 0, ECS_INTERNAL_ERROR, NULL); - } + if (pair.reg_mask & RULE_PAIR_OBJECT) { + ecs_rule_var_t *obj = &rule->vars[pair.obj.reg]; + obj = get_most_specific_var(rule, obj, written); + pair.obj.reg = obj->id; + } + } else { + /* Not all operations have a filter (like Each) */ + } - ecs_vector_t *bitset_columns = match->bitset_columns; - ecs_vector_t *sparse_columns = match->sparse_columns; + ecs_rule_op_t *op = create_operation(rule); + op->on_pass = rule->operation_count; + op->on_fail = rule->operation_count - 2; + op->frame = rule->frame_count; + op->filter = pair; - if (bitset_columns || sparse_columns) { - bool found = false; + /* Store corresponding signature term so we can correlate and + * store the table columns with signature columns. */ + op->term = term_index; - do { - found = false; + return op; +} - if (bitset_columns) { - if (bitset_column_next(table, bitset_columns, iter, - &cur) == -1) - { - /* No more enabled components for table */ - iter->bitset_first = 0; - break; - } else { - found = true; - next = node; - } - } +/* Insert first operation, which is always Input. This creates an entry in + * the register stack for the initial state. */ +static +void insert_input( + ecs_rule_t *rule) +{ + ecs_rule_op_t *op = create_operation(rule); + op->kind = EcsRuleInput; - if (sparse_columns) { - if (sparse_column_next(table, match, - sparse_columns, iter, &cur, found) == -1) - { - /* No more elements in sparse column */ - if (found) { - /* Try again */ - next = node->next; - found = false; - } else { - /* Nothing found */ - iter->bitset_first = 0; - break; - } - } else { - found = true; - next = node; - iter->bitset_first = cur.first + cur.count; - } - } - } while (!found); + /* The first time Input is evaluated it goes to the next/first operation */ + op->on_pass = 1; - if (!found) { - continue; - } - } - } else { - cur.count = 0; - cur.first = 0; - } + /* When Input is evaluated with redo = true it will return false, which will + * finish the program as op becomes -1. */ + op->on_fail = -1; - it->ids = match->ids; - it->columns = match->columns; - it->subjects = match->subjects; - it->sizes = match->sizes; - it->references = match->references; - it->instance_count = 0; + push_frame(rule); +} - flecs_iter_init(it); - flecs_iter_populate_data(world, it, match->table, cur.first, cur.count, - it->ptrs, NULL); +/* Insert last operation, which is always Yield. When the program hits Yield, + * data is returned to the application. */ +static +void insert_yield( + ecs_rule_t *rule) +{ + ecs_rule_op_t *op = create_operation(rule); + op->kind = EcsRuleYield; + op->has_in = true; + op->on_fail = rule->operation_count - 2; + /* Yield can only "fail" since it is the end of the program */ - iter->node = next; - iter->prev = node; - goto yield; + /* Find variable associated with this. It is possible that the variable + * exists both as a table and as an entity. This can happen when a rule + * first selects a table for this, but then subsequently needs to evaluate + * each entity in that table. In that case the yield instruction should + * return the entity, so look for that first. */ + ecs_rule_var_t *var = find_variable(rule, EcsRuleVarKindEntity, "."); + if (!var) { + var = find_variable(rule, EcsRuleVarKindTable, "."); } -done: -error: - ecs_iter_fini(it); - return false; - -yield: - return true; + /* If there is no this, there is nothing to yield. In that case the rule + * simply returns true or false. */ + if (!var) { + op->r_in = UINT8_MAX; + } else { + op->r_in = var->id; + } + + op->frame = push_frame(rule); } -bool ecs_query_changed( - ecs_query_t *query, - const ecs_iter_t *it) +/* Return superset/subset including the root */ +static +void insert_reflexive_set( + ecs_rule_t *rule, + ecs_rule_op_kind_t op_kind, + ecs_rule_var_t *out, + const ecs_rule_pair_t pair, + int32_t c, + bool *written, + bool reflexive) { - if (it) { - ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - - ecs_query_table_match_t *qt = - (ecs_query_table_match_t*)it->priv.iter.query.prev; - ecs_assert(qt != NULL, ECS_INVALID_PARAMETER, NULL); - - if (!query) { - query = it->priv.iter.query.query; - } else { - ecs_check(query == it->priv.iter.query.query, - ECS_INVALID_PARAMETER, NULL); - } + ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_poly_assert(query, ecs_query_t); + ecs_rule_var_t *pred = pair_pred(rule, &pair); + ecs_rule_var_t *obj = pair_obj(rule, &pair); - flecs_process_pending_tables(it->real_world); + int32_t setjmp_lbl = rule->operation_count; + int32_t store_lbl = setjmp_lbl + 1; + int32_t set_lbl = setjmp_lbl + 2; + int32_t next_op = setjmp_lbl + 4; + int32_t prev_op = setjmp_lbl - 1; - return check_match_monitor(query, qt); + /* Insert 4 operations at once, so we don't have to worry about how + * the instruction array reallocs. If operation is not reflexive, we only + * need to insert the set operation. */ + if (reflexive) { + insert_operation(rule, -1, written); + insert_operation(rule, -1, written); + insert_operation(rule, -1, written); } - ecs_poly_assert(query, ecs_query_t); - ecs_check(!(query->flags & EcsQueryIsOrphaned), - ECS_INVALID_PARAMETER, NULL); - - flecs_process_pending_tables(query->world); + ecs_rule_op_t *op = insert_operation(rule, -1, written); + ecs_rule_op_t *setjmp = &rule->operations[setjmp_lbl]; + ecs_rule_op_t *store = &rule->operations[store_lbl]; + ecs_rule_op_t *set = &rule->operations[set_lbl]; + ecs_rule_op_t *jump = op; - if (!(query->flags & EcsQueryHasMonitor)) { - query->flags |= EcsQueryHasMonitor; - init_query_monitors(query); - return true; /* Monitors didn't exist yet */ + if (!reflexive) { + set_lbl = setjmp_lbl; + set = op; + setjmp = NULL; + store = NULL; + jump = NULL; + next_op = set_lbl + 1; + prev_op = set_lbl - 1; } - if (query->match_count != query->prev_match_count) { - return true; + /* The SetJmp operation stores a conditional jump label that either + * points to the Store or *Set operation */ + if (reflexive) { + setjmp->kind = EcsRuleSetJmp; + setjmp->on_pass = store_lbl; + setjmp->on_fail = set_lbl; } - return check_query_monitor(query); -error: - return false; -} + /* The Store operation yields the root of the subtree. After yielding, + * this operation will fail and return to SetJmp, which will cause it + * to switch to the *Set operation. */ + if (reflexive) { + store->kind = EcsRuleStore; + store->on_pass = next_op; + store->on_fail = setjmp_lbl; + store->has_in = true; + store->has_out = true; + store->r_out = out->id; + store->term = c; -void ecs_query_skip( - ecs_iter_t *it) -{ - ecs_assert(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); - ecs_assert(it->is_valid, ECS_INVALID_PARAMETER, NULL); + if (!pred) { + store->filter.pred = pair.pred; + } else { + store->filter.pred.reg = pred->id; + store->filter.reg_mask |= RULE_PAIR_PREDICATE; + } - if (it->instance_count > it->count) { - it->priv.iter.query.skip_count ++; - if (it->priv.iter.query.skip_count == it->instance_count) { - /* For non-instanced queries, make sure all entities are skipped */ - it->priv.iter.query.prev = NULL; + /* If the object of the filter is not a variable, store literal */ + if (!obj) { + store->r_in = UINT8_MAX; + store->subject = ecs_get_alive(rule->world, pair.obj.ent); + store->filter.obj = pair.obj; + } else { + store->r_in = obj->id; + store->filter.obj.reg = obj->id; + store->filter.reg_mask |= RULE_PAIR_OBJECT; } - } else { - it->priv.iter.query.prev = NULL; } -} - -bool ecs_query_orphaned( - ecs_query_t *query) -{ - ecs_poly_assert(query, ecs_query_t); - return query->flags & EcsQueryIsOrphaned; -} - -#include -#define INIT_CACHE(it, f, term_count)\ - if (!it->f && term_count) {\ - if (term_count <= ECS_TERM_CACHE_SIZE) {\ - it->f = it->priv.cache.f;\ - it->priv.cache.f##_alloc = false;\ - } else {\ - it->f = ecs_os_calloc(ECS_SIZEOF(*(it->f)) * term_count);\ - it->priv.cache.f##_alloc = true;\ - }\ - } - -#define FINI_CACHE(it, f)\ - if (it->f) {\ - if (it->priv.cache.f##_alloc) {\ - ecs_os_free((void*)it->f);\ - }\ - } + /* This is either a SubSet or SuperSet operation */ + set->kind = op_kind; + set->on_pass = next_op; + set->on_fail = prev_op; + set->has_out = true; + set->r_out = out->id; + set->term = c; -void flecs_iter_init( - ecs_iter_t *it) -{ - INIT_CACHE(it, ids, it->term_count); - INIT_CACHE(it, subjects, it->term_count); - INIT_CACHE(it, match_indices, it->term_count); - INIT_CACHE(it, columns, it->term_count); - - if (!it->is_filter) { - INIT_CACHE(it, sizes, it->term_count); - INIT_CACHE(it, ptrs, it->term_count); + /* Predicate can be a variable if it's non-final */ + if (!pred) { + set->filter.pred = pair.pred; } else { - it->sizes = NULL; - it->ptrs = NULL; + set->filter.pred.reg = pred->id; + set->filter.reg_mask |= RULE_PAIR_PREDICATE; } - it->is_valid = true; -} - -void ecs_iter_fini( - ecs_iter_t *it) -{ - ecs_check(it->is_valid == true, ECS_INVALID_PARAMETER, NULL); - it->is_valid = false; + if (!obj) { + set->filter.obj = pair.obj; + } else { + set->filter.obj.reg = obj->id; + set->filter.reg_mask |= RULE_PAIR_OBJECT; + } - if (it->fini) { - it->fini(it); + if (reflexive) { + /* The jump operation jumps to either the store or subset operation, + * depending on whether the store operation already yielded. The + * operation is inserted last, so that the on_fail label of the next + * operation will point to it */ + jump->kind = EcsRuleJump; + + /* The pass/fail labels of the Jump operation are not used, since it + * jumps to a variable location. Instead, the pass label is (ab)used to + * store the label of the SetJmp operation, so that the jump can access + * the label it needs to jump to from the setjmp op_ctx. */ + jump->on_pass = setjmp_lbl; + jump->on_fail = -1; } - FINI_CACHE(it, ids); - FINI_CACHE(it, columns); - FINI_CACHE(it, subjects); - FINI_CACHE(it, sizes); - FINI_CACHE(it, ptrs); - FINI_CACHE(it, match_indices); -error: - return; + written[out->id] = true; } static -bool flecs_iter_populate_term_data( - ecs_world_t *world, - ecs_iter_t *it, - int32_t t, - int32_t column, - void **ptr_out, - ecs_size_t *size_out) +ecs_rule_var_t* store_reflexive_set( + ecs_rule_t *rule, + ecs_rule_op_kind_t op_kind, + ecs_rule_pair_t *pair, + bool *written, + bool reflexive, + bool as_entity) { - bool is_shared = false; - - if (!column) { - /* Term has no data. This includes terms that have Not operators. */ - goto no_data; - } - - if (!it->terms) { - goto no_data; + /* Ensure we're using the most specific version of obj */ + ecs_rule_var_t *obj = pair_obj(rule, pair); + if (obj) { + pair->obj.reg = obj->id; } - /* Filter terms may match with data but don't return it */ - if (it->terms[t].inout == EcsInOutFilter) { - goto no_data; + /* The subset operation returns tables */ + ecs_rule_var_kind_t var_kind = EcsRuleVarKindTable; + if (op_kind == EcsSuperSet) { + var_kind = EcsRuleVarKindEntity; } - ecs_table_t *table; - ecs_vector_t *vec; - ecs_size_t size; - ecs_size_t align; - int32_t row; - - if (column < 0) { - is_shared = true; - - /* Data is not from This */ - if (it->references) { - /* Iterator provides cached references for non-This terms */ - ecs_ref_t *ref = &it->references[-column - 1]; - if (ptr_out) ptr_out[0] = (void*)ecs_get_ref_id( - world, ref, ref->entity, ref->component); - - /* If cached references were provided, the code that populated - * the iterator also had a chance to cache sizes, so size array - * should already have been assigned. This saves us from having - * to do additional lookups to find the component size. */ - ecs_assert(size_out == NULL, ECS_INTERNAL_ERROR, NULL); - return true; - } else { - ecs_entity_t subj = it->subjects[t]; - ecs_assert(subj != 0, ECS_INTERNAL_ERROR, NULL); - - /* Don't use ecs_get_id directly. Instead, go directly to the - * storage so that we can get both the pointer and size */ - ecs_record_t *r = ecs_eis_get(world, subj); - ecs_assert(r != NULL && r->table != NULL, ECS_INTERNAL_ERROR, NULL); - - row = ECS_RECORD_TO_ROW(r->row); - table = r->table; + /* Create anonymous variable for storing the set */ + ecs_rule_var_t *av = create_anonymous_variable(rule, var_kind); + int32_t ave_id = 0, av_id = av->id; - ecs_id_t id = it->ids[t]; - ecs_table_t *s_table = table->storage_table; - ecs_table_record_t *tr; + /* If the variable kind is a table, also create an entity variable as the + * result of the set operation should be returned as an entity */ + if (var_kind == EcsRuleVarKindTable && as_entity) { + create_variable(rule, EcsRuleVarKindEntity, av->name); + av = &rule->vars[av_id]; + ave_id = av_id + 1; + } - if (!s_table || !(tr = flecs_get_table_record(world, s_table, id))){ - /* The entity has no components or the id is not a component */ - - ecs_id_t term_id = it->terms[t].id; - if (ECS_HAS_ROLE(term_id, SWITCH) || ECS_HAS_ROLE(term_id, CASE)) { - /* Edge case: if this is a switch. Find switch column in - * actual table, as its not in the storage table */ - tr = flecs_get_table_record(world, table, id); - ecs_assert(tr != NULL, ECS_INTERNAL_ERROR, NULL); - column = tr->column; - goto has_switch; - } else { - goto no_data; - } - } + /* Generate the operations */ + insert_reflexive_set(rule, op_kind, av, *pair, -1, written, reflexive); - /* We now have row and column, so we can get the storage for the id - * which gives us the pointer and size */ - column = tr->column; - ecs_column_t *s = &table->storage.columns[column]; - size = s->size; - align = s->alignment; - vec = s->data; - /* Fallthrough to has_data */ - } + /* Make sure to return entity variable, and that it is populated */ + if (as_entity) { + return ensure_entity_written(rule, &rule->vars[ave_id], written); } else { - /* Data is from This, use table from iterator */ - table = it->table; - if (!table || !ecs_table_count(table)) { - goto no_data; - } - - row = it->offset; - - int32_t storage_column = ecs_table_type_to_storage_index( - table, column - 1); - if (storage_column == -1) { - ecs_id_t id = it->terms[t].id; - if (ECS_HAS_ROLE(id, SWITCH) || ECS_HAS_ROLE(id, CASE)) { - goto has_switch; - } - goto no_data; - } + return &rule->vars[av_id]; + } +} - ecs_column_t *s = &table->storage.columns[storage_column]; - size = s->size; - align = s->alignment; - vec = s->data; - /* Fallthrough to has_data */ +static +bool is_known( + ecs_rule_var_t *var, + bool *written) +{ + if (!var) { + return true; + } else { + return written[var->id]; } +} -has_data: - if (ptr_out) ptr_out[0] = ecs_vector_get_t(vec, size, align, row); - if (size_out) size_out[0] = size; - return is_shared; +static +bool is_pair_known( + ecs_rule_t *rule, + ecs_rule_pair_t *pair, + bool *written) +{ + ecs_rule_var_t *pred_var = pair_pred(rule, pair); + if (!is_known(pred_var, written) || pair->pred.ent == EcsWildcard) { + return false; + } -has_switch: { - /* Edge case: if column is a switch we should return the vector with case - * identifiers. Will be replaced in the future with pluggable storage */ - ecs_switch_t *sw = table->storage.sw_columns[ - (column - 1) - table->sw_column_offset].data; - vec = flecs_switch_values(sw); - size = ECS_SIZEOF(ecs_entity_t); - align = ECS_ALIGNOF(ecs_entity_t); - goto has_data; + ecs_rule_var_t *obj_var = pair_obj(rule, pair); + if (!is_known(obj_var, written) || pair->obj.ent == EcsWildcard) { + return false; } -no_data: - if (ptr_out) ptr_out[0] = NULL; - if (size_out) size_out[0] = 0; - return false; + return true; } -void flecs_iter_populate_data( - ecs_world_t *world, - ecs_iter_t *it, - ecs_table_t *table, - int32_t offset, - int32_t count, - void **ptrs, - ecs_size_t *sizes) +static +void set_input_to_subj( + ecs_rule_t *rule, + ecs_rule_op_t *op, + ecs_term_t *term, + ecs_rule_var_t *var) { - if (it->table) { - it->frame_offset += ecs_table_count(it->table); + (void)rule; + + op->has_in = true; + if (!var) { + op->r_in = UINT8_MAX; + op->subject = term->subj.entity; + + /* Invalid entities should have been caught during parsing */ + ecs_assert(ecs_is_valid(rule->world, op->subject), + ECS_INTERNAL_ERROR, NULL); + } else { + op->r_in = var->id; } +} - it->table = table; - it->offset = offset; - it->count = count; +static +void set_output_to_subj( + ecs_rule_t *rule, + ecs_rule_op_t *op, + ecs_term_t *term, + ecs_rule_var_t *var) +{ + (void)rule; - if (table) { - it->type = it->table->type; - if (!count) { - count = it->count = ecs_table_count(table); - } - if (count) { - it->entities = ecs_vector_get( - table->storage.entities, ecs_entity_t, offset); - } else { - it->entities = NULL; - } - } + op->has_out = true; + if (!var) { + op->r_out = UINT8_MAX; + op->subject = term->subj.entity; - if (it->is_filter) { - it->has_shared = false; - return; + /* Invalid entities should have been caught during parsing */ + ecs_assert(ecs_is_valid(rule->world, op->subject), + ECS_INTERNAL_ERROR, NULL); + } else { + op->r_out = var->id; } +} - int t, term_count = it->term_count; - bool has_shared = false; +static +void insert_select_or_with( + ecs_rule_t *rule, + int32_t c, + ecs_term_t *term, + ecs_rule_var_t *subj, + ecs_rule_pair_t *pair, + bool *written) +{ + ecs_rule_op_t *op; + bool eval_subject_supersets = false; - if (ptrs && sizes) { - for (t = 0; t < term_count; t ++) { - int32_t column = it->columns[t]; - has_shared |= flecs_iter_populate_term_data(world, it, t, column, - &ptrs[t], - &sizes[t]); + /* Find any entity and/or table variables for subject */ + ecs_rule_var_t *tvar = NULL, *evar = to_entity(rule, subj), *var = evar; + if (subj && subj->kind == EcsRuleVarKindTable) { + tvar = subj; + if (!evar) { + var = tvar; } + } + + int32_t lbl_start = rule->operation_count; + ecs_rule_pair_t filter; + if (pair) { + filter = *pair; } else { - for (t = 0; t < term_count; t ++) { - int32_t column = it->columns[t]; - void **ptr = NULL; - if (ptrs) { - ptr = &ptrs[t]; - } - ecs_size_t *size = NULL; - if (sizes) { - size = &sizes[t]; - } - has_shared |= flecs_iter_populate_term_data(world, it, t, column, - ptr, size); - } + filter = term_to_pair(rule, term); } - it->has_shared = has_shared; -} + /* Only insert implicit IsA if filter isn't already an IsA */ + if (!filter.transitive || filter.pred.ent != EcsIsA) { + if (!var) { + ecs_rule_pair_t isa_pair = { + .pred.ent = EcsIsA, + .obj.ent = term->subj.entity + }; -bool flecs_iter_next_row( - ecs_iter_t *it) -{ - ecs_assert(it != NULL, ECS_INTERNAL_ERROR, NULL); + evar = subj = store_reflexive_set(rule, EcsRuleSuperSet, &isa_pair, + written, true, true); + tvar = NULL; + eval_subject_supersets = true; - bool is_instanced = it->is_instanced; - if (!is_instanced) { - int32_t instance_count = it->instance_count; - int32_t count = it->count; - int32_t offset = it->offset; + } else if (ecs_id_is_wildcard(term->id)) { + ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); - if (instance_count > count && offset < (instance_count - 1)) { - ecs_assert(count == 1, ECS_INTERNAL_ERROR, NULL); - int t, term_count = it->term_count; + op = insert_operation(rule, -1, written); - for (t = 0; t < term_count; t ++) { - int32_t column = it->columns[t]; - if (column >= 0) { - void *ptr = it->ptrs[t]; - if (ptr) { - it->ptrs[t] = ECS_OFFSET(ptr, it->sizes[t]); - } - } + if (!is_known(subj, written)) { + op->kind = EcsRuleSelect; + set_output_to_subj(rule, op, term, subj); + written[subj->id] = true; + } else { + op->kind = EcsRuleWith; + set_input_to_subj(rule, op, term, subj); } - if (it->entities) { - it->entities ++; + ecs_rule_pair_t isa_pair = { + .pred.ent = EcsIsA, + .obj.reg = subj->id, + .reg_mask = RULE_PAIR_OBJECT + }; + + op->filter = filter; + if (op->filter.reg_mask & RULE_PAIR_PREDICATE) { + op->filter.pred.ent = EcsWildcard; } - it->offset ++; + if (op->filter.reg_mask & RULE_PAIR_OBJECT) { + op->filter.obj.ent = EcsWildcard; + } + op->filter.reg_mask = 0; - return true; + push_frame(rule); + + tvar = subj = store_reflexive_set(rule, EcsRuleSuperSet, &isa_pair, + written, true, false); + + evar = NULL; } } - return false; -} + /* If no pair is provided, create operation from specified term */ + if (!pair) { + op = insert_operation(rule, c, written); -bool flecs_iter_next_instanced( - ecs_iter_t *it, - bool result) -{ - it->instance_count = it->count; - if (result && !it->is_instanced && it->count && it->has_shared) { - it->count = 1; + /* If an explicit pair is provided, override the default one from the + * term. This allows for using a predicate or object variable different + * from what is in the term. One application of this is to substitute a + * predicate with its subsets, if it is non final */ + } else { + op = insert_operation(rule, -1, written); + op->filter = *pair; + + /* Assign the term id, so that the operation will still be correctly + * associated with the correct expression term. */ + op->term = c; } - return result; -} -/* --- Public API --- */ + /* If entity variable is known and resolved, create with for it */ + if (evar && is_known(evar, written)) { + op->kind = EcsRuleWith; + op->r_in = evar->id; + set_input_to_subj(rule, op, term, subj); -void* ecs_term_w_size( - const ecs_iter_t *it, - size_t size, - int32_t term) -{ - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(!size || ecs_term_size(it, term) == size || - (!ecs_term_size(it, term) && (!it->ptrs || !it->ptrs[term - 1])), - ECS_INVALID_PARAMETER, NULL); + /* If table variable is known and resolved, create with for it */ + } else if (tvar && is_known(tvar, written)) { + op->kind = EcsRuleWith; + op->r_in = tvar->id; + set_input_to_subj(rule, op, term, subj); - (void)size; + /* If subject is neither table nor entitiy, with operates on literal */ + } else if (!tvar && !evar) { + op->kind = EcsRuleWith; + set_input_to_subj(rule, op, term, subj); - if (!term) { - return it->entities; + /* If subject is table or entity but not known, use select */ + } else { + ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); + op->kind = EcsRuleSelect; + set_output_to_subj(rule, op, term, subj); + written[subj->id] = true; } - if (!it->ptrs) { - return NULL; + /* If supersets of subject are being evaluated, and we're looking for a + * specific filter, stop as soon as the filter has been matched. */ + if (eval_subject_supersets && is_pair_known(rule, &op->filter, written)) { + op = insert_operation(rule, -1, written); + + /* When the next operation returns, it will first hit SetJmp with a redo + * which will switch the jump label to the previous operation */ + op->kind = EcsRuleSetJmp; + op->on_pass = rule->operation_count; + op->on_fail = lbl_start - 1; } - return it->ptrs[term - 1]; -error: - return NULL; + if (op->filter.reg_mask & RULE_PAIR_PREDICATE) { + written[op->filter.pred.reg] = true; + } + + if (op->filter.reg_mask & RULE_PAIR_OBJECT) { + written[op->filter.obj.reg] = true; + } } -bool ecs_term_is_readonly( - const ecs_iter_t *it, - int32_t term_index) +static +void prepare_predicate( + ecs_rule_t *rule, + ecs_rule_pair_t *pair, + int32_t term, + bool *written) { - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(term_index > 0, ECS_INVALID_PARAMETER, NULL); + /* If pair is not final, resolve term for all IsA relationships of the + * predicate. Note that if the pair has final set to true, it is guaranteed + * that the predicate can be used in an IsA query */ + if (!pair->final) { + ecs_rule_pair_t isa_pair = { + .pred.ent = EcsIsA, + .obj.ent = pair->pred.ent + }; - ecs_term_t *term = &it->terms[term_index - 1]; - ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); - - if (term->inout == EcsIn) { - return true; - } else { - ecs_term_id_t *subj = &term->subj; + ecs_rule_var_t *pred = store_reflexive_set(rule, EcsRuleSubSet, + &isa_pair, written, true, true); - if (term->inout == EcsInOutDefault) { - if (subj->entity != EcsThis) { - return true; - } + pair->pred.reg = pred->id; + pair->reg_mask |= RULE_PAIR_PREDICATE; - if (!(subj->set.mask & EcsSelf)) { - return true; - } + if (term != -1) { + rule->term_vars[term].pred = pred->id; } } - -error: - return false; } -bool ecs_term_is_writeonly( - const ecs_iter_t *it, - int32_t term_index) +static +void insert_term_2( + ecs_rule_t *rule, + ecs_term_t *term, + ecs_rule_pair_t *filter, + int32_t c, + bool *written) { - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(term_index > 0, ECS_INVALID_PARAMETER, NULL); + int32_t subj_id = -1, obj_id = -1; + ecs_rule_var_t *subj = term_subj(rule, term); + if ((subj = get_most_specific_var(rule, subj, written))) { + subj_id = subj->id; + } - ecs_term_t *term = &it->terms[term_index - 1]; - ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); - - if (term->inout == EcsOut) { - return true; + ecs_rule_var_t *obj = term_obj(rule, term); + if ((obj = get_most_specific_var(rule, obj, written))) { + obj_id = obj->id; } -error: - return false; -} + bool subj_known = is_known(subj, written); + bool same_obj_subj = false; + if (subj && obj) { + same_obj_subj = !ecs_os_strcmp(subj->name, obj->name); + } -int32_t ecs_iter_find_column( - const ecs_iter_t *it, - ecs_entity_t component) -{ - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); - return ecs_search(it->real_world, it->table, component, 0); -error: - return -1; -} + if (!filter->transitive) { + insert_select_or_with(rule, c, term, subj, filter, written); + if (subj) subj = &rule->vars[subj_id]; + if (obj) obj = &rule->vars[obj_id]; -bool ecs_term_is_set( - const ecs_iter_t *it, - int32_t index) -{ - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + } else if (filter->transitive) { + if (subj_known) { + if (is_known(obj, written)) { + if (filter->obj.ent != EcsWildcard) { + ecs_rule_var_t *obj_subsets = store_reflexive_set( + rule, EcsRuleSubSet, filter, written, true, true); - int32_t column = it->columns[index - 1]; - if (!column) { - return false; - } else if (column < 0) { - if (it->references) { - column = -column - 1; - ecs_ref_t *ref = &it->references[column]; - return ref->entity != 0; - } else { - return true; - } - } + if (subj) { + subj = &rule->vars[subj_id]; + } - return true; -error: - return false; -} + rule->term_vars[c].obj = obj_subsets->id; -void* ecs_iter_column_w_size( - const ecs_iter_t *it, - size_t size, - int32_t index) -{ - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); - (void)size; - - ecs_table_t *table = it->table; - int32_t storage_index = ecs_table_type_to_storage_index(table, index); - if (storage_index == -1) { - return NULL; - } + ecs_rule_pair_t pair = *filter; + pair.obj.reg = obj_subsets->id; + pair.reg_mask |= RULE_PAIR_OBJECT; - ecs_column_t *columns = table->storage.columns; - ecs_column_t *column = &columns[storage_index]; - ecs_check(!size || (ecs_size_t)size == column->size, - ECS_INVALID_PARAMETER, NULL); + insert_select_or_with(rule, c, term, subj, &pair, written); + } else { + insert_select_or_with(rule, c, term, subj, filter, written); + } + } else { + ecs_assert(obj != NULL, ECS_INTERNAL_ERROR, NULL); - void *ptr = ecs_vector_first_t( - column->data, column->size, column->alignment); + /* If subject is literal, find supersets for subject */ + if (subj == NULL || subj->kind == EcsRuleVarKindEntity) { + obj = to_entity(rule, obj); - return ECS_OFFSET(ptr, column->size * it->offset); -error: - return NULL; -} + ecs_rule_pair_t set_pair = *filter; + set_pair.reg_mask &= RULE_PAIR_PREDICATE; -size_t ecs_iter_column_size( - const ecs_iter_t *it, - int32_t index) -{ - ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_table_t *table = it->table; - int32_t storage_index = ecs_table_type_to_storage_index(table, index); - if (storage_index == -1) { - return 0; - } + if (subj) { + set_pair.obj.reg = subj->id; + set_pair.reg_mask |= RULE_PAIR_OBJECT; + } else { + set_pair.obj.ent = term->subj.entity; + } - ecs_column_t *columns = table->storage.columns; - ecs_column_t *column = &columns[storage_index]; - - return flecs_ito(size_t, column->size); -error: - return 0; -} + insert_reflexive_set(rule, EcsRuleSuperSet, obj, set_pair, + c, written, filter->reflexive); -char* ecs_iter_str( - const ecs_iter_t *it) -{ - ecs_world_t *world = it->world; - ecs_strbuf_t buf = ECS_STRBUF_INIT; - int i; + /* If subject is variable, first find matching pair for the + * evaluated entity(s) and return supersets */ + } else { + ecs_rule_var_t *av = create_anonymous_variable( + rule, EcsRuleVarKindEntity); - if (it->term_count) { - ecs_strbuf_list_push(&buf, "term: ", ","); - for (i = 0; i < it->term_count; i ++) { - ecs_id_t id = ecs_term_id(it, i + 1); - char *str = ecs_id_str(world, id); - ecs_strbuf_list_appendstr(&buf, str); - ecs_os_free(str); - } - ecs_strbuf_list_pop(&buf, "\n"); + subj = &rule->vars[subj_id]; + obj = &rule->vars[obj_id]; + obj = to_entity(rule, obj); - ecs_strbuf_list_push(&buf, "subj: ", ","); - for (i = 0; i < it->term_count; i ++) { - ecs_entity_t subj = ecs_term_source(it, i + 1); - char *str = ecs_get_fullpath(world, subj); - ecs_strbuf_list_appendstr(&buf, str); - ecs_os_free(str); - } - ecs_strbuf_list_pop(&buf, "\n"); - } + ecs_rule_pair_t set_pair = *filter; + set_pair.obj.reg = av->id; + set_pair.reg_mask |= RULE_PAIR_OBJECT; - if (it->variable_count) { - int32_t actual_count = 0; - for (i = 0; i < it->variable_count; i ++) { - const char *var_name = it->variable_names[i]; - if (!var_name || var_name[0] == '_' || var_name[0] == '.') { - /* Skip anonymous variables */ - continue; - } + /* Insert with to find initial object for relation */ + insert_select_or_with( + rule, c, term, subj, &set_pair, written); - ecs_entity_t var = it->variables[i]; - if (!var) { - /* Skip table variables */ - continue; - } + push_frame(rule); - if (!actual_count) { - ecs_strbuf_list_push(&buf, "vars: ", ","); + /* Find supersets for returned initial object. Make sure + * this is always reflexive since it needs to return the + * object from the pair that the entity has itself. */ + insert_reflexive_set(rule, EcsRuleSuperSet, obj, set_pair, + c, written, true); + } } - char *str = ecs_get_fullpath(world, var); - ecs_strbuf_list_append(&buf, "%s=%s", var_name, str); - ecs_os_free(str); + /* subj is not known */ + } else { + ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); - actual_count ++; - } - if (actual_count) { - ecs_strbuf_list_pop(&buf, "\n"); - } - } + if (is_known(obj, written)) { + ecs_rule_pair_t set_pair = *filter; + set_pair.reg_mask &= RULE_PAIR_PREDICATE; /* clear object mask */ - if (it->count) { - ecs_strbuf_appendstr(&buf, "this:\n"); - for (i = 0; i < it->count; i ++) { - ecs_entity_t e = it->entities[i]; - char *str = ecs_get_fullpath(world, e); - ecs_strbuf_appendstr(&buf, " - "); - ecs_strbuf_appendstr(&buf, str); - ecs_strbuf_appendstr(&buf, "\n"); - ecs_os_free(str); - } - } + if (obj) { + set_pair.obj.reg = obj->id; + set_pair.reg_mask |= RULE_PAIR_OBJECT; + } else { + set_pair.obj.ent = term->obj.entity; + } - return ecs_strbuf_get(&buf); -} + if (obj) { + rule->term_vars[c].obj = obj->id; + } else { + ecs_rule_var_t *av = create_anonymous_variable(rule, + EcsRuleVarKindEntity); + rule->term_vars[c].obj = av->id; + written[av->id] = true; + } -void ecs_iter_poly( - const ecs_world_t *world, - const ecs_poly_t *poly, - ecs_iter_t *iter_out, - ecs_term_t *filter) -{ - ecs_iterable_t *iterable = ecs_get_iterable(poly); - iterable->init(world, poly, iter_out, filter); -} + insert_reflexive_set(rule, EcsRuleSubSet, subj, set_pair, c, + written, filter->reflexive); + } else if (subj == obj) { + insert_select_or_with(rule, c, term, subj, filter, written); + } else { + ecs_assert(obj != NULL, ECS_INTERNAL_ERROR, NULL); -bool ecs_iter_next( - ecs_iter_t *iter) -{ - ecs_check(iter != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(iter->next != NULL, ECS_INVALID_PARAMETER, NULL); - return iter->next(iter); -error: - return false; -} + ecs_rule_var_t *av = NULL; + if (!filter->reflexive) { + av = create_anonymous_variable(rule, EcsRuleVarKindEntity); + } -bool ecs_iter_count( - ecs_iter_t *it) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - int32_t count = 0; - while (ecs_iter_next(it)) { - count += it->count; - } - return count; -error: - return 0; -} + subj = &rule->vars[subj_id]; + obj = &rule->vars[obj_id]; + obj = to_entity(rule, obj); -bool ecs_iter_is_true( - ecs_iter_t *it) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - bool result = ecs_iter_next(it); - if (result) { - ecs_iter_fini(it); - } - return result; -error: - return false; -} + /* Insert instruction to find all subjects and objects */ + ecs_rule_op_t *op = insert_operation(rule, -1, written); + op->kind = EcsRuleSelect; + set_output_to_subj(rule, op, term, subj); + op->filter.pred = filter->pred; -ecs_entity_t ecs_iter_get_var( - ecs_iter_t *it, - int32_t var_id) -{ - ecs_check(var_id < it->variable_count, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->variables != NULL, ECS_INVALID_PARAMETER, NULL); - return it->variables[var_id]; -error: - return 0; -} + if (filter->reflexive) { + op->filter.obj.ent = EcsWildcard; + op->filter.reg_mask = filter->reg_mask & RULE_PAIR_PREDICATE; + } else { + op->filter.obj.reg = av->id; + op->filter.reg_mask = filter->reg_mask | RULE_PAIR_OBJECT; + written[av->id] = true; + } -ecs_iter_t ecs_page_iter( - const ecs_iter_t *it, - int32_t offset, - int32_t limit) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next != NULL, ECS_INVALID_PARAMETER, NULL); + written[subj->id] = true; - ecs_iter_t result = *it; - result.priv.iter.page = (ecs_page_iter_t){ - .offset = offset, - .limit = limit, - .remaining = limit - }; - result.next = ecs_page_next; - result.chain_it = (ecs_iter_t*)it; + /* Create new frame for operations that create reflexive set */ + push_frame(rule); - return result; -error: - return (ecs_iter_t){ 0 }; -} + /* Insert superset instruction to find all supersets */ + if (filter->reflexive) { + subj = ensure_most_specific_var(rule, subj, written); + ecs_assert(subj->kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(written[subj->id] == true, + ECS_INTERNAL_ERROR, NULL); -static -void offset_iter( - ecs_iter_t *it, - int32_t offset) -{ - it->entities = &it->entities[offset]; + ecs_rule_pair_t super_filter = {0}; + super_filter.pred = filter->pred; + super_filter.obj.reg = subj->id; + super_filter.reg_mask = filter->reg_mask | RULE_PAIR_OBJECT; - int32_t t, term_count = it->term_count; - for (t = 0; t < term_count; t ++) { - void *ptrs = it->ptrs[t]; - if (!ptrs) { - continue; + insert_reflexive_set(rule, EcsRuleSuperSet, obj, + super_filter, c, written, true); + } else { + insert_reflexive_set(rule, EcsRuleSuperSet, obj, + op->filter, c, written, true); + } + } } + } - if (it->subjects[t]) { - continue; - } + if (same_obj_subj) { + /* Can't have relation with same variables that is acyclic and not + * reflexive, this should've been caught earlier. */ + ecs_assert(!filter->acyclic || filter->reflexive, + ECS_INTERNAL_ERROR, NULL); - it->ptrs[t] = ECS_OFFSET(ptrs, offset * it->sizes[t]); + /* If relation is reflexive and entity has an instance of R, no checks + * are needed because R(X, X) is always true. */ + if (!filter->reflexive) { + push_frame(rule); + + /* Insert check if the (R, X) pair that was found matches with one + * of the entities in the table with the pair. */ + ecs_rule_op_t *op = insert_operation(rule, -1, written); + obj = get_most_specific_var(rule, obj, written); + ecs_assert(obj->kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(written[subj->id] == true, ECS_INTERNAL_ERROR, NULL); + ecs_assert(written[obj->id] == true, ECS_INTERNAL_ERROR, NULL); + + set_input_to_subj(rule, op, term, subj); + op->filter.obj.reg = obj->id; + op->filter.reg_mask = RULE_PAIR_OBJECT; + + if (subj->kind == EcsRuleVarKindTable) { + op->kind = EcsRuleInTable; + } else { + op->kind = EcsRuleEq; + } + } } } static -bool ecs_page_next_instanced( - ecs_iter_t *it) +void insert_term_1( + ecs_rule_t *rule, + ecs_term_t *term, + ecs_rule_pair_t *filter, + int32_t c, + bool *written) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_page_next, ECS_INVALID_PARAMETER, NULL); - - ecs_iter_t *chain_it = it->chain_it; - bool instanced = it->is_instanced; + ecs_rule_var_t *subj = term_subj(rule, term); + subj = get_most_specific_var(rule, subj, written); + insert_select_or_with(rule, c, term, subj, filter, written); +} - do { - if (!ecs_iter_next(chain_it)) { - goto done; - } +static +void insert_term( + ecs_rule_t *rule, + ecs_term_t *term, + int32_t c, + bool *written) +{ + bool obj_set = obj_is_set(term); - ecs_page_iter_t *iter = &it->priv.iter.page; - - /* Copy everything up to the private iterator data */ - ecs_os_memcpy(it, chain_it, offsetof(ecs_iter_t, priv)); - it->is_instanced = instanced; + ensure_most_specific_var(rule, term_pred(rule, term), written); + if (obj_set) { + ensure_most_specific_var(rule, term_obj(rule, term), written); + } - if (!chain_it->table) { - goto yield; /* Task query */ - } + /* If term has Not operator, prepend Not which turns a fail into a pass */ + int32_t prev = rule->operation_count; + ecs_rule_op_t *not_pre; + if (term->oper == EcsNot) { + not_pre = insert_operation(rule, -1, written); + not_pre->kind = EcsRuleNot; + not_pre->has_in = false; + not_pre->has_out = false; + } - int32_t offset = iter->offset; - int32_t limit = iter->limit; - if (!(offset || limit)) { - if (it->count) { - goto yield; - } else { - goto done; - } - } + ecs_rule_pair_t filter = term_to_pair(rule, term); + prepare_predicate(rule, &filter, c, written); - int32_t count = it->count; - int32_t remaining = iter->remaining; - - if (offset) { - if (offset > count) { - /* No entities to iterate in current table */ - iter->offset -= count; - it->count = 0; - continue; - } else { - it->offset += offset; - count = it->count -= offset; - iter->offset = 0; - offset_iter(it, offset); - } - } - - if (remaining) { - if (remaining > count) { - iter->remaining -= count; - } else { - it->count = remaining; - iter->remaining = 0; - } - } else if (limit) { - /* Limit hit: no more entities left to iterate */ - goto done; - } - } while (it->count == 0); - -yield: - if (!it->is_instanced) { - it->offset = 0; + if (subj_is_set(term) && !obj_set) { + insert_term_1(rule, term, &filter, c, written); + } else if (obj_set) { + insert_term_2(rule, term, &filter, c, written); } - return true; -done: -error: - return false; -} - -bool ecs_page_next( - ecs_iter_t *it) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_page_next, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); - - it->chain_it->is_instanced = true; + /* If term has Not operator, append Not which turns a pass into a fail */ + if (term->oper == EcsNot) { + ecs_rule_op_t *not_post = insert_operation(rule, -1, written); + not_post->kind = EcsRuleNot; + not_post->has_in = false; + not_post->has_out = false; - if (flecs_iter_next_row(it)) { - return true; + not_post->on_pass = prev - 1; + not_post->on_fail = prev - 1; + not_pre = &rule->operations[prev]; + not_pre->on_fail = rule->operation_count; } - return flecs_iter_next_instanced(it, ecs_page_next_instanced(it)); -error: - return false; -} + if (term->oper == EcsOptional) { + /* Insert Not instruction that ensures that the optional term is only + * executed once */ + ecs_rule_op_t *jump = insert_operation(rule, -1, written); + jump->kind = EcsRuleNot; + jump->has_in = false; + jump->has_out = false; + jump->on_pass = rule->operation_count; + jump->on_fail = prev - 1; -ecs_iter_t ecs_worker_iter( - const ecs_iter_t *it, - int32_t index, - int32_t count) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(count > 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(index >= 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(index < count, ECS_INVALID_PARAMETER, NULL); + /* Find exit instruction for optional term, and make the fail label + * point to the Not operation, so that even when the operation fails, + * it won't discard the result */ + int i, min_fail = -1, exit_op = -1; + for (i = prev; i < rule->operation_count; i ++) { + ecs_rule_op_t *op = &rule->operations[i]; + if (min_fail == -1 || (op->on_fail >= 0 && op->on_fail < min_fail)){ + min_fail = op->on_fail; + exit_op = i; + } + } - return (ecs_iter_t){ - .real_world = it->real_world, - .world = it->world, - .priv.iter.worker = { - .index = index, - .count = count - }, - .next = ecs_worker_next, - .chain_it = (ecs_iter_t*)it, - .is_instanced = it->is_instanced - }; + ecs_assert(exit_op != -1, ECS_INTERNAL_ERROR, NULL); + ecs_rule_op_t *op = &rule->operations[exit_op]; + op->on_fail = rule->operation_count - 1; + } -error: - return (ecs_iter_t){ 0 }; + push_frame(rule); } +/* Create program from operations that will execute the query */ static -bool ecs_worker_next_instanced( - ecs_iter_t *it) +void compile_program( + ecs_rule_t *rule) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_worker_next, ECS_INVALID_PARAMETER, NULL); + /* Trace which variables have been written while inserting instructions. + * This determines which instruction needs to be inserted */ + bool written[ECS_RULE_MAX_VAR_COUNT] = { false }; - bool instanced = it->is_instanced; + ecs_term_t *terms = rule->filter.terms; + int32_t v, c, term_count = rule->filter.term_count; + ecs_rule_op_t *op; - ecs_iter_t *chain_it = it->chain_it; - ecs_worker_iter_t *iter = &it->priv.iter.worker; - int32_t res_count = iter->count, res_index = iter->index; - int32_t per_worker, instances_per_worker, first; + /* Insert input, which is always the first instruction */ + insert_input(rule); - do { - if (!ecs_iter_next(chain_it)) { - return false; + /* First insert all instructions that do not have a variable subject. Such + * instructions iterate the type of an entity literal and are usually good + * candidates for quickly narrowing down the set of potential results. */ + for (c = 0; c < term_count; c ++) { + ecs_term_t *term = &terms[c]; + if (skip_term(term)) { + continue; } - /* Copy everything up to the private iterator data */ - ecs_os_memcpy(it, chain_it, offsetof(ecs_iter_t, priv)); - it->is_instanced = instanced; - - int32_t count = it->count; - int32_t instance_count = it->instance_count; - per_worker = count / res_count; - instances_per_worker = instance_count / res_count; - first = per_worker * res_index; - count -= per_worker * res_count; - - if (count) { - if (res_index < count) { - per_worker ++; - first += res_index; - } else { - first += count; - } + if (term->oper == EcsOptional) { + continue; } - if (!per_worker && it->table == NULL) { - if (res_index == 0) { - return true; - } else { - return false; - } + ecs_rule_var_t* subj = term_subj(rule, term); + if (subj) { + continue; } - } while (!per_worker); - it->instance_count = instances_per_worker; - it->frame_offset += first; + insert_term(rule, term, c, written); + } - offset_iter(it, it->offset + first); - it->count = per_worker; + /* Insert variables based on dependency order */ + for (v = 0; v < rule->subj_var_count; v ++) { + ecs_rule_var_t *var = &rule->vars[v]; - if (it->is_instanced) { - it->offset += first; - } else { - it->offset = 0; - } + ecs_assert(var->kind == EcsRuleVarKindTable, ECS_INTERNAL_ERROR, NULL); - return true; -error: - return false; -} + for (c = 0; c < term_count; c ++) { + ecs_term_t *term = &terms[c]; + if (skip_term(term)) { + continue; + } -bool ecs_worker_next( - ecs_iter_t *it) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_worker_next, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); + if (term->oper == EcsOptional) { + continue; + } - it->chain_it->is_instanced = true; + /* Only process columns for which variable is subject */ + ecs_rule_var_t* subj = term_subj(rule, term); + if (subj != var) { + continue; + } - if (flecs_iter_next_row(it)) { - return true; + insert_term(rule, term, c, written); + + var = &rule->vars[v]; + } } - return flecs_iter_next_instanced(it, ecs_worker_next_instanced(it)); -error: - return false; -} + /* Insert terms with Not operators */ + for (c = 0; c < term_count; c ++) { + ecs_term_t *term = &terms[c]; + if (term->oper != EcsNot) { + continue; + } + insert_term(rule, term, c, written); + } -/* -- Component lifecycle -- */ + /* Insert terms with Optional operators last, as optional terms cannot + * eliminate results, and would just add overhead to evaluation of + * non-matching entities. */ + for (c = 0; c < term_count; c ++) { + ecs_term_t *term = &terms[c]; + if (term->oper != EcsOptional) { + continue; + } + + insert_term(rule, term, c, written); + } -/* Component lifecycle actions for EcsIdentifier */ -static ECS_CTOR(EcsIdentifier, ptr, { - ptr->value = NULL; - ptr->hash = 0; - ptr->length = 0; - ptr->index_hash = 0; - ptr->index = NULL; -}) + /* Verify all subject variables have been written. Subject variables are of + * the table type, and a select/subset should have been inserted for each */ + for (v = 0; v < rule->subj_var_count; v ++) { + if (!written[v]) { + /* If the table variable hasn't been written, this can only happen + * if an instruction wrote the variable before a select/subset could + * have been inserted for it. Make sure that this is the case by + * testing if an entity variable exists and whether it has been + * written. */ + ecs_rule_var_t *var = find_variable( + rule, EcsRuleVarKindEntity, rule->vars[v].name); + ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(written[var->id], ECS_INTERNAL_ERROR, var->name); + (void)var; + } + } -static ECS_DTOR(EcsIdentifier, ptr, { - ecs_os_strset(&ptr->value, NULL); -}) + /* Make sure that all entity variables are written. With the exception of + * the this variable, which can be returned as a table, other variables need + * to be available as entities. This ensures that all permutations for all + * variables are correctly returned by the iterator. When an entity variable + * hasn't been written yet at this point, it is because it only constrained + * through a common predicate or object. */ + for (; v < rule->var_count; v ++) { + if (!written[v]) { + ecs_rule_var_t *var = &rule->vars[v]; + ecs_assert(var->kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); -static ECS_COPY(EcsIdentifier, dst, src, { - ecs_os_strset(&dst->value, src->value); - dst->hash = src->hash; - dst->length = src->length; - dst->index_hash = src->index_hash; - dst->index = src->index; -}) + ecs_rule_var_t *table_var = find_variable( + rule, EcsRuleVarKindTable, var->name); + + /* A table variable must exist if the variable hasn't been resolved + * yet. If there doesn't exist one, this could indicate an + * unconstrained variable which should have been caught earlier */ + ecs_assert(table_var != NULL, ECS_INTERNAL_ERROR, var->name); -static ECS_MOVE(EcsIdentifier, dst, src, { - ecs_os_strset(&dst->value, NULL); - dst->value = src->value; - dst->hash = src->hash; - dst->length = src->length; - dst->index_hash = src->index_hash; - dst->index = src->index; + /* Insert each operation that takes the table variable as input, and + * yields each entity in the table */ + op = insert_operation(rule, -1, written); + op->kind = EcsRuleEach; + op->r_in = table_var->id; + op->r_out = var->id; + op->frame = rule->frame_count; + op->has_in = true; + op->has_out = true; + written[var->id] = true; + + push_frame(rule); + } + } - src->value = NULL; - src->hash = 0; - src->index_hash = 0; - src->index = 0; - src->length = 0; -}) + /* Insert yield, which is always the last operation */ + insert_yield(rule); +} static -void ecs_on_set(EcsIdentifier)(ecs_iter_t *it) { - EcsIdentifier *ptr = ecs_term(it, EcsIdentifier, 1); - - ecs_world_t *world = it->real_world; - ecs_entity_t evt = it->event; - ecs_id_t evt_id = it->event_id; - ecs_entity_t kind = ECS_PAIR_SECOND(evt_id); /* Name, Symbol, Alias */ - - ecs_id_t pair = ecs_childof(0); - - ecs_hashmap_t *name_index = NULL; - if (kind == EcsSymbol) { - name_index = &world->symbols; - } else if (kind == EcsAlias) { - name_index = &world->aliases; - } else if (kind == EcsName) { - ecs_assert(it->table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_search(world, it->table, ecs_childof(EcsWildcard), &pair); - ecs_assert(pair != 0, ECS_INTERNAL_ERROR, NULL); +void create_variable_name_array( + ecs_rule_t *rule) +{ + if (rule->var_count) { + int i; + for (i = 0; i < rule->var_count; i ++) { + ecs_rule_var_t *var = &rule->vars[i]; - if (evt == EcsOnSet) { - name_index = flecs_ensure_id_name_index(world, pair); - } else { - name_index = flecs_get_id_name_index(world, pair); + if (var->kind != EcsRuleVarKindEntity) { + /* Table variables are hidden for applications. */ + rule->var_names[var->id] = NULL; + } else { + rule->var_names[var->id] = var->name; + } } } +} - for (int i = 0; i < it->count; i ++) { - EcsIdentifier *cur = &ptr[i]; - uint64_t hash; - ecs_size_t len; - const char *name = cur->value; - - if (cur->index && cur->index != name_index) { - /* If index doesn't match up, the value must have been copied from - * another entity, so reset index & cached index hash */ - cur->index = NULL; - cur->index_hash = 0; +static +void create_variable_cross_references( + ecs_rule_t *rule) +{ + if (rule->var_count) { + int i; + for (i = 0; i < rule->var_count; i ++) { + ecs_rule_var_t *var = &rule->vars[i]; + if (var->kind == EcsRuleVarKindEntity) { + ecs_rule_var_t *tvar = find_variable( + rule, EcsRuleVarKindTable, var->name); + if (tvar) { + var->other = tvar->id; + } else { + var->other = -1; + } + } else { + ecs_rule_var_t *evar = find_variable( + rule, EcsRuleVarKindEntity, var->name); + if (evar) { + var->other = evar->id; + } else { + var->other = -1; + } + } } + } +} - if (cur->value && (evt == EcsOnSet)) { - len = cur->length = ecs_os_strlen(name); - hash = cur->hash = flecs_hash(name, len); - } else { - len = cur->length = 0; - hash = cur->hash = 0; - cur->index = NULL; - } +/* Implementation for iterable mixin */ +static +void rule_iter_init( + const ecs_world_t *world, + const ecs_poly_t *poly, + ecs_iter_t *iter, + ecs_term_t *filter) +{ + ecs_poly_assert(poly, ecs_rule_t); - if (name_index) { - uint64_t index_hash = cur->index_hash; - ecs_entity_t e = it->entities[i]; + if (filter) { + iter[1] = ecs_rule_iter(world, (ecs_rule_t*)poly); + iter[0] = ecs_term_chain_iter(&iter[1], filter); + } else { + iter[0] = ecs_rule_iter(world, (ecs_rule_t*)poly); + } +} - if (hash != index_hash) { - if (index_hash) { - flecs_name_index_remove(name_index, e, index_hash); - } - if (hash) { - flecs_name_index_ensure(name_index, e, name, len, hash); - cur->index_hash = hash; - cur->index = name_index; +static +int32_t find_term_var_id( + ecs_rule_t *rule, + ecs_term_id_t *term_id) +{ + if (term_id_is_variable(term_id)) { + const char *var_name = term_id_var_name(term_id); + ecs_rule_var_t *var = find_variable( + rule, EcsRuleVarKindEntity, var_name); + if (var) { + return var->id; + } else { + /* If this is Any look for table variable. Since Any is only + * required to return a single result, there is no need to + * insert an each instruction for a matching table. */ + if (term_id->entity == EcsAny) { + var = find_variable( + rule, EcsRuleVarKindTable, var_name); + if (var) { + return var->id; } - } else { - /* Name didn't change, but the string could have been - * reallocated. Make sure name index points to correct string */ - flecs_name_index_update_name(name_index, e, hash, name); } } } + + return -1; } -/* Component lifecycle actions for EcsTrigger */ -static ECS_CTOR(EcsTrigger, ptr, { - ptr->trigger = NULL; -}) +ecs_rule_t* ecs_rule_init( + ecs_world_t *world, + const ecs_filter_desc_t *desc) +{ + ecs_rule_t *result = ecs_poly_new(ecs_rule_t); -static ECS_DTOR(EcsTrigger, ptr, { - if (ptr->trigger) { - flecs_trigger_fini(world, (ecs_trigger_t*)ptr->trigger); + /* Parse the signature expression. This initializes the columns array which + * contains the information about which components/pairs are requested. */ + if (ecs_filter_init(world, &result->filter, desc)) { + goto error; } -}) -static ECS_COPY(EcsTrigger, dst, src, { - ecs_abort(ECS_INVALID_OPERATION, "Trigger component cannot be copied"); -}) + result->world = world; -static ECS_MOVE(EcsTrigger, dst, src, { - if (dst->trigger) { - flecs_trigger_fini(world, (ecs_trigger_t*)dst->trigger); + /* Rule has no terms */ + if (!result->filter.term_count) { + rule_error(result, "rule has no terms"); + goto error; } - dst->trigger = src->trigger; - src->trigger = NULL; -}) -/* Component lifecycle actions for EcsObserver */ -static ECS_CTOR(EcsObserver, ptr, { - ptr->observer = NULL; -}) + ecs_term_t *terms = result->filter.terms; + int32_t i, term_count = result->filter.term_count; -static ECS_DTOR(EcsObserver, ptr, { - if (ptr->observer) { - flecs_observer_fini(world, (ecs_observer_t*)ptr->observer); + /* Make sure rule doesn't just have Not terms */ + for (i = 0; i < term_count; i++) { + ecs_term_t *term = &terms[i]; + if (term->oper != EcsNot) { + break; + } + } + if (i == term_count) { + rule_error(result, "rule cannot only have terms with Not operator"); + goto error; } -}) -static ECS_COPY(EcsObserver, dst, src, { - ecs_abort(ECS_INVALID_OPERATION, "Observer component cannot be copied"); -}) + /* Find all variables & resolve dependencies */ + if (scan_variables(result) != 0) { + goto error; + } -static ECS_MOVE(EcsObserver, dst, src, { - if (dst->observer) { - flecs_observer_fini(world, (ecs_observer_t*)dst->observer); + /* Create lookup array for subject variables */ + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_rule_term_vars_t *vars = &result->term_vars[i]; + vars->pred = find_term_var_id(result, &term->pred); + vars->subj = find_term_var_id(result, &term->subj); + vars->obj = find_term_var_id(result, &term->obj); } - dst->observer = src->observer; - src->observer = NULL; -}) + /* Generate the opcode array */ + compile_program(result); -/* -- Builtin triggers -- */ + /* Create array with variable names so this can be easily accessed by + * iterators without requiring access to the ecs_rule_t */ + create_variable_name_array(result); -static -void assert_relation_unused( - ecs_world_t *world, - ecs_entity_t rel, - ecs_entity_t property) -{ - if (flecs_get_id_record(world, ecs_pair(rel, EcsWildcard)) != NULL) { - char *r_str = ecs_get_fullpath(world, rel); - char *p_str = ecs_get_fullpath(world, property); + /* Create cross-references between variables so it's easy to go from entity + * to table variable and vice versa */ + create_variable_cross_references(result); - ecs_throw(ECS_ID_IN_USE, - "cannot add property '%s' to relation '%s': already in use", - p_str, r_str); - - ecs_os_free(r_str); - ecs_os_free(p_str); - } + result->iterable.init = rule_iter_init; + return result; error: - return; + ecs_rule_fini(result); + return NULL; } -static -void register_final(ecs_iter_t *it) { - ecs_world_t *world = it->world; - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - if (flecs_get_id_record(world, ecs_pair(EcsIsA, e)) != NULL) { - char *e_str = ecs_get_fullpath(world, e); - ecs_throw(ECS_ID_IN_USE, - "cannot add property 'Final' to '%s': already inherited from", - e_str); - ecs_os_free(e_str); - error: - continue; - } +void ecs_rule_fini( + ecs_rule_t *rule) +{ + int32_t i; + for (i = 0; i < rule->var_count; i ++) { + ecs_os_free(rule->vars[i].name); } -} -static -void register_on_delete(ecs_iter_t *it) { - ecs_world_t *world = it->world; - ecs_id_t id = ecs_term_id(it, 1); - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - assert_relation_unused(world, e, EcsOnDelete); + ecs_filter_fini(&rule->filter); - ecs_id_record_t *r = flecs_ensure_id_record(world, e); - ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); - r->flags |= ECS_ID_ON_DELETE_FLAG(ECS_PAIR_SECOND(id)); + ecs_os_free(rule->operations); + ecs_os_free(rule); +} - flecs_add_flag(world, e, ECS_FLAG_OBSERVED_ID); - } +const ecs_filter_t* ecs_rule_get_filter( + const ecs_rule_t *rule) +{ + return &rule->filter; } +/* Quick convenience function to get a variable from an id */ static -void register_on_delete_object(ecs_iter_t *it) { - ecs_world_t *world = it->world; - ecs_id_t id = ecs_term_id(it, 1); - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - assert_relation_unused(world, e, EcsOnDeleteObject); - - ecs_id_record_t *r = flecs_ensure_id_record(world, e); - ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); - r->flags |= ECS_ID_ON_DELETE_OBJECT_FLAG(ECS_PAIR_SECOND(id)); +ecs_rule_var_t* get_variable( + const ecs_rule_t *rule, + int32_t var_id) +{ + if (var_id == UINT8_MAX) { + return NULL; + } - flecs_add_flag(world, e, ECS_FLAG_OBSERVED_ID); - } + return (ecs_rule_var_t*)&rule->vars[var_id]; } -static -void register_exclusive(ecs_iter_t *it) { - ecs_world_t *world = it->world; +/* Convert the program to a string. This can be useful to analyze how a rule is + * being evaluated. */ +char* ecs_rule_str( + ecs_rule_t *rule) +{ + ecs_check(rule != NULL, ECS_INVALID_PARAMETER, NULL); - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - assert_relation_unused(world, e, EcsExclusive); + ecs_world_t *world = rule->world; + ecs_strbuf_t buf = ECS_STRBUF_INIT; + char filter_expr[256]; - ecs_id_record_t *r = flecs_ensure_id_record(world, e); - r->flags |= ECS_ID_EXCLUSIVE; - } -} + int32_t i, count = rule->operation_count; + for (i = 1; i < count; i ++) { + ecs_rule_op_t *op = &rule->operations[i]; + ecs_rule_pair_t pair = op->filter; + ecs_entity_t pred = pair.pred.ent; + ecs_entity_t obj = pair.obj.ent; + const char *pred_name = NULL, *obj_name = NULL; + char *pred_name_alloc = NULL, *obj_name_alloc = NULL; -static -void register_dont_inherit(ecs_iter_t *it) { - ecs_world_t *world = it->world; - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - assert_relation_unused(world, e, EcsDontInherit); + if (pair.reg_mask & RULE_PAIR_PREDICATE) { + ecs_assert(rule->vars != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_rule_var_t *type_var = &rule->vars[pair.pred.reg]; + pred_name = type_var->name; + } else if (pred) { + pred_name_alloc = ecs_get_fullpath(world, ecs_get_alive(world, pred)); + pred_name = pred_name_alloc; + } - ecs_id_record_t *r = flecs_ensure_id_record(world, e); - r->flags |= ECS_ID_DONT_INHERIT; - } -} + if (pair.reg_mask & RULE_PAIR_OBJECT) { + ecs_assert(rule->vars != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_rule_var_t *obj_var = &rule->vars[pair.obj.reg]; + obj_name = obj_var->name; + } else if (obj) { + obj_name_alloc = ecs_get_fullpath(world, ecs_get_alive(world, obj)); + obj_name = obj_name_alloc; + } else if (pair.obj_0) { + obj_name = "0"; + } -static -void on_symmetric_add_remove(ecs_iter_t *it) { - ecs_entity_t pair = ecs_term_id(it, 1); + ecs_strbuf_append(&buf, "%2d: [S:%2d, P:%2d, F:%2d, T:%2d] ", i, + op->frame, op->on_pass, op->on_fail, op->term); - if (!ECS_HAS_ROLE(pair, PAIR)) { - /* If relationship was not added as a pair, there's nothing to do */ - return; - } + bool has_filter = false; - ecs_entity_t rel = ECS_PAIR_FIRST(pair); - ecs_entity_t obj = ECS_PAIR_SECOND(pair); - ecs_entity_t event = it->event; - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t subj = it->entities[i]; - if (event == EcsOnAdd) { - if (!ecs_has_id(it->real_world, obj, ecs_pair(rel, subj))) { - ecs_add_pair(it->world, obj, rel, subj); + switch(op->kind) { + case EcsRuleSelect: + ecs_strbuf_append(&buf, "select "); + has_filter = true; + break; + case EcsRuleWith: + ecs_strbuf_append(&buf, "with "); + has_filter = true; + break; + case EcsRuleStore: + ecs_strbuf_append(&buf, "store "); + break; + case EcsRuleSuperSet: + ecs_strbuf_append(&buf, "superset "); + has_filter = true; + break; + case EcsRuleSubSet: + ecs_strbuf_append(&buf, "subset "); + has_filter = true; + break; + case EcsRuleEach: + ecs_strbuf_append(&buf, "each "); + break; + case EcsRuleSetJmp: + ecs_strbuf_append(&buf, "setjmp "); + break; + case EcsRuleJump: + ecs_strbuf_append(&buf, "jump "); + break; + case EcsRuleNot: + ecs_strbuf_append(&buf, "not "); + break; + case EcsRuleInTable: + ecs_strbuf_append(&buf, "intable "); + has_filter = true; + break; + case EcsRuleEq: + ecs_strbuf_append(&buf, "eq "); + has_filter = true; + break; + case EcsRuleYield: + ecs_strbuf_append(&buf, "yield "); + break; + default: + continue; + } + + if (op->has_out) { + ecs_rule_var_t *r_out = get_variable(rule, op->r_out); + if (r_out) { + ecs_strbuf_append(&buf, "O:%s%s ", + r_out->kind == EcsRuleVarKindTable ? "t" : "", + r_out->name); + } else if (op->subject) { + char *subj_path = ecs_get_fullpath(world, op->subject); + ecs_strbuf_append(&buf, "O:%s ", subj_path); + ecs_os_free(subj_path); } - } else { - if (ecs_has_id(it->real_world, obj, ecs_pair(rel, subj))) { - ecs_remove_pair(it->world, obj, rel, subj); + } + + if (op->has_in) { + ecs_rule_var_t *r_in = get_variable(rule, op->r_in); + if (r_in) { + ecs_strbuf_append(&buf, "I:%s%s ", + r_in->kind == EcsRuleVarKindTable ? "t" : "", + r_in->name); + } + if (op->subject) { + char *subj_path = ecs_get_fullpath(world, op->subject); + ecs_strbuf_append(&buf, "I:%s ", subj_path); + ecs_os_free(subj_path); } } - } -} -static -void register_symmetric(ecs_iter_t *it) { - ecs_world_t *world = it->real_world; + if (has_filter) { + if (!pred_name) { + pred_name = "-"; + } + if (!obj_name && !pair.obj_0) { + ecs_os_sprintf(filter_expr, "(%s)", pred_name); + } else { + ecs_os_sprintf(filter_expr, "(%s, %s)", pred_name, obj_name); + } + ecs_strbuf_append(&buf, "F:%s", filter_expr); + } - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t r = it->entities[i]; - assert_relation_unused(world, r, EcsSymmetric); + ecs_strbuf_appendstr(&buf, "\n"); - /* Create trigger that adds the reverse relationship when R(X, Y) is - * added, or remove the reverse relationship when R(X, Y) is removed. */ - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_pair(r, EcsWildcard), - .callback = on_symmetric_add_remove, - .events = {EcsOnAdd, EcsOnRemove} - }); - } + ecs_os_free(pred_name_alloc); + ecs_os_free(obj_name_alloc); + } + + return ecs_strbuf_get(&buf); +error: + return NULL; } -static -void on_set_component(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsComponent *c = ecs_term(it, EcsComponent, 1); +/* Public function that returns number of variables. This enables an application + * to iterate the variables and obtain their values. */ +int32_t ecs_rule_var_count( + const ecs_rule_t *rule) +{ + ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); + return rule->var_count; +} - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_type_info_t *ti = flecs_ensure_type_info(world, e); - ti->size = c[i].size; - ti->alignment = c[i].alignment; +/* Public function to find a variable by name */ +int32_t ecs_rule_find_var( + const ecs_rule_t *rule, + const char *name) +{ + ecs_rule_var_t *v = find_variable(rule, EcsRuleVarKindEntity, name); + if (v) { + return v->id; + } else { + return -1; } } -static -void on_set_component_lifecycle(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsComponentLifecycle *cl = ecs_term(it, EcsComponentLifecycle, 1); +/* Public function to get the name of a variable. */ +const char* ecs_rule_var_name( + const ecs_rule_t *rule, + int32_t var_id) +{ + return rule->vars[var_id].name; +} - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_set_component_actions_w_id(world, e, &cl[i]); - } +/* Public function to get the type of a variable. */ +bool ecs_rule_var_is_entity( + const ecs_rule_t *rule, + int32_t var_id) +{ + return rule->vars[var_id].kind == EcsRuleVarKindEntity; } -static -void ensure_module_tag(ecs_iter_t *it) { - ecs_world_t *world = it->world; +/* Public function to set the value of a variable before iterating. */ +void ecs_rule_set_var( + ecs_iter_t *it, + int32_t var_id, + ecs_entity_t value) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(var_id != -1, ECS_INVALID_PARAMETER, NULL); + ecs_check(value != 0, ECS_INVALID_PARAMETER, NULL); + /* Can't set variable while iterating */ + ecs_check(it->is_valid == false, ECS_INVALID_OPERATION, NULL); + ecs_check(it->next == ecs_rule_next, ECS_INVALID_OPERATION, NULL); - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); - if (parent) { - ecs_add_id(world, parent, EcsModule); - } + ecs_rule_iter_t *iter = &it->priv.iter.rule; + ecs_check(iter->registers != NULL, ECS_INVALID_PARAMETER, NULL); + + const ecs_rule_t *r = iter->rule; + ecs_check(var_id < r->var_count, ECS_INVALID_PARAMETER, NULL); + + entity_reg_set(r, iter->registers, var_id, value); + + /* Also set table variable if it exists */ + const ecs_rule_var_t *var = &r->vars[var_id]; + if (var->other != -1) { + const ecs_rule_var_t *tvar = &r->vars[var->other]; + ecs_assert(tvar->kind == EcsRuleVarKindTable, + ECS_INTERNAL_ERROR, NULL); + (void)tvar; + reg_set_entity(r, iter->registers, var->other, value); } +error: + return; } -/* -- Triggers for keeping hashed ids in sync -- */ - static -void on_parent_change(ecs_iter_t *it) { - ecs_world_t *world = it->world; - ecs_table_t *other_table = it->other_table, *table = it->table; +void ecs_rule_iter_free( + ecs_iter_t *iter) +{ + ecs_rule_iter_t *it = &iter->priv.iter.rule; + ecs_os_free(it->registers); + ecs_os_free(it->columns); + ecs_os_free(it->op_ctx); + ecs_os_free(it->variables); + iter->columns = NULL; + it->registers = NULL; + it->columns = NULL; + it->op_ctx = NULL; +} - int32_t col = ecs_search(it->real_world, table, - ecs_pair(ecs_id(EcsIdentifier), EcsName), 0); - bool has_name = col != -1; - bool other_has_name = ecs_search(it->real_world, other_table, - ecs_pair(ecs_id(EcsIdentifier), EcsName), 0) != -1; +/* Create rule iterator */ +ecs_iter_t ecs_rule_iter( + const ecs_world_t *world, + const ecs_rule_t *rule) +{ + ecs_assert(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(rule != NULL, ECS_INVALID_PARAMETER, NULL); - if (!has_name && !other_has_name) { - /* If tables don't have names, index does not need to be updated */ - return; - } + ecs_iter_t result = {0}; + int i; - ecs_id_t to_pair = it->event_id; - ecs_id_t from_pair = ecs_childof(0); + result.world = (ecs_world_t*)world; + result.real_world = (ecs_world_t*)ecs_get_world(rule->world); - /* Find the other ChildOf relationship */ - ecs_search(it->real_world, other_table, - ecs_pair(EcsChildOf, EcsWildcard), &from_pair); + flecs_process_pending_tables(result.real_world); - bool to_has_name = has_name, from_has_name = other_has_name; - if (it->event == EcsOnRemove) { - if (from_pair != ecs_childof(0)) { - /* Because ChildOf is an exclusive relationship, events always come - * in OnAdd/OnRemove pairs (add for the new, remove for the old - * parent). We only need one of those events, so filter out the - * OnRemove events except for the case where a parent is removed and - * not replaced with another parent. */ - return; - } + ecs_rule_iter_t *it = &result.priv.iter.rule; + it->rule = rule; - ecs_id_t temp = from_pair; - from_pair = to_pair; - to_pair = temp; + if (rule->operation_count) { + if (rule->var_count) { + it->registers = ecs_os_malloc_n(ecs_rule_reg_t, + rule->operation_count * rule->var_count); - to_has_name = other_has_name; - from_has_name = has_name; - } + it->variables = ecs_os_malloc_n(ecs_entity_t, rule->var_count); + } + + it->op_ctx = ecs_os_calloc_n(ecs_rule_op_ctx_t, rule->operation_count); - /* Get the table column with names */ - const EcsIdentifier *names = ecs_iter_column(it, EcsIdentifier, col); + if (rule->filter.term_count) { + it->columns = ecs_os_malloc_n(int32_t, + rule->operation_count * rule->filter.term_count); + } - ecs_hashmap_t *from_index = 0; - if (from_has_name) { - from_index = flecs_get_id_name_index(world, from_pair); - } - ecs_hashmap_t *to_index = NULL; - if (to_has_name) { - to_index = flecs_ensure_id_name_index(world, to_pair); + for (i = 0; i < rule->filter.term_count; i ++) { + it->columns[i] = -1; + } } - int32_t i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - const EcsIdentifier *name = &names[i]; + it->op = 0; - uint64_t index_hash = name->index_hash; - if (from_index && index_hash) { - flecs_name_index_remove(from_index, e, index_hash); - } - const char *name_str = name->value; - if (to_index && name_str) { - ecs_assert(name->hash != 0, ECS_INTERNAL_ERROR, NULL); - flecs_name_index_ensure( - to_index, e, name_str, name->length, name->hash); + for (i = 0; i < rule->var_count; i ++) { + if (rule->vars[i].kind == EcsRuleVarKindEntity) { + entity_reg_set(rule, it->registers, i, EcsWildcard); + } else { + table_reg_set(rule, it->registers, i, NULL); } } -} + result.variable_names = (char**)rule->var_names; + result.variable_count = rule->var_count; + result.term_count = rule->filter.term_count; + result.terms = rule->filter.terms; + result.next = ecs_rule_next; + result.fini = ecs_rule_iter_free; + result.is_filter = rule->filter.filter; + result.columns = it->columns; /* prevent alloc */ -/* -- Iterable mixins -- */ + return result; +} +/* Edge case: if the filter has the same variable for both predicate and + * object, they are both resolved at the same time but at the time of + * evaluating the filter they're still wildcards which would match columns + * that have different predicates/objects. Do an additional scan to make + * sure the column we're returning actually matches. */ static -void on_event_iterable_init( - const ecs_world_t *world, - const ecs_poly_t *poly, /* Observable */ - ecs_iter_t *it, - ecs_term_t *filter) +int32_t find_next_same_var( + ecs_type_t type, + int32_t column, + ecs_id_t pattern) { - ecs_iter_poly(world, poly, it, filter); - it->event_id = filter->id; -} + /* If same_var is true, this has to be a wildcard pair. We cannot have + * the same variable in a pair, and one part of a pair resolved with + * another part unresolved. */ + ecs_assert(pattern == ecs_pair(EcsWildcard, EcsWildcard), + ECS_INTERNAL_ERROR, NULL); + (void)pattern; + + /* Keep scanning for an id where rel and obj are the same */ + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t i, count = ecs_vector_count(type); + for (i = column + 1; i < count; i ++) { + ecs_id_t id = ids[i]; + if (!ECS_HAS_ROLE(id, PAIR)) { + /* If id is not a pair, this will definitely not match, and we + * will find no further matches. */ + return -1; + } -/* -- Bootstrapping -- */ + if (ECS_PAIR_FIRST(id) == ECS_PAIR_SECOND(id)) { + /* Found a match! */ + return i; + } + } -#define bootstrap_component(world, table, name)\ - _bootstrap_component(world, table, ecs_id(name), #name, sizeof(name),\ - ECS_ALIGNOF(name)) + /* No pairs found with same rel/obj */ + return -1; +} static -void _bootstrap_component( - ecs_world_t *world, - ecs_table_t *table, - ecs_entity_t entity, - const char *symbol, - ecs_size_t size, - ecs_size_t alignment) +int32_t find_next_column( + const ecs_world_t *world, + const ecs_table_t *table, + int32_t column, + ecs_rule_filter_t *filter) { ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_column_t *columns = table->storage.columns; - ecs_assert(columns != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_record_t *record = ecs_eis_ensure(world, entity); - record->table = table; - - int32_t index = flecs_table_append(world, table, &table->storage, - entity, record, false); - record->row = ECS_ROW_TO_RECORD(index, 0); - - EcsComponent *component = ecs_vector_first(columns[0].data, EcsComponent); - component[index].size = size; - component[index].alignment = alignment; + ecs_entity_t pattern = filter->mask; + ecs_type_t type = table->type; - const char *name = &symbol[3]; /* Strip 'Ecs' */ - ecs_size_t symbol_length = ecs_os_strlen(symbol); - ecs_size_t name_length = symbol_length - 3; + if (column == -1) { + ecs_table_record_t *tr = flecs_get_table_record(world, table, pattern); + if (!tr) { + return -1; + } + column = tr->column; + } else { + column = ecs_search_offset(world, table, column + 1, filter->mask, 0); + if (column == -1) { + return -1; + } + } - EcsIdentifier *name_col = ecs_vector_first(columns[1].data, EcsIdentifier); - name_col[index].value = ecs_os_strdup(name); - name_col[index].length = name_length; - name_col[index].hash = flecs_hash(name, name_length); - name_col[index].index_hash = 0; - name_col[index].index = NULL; + if (filter->same_var) { + column = find_next_same_var(type, column - 1, filter->mask); + } - EcsIdentifier *symbol_col = ecs_vector_first(columns[2].data, EcsIdentifier); - symbol_col[index].value = ecs_os_strdup(symbol); - symbol_col[index].length = symbol_length; - symbol_col[index].hash = flecs_hash(symbol, symbol_length); - symbol_col[index].index_hash = 0; - symbol_col[index].index = NULL; + return column; } -/** Initialize component table. This table is manually constructed to bootstrap - * flecs. After this function has been called, the builtin components can be - * created. - * The reason this table is constructed manually is because it requires the size - * and alignment of the EcsComponent and EcsIdentifier components, which haven't - * been created yet */ +/* This function finds the next table in a table set, and is used by the select + * operation. The function automatically skips empty tables, so that subsequent + * operations don't waste a lot of processing for nothing. */ static -ecs_table_t* bootstrap_component_table( - ecs_world_t *world) +ecs_table_record_t find_next_table( + ecs_rule_filter_t *filter, + ecs_rule_with_ctx_t *op_ctx) { - /* Before creating the table, ensure component ids are alive */ - ecs_ensure(world, ecs_id(EcsComponent)); - ecs_ensure(world, EcsFinal); - ecs_ensure(world, ecs_id(EcsIdentifier)); - ecs_ensure(world, EcsName); - ecs_ensure(world, EcsSymbol); - ecs_ensure(world, EcsAlias); - ecs_ensure(world, EcsChildOf); - ecs_ensure(world, EcsFlecsCore); - ecs_ensure(world, EcsOnDelete); - ecs_ensure(world, EcsThrow); - ecs_ensure(world, EcsWildcard); - ecs_ensure(world, EcsAny); - - /* Before creating table, manually set flags for ChildOf/Identifier, as this - * can no longer be done after they are in use. */ - ecs_id_record_t *childof_idr = flecs_ensure_id_record(world, EcsChildOf); - childof_idr->flags |= ECS_ID_ON_DELETE_OBJECT_DELETE; - childof_idr->flags |= ECS_ID_DONT_INHERIT; + ecs_table_cache_iter_t *it = &op_ctx->it; + ecs_table_t *table = NULL; + int32_t column = -1; - ecs_id_record_t *ident_idr = flecs_ensure_id_record( - world, ecs_id(EcsIdentifier)); - ident_idr->flags |= ECS_ID_DONT_INHERIT; + const ecs_table_record_t *tr; + while ((column == -1) && (tr = flecs_table_cache_next(it, ecs_table_record_t))) { + table = tr->hdr.table; - ecs_id_t entities[] = { - ecs_id(EcsComponent), - EcsFinal, - ecs_pair(ecs_id(EcsIdentifier), EcsName), - ecs_pair(ecs_id(EcsIdentifier), EcsSymbol), - ecs_pair(EcsChildOf, EcsFlecsCore), - ecs_pair(EcsOnDelete, EcsThrow) - }; - - ecs_ids_t array = { - .array = entities, - .count = 6 - }; + /* Should only iterate non-empty tables */ + ecs_assert(ecs_table_count(table) != 0, ECS_INTERNAL_ERROR, NULL); - ecs_table_t *result = flecs_table_find_or_create(world, &array); - ecs_data_t *data = &result->storage; + column = tr->column; + if (filter->same_var) { + column = find_next_same_var(table->type, column - 1, filter->mask); + } + } - /* Preallocate enough memory for initial components */ - data->entities = ecs_vector_new(ecs_entity_t, EcsFirstUserComponentId); - data->record_ptrs = ecs_vector_new(ecs_record_t*, EcsFirstUserComponentId); + if (column == -1) { + table = NULL; + } - data->columns[0].data = ecs_vector_new(EcsComponent, EcsFirstUserComponentId); - data->columns[1].data = ecs_vector_new(EcsIdentifier, EcsFirstUserComponentId); - data->columns[2].data = ecs_vector_new(EcsIdentifier, EcsFirstUserComponentId); - - return result; + return (ecs_table_record_t){.hdr.table = table, .column = column}; } + static -void bootstrap_entity( +ecs_id_record_t* find_tables( ecs_world_t *world, - ecs_entity_t id, - const char *name, - ecs_entity_t parent) + ecs_id_t id) { - char symbol[256]; - ecs_os_strcpy(symbol, "flecs.core."); - ecs_os_strcat(symbol, name); - - ecs_add_pair(world, id, EcsChildOf, parent); - ecs_set_name(world, id, name); - ecs_set_symbol(world, id, symbol); - - ecs_assert(ecs_get_name(world, id) != NULL, ECS_INTERNAL_ERROR, NULL); - - if (!parent || parent == EcsFlecsCore) { - ecs_assert(ecs_lookup_fullpath(world, name) == id, - ECS_INTERNAL_ERROR, NULL); + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr || !ecs_table_cache_count(&idr->cache)) { + /* Skip ids that don't have (non-empty) tables */ + return NULL; } + return idr; } -void flecs_bootstrap( - ecs_world_t *world) +static +ecs_id_t rule_get_column( + ecs_type_t type, + int32_t column) { - ecs_log_push(); - - ecs_set_name_prefix(world, "Ecs"); + ecs_id_t *comp = ecs_vector_get(type, ecs_id_t, column); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); + return *comp; +} - /* Bootstrap type info (otherwise initialized by setting EcsComponent) */ - flecs_init_type_info_t(world, EcsComponent); - flecs_init_type_info_t(world, EcsIdentifier); - flecs_init_type_info_t(world, EcsComponentLifecycle); - flecs_init_type_info_t(world, EcsType); - flecs_init_type_info_t(world, EcsQuery); - flecs_init_type_info_t(world, EcsTrigger); - flecs_init_type_info_t(world, EcsObserver); - flecs_init_type_info_t(world, EcsIterable); +static +void set_source( + ecs_iter_t *it, + ecs_rule_op_t *op, + ecs_rule_reg_t *regs, + int32_t r) +{ + if (op->term == -1) { + /* If operation is not associated with a term, don't set anything */ + return; + } - /* Setup component lifecycle actions */ - ecs_set_component_actions(world, EcsComponent, { - .ctor = ecs_default_ctor - }); + ecs_assert(op->term >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_set_component_actions(world, EcsIdentifier, { - .ctor = ecs_ctor(EcsIdentifier), - .dtor = ecs_dtor(EcsIdentifier), - .copy = ecs_copy(EcsIdentifier), - .move = ecs_move(EcsIdentifier), - .on_set = ecs_on_set(EcsIdentifier), - .on_remove = ecs_on_set(EcsIdentifier) - }); + const ecs_rule_t *rule = it->priv.iter.rule.rule; + if ((r != UINT8_MAX) && rule->vars[r].kind == EcsRuleVarKindEntity) { + it->subjects[op->term] = reg_get_entity(rule, op, regs, r); + } else { + it->subjects[op->term] = 0; + } +} - ecs_set_component_actions(world, EcsTrigger, { - .ctor = ecs_ctor(EcsTrigger), - .dtor = ecs_dtor(EcsTrigger), - .copy = ecs_copy(EcsTrigger), - .move = ecs_move(EcsTrigger) - }); +static +void set_term_vars( + const ecs_rule_t *rule, + ecs_rule_reg_t *regs, + int32_t term, + ecs_id_t id) +{ + if (term != -1) { + const ecs_rule_term_vars_t *vars = &rule->term_vars[term]; + if (vars->pred != -1) { + regs[vars->pred].entity = ECS_PAIR_FIRST(id); + } + if (vars->obj != -1) { + regs[vars->obj].entity = ECS_PAIR_SECOND(id); + } + } +} - ecs_set_component_actions(world, EcsObserver, { - .ctor = ecs_ctor(EcsObserver), - .dtor = ecs_dtor(EcsObserver), - .copy = ecs_copy(EcsObserver), - .move = ecs_move(EcsObserver) - }); +/* Input operation. The input operation acts as a placeholder for the start of + * the program, and creates an entry in the register array that can serve to + * store variables passed to an iterator. */ +static +bool eval_input( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) +{ + (void)it; + (void)op; + (void)op_index; - /* Create table for initial components */ - ecs_table_t *table = bootstrap_component_table(world); - assert(table != NULL); + if (!redo) { + /* First operation executed by the iterator. Always return true. */ + return true; + } else { + /* When Input is asked to redo, it means that all other operations have + * exhausted their results. Input itself does not yield anything, so + * return false. This will terminate rule execution. */ + return false; + } +} - bootstrap_component(world, table, EcsIdentifier); - bootstrap_component(world, table, EcsComponent); - bootstrap_component(world, table, EcsComponentLifecycle); +static +bool eval_superset( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) +{ + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_world_t *world = rule->world; + ecs_rule_superset_ctx_t *op_ctx = &iter->op_ctx[op_index].is.superset; + ecs_rule_superset_frame_t *frame = NULL; + ecs_rule_reg_t *regs = get_registers(iter, op); - bootstrap_component(world, table, EcsType); - bootstrap_component(world, table, EcsQuery); - bootstrap_component(world, table, EcsTrigger); - bootstrap_component(world, table, EcsObserver); - bootstrap_component(world, table, EcsIterable); + /* Get register indices for output */ + int32_t sp; + int32_t r = op->r_out; - world->stats.last_component_id = EcsFirstUserComponentId; - world->stats.last_id = EcsFirstUserEntityId; - world->stats.min_id = 0; - world->stats.max_id = 0; + /* Register cannot be a literal, since we need to store things in it */ + ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); - /* Populate core module */ - ecs_set_scope(world, EcsFlecsCore); + /* Get queried for id, fill out potential variables */ + ecs_rule_pair_t pair = op->filter; - flecs_bootstrap_tag(world, EcsName); - flecs_bootstrap_tag(world, EcsSymbol); - flecs_bootstrap_tag(world, EcsAlias); + ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); + ecs_entity_t rel = ECS_PAIR_FIRST(filter.mask); + ecs_rule_filter_t super_filter = { + .mask = ecs_pair(rel, EcsWildcard) + }; + ecs_table_t *table = NULL; - flecs_bootstrap_tag(world, EcsModule); - flecs_bootstrap_tag(world, EcsPrivate); - flecs_bootstrap_tag(world, EcsPrefab); - flecs_bootstrap_tag(world, EcsDisabled); + /* If the input register is not NULL, this is a variable that's been set by + * the application. */ + ecs_entity_t result = iter->registers[r].entity; + bool output_is_input = result && result != EcsWildcard; - /* Initialize builtin modules */ - ecs_set_name(world, EcsFlecs, "flecs"); - ecs_add_id(world, EcsFlecs, EcsModule); + if (output_is_input && !redo) { + ecs_assert(regs[r].entity == iter->registers[r].entity, + ECS_INTERNAL_ERROR, NULL); + } - ecs_add_pair(world, EcsFlecsCore, EcsChildOf, EcsFlecs); - ecs_set_name(world, EcsFlecsCore, "core"); - ecs_add_id(world, EcsFlecsCore, EcsModule); + if (!redo) { + op_ctx->stack = op_ctx->storage; + sp = op_ctx->sp = 0; + frame = &op_ctx->stack[sp]; - ecs_add_pair(world, EcsFlecsHidden, EcsChildOf, EcsFlecs); - ecs_set_name(world, EcsFlecsHidden, "hidden"); - ecs_add_id(world, EcsFlecsHidden, EcsModule); + /* Get table of object for which to get supersets */ + ecs_entity_t obj = ECS_PAIR_SECOND(filter.mask); + if (obj == EcsWildcard) { + ecs_assert(pair.reg_mask & RULE_PAIR_OBJECT, + ECS_INTERNAL_ERROR, NULL); + table = regs[pair.obj.reg].table.table; + } else { + table = table_from_entity(world, obj).table; + } - /* Initialize builtin entities */ - bootstrap_entity(world, EcsWorld, "World", EcsFlecsCore); - bootstrap_entity(world, EcsThis, "This", EcsFlecsCore); - bootstrap_entity(world, EcsWildcard, "*", EcsFlecsCore); - bootstrap_entity(world, EcsAny, "_", EcsFlecsCore); + int32_t column; - /* Component/relationship properties */ - flecs_bootstrap_tag(world, EcsTransitive); - flecs_bootstrap_tag(world, EcsReflexive); - flecs_bootstrap_tag(world, EcsSymmetric); - flecs_bootstrap_tag(world, EcsFinal); - flecs_bootstrap_tag(world, EcsDontInherit); - flecs_bootstrap_tag(world, EcsTag); - flecs_bootstrap_tag(world, EcsExclusive); - flecs_bootstrap_tag(world, EcsAcyclic); - flecs_bootstrap_tag(world, EcsWith); + /* If output variable is already set, check if it matches */ + if (output_is_input) { + ecs_id_t id = ecs_pair(rel, result); + ecs_entity_t subj = 0; + column = ecs_search_relation(world, table, 0, id, rel, + 0, 0, &subj, 0, NULL); + if (column != -1) { + if (subj != 0) { + table = ecs_get_table(world, subj); + } + } + } else { + column = find_next_column(world, table, -1, &super_filter); + } - flecs_bootstrap_tag(world, EcsOnDelete); - flecs_bootstrap_tag(world, EcsOnDeleteObject); - flecs_bootstrap_tag(world, EcsRemove); - flecs_bootstrap_tag(world, EcsDelete); - flecs_bootstrap_tag(world, EcsThrow); + /* If no matching column was found, there are no supersets */ + if (column == -1) { + return false; + } - flecs_bootstrap_tag(world, EcsDefaultChildComponent); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - /* Builtin relations */ - flecs_bootstrap_tag(world, EcsIsA); - flecs_bootstrap_tag(world, EcsChildOf); + ecs_entity_t col_entity = rule_get_column(table->type, column); + ecs_entity_t col_obj = ecs_entity_t_lo(col_entity); - /* Builtin events */ - bootstrap_entity(world, EcsOnAdd, "OnAdd", EcsFlecsCore); - bootstrap_entity(world, EcsOnRemove, "OnRemove", EcsFlecsCore); - bootstrap_entity(world, EcsOnSet, "OnSet", EcsFlecsCore); - bootstrap_entity(world, EcsUnSet, "UnSet", EcsFlecsCore); - bootstrap_entity(world, EcsOnTableEmpty, "OnTableEmpty", EcsFlecsCore); - bootstrap_entity(world, EcsOnTableFill, "OnTableFilled", EcsFlecsCore); + reg_set_entity(rule, regs, r, col_obj); - /* Transitive relations are always Acyclic */ - ecs_add_pair(world, EcsTransitive, EcsWith, EcsAcyclic); + frame->table = table; + frame->column = column; - /* Transitive relations */ - ecs_add_id(world, EcsIsA, EcsTransitive); - ecs_add_id(world, EcsIsA, EcsReflexive); + return true; + } else if (output_is_input) { + return false; + } - /* Tag relations (relations that should never have data) */ - ecs_add_id(world, EcsIsA, EcsTag); - ecs_add_id(world, EcsChildOf, EcsTag); - ecs_add_id(world, EcsDefaultChildComponent, EcsTag); + sp = op_ctx->sp; + frame = &op_ctx->stack[sp]; + table = frame->table; + int32_t column = frame->column; - /* Acyclic relations */ - ecs_add_id(world, EcsIsA, EcsAcyclic); - ecs_add_id(world, EcsChildOf, EcsAcyclic); - ecs_add_id(world, EcsWith, EcsAcyclic); + ecs_entity_t col_entity = rule_get_column(table->type, column); + ecs_entity_t col_obj = ecs_entity_t_lo(col_entity); + ecs_table_t *next_table = table_from_entity(world, col_obj).table; - /* Exclusive properties */ - ecs_add_id(world, EcsChildOf, EcsExclusive); - ecs_add_id(world, EcsOnDelete, EcsExclusive); - ecs_add_id(world, EcsOnDeleteObject, EcsExclusive); - ecs_add_id(world, EcsDefaultChildComponent, EcsExclusive); + if (next_table) { + sp ++; + frame = &op_ctx->stack[sp]; + frame->table = next_table; + frame->column = -1; + } - /* Make EcsOnAdd, EcsOnSet events iterable to enable .yield_existing */ - ecs_set(world, EcsOnAdd, EcsIterable, { .init = on_event_iterable_init }); - ecs_set(world, EcsOnSet, EcsIterable, { .init = on_event_iterable_init }); + do { + frame = &op_ctx->stack[sp]; + table = frame->table; + column = frame->column; - /* Removal of ChildOf objects (parents) deletes the subject (child) */ - ecs_add_pair(world, EcsChildOf, EcsOnDeleteObject, EcsDelete); + column = find_next_column(world, table, column, &super_filter); + if (column != -1) { + op_ctx->sp = sp; + frame->column = column; + col_entity = rule_get_column(table->type, column); + col_obj = ecs_entity_t_lo(col_entity); + reg_set_entity(rule, regs, r, col_obj); + return true; + } - /* ChildOf, Identifier, Disabled and Prefab should never be inherited */ - ecs_add_id(world, EcsChildOf, EcsDontInherit); - ecs_add_id(world, ecs_id(EcsIdentifier), EcsDontInherit); + sp --; + } while (sp >= 0); - /* The (IsA, *) id record is used often in searches, so cache it */ - world->idr_isa_wildcard = flecs_ensure_id_record(world, - ecs_pair(EcsIsA, EcsWildcard)); + return false; +} - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term = { - .id = ecs_pair(EcsChildOf, EcsWildcard), - .subj.set.mask = EcsSelf - }, - .events = { EcsOnAdd, EcsOnRemove }, - .yield_existing = true, - .callback = on_parent_change - }); +static +bool eval_subset( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) +{ + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_world_t *world = rule->world; + ecs_rule_subset_ctx_t *op_ctx = &iter->op_ctx[op_index].is.subset; + ecs_rule_subset_frame_t *frame = NULL; + ecs_table_record_t table_record; + ecs_rule_reg_t *regs = get_registers(iter, op); - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = EcsFinal, .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_final - }); + /* Get register indices for output */ + int32_t sp, row; + int32_t r = op->r_out; + ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = ecs_pair(EcsOnDelete, EcsWildcard), .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_on_delete - }); + /* Get queried for id, fill out potential variables */ + ecs_rule_pair_t pair = op->filter; + ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); + ecs_id_record_t *idr; + ecs_table_t *table = NULL; - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = ecs_pair(EcsOnDeleteObject, EcsWildcard), .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_on_delete_object - }); + if (!redo) { + op_ctx->stack = op_ctx->storage; + sp = op_ctx->sp = 0; + frame = &op_ctx->stack[sp]; + idr = frame->with_ctx.idr = find_tables(world, filter.mask); + if (!idr) { + return false; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = EcsExclusive, .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_exclusive - }); + flecs_table_cache_iter(&idr->cache, &frame->with_ctx.it); + table_record = find_next_table(&filter, &frame->with_ctx); + + /* If first table set has no non-empty table, yield nothing */ + if (!table_record.hdr.table) { + return false; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = EcsSymmetric, .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_symmetric - }); + frame->row = 0; + frame->column = table_record.column; + table_reg_set(rule, regs, r, (frame->table = table_record.hdr.table)); + goto yield; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = EcsDontInherit, .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = register_dont_inherit - }); + do { + sp = op_ctx->sp; + frame = &op_ctx->stack[sp]; + table = frame->table; + row = frame->row; - /* Define trigger to make sure that adding a module to a child entity also - * adds it to the parent. */ - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = EcsModule, .subj.set.mask = EcsSelf }, - .events = {EcsOnAdd}, - .callback = ensure_module_tag - }); + /* If row exceeds number of elements in table, find next table in frame that + * still has entities */ + while ((sp >= 0) && (row >= ecs_table_count(table))) { + table_record = find_next_table(&filter, &frame->with_ctx); - /* Define trigger for when component lifecycle is set for component */ - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = ecs_id(EcsComponentLifecycle), .subj.set.mask = EcsSelf }, - .events = {EcsOnSet}, - .callback = on_set_component_lifecycle - }); + if (table_record.hdr.table) { + table = frame->table = table_record.hdr.table; + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + frame->row = 0; + frame->column = table_record.column; + table_reg_set(rule, regs, r, table); + goto yield; + } else { + sp = -- op_ctx->sp; + if (sp < 0) { + /* If none of the frames yielded anything, no more data */ + return false; + } + frame = &op_ctx->stack[sp]; + table = frame->table; + idr = frame->with_ctx.idr; + row = ++ frame->row; - /* Define trigger for updating component size when it changes */ - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = ecs_id(EcsComponent), .subj.set.mask = EcsSelf }, - .events = {EcsOnSet}, - .callback = on_set_component - }); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); + } + } - ecs_add_id(world, EcsDisabled, EcsDontInherit); - ecs_add_id(world, EcsPrefab, EcsDontInherit); + int32_t row_count = ecs_table_count(table); - /* Run bootstrap functions for other parts of the code */ - flecs_bootstrap_hierarchy(world); + /* Table must have at least row elements */ + ecs_assert(row_count > row, ECS_INTERNAL_ERROR, NULL); - ecs_set_scope(world, 0); + ecs_entity_t *entities = ecs_vector_first( + table->storage.entities, ecs_entity_t); + ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_log_pop(); -} + /* The entity used to find the next table set */ + do { + ecs_entity_t e = entities[row]; + /* Create look_for expression with the resolved entity as object */ + pair.reg_mask &= ~RULE_PAIR_OBJECT; /* turn of bit because it's not a reg */ + pair.obj.ent = e; + filter = pair_to_filter(iter, op, pair); -static -void table_cache_list_remove( - ecs_table_cache_t *cache, - ecs_table_cache_hdr_t *elem) -{ - ecs_table_cache_hdr_t *next = elem->next; - ecs_table_cache_hdr_t *prev = elem->prev; + /* Find table set for expression */ + table = NULL; + idr = find_tables(world, filter.mask); - if (next) { - next->prev = prev; - } - if (prev) { - prev->next = next; - } + /* If table set is found, find first non-empty table */ + if (idr) { + ecs_rule_subset_frame_t *new_frame = &op_ctx->stack[sp + 1]; + new_frame->with_ctx.idr = idr; + flecs_table_cache_iter(&idr->cache, &new_frame->with_ctx.it); + table_record = find_next_table(&filter, &new_frame->with_ctx); - cache->empty_tables.count -= !!elem->empty; - cache->tables.count -= !elem->empty; + /* If set contains non-empty table, push it to stack */ + if (table_record.hdr.table) { + table = table_record.hdr.table; + op_ctx->sp ++; + new_frame->table = table; + new_frame->row = 0; + new_frame->column = table_record.column; + frame = new_frame; + } + } - if (cache->empty_tables.first == elem) { - cache->empty_tables.first = next; - } else if (cache->tables.first == elem) { - cache->tables.first = next; - } - if (cache->empty_tables.last == elem) { - cache->empty_tables.last = prev; - } - if (cache->tables.last == elem) { - cache->tables.last = prev; - } -} + /* If no table was found for the current entity, advance row */ + if (!table) { + row = ++ frame->row; + } + } while (!table && row < row_count); + } while (!table); -static -void table_cache_list_insert( - ecs_table_cache_t *cache, - ecs_table_cache_hdr_t *elem) -{ - ecs_table_cache_hdr_t *last; - if (elem->empty) { - last = cache->empty_tables.last; - cache->empty_tables.last = elem; - if ((++ cache->empty_tables.count) == 1) { - cache->empty_tables.first = elem; - } - } else { - last = cache->tables.last; - cache->tables.last = elem; - if ((++ cache->tables.count) == 1) { - cache->tables.first = elem; - } - } + table_reg_set(rule, regs, r, table); - elem->next = NULL; - elem->prev = last; +yield: + set_term_vars(rule, regs, op->term, ecs_vector_get(frame->table->type, + ecs_id_t, frame->column)[0]); - if (last) { - last->next = elem; - } + return true; } -void ecs_table_cache_init( - ecs_table_cache_t *cache) +/* Select operation. The select operation finds and iterates a table set that + * corresponds to its pair expression. */ +static +bool eval_select( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_map_init(&cache->index, ecs_table_cache_hdr_t*, 0); -} + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_world_t *world = rule->world; + ecs_rule_with_ctx_t *op_ctx = &iter->op_ctx[op_index].is.with; + ecs_table_record_t table_record; + ecs_rule_reg_t *regs = get_registers(iter, op); -void ecs_table_cache_fini( - ecs_table_cache_t *cache) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_map_fini(&cache->index); -} + /* Get register indices for output */ + int32_t r = op->r_out; + ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); -bool ecs_table_cache_is_empty( - const ecs_table_cache_t *cache) -{ - return ecs_map_count(&cache->index) == 0; -} + /* Get queried for id, fill out potential variables */ + ecs_rule_pair_t pair = op->filter; + ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); + ecs_entity_t pattern = filter.mask; + int32_t *columns = rule_get_columns(iter, op); -void ecs_table_cache_insert( - ecs_table_cache_t *cache, - const ecs_table_t *table, - ecs_table_cache_hdr_t *result) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!table || (ecs_table_cache_get(cache, table) == NULL), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); + int32_t column = -1; + ecs_table_t *table = NULL; + ecs_id_record_t *idr; - bool empty; - if (!table) { - empty = false; - } else { - empty = ecs_table_count(table) == 0; + if (!redo && op->term != -1) { + columns[op->term] = -1; } - result->cache = cache; - result->table = (ecs_table_t*)table; - result->empty = empty; - - table_cache_list_insert(cache, result); + /* If this is a redo, we already looked up the table set */ + if (redo) { + idr = op_ctx->idr; + + /* If this is not a redo lookup the table set. Even though this may not be + * the first time the operation is evaluated, variables may have changed + * since last time, which could change the table set to lookup. */ + } else { + /* A table set is a set of tables that all contain at least the + * requested look_for expression. What is returned is a table record, + * which in addition to the table also stores the first occurrance at + * which the requested expression occurs in the table. This reduces (and + * in most cases eliminates) any searching that needs to occur in a + * table type. Tables are also registered under wildcards, which is why + * this operation can simply use the look_for variable directly */ - if (table) { - ecs_map_set_ptr(&cache->index, table->id, result); + idr = op_ctx->idr = find_tables(world, pattern); } - ecs_assert(empty || cache->tables.first != NULL, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!empty || cache->empty_tables.first != NULL, - ECS_INTERNAL_ERROR, NULL); -} + /* If no table set was found for queried for entity, there are no results */ + if (!idr) { + return false; + } -void* ecs_table_cache_get( - const ecs_table_cache_t *cache, - const ecs_table_t *table) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - return ecs_map_get_ptr(&cache->index, ecs_table_cache_hdr_t*, table->id); -} + /* If the input register is not NULL, this is a variable that's been set by + * the application. */ + table = iter->registers[r].table.table; + bool output_is_input = table != NULL; -void* ecs_table_cache_remove( - ecs_table_cache_t *cache, - const ecs_table_t *table, - ecs_table_cache_hdr_t *elem) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + if (output_is_input && !redo) { + ecs_assert(regs[r].table.table == iter->registers[r].table.table, + ECS_INTERNAL_ERROR, NULL); - if (!ecs_map_is_initialized(&cache->index)) { - return NULL; - } + table = iter->registers[r].table.table; - if (!elem) { - elem = ecs_map_get_ptr( - &cache->index, ecs_table_cache_hdr_t*, table->id); - if (!elem) { + /* Check if table can be found in the id record. If not, the provided + * table does not match with the query. */ + ecs_table_record_t *tr = ecs_table_cache_get(&idr->cache, table); + if (!tr) { return false; } + + column = op_ctx->column = tr->column; } - ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(elem->cache == cache, ECS_INTERNAL_ERROR, NULL); - ecs_assert(elem->table == table, ECS_INTERNAL_ERROR, NULL); + /* If this is not a redo, start at the beginning */ + if (!redo) { + if (!table) { + flecs_table_cache_iter(&idr->cache, &op_ctx->it); - table_cache_list_remove(cache, elem); + /* Return the first table_record in the table set. */ + table_record = find_next_table(&filter, op_ctx); + + /* If no table record was found, there are no results. */ + if (!table_record.hdr.table) { + return false; + } - ecs_map_remove(&cache->index, table->id); + table = table_record.hdr.table; - return elem; -} + /* Set current column to first occurrence of queried for entity */ + column = op_ctx->column = table_record.column; -bool ecs_table_cache_set_empty( - ecs_table_cache_t *cache, - const ecs_table_t *table, - bool empty) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + /* Store table in register */ + table_reg_set(rule, regs, r, table); + } + + /* If this is a redo, progress to the next match */ + } else { + /* First test if there are any more matches for the current table, in + * case we're looking for a wildcard. */ + if (filter.wildcard) { + table = table_reg_get(rule, regs, r).table; + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_table_cache_hdr_t *elem = ecs_map_get_ptr( - &cache->index, ecs_table_cache_hdr_t*, table->id); - if (!elem) { - return false; - } + column = op_ctx->column; + column = find_next_column(world, table, column, &filter); + op_ctx->column = column; + } - if (elem->empty == empty) { - return false; - } + /* If no next match was found for this table, move to next table */ + if (column == -1) { + if (output_is_input) { + return false; + } - table_cache_list_remove(cache, elem); - elem->empty = empty; - table_cache_list_insert(cache, elem); + table_record = find_next_table(&filter, op_ctx); + if (!table_record.hdr.table) { + return false; + } - return true; -} + /* Assign new table to table register */ + table_reg_set(rule, regs, r, (table = table_record.hdr.table)); -void ecs_table_cache_fini_delete_all( - ecs_world_t *world, - ecs_table_cache_t *cache) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - if (!ecs_map_is_initialized(&cache->index)) { - return; + /* Assign first matching column */ + column = op_ctx->column = table_record.column; + } } - /* Temporarily set index to NULL, so that when the table tries to remove - * itself from the cache it won't be able to. This keeps the arrays we're - * iterating over consistent */ - ecs_map_t index = cache->index; - ecs_os_zeromem(&cache->index); + /* If we got here, we found a match. Table and column must be set */ + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(column != -1, ECS_INTERNAL_ERROR, NULL); - ecs_table_cache_hdr_t *cur, *next = cache->tables.first; - while ((cur = next)) { - flecs_delete_table(world, cur->table); - next = cur->next; + if (op->term != -1) { + columns[op->term] = column; } - next = cache->empty_tables.first; - while ((cur = next)) { - flecs_delete_table(world, cur->table); - next = cur->next; + /* If this is a wildcard query, fill out the variable registers */ + if (filter.wildcard) { + reify_variables(iter, op, &filter, table->type, column); } - cache->index = index; - - ecs_table_cache_fini(cache); + return true; } -bool flecs_table_cache_iter( - ecs_table_cache_t *cache, - ecs_table_cache_iter_t *out) +/* With operation. The With operation always comes after either the Select or + * another With operation, and applies additional filters to the table. */ +static +bool eval_with( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); - out->next = cache->tables.first; - out->cur = NULL; - return out->next != NULL; -} + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_world_t *world = rule->world; + ecs_rule_with_ctx_t *op_ctx = &iter->op_ctx[op_index].is.with; + ecs_rule_reg_t *regs = get_registers(iter, op); -bool flecs_table_cache_empty_iter( - ecs_table_cache_t *cache, - ecs_table_cache_iter_t *out) -{ - ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); - out->next = cache->empty_tables.first; - out->cur = NULL; - return out->next != NULL; -} + /* Get register indices for input */ + int32_t r = op->r_in; -ecs_table_cache_hdr_t* _flecs_table_cache_next( - ecs_table_cache_iter_t *it) -{ - ecs_table_cache_hdr_t *next = it->next; - if (!next) { + /* Get queried for id, fill out potential variables */ + ecs_rule_pair_t pair = op->filter; + ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); + int32_t *columns = rule_get_columns(iter, op); + + /* If looked for entity is not a wildcard (meaning there are no unknown/ + * unconstrained variables) and this is a redo, nothing more to yield. */ + if (redo && !filter.wildcard) { return false; } - it->cur = next; - it->next = next->next; - return next; -} - + int32_t column = -1; + ecs_table_t *table = NULL; + ecs_id_record_t *idr; -/* Table sanity check to detect storage issues. Only enabled in SANITIZE mode as - * this can severly slow down many ECS operations. */ -#ifdef FLECS_SANITIZE -static -void check_table_sanity(ecs_table_t *table) { - int32_t size = ecs_vector_size(table->storage.entities); - int32_t count = ecs_vector_count(table->storage.entities); - - ecs_assert(size == ecs_vector_size(table->storage.record_ptrs), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(count == ecs_vector_count(table->storage.record_ptrs), - ECS_INTERNAL_ERROR, NULL); - - int32_t sw_offset = table->sw_column_offset; - int32_t sw_count = table->sw_column_count; - int32_t bs_offset = table->bs_column_offset; - int32_t bs_count = table->bs_column_count; - int32_t type_count = ecs_vector_count(table->type); - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - - ecs_assert((sw_count + sw_offset) <= type_count, ECS_INTERNAL_ERROR, NULL); - ecs_assert((bs_count + bs_offset) <= type_count, ECS_INTERNAL_ERROR, NULL); - - ecs_type_t storage_type = table->storage_type; - ecs_table_t *storage_table = table->storage_table; - ecs_assert(table->storage_type == NULL || table->storage_table != NULL, - ECS_INTERNAL_ERROR, NULL); + if (op->term != -1) { + columns[op->term] = -1; + } - int32_t i; - if (storage_table) { - ecs_assert(storage_type == storage_table->type, - ECS_INTERNAL_ERROR, NULL); - int32_t storage_count = ecs_vector_count(storage_type); - ecs_assert(type_count >= storage_count, ECS_INTERNAL_ERROR, NULL); + /* If this is a redo, we already looked up the table set */ + if (redo) { + idr = op_ctx->idr; + + /* If this is not a redo lookup the table set. Even though this may not be + * the first time the operation is evaluated, variables may have changed + * since last time, which could change the table set to lookup. */ + } else { + /* Predicates can be reflexive, which means that if we have a + * transitive predicate which is provided with the same subject and + * object, it should return true. By default with will not return true + * as the subject likely does not have itself as a relationship, which + * is why this is a special case. + * + * TODO: might want to move this code to a separate with_reflexive + * instruction to limit branches for non-transitive queries (and to keep + * code more readable). + */ + if (pair.transitive && pair.reflexive) { + ecs_entity_t subj = 0, obj = 0; + + if (r == UINT8_MAX) { + subj = op->subject; + } else { + const ecs_rule_var_t *v_subj = &rule->vars[r]; - int32_t *storage_map = table->storage_map; - ecs_assert(storage_map != NULL, ECS_INTERNAL_ERROR, NULL); + if (v_subj->kind == EcsRuleVarKindEntity) { + subj = entity_reg_get(rule, regs, r); - ecs_id_t *storage_ids = ecs_vector_first(storage_type, ecs_id_t); - for (i = 0; i < type_count; i ++) { - if (storage_map[i] != -1) { - ecs_assert(ids[i] == storage_ids[storage_map[i]], - ECS_INTERNAL_ERROR, NULL); + /* This is the input for the op, so should always be set */ + ecs_assert(subj != 0, ECS_INTERNAL_ERROR, NULL); + } } - } - for (i = 0; i < storage_count; i ++) { - ecs_type_info_t *ti = NULL; - ecs_column_t *column = &table->storage.columns[i]; - if (table->type_info) { - ti = table->type_info[i]; - } - if (ti) { - ecs_assert(ti->size == column->size, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ti->alignment == column->alignment, - ECS_INTERNAL_ERROR, NULL); + /* If subj is set, it means that it is an entity. Try to also + * resolve the object. */ + if (subj) { + /* If the object is not a wildcard, it has been reified. Get the + * value from either the register or as a literal */ + if (!filter.obj_wildcard) { + obj = ecs_entity_t_lo(filter.mask); + if (subj == obj) { + return true; + } + } } - ecs_assert(size == ecs_vector_size(column->data), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(count == ecs_vector_count(column->data), - ECS_INTERNAL_ERROR, NULL); - ecs_vector_assert_size(column->data, column->size); - int32_t storage_map_id = storage_map[i + type_count]; - ecs_assert(storage_map_id >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ids[storage_map_id] == storage_ids[i], - ECS_INTERNAL_ERROR, NULL); } + + /* The With operation finds the table set that belongs to its pair + * filter. The table set is a sparse set that provides an O(1) operation + * to check whether the current table has the required expression. */ + idr = op_ctx->idr = find_tables(world, filter.mask); } - if (sw_count) { - ecs_assert(table->storage.sw_columns != NULL, - ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < sw_count; i ++) { - ecs_sw_column_t *sw = &table->storage.sw_columns[i]; - ecs_assert(sw->data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ecs_vector_count(sw->data->values) == count, - ECS_INTERNAL_ERROR, NULL); - ecs_assert((ids[i + sw_offset] & ECS_ROLE_MASK) == - ECS_SWITCH, ECS_INTERNAL_ERROR, NULL); - } + /* If no table set was found for queried for entity, there are no results. + * If this result is a transitive query, the table we're evaluating may not + * be in the returned table set. Regardless, if the filter that contains a + * transitive predicate does not have any tables associated with it, there + * can be no transitive matches for the filter. */ + if (!idr) { + return false; } - if (bs_count) { - ecs_assert(table->storage.bs_columns != NULL, - ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < bs_count; i ++) { - ecs_bs_column_t *bs = &table->storage.bs_columns[i]; - ecs_assert(flecs_bitset_count(&bs->data) == count, - ECS_INTERNAL_ERROR, NULL); - ecs_assert((ids[i + bs_offset] & ECS_ROLE_MASK) == - ECS_DISABLED, ECS_INTERNAL_ERROR, NULL); + table = reg_get_table(rule, op, regs, r).table; + if (!table) { + return false; + } + + /* If this is not a redo, start at the beginning */ + if (!redo) { + column = op_ctx->column = find_next_column(world, table, -1, &filter); + + /* If this is a redo, progress to the next match */ + } else { + if (!filter.wildcard) { + return false; } + + /* Find the next match for the expression in the column. The columns + * array keeps track of the state for each With operation, so that + * even after redoing a With, the search doesn't have to start from + * the beginning. */ + column = find_next_column(world, table, op_ctx->column, &filter); + op_ctx->column = column; } -} -#else -#define check_table_sanity(table) -#endif -/* Count number of switch columns */ -static -int32_t switch_column_count( - ecs_table_t *table) -{ - int32_t i, sw_count = 0, count = ecs_vector_count(table->type); - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + /* If no next match was found for this table, no more data */ + if (column == -1) { + return false; + } - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - if (ECS_HAS_ROLE(id, SWITCH)) { - if (!sw_count) { - table->sw_column_offset = i; - } - sw_count ++; - } + if (op->term != -1) { + columns[op->term] = column; } - return sw_count; -} + /* If we got here, we found a match. Table and column must be set */ + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(column != -1, ECS_INTERNAL_ERROR, NULL); -/* Count number of bitset columns */ -static -int32_t bitset_column_count( - ecs_table_t *table) -{ - int32_t count = 0; - ecs_vector_each(table->type, ecs_entity_t, c_ptr, { - ecs_entity_t component = *c_ptr; + /* If this is a wildcard query, fill out the variable registers */ + if (filter.wildcard) { + reify_variables(iter, op, &filter, table->type, column); + } - if (ECS_HAS_ROLE(component, DISABLED)) { - if (!count) { - table->bs_column_offset = c_ptr_i; - } - count ++; - } - }); + set_source(it, op, regs, r); - return count; + return true; } +/* Each operation. The each operation is a simple operation that takes a table + * as input, and outputs each of the entities in a table. This operation is + * useful for rules that match a table, and where the entities of the table are + * used as predicate or object. If a rule contains an each operation, an + * iterator is guaranteed to yield an entity instead of a table. The input for + * an each operation can only be the root variable. */ static -void init_storage_map( - ecs_table_t *table) +bool eval_each( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - if (!table->storage_table) { - return; - } - - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - int32_t t, ids_count = ecs_vector_count(table->type); - ecs_id_t *storage_ids = ecs_vector_first(table->storage_type, ecs_id_t); - int32_t s, storage_ids_count = ecs_vector_count(table->storage_type); + ecs_rule_iter_t *iter = &it->priv.iter.rule; + ecs_rule_each_ctx_t *op_ctx = &iter->op_ctx[op_index].is.each; + ecs_rule_reg_t *regs = get_registers(iter, op); + int32_t r_in = op->r_in; + int32_t r_out = op->r_out; + ecs_entity_t e; - if (!ids_count) { - table->storage_map = NULL; - return; - } + /* Make sure in/out registers are of the correct kind */ + ecs_assert(iter->rule->vars[r_in].kind == EcsRuleVarKindTable, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(iter->rule->vars[r_out].kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); - table->storage_map = ecs_os_malloc_n( - int32_t, ids_count + storage_ids_count); + /* Get table, make sure that it contains data. The select operation should + * ensure that empty tables are never forwarded. */ + ecs_table_slice_t slice = table_reg_get(iter->rule, regs, r_in); + ecs_table_t *table = slice.table; + if (table) { + int32_t row, count = slice.count; + int32_t offset = slice.offset; - int32_t *t2s = table->storage_map; - int32_t *s2t = &table->storage_map[ids_count]; + if (!count) { + count = ecs_table_count(table); + ecs_assert(count != 0, ECS_INTERNAL_ERROR, NULL); + } else { + count += offset; + } - for (s = 0, t = 0; (t < ids_count) && (s < storage_ids_count); ) { - ecs_id_t id = ids[t]; - ecs_id_t storage_id = storage_ids[s]; + ecs_entity_t *entities = ecs_vector_first( + table->storage.entities, ecs_entity_t); + ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); - if (id == storage_id) { - t2s[t] = s; - s2t[s] = t; + /* If this is is not a redo, start from row 0, otherwise go to the + * next entity. */ + if (!redo) { + row = op_ctx->row = offset; } else { - t2s[t] = -1; + row = ++ op_ctx->row; } - /* Ids can never get ahead of storage id, as ids are a superset of the - * storage ids */ - ecs_assert(id <= storage_id, ECS_INTERNAL_ERROR, NULL); + /* If row exceeds number of entities in table, return false */ + if (row >= count) { + return false; + } - t += (id <= storage_id); - s += (id == storage_id); + /* Skip builtin entities that could confuse operations */ + e = entities[row]; + while (e == EcsWildcard || e == EcsThis || e == EcsAny) { + row ++; + if (row == count) { + return false; + } + e = entities[row]; + } + } else { + if (!redo) { + e = entity_reg_get(iter->rule, regs, r_in); + } else { + return false; + } } - /* Storage ids is always a subset of ids, so all should be iterated */ - ecs_assert(s == storage_ids_count, ECS_INTERNAL_ERROR, NULL); + /* Assign entity */ + entity_reg_set(iter->rule, regs, r_out, e); - /* Initialize remainder of type -> storage_type map */ - for (; (t < ids_count); t ++) { - t2s[t] = -1; - } + return true; } +/* Store operation. Stores entity in register. This can either be an entity + * literal or an entity variable that will be stored in a table register. The + * latter facilitates scenarios where an iterator only need to return a single + * entity but where the Yield returns tables. */ static -void init_storage_table( - ecs_world_t *world, - ecs_table_t *table) +bool eval_store( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - if (table->storage_table) { - return; + (void)op_index; + + if (redo) { + /* Only ever return result once */ + return false; } - - int32_t i, count = ecs_vector_count(table->type); - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); - ecs_ids_t storage_ids = { - .array = ecs_os_alloca_n(ecs_id_t, count) - }; - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_rule_reg_t *regs = get_registers(iter, op); + int32_t r_in = op->r_in; + int32_t r_out = op->r_out; - if ((id == ecs_id(EcsComponent)) || - (ECS_PAIR_FIRST(id) == ecs_id(EcsIdentifier))) - { - storage_ids.array[storage_ids.count ++] = id; - continue; + const ecs_rule_var_t *var_out = &rule->vars[r_out]; + if (var_out->kind == EcsRuleVarKindEntity) { + ecs_entity_t out, in = reg_get_entity(rule, op, regs, r_in); + + out = iter->registers[r_out].entity; + bool output_is_input = out && out != EcsWildcard; + + if (output_is_input && !redo) { + ecs_assert(regs[r_out].entity == iter->registers[r_out].entity, + ECS_INTERNAL_ERROR, NULL); + + if (out != in) { + /* If output variable is set it must match the input */ + return false; + } } - const EcsComponent *comp = flecs_component_from_id(world, id); - if (!comp || !comp->size) { - continue; + reg_set_entity(rule, regs, r_out, in); + } else { + ecs_table_slice_t out, in = reg_get_table(rule, op, regs, r_in); + + out = iter->registers[r_out].table; + bool output_is_input = out.table != NULL; + + if (output_is_input && !redo) { + ecs_assert(regs[r_out].entity == iter->registers[r_out].entity, + ECS_INTERNAL_ERROR, NULL); + + if (ecs_os_memcmp_t(&out, &in, ecs_table_slice_t)) { + /* If output variable is set it must match the input */ + return false; + } } - storage_ids.array[storage_ids.count ++] = id; - } - - if (storage_ids.count && storage_ids.count != count) { - table->storage_table = flecs_table_find_or_create(world, &storage_ids); - table->storage_type = table->storage_table->type; - table->storage_table->refcount ++; - ecs_assert(table->storage_table != NULL, ECS_INTERNAL_ERROR, NULL); - } else if (storage_ids.count) { - table->storage_table = table; - table->storage_type = table->storage_table->type; - ecs_assert(table->storage_table != NULL, ECS_INTERNAL_ERROR, NULL); - } + reg_set_table(rule, regs, r_out, in); - if (!table->storage_map) { - init_storage_map(table); + /* Ensure that if the input was an empty entity, information is not + * lost */ + if (!regs[r_out].table.table) { + regs[r_out].entity = reg_get_entity(rule, op, regs, r_in); + } } + + ecs_rule_filter_t filter = pair_to_filter(iter, op, op->filter); + set_term_vars(rule, regs, op->term, filter.mask); + + return true; } +/* A setjmp operation sets the jump label for a subsequent jump label. When the + * operation is first evaluated (redo=false) it sets the label to the on_pass + * label, and returns true. When the operation is evaluated again (redo=true) + * the label is set to on_fail and the operation returns false. */ static -ecs_flags32_t type_info_flags( - const ecs_type_info_t *ti) +bool eval_setjmp( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - ecs_flags32_t flags = 0; + ecs_rule_iter_t *iter = &it->priv.iter.rule; + ecs_rule_setjmp_ctx_t *ctx = &iter->op_ctx[op_index].is.setjmp; - if (ti->lifecycle.ctor) { - flags |= EcsTableHasCtors; - } - if (ti->lifecycle.dtor) { - flags |= EcsTableHasDtors; - } - if (ti->lifecycle.on_remove) { - flags |= EcsTableHasDtors; - } - if (ti->lifecycle.copy) { - flags |= EcsTableHasCopy; + if (!redo) { + ctx->label = op->on_pass; + return true; + } else { + ctx->label = op->on_fail; + return false; } - if (ti->lifecycle.move) { - flags |= EcsTableHasMove; - } - - return flags; } +/* The jump operation jumps to an operation label. The operation always returns + * true. Since the operation modifies the control flow of the program directly, + * the dispatcher does not look at the on_pass or on_fail labels of the jump + * instruction. Instead, the on_pass label is used to store the label of the + * operation that contains the label to jump to. */ static -void init_type_info( - ecs_world_t *world, - ecs_table_t *table) +bool eval_jump( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - ecs_table_t *storage_table = table->storage_table; - if (!storage_table) { - return; - } - - if (storage_table != table) { - /* Because the storage table is guaranteed to have the same components - * (but not tags) as this table, we can share the type info cache */ - table->type_info = storage_table->type_info; - table->flags |= storage_table->flags; - return; - } - - ecs_type_t type = table->storage_type; - ecs_assert(type != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t i, count = ecs_vector_count(type); + (void)it; + (void)op; + (void)op_index; - table->type_info = ecs_os_calloc_n(ecs_type_info_t*, count); + /* Passthrough, result is not used for control flow */ + return !redo; +} - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - ecs_entity_t t = ecs_get_typeid(world, id); +/* The not operation reverts the result of the operation it embeds */ +static +bool eval_not( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) +{ + (void)it; + (void)op; + (void)op_index; - /* Component type info must have been registered before using it */ - const ecs_type_info_t *ti = flecs_get_type_info(world, t); - ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); - table->flags |= type_info_flags(ti); - table->type_info[i] = (ecs_type_info_t*)ti; - } + return !redo; } -void flecs_table_init_data( - ecs_world_t *world, - ecs_table_t *table) +/* Check if entity is stored in table */ +static +bool eval_intable( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - init_storage_table(world, table); - init_type_info(world, table); - - int32_t sw_count = table->sw_column_count = switch_column_count(table); - int32_t bs_count = table->bs_column_count = bitset_column_count(table); + (void)op_index; + + if (redo) { + return false; + } - ecs_data_t *storage = &table->storage; - ecs_type_t type = table->storage_type; - - int32_t i, count = ecs_vector_count(type); - - /* Root tables don't have columns */ - if (!count && !sw_count && !bs_count) { - storage->columns = NULL; - } - - if (count) { - ecs_entity_t *ids = ecs_vector_first(type, ecs_entity_t); - storage->columns = ecs_os_calloc_n(ecs_column_t, count); - - for (i = 0; i < count; i ++) { - ecs_entity_t id = ids[i]; - - /* Bootstrap components */ - if (id == ecs_id(EcsComponent)) { - storage->columns[i].size = ECS_SIZEOF(EcsComponent); - storage->columns[i].alignment = ECS_ALIGNOF(EcsComponent); - continue; - } else if (ECS_PAIR_FIRST(id) == ecs_id(EcsIdentifier)) { - storage->columns[i].size = ECS_SIZEOF(EcsIdentifier); - storage->columns[i].alignment = ECS_ALIGNOF(EcsIdentifier); - continue; - } - - const EcsComponent *component = flecs_component_from_id(world, id); - ecs_assert(component != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(component->size != 0, ECS_INTERNAL_ERROR, NULL); - - storage->columns[i].size = flecs_itoi16(component->size); - storage->columns[i].alignment = flecs_itoi16(component->alignment); - } - } - - if (sw_count) { - ecs_entity_t *ids = ecs_vector_first(table->type, ecs_entity_t); - int32_t sw_offset = table->sw_column_offset; - storage->sw_columns = ecs_os_calloc_n(ecs_sw_column_t, sw_count); - - for (i = 0; i < sw_count; i ++) { - ecs_entity_t e = ids[i + sw_offset]; - ecs_assert(ECS_HAS_ROLE(e, SWITCH), ECS_INTERNAL_ERROR, NULL); - e = e & ECS_COMPONENT_MASK; - const EcsType *type_ptr = ecs_get(world, e, EcsType); - ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_table_t *sw_table = type_ptr->normalized; - ecs_type_t sw_type = sw_table->type; - - ecs_entity_t *sw_array = ecs_vector_first(sw_type, ecs_entity_t); - int32_t sw_array_count = ecs_vector_count(sw_type); - - ecs_switch_t *sw = flecs_switch_new( - sw_array[0], - sw_array[sw_array_count - 1], - 0); + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + ecs_world_t *world = rule->world; + ecs_rule_reg_t *regs = get_registers(iter, op); + ecs_table_t *table = table_reg_get(rule, regs, op->r_in).table; - storage->sw_columns[i].data = sw; - storage->sw_columns[i].type = sw_table; - } - } + ecs_rule_pair_t pair = op->filter; + ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); + ecs_entity_t obj = ECS_PAIR_SECOND(filter.mask); + ecs_assert(obj != 0 && obj != EcsWildcard, ECS_INTERNAL_ERROR, NULL); + obj = ecs_get_alive(world, obj); + ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); - if (bs_count) { - storage->bs_columns = ecs_os_calloc_n(ecs_bs_column_t, bs_count); - for (i = 0; i < bs_count; i ++) { - flecs_bitset_init(&storage->bs_columns[i].data); - } - } + ecs_table_t *obj_table = ecs_get_table(world, obj); + return obj_table == table; } +/* Yield operation. This is the simplest operation, as all it does is return + * false. This will move the solver back to the previous instruction which + * forces redo's on previous operations, for as long as there are matching + * results. */ static -void notify_trigger( - ecs_world_t *world, - ecs_table_t *table, - ecs_entity_t event) +bool eval_yield( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - (void)world; + (void)it; + (void)op; + (void)op_index; + (void)redo; - if (event == EcsOnAdd) { - table->flags |= EcsTableHasOnAdd; - } else if (event == EcsOnRemove) { - table->flags |= EcsTableHasOnRemove; - } else if (event == EcsOnSet) { - table->flags |= EcsTableHasOnSet; - } else if (event == EcsUnSet) { - table->flags |= EcsTableHasUnSet; - } + /* Yield always returns false, because there are never any operations after + * a yield. */ + return false; } +/* Dispatcher for operations */ static -void run_on_remove( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data) +bool eval_op( + ecs_iter_t *it, + ecs_rule_op_t *op, + int32_t op_index, + bool redo) { - int32_t count = ecs_vector_count(data->entities); - if (count) { - ecs_ids_t removed = { - .array = ecs_vector_first(table->type, ecs_id_t), - .count = ecs_vector_count(table->type) - }; - - ecs_table_diff_t diff = { - .removed = removed, - .un_set = removed - }; - - flecs_notify_on_remove(world, table, NULL, 0, count, &diff); + switch(op->kind) { + case EcsRuleInput: + return eval_input(it, op, op_index, redo); + case EcsRuleSelect: + return eval_select(it, op, op_index, redo); + case EcsRuleWith: + return eval_with(it, op, op_index, redo); + case EcsRuleSubSet: + return eval_subset(it, op, op_index, redo); + case EcsRuleSuperSet: + return eval_superset(it, op, op_index, redo); + case EcsRuleEach: + return eval_each(it, op, op_index, redo); + case EcsRuleStore: + return eval_store(it, op, op_index, redo); + case EcsRuleSetJmp: + return eval_setjmp(it, op, op_index, redo); + case EcsRuleJump: + return eval_jump(it, op, op_index, redo); + case EcsRuleNot: + return eval_not(it, op, op_index, redo); + case EcsRuleInTable: + return eval_intable(it, op, op_index, redo); + case EcsRuleYield: + return eval_yield(it, op, op_index, redo); + default: + return false; } } -/* -- Private functions -- */ - +/* Utility to copy all registers to the next frame. Keeping track of register + * values for each operation is necessary, because if an operation is asked to + * redo matching, it must to be able to pick up from where it left of */ static -void ctor_component( - ecs_world_t *world, - ecs_type_info_t *ti, - ecs_column_t *column, - ecs_entity_t *entities, - int32_t row, - int32_t count) +void push_registers( + ecs_rule_iter_t *it, + int32_t cur, + int32_t next) { - /* A new component is constructed */ - ecs_xtor_t ctor; - if (ti && (ctor = ti->lifecycle.ctor)) { - int16_t size = column->size; - int16_t alignment = column->alignment; - void *ptr = ecs_vector_get_t(column->data, size, alignment, row); - ctor(world, entities, ptr, count, ti); + if (!it->rule->var_count) { + return; } -} -static -void on_remove_component( - ecs_world_t *world, - ecs_table_t *table, - ecs_iter_action_t on_remove, - void *ptr, - ecs_size_t size, - ecs_entity_t *entities, - ecs_id_t id, - int32_t count, - void *ctx) -{ - ecs_iter_t it = { .term_count = 1 }; - it.entities = entities; + ecs_rule_reg_t *src_regs = get_register_frame(it, cur); + ecs_rule_reg_t *dst_regs = get_register_frame(it, next); - flecs_iter_init(&it); - it.world = world; - it.real_world = world; - it.table = table; - it.type = table->type; - it.ptrs[0] = ptr; - it.sizes[0] = size; - it.ids[0] = id; - it.event = EcsOnRemove; - it.event_id = id; - it.ctx = ctx; - it.count = count; - on_remove(&it); + ecs_os_memcpy_n(dst_regs, src_regs, + ecs_rule_reg_t, it->rule->var_count); } +/* Utility to copy all columns to the next frame. Columns keep track of which + * columns are currently being evaluated for a table, and are populated by the + * Select and With operations. The columns array is important, as it is used + * to tell the application where to find component data. */ static -void dtor_component( - ecs_world_t *world, - ecs_table_t *table, - ecs_type_info_t *ti, - ecs_column_t *column, - ecs_entity_t *entities, - ecs_id_t id, - int32_t row, - int32_t count, - bool is_remove) +void push_columns( + ecs_rule_iter_t *it, + int32_t cur, + int32_t next) { - if (!count) { - return; - } - - if (!ti) { - return; - } - - ecs_iter_action_t on_remove = 0; - if (is_remove) { - on_remove = ti->lifecycle.on_remove; - } - - ecs_xtor_t dtor = ti->lifecycle.dtor; - if (!on_remove && !dtor) { + if (!it->rule->filter.term_count) { return; } - void *ctx = ti->lifecycle.ctx; - int16_t size = column->size; - int16_t alignment = column->alignment; - ecs_entity_t *entity_elem = &entities[row]; - - ecs_assert(column->data != NULL, ECS_INTERNAL_ERROR, NULL); - void *ptr = ecs_vector_get_t(column->data, size, alignment, row); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - - if (on_remove) { - on_remove_component(world, table, on_remove, ptr, size, - entity_elem, id, count, ctx); - } + int32_t *src_cols = rule_get_columns_frame(it, cur); + int32_t *dst_cols = rule_get_columns_frame(it, next); - if (dtor) { - dtor(world, entity_elem, ptr, count, ti); - } + ecs_os_memcpy_n(dst_cols, src_cols, int32_t, it->rule->filter.term_count); } +/* Populate iterator with data before yielding to application */ static -void dtor_all_components( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t row, - int32_t count, - bool update_entity_index, - bool is_delete) +void populate_iterator( + const ecs_rule_t *rule, + ecs_iter_t *iter, + ecs_rule_iter_t *it, + ecs_rule_op_t *op) { - /* Can't delete and not update the entity index */ - ecs_assert(!is_delete || update_entity_index, ECS_INTERNAL_ERROR, NULL); + ecs_world_t *world = rule->world; + int32_t r = op->r_in; + ecs_rule_reg_t *regs = get_register_frame(it, op->frame); + ecs_table_t *table = NULL; + int32_t count = 0; + int32_t offset = 0; - ecs_id_t *ids = ecs_vector_first(table->storage_type, ecs_id_t); - ecs_record_t **records = ecs_vector_first(data->record_ptrs, ecs_record_t*); - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - int32_t i, c, end = row + count; - int32_t column_count = ecs_vector_count(table->storage_type); + /* If the input register for the yield does not point to a variable, + * the rule doesn't contain a this (.) variable. In that case, the + * iterator doesn't contain any data, and this function will simply + * return true or false. An application will still be able to obtain + * the variables that were resolved. */ + if (r != UINT8_MAX) { + const ecs_rule_var_t *var = &rule->vars[r]; + ecs_rule_reg_t *reg = ®s[r]; - (void)records; + if (var->kind == EcsRuleVarKindTable) { + ecs_table_slice_t slice = table_reg_get(rule, regs, r); + table = slice.table; + count = slice.count; + offset = slice.offset; + } else { + /* If a single entity is returned, simply return the + * iterator with count 1 and a pointer to the entity id */ + ecs_assert(var->kind == EcsRuleVarKindEntity, + ECS_INTERNAL_ERROR, NULL); - /* If table has components with destructors, iterate component columns */ - if (table->flags & EcsTableHasDtors) { - /* Prevent the storage from getting modified while deleting */ - ecs_defer_begin(world); + ecs_entity_t e = reg->entity; + ecs_record_t *record = ecs_eis_get(world, e); + offset = ECS_RECORD_TO_ROW(record->row); - /* Throw up a lock just to be sure */ - table->lock = true; + /* If an entity is not stored in a table, it could not have + * been matched by anything */ + ecs_assert(record != NULL, ECS_INTERNAL_ERROR, NULL); + table = record->table; + count = 1; + } + } - /* Run on_remove callbacks in bulk for improved performance */ - for (c = 0; c < column_count; c++) { - ecs_column_t *column = &data->columns[c]; - ecs_type_info_t *cdata = table->type_info[c]; - if (!cdata) { - continue; - } + int32_t i, var_count = rule->var_count; + int32_t term_count = rule->filter.term_count; + iter->variables = it->variables; - ecs_iter_action_t on_remove = cdata->lifecycle.on_remove; - if (on_remove) { - ecs_size_t size = column->size; - ecs_size_t align = column->alignment; - void *ptr = ecs_vector_get_t(column->data, size, align, row); - on_remove_component(world, table, on_remove, ptr, column->size, - &entities[row], ids[c], count, cdata->lifecycle.ctx); - } + for (i = 0; i < var_count; i ++) { + if (rule->vars[i].kind == EcsRuleVarKindEntity) { + it->variables[i] = regs[i].entity; + } else { + it->variables[i] = 0; } + } - /* Iterate entities first, then components. This ensures that only one - * entity is invalidated at a time, which ensures that destructors can - * safely access other entities. */ - for (i = row; i < end; i ++) { - for (c = 0; c < column_count; c++) { - ecs_column_t *column = &data->columns[c]; - dtor_component(world, table, table->type_info[c], column, - entities, ids[c], i, 1, false); + for (i = 0; i < term_count; i ++) { + int32_t v = rule->term_vars[i].subj; + if (v != -1) { + const ecs_rule_var_t *var = &rule->vars[v]; + if (var->name[0] != '.') { + if (var->kind == EcsRuleVarKindEntity) { + iter->subjects[i] = regs[var->id].entity; + } else { + /* This can happen for Any variables, where the actual + * content of the variable is not of interest to the query. + * Just pick the first entity from the table, so that the + * column can be correctly resolved */ + ecs_table_t *t = regs[var->id].table.table; + if (t) { + iter->subjects[i] = ecs_vector_first( + t->storage.entities, ecs_entity_t)[0]; + } else { + /* Can happen if term is optional */ + iter->subjects[i] = 0; + } + } } + } + } - /* Update entity index after invoking destructors so that entity can - * be safely used in destructor callbacks. */ - if (update_entity_index) { - ecs_entity_t e = entities[i]; - ecs_assert(!e || ecs_is_valid(world, e), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i] == ecs_eis_get(world, e), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i]->table == table, - ECS_INTERNAL_ERROR, NULL); + /* Iterator expects column indices to start at 1 */ + iter->columns = rule_get_columns_frame(it, op->frame); + for (i = 0; i < term_count; i ++) { + ecs_entity_t subj = iter->subjects[i]; + int32_t c = ++ iter->columns[i]; + if (!subj) { + subj = iter->terms[i].subj.entity; + if (subj != EcsThis && subj != EcsAny) { + iter->columns[i] = 0; + } + } else if (c) { + iter->columns[i] = -1; + } + } - if (is_delete) { - ecs_eis_delete(world, e); - ecs_assert(ecs_is_valid(world, e) == false, - ECS_INTERNAL_ERROR, NULL); - } else { - // If this is not a delete, clear the entity index record - records[i]->table = NULL; - records[i]->row = 0; - } - } else { - /* This should only happen in rare cases, such as when the data - * cleaned up is not part of the world (like with snapshots) */ + /* Set iterator ids */ + for (i = 0; i < term_count; i ++) { + const ecs_rule_term_vars_t *vars = &rule->term_vars[i]; + ecs_term_t *term = &rule->filter.terms[i]; + if (term->oper == EcsOptional || term->oper == EcsNot) { + if (iter->columns[i] == 0) { + iter->ids[i] = term->id; + continue; } } - table->lock = false; - - ecs_defer_end(world); + ecs_id_t id = term->id; + ecs_entity_t pred = 0; + ecs_entity_t obj = 0; + bool is_pair = ECS_HAS_ROLE(id, PAIR); - /* If table does not have destructors, just update entity index */ - } else if (update_entity_index) { - if (is_delete) { - for (i = row; i < end; i ++) { - ecs_entity_t e = entities[i]; - ecs_assert(!e || ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i] == ecs_eis_get(world, e), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i]->table == table, - ECS_INTERNAL_ERROR, NULL); + if (!is_pair) { + pred = id; + } else { + pred = ECS_PAIR_FIRST(id); + obj = ECS_PAIR_SECOND(id); + } - ecs_eis_delete(world, e); - ecs_assert(!ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); - } + if (vars->pred != -1) { + pred = regs[vars->pred].entity; + } + if (vars->obj != -1) { + ecs_assert(is_pair, ECS_INTERNAL_ERROR, NULL); + obj = regs[vars->obj].entity; + } + + if (!is_pair) { + id = pred; } else { - for (i = row; i < end; i ++) { - ecs_entity_t e = entities[i]; - ecs_assert(!e || ecs_is_valid(world, e), ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i] == ecs_eis_get(world, e), - ECS_INTERNAL_ERROR, NULL); - ecs_assert(!e || records[i]->table == table, - ECS_INTERNAL_ERROR, NULL); - records[i]->table = NULL; - records[i]->row = 0; - (void)e; - } - } + id = ecs_pair(pred, obj); + } + + iter->ids[i] = id; } + + flecs_iter_populate_data(world, iter, table, offset, count, + iter->ptrs, iter->sizes); } static -void fini_data( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - bool do_on_remove, - bool update_entity_index, - bool is_delete, - bool deactivate) +bool is_control_flow( + ecs_rule_op_t *op) { - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - - if (!data) { - return; + switch(op->kind) { + case EcsRuleSetJmp: + case EcsRuleJump: + return true; + default: + return false; } +} - ecs_flags32_t flags = table->flags; +bool ecs_rule_next( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_rule_next, ECS_INVALID_PARAMETER, NULL); - if (do_on_remove && (flags & EcsTableHasOnRemove)) { - run_on_remove(world, table, data); + if (flecs_iter_next_row(it)) { + return true; } - int32_t count = flecs_table_data_count(data); - if (count) { - dtor_all_components(world, table, data, 0, count, - update_entity_index, is_delete); - } + return flecs_iter_next_instanced(it, ecs_rule_next_instanced(it)); +error: + return false; +} - /* Sanity check */ - ecs_assert(ecs_vector_count(data->record_ptrs) == - ecs_vector_count(data->entities), ECS_INTERNAL_ERROR, NULL); +/* Iterator next function. This evaluates the program until it reaches a Yield + * operation, and returns the intermediate result(s) to the application. An + * iterator can, depending on the program, either return a table, entity, or + * just true/false, in case a rule doesn't contain the this variable. */ +bool ecs_rule_next_instanced( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_rule_next, ECS_INVALID_PARAMETER, NULL); - ecs_column_t *columns = data->columns; - if (columns) { - int32_t c, column_count = ecs_vector_count(table->storage_type); - for (c = 0; c < column_count; c ++) { - /* Sanity check */ - ecs_assert(!columns[c].data || (ecs_vector_count(columns[c].data) == - ecs_vector_count(data->entities)), ECS_INTERNAL_ERROR, NULL); + ecs_rule_iter_t *iter = &it->priv.iter.rule; + const ecs_rule_t *rule = iter->rule; + bool redo = iter->redo; + int32_t last_frame = -1; + bool init_subjects = it->subjects == NULL; - ecs_vector_free(columns[c].data); + /* Can't iterate an iterator that's already depleted */ + ecs_check(iter->op != -1, ECS_INVALID_PARAMETER, NULL); + + flecs_iter_init(it); + + /* Make sure that if there are any terms with literal subjects, they're + * initialized in the subjects array */ + if (init_subjects) { + int32_t i; + for (i = 0; i < rule->filter.term_count; i ++) { + ecs_term_t *t = &rule->filter.terms[i]; + ecs_term_id_t *subj = &t->subj; + ecs_assert(subj->var == EcsVarIsVariable || subj->entity != EcsThis, + ECS_INTERNAL_ERROR, NULL); + + if (subj->var == EcsVarIsEntity) { + it->subjects[i] = subj->entity; + } } - ecs_os_free(columns); - data->columns = NULL; } - ecs_sw_column_t *sw_columns = data->sw_columns; - if (sw_columns) { - int32_t c, column_count = table->sw_column_count; - for (c = 0; c < column_count; c ++) { - flecs_switch_free(sw_columns[c].data); + do { + /* Evaluate an operation. The result of an operation determines the + * flow of the program. If an operation returns true, the program + * continues to the operation pointed to by 'on_pass'. If the operation + * returns false, the program continues to the operation pointed to by + * 'on_fail'. + * + * In most scenarios, on_pass points to the next operation, and on_fail + * points to the previous operation. + * + * When an operation fails, the previous operation will be invoked with + * redo=true. This will cause the operation to continue its search from + * where it left off. When the operation succeeds, the next operation + * will be invoked with redo=false. This causes the operation to start + * from the beginning, which is necessary since it just received a new + * input. */ + int32_t op_index = iter->op; + ecs_rule_op_t *op = &rule->operations[op_index]; + int32_t cur = op->frame; + + /* If this is not the first operation and is also not a control flow + * operation, push a new frame on the stack for the next operation */ + if (!redo && !is_control_flow(op) && cur && cur != last_frame) { + int32_t prev = cur - 1; + push_registers(iter, prev, cur); + push_columns(iter, prev, cur); } - ecs_os_free(sw_columns); - data->sw_columns = NULL; - } - ecs_bs_column_t *bs_columns = data->bs_columns; - if (bs_columns) { - int32_t c, column_count = table->bs_column_count; - for (c = 0; c < column_count; c ++) { - flecs_bitset_fini(&bs_columns[c].data); + /* Dispatch the operation */ + bool result = eval_op(it, op, op_index, redo); + iter->op = result ? op->on_pass : op->on_fail; + + /* If the current operation is yield, return results */ + if (op->kind == EcsRuleYield) { + populate_iterator(rule, it, iter, op); + iter->redo = true; + return true; } - ecs_os_free(bs_columns); - data->bs_columns = NULL; - } - ecs_vector_free(data->entities); - ecs_vector_free(data->record_ptrs); + /* If the current operation is a jump, goto stored label */ + if (op->kind == EcsRuleJump) { + /* Label is stored in setjmp context */ + iter->op = iter->op_ctx[op->on_pass].is.setjmp.label; + } - data->entities = NULL; - data->record_ptrs = NULL; + /* If jumping backwards, it's a redo */ + redo = iter->op <= op_index; - if (deactivate && count) { - flecs_table_set_empty(world, table); - } -} + if (!is_control_flow(op)) { + last_frame = op->frame; + } + } while (iter->op != -1); -/* Cleanup, no OnRemove, don't update entity index, don't deactivate table */ -void flecs_table_clear_data( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data) -{ - fini_data(world, table, data, false, false, false, false); -} + ecs_iter_fini(it); -/* Cleanup, no OnRemove, clear entity index, deactivate table */ -void flecs_table_clear_entities_silent( - ecs_world_t *world, - ecs_table_t *table) -{ - fini_data(world, table, &table->storage, false, true, false, true); +error: + return false; } -/* Cleanup, run OnRemove, clear entity index, deactivate table */ -void flecs_table_clear_entities( - ecs_world_t *world, - ecs_table_t *table) -{ - fini_data(world, table, &table->storage, true, true, false, true); -} +#endif -/* Cleanup, run OnRemove, delete from entity index, deactivate table */ -void flecs_table_delete_entities( - ecs_world_t *world, - ecs_table_t *table) + +#ifdef FLECS_MODULE + +#include + +char* ecs_module_path_from_c( + const char *c_name) { - fini_data(world, table, &table->storage, true, true, true, true); + ecs_strbuf_t str = ECS_STRBUF_INIT; + const char *ptr; + char ch; + + for (ptr = c_name; (ch = *ptr); ptr++) { + if (isupper(ch)) { + ch = flecs_ito(char, tolower(ch)); + if (ptr != c_name) { + ecs_strbuf_appendstrn(&str, ".", 1); + } + } + + ecs_strbuf_appendstrn(&str, &ch, 1); + } + + return ecs_strbuf_get(&str); } -/* Unset all components in table. This function is called before a table is - * deleted, and invokes all UnSet handlers, if any */ -void flecs_table_remove_actions( +ecs_entity_t ecs_import( ecs_world_t *world, - ecs_table_t *table) + ecs_module_action_t init_action, + const char *module_name) { - (void)world; - run_on_remove(world, table, &table->storage); + ecs_check(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); + + ecs_entity_t old_scope = ecs_set_scope(world, 0); + const char *old_name_prefix = world->name_prefix; + + char *path = ecs_module_path_from_c(module_name); + ecs_entity_t e = ecs_lookup_fullpath(world, path); + ecs_os_free(path); + + if (!e) { + ecs_trace("#[magenta]import#[reset] %s", module_name); + ecs_log_push(); + + /* Load module */ + init_action(world); + + /* Lookup module entity (must be registered by module) */ + e = ecs_lookup_fullpath(world, module_name); + ecs_check(e != 0, ECS_MODULE_UNDEFINED, module_name); + + ecs_log_pop(); + } + + /* Restore to previous state */ + ecs_set_scope(world, old_scope); + world->name_prefix = old_name_prefix; + + return e; +error: + return 0; } -/* Free table resources. */ -void flecs_table_free( +ecs_entity_t ecs_import_from_library( ecs_world_t *world, - ecs_table_t *table) + const char *library_name, + const char *module_name) { - bool is_root = table == &world->store.root; - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_assert(is_root || table->id != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(is_root || flecs_sparse_is_alive(&world->store.tables, table->id), - ECS_INTERNAL_ERROR, NULL); - (void)world; + ecs_check(library_name != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(table->refcount == 0, ECS_INTERNAL_ERROR, NULL); + char *import_func = (char*)module_name; /* safe */ + char *module = (char*)module_name; - if (!is_root) { - flecs_notify_queries( - world, &(ecs_query_event_t){ - .kind = EcsQueryTableUnmatch, - .table = table - }); + if (!ecs_os_has_modules() || !ecs_os_has_dl()) { + ecs_err( + "library loading not supported, set module_to_dl, dlopen, dlclose " + "and dlproc os API callbacks first"); + return 0; } - if (ecs_should_log_2()) { - char *expr = ecs_type_str(world, table->type); - ecs_dbg_2( - "#[green]table#[normal] [%s] #[red]deleted#[normal] with id %d", - expr, table->id); - ecs_os_free(expr); - } + /* If no module name is specified, try default naming convention for loading + * the main module from the library */ + if (!import_func) { + import_func = ecs_os_malloc(ecs_os_strlen(library_name) + ECS_SIZEOF("Import")); + ecs_assert(import_func != NULL, ECS_OUT_OF_MEMORY, NULL); + + const char *ptr; + char ch, *bptr = import_func; + bool capitalize = true; + for (ptr = library_name; (ch = *ptr); ptr ++) { + if (ch == '.') { + capitalize = true; + } else { + if (capitalize) { + *bptr = flecs_ito(char, toupper(ch)); + bptr ++; + capitalize = false; + } else { + *bptr = flecs_ito(char, tolower(ch)); + bptr ++; + } + } + } - /* Cleanup data, no OnRemove, delete from entity index, don't deactivate */ - fini_data(world, table, &table->storage, false, true, true, false); + *bptr = '\0'; - flecs_table_clear_edges(world, table); + module = ecs_os_strdup(import_func); + ecs_assert(module != NULL, ECS_OUT_OF_MEMORY, NULL); - if (!is_root) { - ecs_ids_t ids = { - .array = ecs_vector_first(table->type, ecs_id_t), - .count = ecs_vector_count(table->type) - }; + ecs_os_strcat(bptr, "Import"); + } - flecs_hashmap_remove(&world->store.table_map, &ids, ecs_table_t*); + char *library_filename = ecs_os_module_to_dl(library_name); + if (!library_filename) { + ecs_err("failed to find library file for '%s'", library_name); + if (module != module_name) { + ecs_os_free(module); + } + return 0; + } else { + ecs_trace("found file '%s' for library '%s'", + library_filename, library_name); } - ecs_os_free(table->dirty_state); - ecs_os_free(table->storage_map); + ecs_os_dl_t dl = ecs_os_dlopen(library_filename); + if (!dl) { + ecs_err("failed to load library '%s' ('%s')", + library_name, library_filename); + + ecs_os_free(library_filename); - flecs_table_records_unregister(world, table); + if (module != module_name) { + ecs_os_free(module); + } - ecs_table_t *storage_table = table->storage_table; - if (storage_table == table) { - if (table->type_info) { - ecs_os_free(table->type_info); - } - } else if (storage_table) { - flecs_table_release(world, storage_table); + return 0; + } else { + ecs_trace("library '%s' ('%s') loaded", + library_name, library_filename); } - if (!world->is_fini) { - ecs_assert(!is_root, ECS_INTERNAL_ERROR, NULL); - flecs_table_free_type(table); - flecs_sparse_remove(&world->store.tables, table->id); + ecs_module_action_t action = (ecs_module_action_t) + ecs_os_dlproc(dl, import_func); + if (!action) { + ecs_err("failed to load import function %s from library %s", + import_func, library_name); + ecs_os_free(library_filename); + ecs_os_dlclose(dl); + return 0; + } else { + ecs_trace("found import function '%s' in library '%s' for module '%s'", + import_func, library_name, module); } -} -void flecs_table_claim( - ecs_world_t *world, - ecs_table_t *table) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table->refcount > 0, ECS_INTERNAL_ERROR, NULL); - table->refcount ++; - (void)world; -} + /* Do not free id, as it will be stored as the component identifier */ + ecs_entity_t result = ecs_import(world, action, module); -bool flecs_table_release( - ecs_world_t *world, - ecs_table_t *table) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table->refcount > 0, ECS_INTERNAL_ERROR, NULL); + if (import_func != module_name) { + ecs_os_free(import_func); + } - if (--table->refcount == 0) { - flecs_table_free(world, table); - return true; + if (module != module_name) { + ecs_os_free(module); } - - return false; -} -/* Free table type. Do this separately from freeing the table as types can be - * in use by application destructors. */ -void flecs_table_free_type( - ecs_table_t *table) -{ - ecs_vector_free((ecs_vector_t*)table->type); -} + ecs_os_free(library_filename); -/* Reset a table to its initial state. */ -void flecs_table_reset( - ecs_world_t *world, - ecs_table_t *table) -{ - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - flecs_table_clear_edges(world, table); + return result; +error: + return 0; } -static -void mark_table_dirty( +ecs_entity_t ecs_module_init( ecs_world_t *world, - ecs_table_t *table, - int32_t index) + const ecs_component_desc_t *desc) { - (void)world; - if (table->dirty_state) { - table->dirty_state[index] ++; - } -} + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_poly_assert(world, ecs_world_t); -void flecs_table_mark_dirty( - ecs_world_t *world, - ecs_table_t *table, - ecs_entity_t component) -{ - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + const char *name = desc->entity.name; - if (table->dirty_state) { - int32_t index = ecs_search(world, table->storage_table, component, 0); - ecs_assert(index != -1, ECS_INTERNAL_ERROR, NULL); - table->dirty_state[index + 1] ++; + char *module_path = ecs_module_path_from_c(name); + ecs_entity_t e = ecs_new_from_fullpath(world, module_path); + ecs_set_symbol(world, e, module_path); + ecs_os_free(module_path); + + ecs_component_desc_t private_desc = *desc; + private_desc.entity.entity = e; + private_desc.entity.name = NULL; + + if (desc->size) { + ecs_entity_t result = ecs_component_init(world, &private_desc); + ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(result == e, ECS_INTERNAL_ERROR, NULL); + (void)result; + } else { + ecs_entity_t result = ecs_entity_init(world, &private_desc.entity); + ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(result == e, ECS_INTERNAL_ERROR, NULL); + (void)result; } + + return e; +error: + return 0; } -static -void move_switch_columns( - ecs_table_t *new_table, - ecs_data_t *new_data, - int32_t new_index, - ecs_table_t *old_table, - ecs_data_t *old_data, - int32_t old_index, - int32_t count, - bool clear) -{ - int32_t i_old = 0, old_column_count = old_table->sw_column_count; - int32_t i_new = 0, new_column_count = new_table->sw_column_count; +#endif - if (!old_column_count && !new_column_count) { - return; - } +#ifndef FLECS_META_PRIVATE_H +#define FLECS_META_PRIVATE_H - ecs_sw_column_t *old_columns = old_data->sw_columns; - ecs_sw_column_t *new_columns = new_data->sw_columns; - ecs_type_t new_type = new_table->type; - ecs_type_t old_type = old_table->type; +#ifdef FLECS_META - int32_t offset_new = new_table->sw_column_offset; - int32_t offset_old = old_table->sw_column_offset; +void ecs_meta_type_serialized_init( + ecs_iter_t *it); - ecs_id_t *new_ids = ecs_vector_first(new_type, ecs_id_t); - ecs_id_t *old_ids = ecs_vector_first(old_type, ecs_id_t); +void ecs_meta_dtor_serialized( + EcsMetaTypeSerialized *ptr); - for (; (i_new < new_column_count) && (i_old < old_column_count);) { - ecs_entity_t new_id = new_ids[i_new + offset_new]; - ecs_entity_t old_id = old_ids[i_old + offset_old]; - if (new_id == old_id) { - ecs_switch_t *old_switch = old_columns[i_old].data; - ecs_switch_t *new_switch = new_columns[i_new].data; +bool flecs_unit_validate( + ecs_world_t *world, + ecs_entity_t t, + EcsUnit *data); - flecs_switch_ensure(new_switch, new_index + count); +#endif + +#endif - int i; - for (i = 0; i < count; i ++) { - uint64_t value = flecs_switch_get(old_switch, old_index + i); - flecs_switch_set(new_switch, new_index + i, value); - } - if (clear) { - ecs_assert(count == flecs_switch_count(old_switch), - ECS_INTERNAL_ERROR, NULL); - flecs_switch_clear(old_switch); - } - } +#ifdef FLECS_META - i_new += new_id <= old_id; - i_old += new_id >= old_id; +ecs_entity_t ecs_primitive_init( + ecs_world_t *world, + const ecs_primitive_desc_t *desc) +{ + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; } - /* Clear remaining columns */ - if (clear) { - for (; (i_old < old_column_count); i_old ++) { - ecs_switch_t *old_switch = old_columns[i_old].data; - ecs_assert(count == flecs_switch_count(old_switch), - ECS_INTERNAL_ERROR, NULL); - flecs_switch_clear(old_switch); - } - } + ecs_set(world, t, EcsPrimitive, { desc->kind }); + + return t; } -static -void move_bitset_columns( - ecs_table_t *new_table, - ecs_data_t *new_data, - int32_t new_index, - ecs_table_t *old_table, - ecs_data_t *old_data, - int32_t old_index, - int32_t count, - bool clear) +ecs_entity_t ecs_enum_init( + ecs_world_t *world, + const ecs_enum_desc_t *desc) { - int32_t i_old = 0, old_column_count = old_table->bs_column_count; - int32_t i_new = 0, new_column_count = new_table->bs_column_count; - - if (!old_column_count && !new_column_count) { - return; + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; } - ecs_bs_column_t *old_columns = old_data->bs_columns; - ecs_bs_column_t *new_columns = new_data->bs_columns; - - ecs_type_t new_type = new_table->type; - ecs_type_t old_type = old_table->type; - - int32_t offset_new = new_table->bs_column_offset; - int32_t offset_old = old_table->bs_column_offset; - - ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); - ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - - for (; (i_new < new_column_count) && (i_old < old_column_count);) { - ecs_entity_t new_component = new_components[i_new + offset_new]; - ecs_entity_t old_component = old_components[i_old + offset_old]; + ecs_add(world, t, EcsEnum); - if (new_component == old_component) { - ecs_bitset_t *old_bs = &old_columns[i_old].data; - ecs_bitset_t *new_bs = &new_columns[i_new].data; + ecs_entity_t old_scope = ecs_set_scope(world, t); - flecs_bitset_ensure(new_bs, new_index + count); + int i; + for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { + const ecs_enum_constant_t *m_desc = &desc->constants[i]; + if (!m_desc->name) { + break; + } - int i; - for (i = 0; i < count; i ++) { - uint64_t value = flecs_bitset_get(old_bs, old_index + i); - flecs_bitset_set(new_bs, new_index + i, value); - } + ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = m_desc->name + }); - if (clear) { - ecs_assert(count == flecs_bitset_count(old_bs), - ECS_INTERNAL_ERROR, NULL); - flecs_bitset_fini(old_bs); - } + if (!m_desc->value) { + ecs_add_id(world, c, EcsConstant); + } else { + ecs_set_pair_object(world, c, EcsConstant, ecs_i32_t, + {m_desc->value}); } - - i_new += new_component <= old_component; - i_old += new_component >= old_component; } - /* Clear remaining columns */ - if (clear) { - for (; (i_old < old_column_count); i_old ++) { - ecs_bitset_t *old_bs = &old_columns[i_old].data; - ecs_assert(count == flecs_bitset_count(old_bs), - ECS_INTERNAL_ERROR, NULL); - flecs_bitset_fini(old_bs); - } + ecs_set_scope(world, old_scope); + + if (i == 0) { + ecs_err("enum '%s' has no constants", ecs_get_name(world, t)); + ecs_delete(world, t); + return 0; } + + return t; } -static -void grow_column( +ecs_entity_t ecs_bitmask_init( ecs_world_t *world, - ecs_entity_t *entities, - ecs_column_t *column, - ecs_type_info_t *ti, - int32_t to_add, - int32_t new_size, - bool construct) + const ecs_bitmask_desc_t *desc) { - ecs_vector_t *vec = column->data; - int16_t alignment = column->alignment; - - int32_t size = column->size; - int32_t count = ecs_vector_count(vec); - int32_t old_size = ecs_vector_size(vec); - int32_t new_count = count + to_add; - bool can_realloc = new_size != old_size; - - ecs_assert(new_size >= new_count, ECS_INTERNAL_ERROR, NULL); - - /* If the array could possibly realloc and the component has a move action - * defined, move old elements manually */ - ecs_move_t move_ctor; - if (ti && count && can_realloc && - (move_ctor = ti->lifecycle.move_ctor)) - { - ecs_xtor_t ctor = ti->lifecycle.ctor; - ecs_assert(ctor != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(move_ctor != NULL, ECS_INTERNAL_ERROR, NULL); - - /* Create new vector */ - ecs_vector_t *new_vec = ecs_vector_new_t(size, alignment, new_size); - ecs_vector_set_count_t(&new_vec, size, alignment, new_count); + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; + } - void *old_buffer = ecs_vector_first_t(vec, size, alignment); - void *new_buffer = ecs_vector_first_t(new_vec, size, alignment); + ecs_add(world, t, EcsBitmask); - /* Move (and construct) existing elements to new vector */ - move_ctor(world, entities, entities, new_buffer, old_buffer, count, ti); + ecs_entity_t old_scope = ecs_set_scope(world, t); - if (construct) { - /* Construct new element(s) */ - void *elem = ECS_OFFSET(new_buffer, size * count); - ctor(world, &entities[count], elem, to_add, ti); + int i; + for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { + const ecs_bitmask_constant_t *m_desc = &desc->constants[i]; + if (!m_desc->name) { + break; } - /* Free old vector */ - ecs_vector_free(vec); + ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = m_desc->name + }); - column->data = new_vec; - } else { - /* If array won't realloc or has no move, simply add new elements */ - if (can_realloc) { - ecs_vector_set_size_t(&vec, size, alignment, new_size); + if (!m_desc->value) { + ecs_add_id(world, c, EcsConstant); + } else { + ecs_set_pair_object(world, c, EcsConstant, ecs_u32_t, + {m_desc->value}); } + } - void *elem = ecs_vector_addn_t(&vec, size, alignment, to_add); - - ecs_xtor_t ctor; - if (construct && ti && (ctor = ti->lifecycle.ctor)) { - /* If new elements need to be constructed and component has a - * constructor, construct */ - ctor(world, &entities[count], elem, to_add, ti); - } + ecs_set_scope(world, old_scope); - column->data = vec; + if (i == 0) { + ecs_err("bitmask '%s' has no constants", ecs_get_name(world, t)); + ecs_delete(world, t); + return 0; } - ecs_assert(ecs_vector_size(column->data) == new_size, - ECS_INTERNAL_ERROR, NULL); + return t; } -static -int32_t grow_data( +ecs_entity_t ecs_array_init( ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t to_add, - int32_t size, - const ecs_entity_t *ids) + const ecs_array_desc_t *desc) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; + } - int32_t cur_count = flecs_table_data_count(data); - int32_t column_count = ecs_vector_count(table->storage_type); - int32_t sw_column_count = table->sw_column_count; - int32_t bs_column_count = table->bs_column_count; - ecs_column_t *columns = data->columns; - ecs_sw_column_t *sw_columns = data->sw_columns; - ecs_bs_column_t *bs_columns = data->bs_columns; + ecs_set(world, t, EcsArray, { + .type = desc->type, + .count = desc->count + }); - /* Add record to record ptr array */ - ecs_vector_set_size(&data->record_ptrs, ecs_record_t*, size); - ecs_record_t **r = ecs_vector_addn(&data->record_ptrs, ecs_record_t*, to_add); - ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); - if (ecs_vector_size(data->record_ptrs) > size) { - size = ecs_vector_size(data->record_ptrs); + return t; +} + +ecs_entity_t ecs_vector_init( + ecs_world_t *world, + const ecs_vector_desc_t *desc) +{ + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; } - /* Add entity to column with entity ids */ - ecs_vector_set_size(&data->entities, ecs_entity_t, size); - ecs_entity_t *e = ecs_vector_addn(&data->entities, ecs_entity_t, to_add); - ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ecs_vector_size(data->entities) == size, ECS_INTERNAL_ERROR, NULL); + ecs_set(world, t, EcsVector, { + .type = desc->type + }); - /* Initialize entity ids and record ptrs */ - int32_t i; - if (ids) { - for (i = 0; i < to_add; i ++) { - e[i] = ids[i]; - } - } else { - ecs_os_memset(e, 0, ECS_SIZEOF(ecs_entity_t) * to_add); + return t; +} + +ecs_entity_t ecs_struct_init( + ecs_world_t *world, + const ecs_struct_desc_t *desc) +{ + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; } - ecs_os_memset(r, 0, ECS_SIZEOF(ecs_record_t*) * to_add); - /* Add elements to each column array */ - ecs_type_info_t **c_info_array = table->type_info; - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t old_scope = ecs_set_scope(world, t); - ecs_type_info_t *c_info = NULL; - if (c_info_array) { - c_info = c_info_array[i]; + int i; + for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { + const ecs_member_t *m_desc = &desc->members[i]; + if (!m_desc->type) { + break; } - grow_column(world, entities, column, c_info, to_add, size, true); - ecs_assert(ecs_vector_size(columns[i].data) == size, - ECS_INTERNAL_ERROR, NULL); - } + if (!m_desc->name) { + ecs_err("member %d of struct '%s' does not have a name", i, + ecs_get_name(world, t)); + ecs_delete(world, t); + return 0; + } - /* Add elements to each switch column */ - for (i = 0; i < sw_column_count; i ++) { - ecs_switch_t *sw = sw_columns[i].data; - flecs_switch_addn(sw, to_add); - } + ecs_entity_t m = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = m_desc->name + }); - /* Add elements to each bitset column */ - for (i = 0; i < bs_column_count; i ++) { - ecs_bitset_t *bs = &bs_columns[i].data; - flecs_bitset_addn(bs, to_add); + ecs_set(world, m, EcsMember, { + .type = m_desc->type, + .count = m_desc->count, + .unit = m_desc->unit + }); } - /* If the table is monitored indicate that there has been a change */ - mark_table_dirty(world, table, 0); + ecs_set_scope(world, old_scope); - if (!world->is_readonly && !cur_count) { - flecs_table_set_empty(world, table); + if (i == 0) { + ecs_err("struct '%s' has no members", ecs_get_name(world, t)); + ecs_delete(world, t); + return 0; } - table->alloc_count ++; - - /* Return index of first added entity */ - return cur_count; -} - -static -void fast_append( - ecs_column_t *columns, - int32_t column_count) -{ - /* Add elements to each column array */ - int32_t i; - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - int16_t size = column->size; - if (size) { - int16_t alignment = column->alignment; - ecs_vector_add_t(&column->data, size, alignment); - } + if (!ecs_has(world, t, EcsStruct)) { + /* Invalid members */ + ecs_delete(world, t); + return 0; } + + return t; } -int32_t flecs_table_append( +ecs_entity_t ecs_unit_init( ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - ecs_entity_t entity, - ecs_record_t *record, - bool construct) + const ecs_unit_desc_t *desc) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - - check_table_sanity(table); - - /* Get count & size before growing entities array. This tells us whether the - * arrays will realloc */ - int32_t count = ecs_vector_count(data->entities); - int32_t size = ecs_vector_size(data->entities); - int32_t column_count = ecs_vector_count(table->storage_type); - ecs_column_t *columns = table->storage.columns; - - /* Grow buffer with entity ids, set new element to new entity */ - ecs_entity_t *e = ecs_vector_add(&data->entities, ecs_entity_t); - ecs_assert(e != NULL, ECS_INTERNAL_ERROR, NULL); - *e = entity; - - /* Keep track of alloc count. This allows references to check if cached - * pointers need to be updated. */ - table->alloc_count += (count == size); - - /* Add record ptr to array with record ptrs */ - ecs_record_t **r = ecs_vector_add(&data->record_ptrs, ecs_record_t*); - ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); - *r = record; - - /* If the table is monitored indicate that there has been a change */ - mark_table_dirty(world, table, 0); - ecs_assert(count >= 0, ECS_INTERNAL_ERROR, NULL); - - /* Fast path: no switch columns, no lifecycle actions */ - if (!(table->flags & EcsTableIsComplex)) { - fast_append(columns, column_count); - if (!count) { - flecs_table_set_empty(world, table); /* See below */ - } - return count; + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + goto error; } - int32_t sw_column_count = table->sw_column_count; - int32_t bs_column_count = table->bs_column_count; - ecs_sw_column_t *sw_columns = table->storage.sw_columns; - ecs_bs_column_t *bs_columns = table->storage.bs_columns; - - ecs_type_info_t **c_info_array = table->type_info; - ecs_entity_t *entities = ecs_vector_first( - data->entities, ecs_entity_t); - - /* Reobtain size to ensure that the columns have the same size as the - * entities and record vectors. This keeps reasoning about when allocations - * occur easier. */ - size = ecs_vector_size(data->entities); - - /* Grow component arrays with 1 element */ - int32_t i; - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); - - ecs_type_info_t *c_info = NULL; - if (c_info_array) { - c_info = c_info_array[i]; + ecs_entity_t quantity = desc->quantity; + if (quantity) { + if (!ecs_has_id(world, quantity, EcsQuantity)) { + ecs_err("entity '%s' for unit '%s' is not a quantity", + ecs_get_name(world, quantity), ecs_get_name(world, t)); + goto error; } - - grow_column(world, entities, column, c_info, 1, size, construct); - - ecs_assert( - ecs_vector_size(columns[i].data) == ecs_vector_size(data->entities), - ECS_INTERNAL_ERROR, NULL); - - ecs_assert( - ecs_vector_count(columns[i].data) == ecs_vector_count(data->entities), - ECS_INTERNAL_ERROR, NULL); - } - /* Add element to each switch column */ - for (i = 0; i < sw_column_count; i ++) { - ecs_assert(sw_columns != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_switch_t *sw = sw_columns[i].data; - flecs_switch_add(sw); + ecs_add_pair(world, t, EcsQuantity, desc->quantity); + } else { + ecs_remove_pair(world, t, EcsQuantity, EcsWildcard); } - /* Add element to each bitset column */ - for (i = 0; i < bs_column_count; i ++) { - ecs_assert(bs_columns != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_bitset_t *bs = &bs_columns[i].data; - flecs_bitset_addn(bs, 1); - } + EcsUnit *value = ecs_get_mut(world, t, EcsUnit, 0); + value->base = desc->base; + value->over = desc->over; + value->translation = desc->translation; + value->prefix = desc->prefix; + ecs_os_strset(&value->symbol, desc->symbol); - /* If this is the first entity in this table, signal queries so that the - * table moves from an inactive table to an active table. */ - if (!count) { - flecs_table_set_empty(world, table); + if (!flecs_unit_validate(world, t, value)) { + goto error; } - check_table_sanity(table); + ecs_modified(world, t, EcsUnit); - return count; + return t; +error: + if (t) { + ecs_delete(world, t); + } + return 0; } -static -void fast_delete_last( - ecs_column_t *columns, - int32_t column_count) +ecs_entity_t ecs_unit_prefix_init( + ecs_world_t *world, + const ecs_unit_prefix_desc_t *desc) { - int i; - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - ecs_vector_remove_last(column->data); + ecs_entity_t t = ecs_entity_init(world, &desc->entity); + if (!t) { + return 0; } -} -static -void fast_delete( - ecs_column_t *columns, - int32_t column_count, - int32_t index) -{ - int i; - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - int16_t size = column->size; - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + ecs_set(world, t, EcsUnitPrefix, { + .symbol = (char*)desc->symbol, + .translation = desc->translation + }); - int16_t alignment = column->alignment; - ecs_vector_remove_t(column->data, size, alignment, index); - } + return t; } -void flecs_table_delete( +ecs_entity_t ecs_quantity_init( ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t index, - bool destruct) + const ecs_entity_desc_t *desc) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + ecs_entity_t t = ecs_entity_init(world, desc); + if (!t) { + return 0; + } - check_table_sanity(table); + ecs_add_id(world, t, EcsQuantity); - ecs_vector_t *v_entities = data->entities; - int32_t count = ecs_vector_count(v_entities); + return t; +} - ecs_assert(count > 0, ECS_INTERNAL_ERROR, NULL); - count --; - ecs_assert(index <= count, ECS_INTERNAL_ERROR, NULL); +#endif - /* Move last entity id to index */ - ecs_entity_t *entities = ecs_vector_first(v_entities, ecs_entity_t); - ecs_entity_t entity_to_move = entities[count]; - ecs_entity_t entity_to_delete = entities[index]; - entities[index] = entity_to_move; - ecs_vector_remove_last(v_entities); - /* Move last record ptr to index */ - ecs_vector_t *v_records = data->record_ptrs; - ecs_assert(count < ecs_vector_count(v_records), ECS_INTERNAL_ERROR, NULL); +#ifdef FLECS_META - ecs_record_t **records = ecs_vector_first(v_records, ecs_record_t*); - ecs_record_t *record_to_move = records[count]; - records[index] = record_to_move; - ecs_vector_remove_last(v_records); +static +ecs_vector_t* serialize_type( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops); - /* Update record of moved entity in entity index */ - if (index != count) { - if (record_to_move) { - uint32_t row_flags = record_to_move->row & ECS_ROW_FLAGS_MASK; - record_to_move->row = ECS_ROW_TO_RECORD(index, row_flags); - ecs_assert(record_to_move->table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(record_to_move->table == table, ECS_INTERNAL_ERROR, NULL); - } - } - - /* If the table is monitored indicate that there has been a change */ - mark_table_dirty(world, table, 0); +static +ecs_meta_type_op_kind_t primitive_to_op_kind(ecs_primitive_kind_t kind) { + return EcsOpPrimitive + kind; +} - /* If table is empty, deactivate it */ - if (!count) { - flecs_table_set_empty(world, table); - } +static +ecs_size_t type_size(ecs_world_t *world, ecs_entity_t type) { + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); + return comp->size; +} - /* Destruct component data */ - ecs_type_info_t **c_info_array = table->type_info; - ecs_column_t *columns = data->columns; - int32_t column_count = ecs_vector_count(table->storage_type); - int32_t i; +static +ecs_meta_type_op_t* ops_add(ecs_vector_t **ops, ecs_meta_type_op_kind_t kind) { + ecs_meta_type_op_t *op = ecs_vector_add(ops, ecs_meta_type_op_t); + op->kind = kind; + op->offset = 0; + op->count = 1; + op->op_count = 1; + op->size = 0; + op->name = NULL; + op->members = NULL; + op->type = 0; + op->unit = 0; + return op; +} - /* If this is a table without lifecycle callbacks or special columns, take - * fast path that just remove an element from the array(s) */ - if (!(table->flags & EcsTableIsComplex)) { - if (index == count) { - fast_delete_last(columns, column_count); - } else { - fast_delete(columns, column_count, index); - } +static +ecs_meta_type_op_t* ops_get(ecs_vector_t *ops, int32_t index) { + ecs_meta_type_op_t* op = ecs_vector_get(ops, ecs_meta_type_op_t, index); + ecs_assert(op != NULL, ECS_INTERNAL_ERROR, NULL); + return op; +} - check_table_sanity(table); +static +ecs_vector_t* serialize_primitive( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) +{ + const EcsPrimitive *ptr = ecs_get(world, type, EcsPrimitive); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - return; - } + ecs_meta_type_op_t *op = ops_add(&ops, primitive_to_op_kind(ptr->kind)); + op->offset = offset, + op->type = type; + op->size = type_size(world, type); - ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + return ops; +} - /* Last element, destruct & remove */ - if (index == count) { - /* If table has component destructors, invoke */ - if (destruct && (table->flags & EcsTableHasDtors)) { - ecs_assert(c_info_array != NULL, ECS_INTERNAL_ERROR, NULL); - - for (i = 0; i < column_count; i ++) { - ecs_type_info_t *ti = c_info_array[i]; - if (!ti) { - continue; - } +static +ecs_vector_t* serialize_enum( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) +{ + (void)world; + + ecs_meta_type_op_t *op = ops_add(&ops, EcsOpEnum); + op->offset = offset, + op->type = type; + op->size = ECS_SIZEOF(ecs_i32_t); - dtor_component(world, table, ti, &columns[i], - entities, ids[i], index, 1, true); - } - } + return ops; +} - fast_delete_last(columns, column_count); +static +ecs_vector_t* serialize_bitmask( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) +{ + (void)world; + + ecs_meta_type_op_t *op = ops_add(&ops, EcsOpBitmask); + op->offset = offset, + op->type = type; + op->size = ECS_SIZEOF(ecs_u32_t); - /* Not last element, move last element to deleted element & destruct */ - } else { - /* If table has component destructors, invoke */ - if (destruct && (table->flags & (EcsTableHasDtors | EcsTableHasMove))) { - ecs_assert(c_info_array != NULL, ECS_INTERNAL_ERROR, NULL); + return ops; +} - for (i = 0; i < column_count; i ++) { - ecs_column_t *column = &columns[i]; - ecs_size_t size = column->size; - ecs_size_t align = column->alignment; - ecs_vector_t *vec = column->data; - void *dst = ecs_vector_get_t(vec, size, align, index); - void *src = ecs_vector_last_t(vec, size, align); - - ecs_type_info_t *ti = c_info_array[i]; +static +ecs_vector_t* serialize_array( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) +{ + (void)world; - ecs_iter_action_t on_remove; - if (ti && (on_remove = ti->lifecycle.on_remove)) { - on_remove_component(world, table, on_remove, dst, - size, &entity_to_delete, ids[i], 1, - ti->lifecycle.ctx); - } + ecs_meta_type_op_t *op = ops_add(&ops, EcsOpArray); + op->offset = offset; + op->type = type; + op->size = type_size(world, type); - ecs_move_t move_dtor; - if (ti && (move_dtor = ti->lifecycle.move_dtor)) { - move_dtor(world, &entity_to_move, - &entity_to_delete, dst, src, 1, ti); - } else { - ecs_os_memcpy(dst, src, size); - } + return ops; +} - ecs_vector_remove_last(vec); - } - } else { - fast_delete(columns, column_count, index); - } +static +ecs_vector_t* serialize_array_component( + ecs_world_t *world, + ecs_entity_t type) +{ + const EcsArray *ptr = ecs_get(world, type, EcsArray); + if (!ptr) { + return NULL; /* Should never happen, will trigger internal error */ } - /* Remove elements from switch columns */ - ecs_sw_column_t *sw_columns = data->sw_columns; - int32_t sw_column_count = table->sw_column_count; - for (i = 0; i < sw_column_count; i ++) { - flecs_switch_remove(sw_columns[i].data, index); - } + ecs_vector_t *ops = serialize_type(world, ptr->type, 0, NULL); + ecs_assert(ops != NULL, ECS_INTERNAL_ERROR, NULL); - /* Remove elements from bitset columns */ - ecs_bs_column_t *bs_columns = data->bs_columns; - int32_t bs_column_count = table->bs_column_count; - for (i = 0; i < bs_column_count; i ++) { - flecs_bitset_remove(&bs_columns[i].data, index); - } + ecs_meta_type_op_t *first = ecs_vector_first(ops, ecs_meta_type_op_t); + first->count = ptr->count; - check_table_sanity(table); + return ops; } static -void fast_move( - ecs_table_t *new_table, - ecs_data_t *new_data, - int32_t new_index, - ecs_table_t *old_table, - ecs_data_t *old_data, - int32_t old_index) +ecs_vector_t* serialize_vector( + ecs_world_t *world, + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) { - ecs_type_t new_type = new_table->storage_type; - ecs_type_t old_type = old_table->storage_type; - - int32_t i_new = 0, new_column_count = ecs_vector_count(new_table->storage_type); - int32_t i_old = 0, old_column_count = ecs_vector_count(old_table->storage_type); - ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); - ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - - ecs_column_t *old_columns = old_data->columns; - ecs_column_t *new_columns = new_data->columns; - - - for (; (i_new < new_column_count) && (i_old < old_column_count);) { - ecs_entity_t new_component = new_components[i_new]; - ecs_entity_t old_component = old_components[i_old]; - - if (new_component == old_component) { - ecs_column_t *new_column = &new_columns[i_new]; - ecs_column_t *old_column = &old_columns[i_old]; - int16_t size = new_column->size; - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); - - int16_t alignment = new_column->alignment; - void *dst = ecs_vector_get_t( - new_column->data, size, alignment, new_index); - void *src = ecs_vector_get_t( - old_column->data, size, alignment, old_index); + (void)world; - ecs_assert(dst != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(src != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_os_memcpy(dst, src, size); - } + ecs_meta_type_op_t *op = ops_add(&ops, EcsOpVector); + op->offset = offset; + op->type = type; + op->size = type_size(world, type); - i_new += new_component <= old_component; - i_old += new_component >= old_component; - } + return ops; } -void flecs_table_move( +static +ecs_vector_t* serialize_struct( ecs_world_t *world, - ecs_entity_t dst_entity, - ecs_entity_t src_entity, - ecs_table_t *new_table, - ecs_data_t *new_data, - int32_t new_index, - ecs_table_t *old_table, - ecs_data_t *old_data, - int32_t old_index, - bool construct) + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) { - ecs_assert(new_table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(old_table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!new_table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_assert(!old_table->lock, ECS_LOCKED_STORAGE, NULL); - - ecs_assert(old_index >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(new_index >= 0, ECS_INTERNAL_ERROR, NULL); + const EcsStruct *ptr = ecs_get(world, type, EcsStruct); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(old_data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(new_data != NULL, ECS_INTERNAL_ERROR, NULL); + int32_t cur, first = ecs_vector_count(ops); + ecs_meta_type_op_t *op = ops_add(&ops, EcsOpPush); + op->offset = offset; + op->type = type; + op->size = type_size(world, type); - check_table_sanity(new_table); - check_table_sanity(old_table); + ecs_member_t *members = ecs_vector_first(ptr->members, ecs_member_t); + int32_t i, count = ecs_vector_count(ptr->members); - if (!((new_table->flags | old_table->flags) & EcsTableIsComplex)) { - fast_move(new_table, new_data, new_index, old_table, old_data, - old_index); - check_table_sanity(new_table); - check_table_sanity(old_table); - return; + ecs_hashmap_t *member_index = NULL; + if (count) { + op->members = member_index = flecs_name_index_new(); } - move_switch_columns(new_table, new_data, new_index, old_table, old_data, - old_index, 1, false); - move_bitset_columns(new_table, new_data, new_index, old_table, old_data, - old_index, 1, false); - - bool same_entity = dst_entity == src_entity; - - ecs_type_t new_type = new_table->storage_type; - ecs_type_t old_type = old_table->storage_type; - - int32_t i_new = 0, new_column_count = ecs_vector_count(new_table->storage_type); - int32_t i_old = 0, old_column_count = ecs_vector_count(old_table->storage_type); - ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); - ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - - ecs_column_t *old_columns = old_data->columns; - ecs_column_t *new_columns = new_data->columns; - - for (; (i_new < new_column_count) && (i_old < old_column_count);) { - ecs_entity_t new_component = new_components[i_new]; - ecs_entity_t old_component = old_components[i_old]; - - if (new_component == old_component) { - ecs_column_t *new_column = &new_columns[i_new]; - ecs_column_t *old_column = &old_columns[i_old]; - int16_t size = new_column->size; - int16_t alignment = new_column->alignment; - - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + for (i = 0; i < count; i ++) { + ecs_member_t *member = &members[i]; - void *dst = ecs_vector_get_t( - new_column->data, size, alignment, new_index); - void *src = ecs_vector_get_t( - old_column->data, size, alignment, old_index); + cur = ecs_vector_count(ops); + ops = serialize_type(world, member->type, offset + member->offset, ops); - ecs_assert(dst != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(src != NULL, ECS_INTERNAL_ERROR, NULL); + op = ops_get(ops, cur); + if (!op->type) { + op->type = member->type; + } - ecs_type_info_t *ti = new_table->type_info[i_new]; - if (same_entity) { - ecs_move_t callback; - if (ti && (callback = ti->lifecycle.ctor_move_dtor)) { - /* ctor + move + dtor */ - callback(world, &dst_entity, &src_entity, dst, src, 1, ti); - } else { - ecs_os_memcpy(dst, src, size); - } - } else { - ecs_copy_t copy; - if (ti && (copy = ti->lifecycle.copy_ctor)) { - copy(world, &dst_entity, &src_entity, dst, src, 1, ti); - } else { - ecs_os_memcpy(dst, src, size); - } - } - } else { - if (new_component < old_component) { - if (construct) { - ctor_component(world, new_table->type_info[i_new], - &new_columns[i_new], &dst_entity, new_index, 1); - } - } else { - dtor_component(world, old_table, old_table->type_info[i_old], - &old_columns[i_old], &src_entity, old_component, - old_index, 1, true); - } + if (op->count <= 1) { + op->count = member->count; } - i_new += new_component <= old_component; - i_old += new_component >= old_component; - } + const char *member_name = member->name; + op->name = member_name; + op->unit = member->unit; + op->op_count = ecs_vector_count(ops) - cur; - if (construct) { - for (; (i_new < new_column_count); i_new ++) { - ctor_component(world, new_table->type_info[i_new], - &new_columns[i_new], &dst_entity, new_index, 1); - } + flecs_name_index_ensure( + member_index, flecs_ito(uint64_t, cur - first - 1), + member_name, 0, 0); } - for (; (i_old < old_column_count); i_old ++) { - dtor_component(world, old_table, old_table->type_info[i_old], - &old_columns[i_old], &src_entity, old_components[i_old], - old_index, 1, true); - } + ops_add(&ops, EcsOpPop); + ops_get(ops, first)->op_count = ecs_vector_count(ops) - first; - check_table_sanity(new_table); - check_table_sanity(old_table); + return ops; } -int32_t flecs_table_appendn( +static +ecs_vector_t* serialize_type( ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t to_add, - const ecs_entity_t *ids) + ecs_entity_t type, + ecs_size_t offset, + ecs_vector_t *ops) { - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + const EcsMetaType *ptr = ecs_get(world, type, EcsMetaType); + if (!ptr) { + char *path = ecs_get_fullpath(world, type); + ecs_err("missing EcsMetaType for type %s'", path); + ecs_os_free(path); + return NULL; + } - check_table_sanity(table); + switch(ptr->kind) { + case EcsPrimitiveType: + ops = serialize_primitive(world, type, offset, ops); + break; - int32_t cur_count = flecs_table_data_count(data); - int32_t result = grow_data( - world, table, data, to_add, cur_count + to_add, ids); - check_table_sanity(table); - return result; -} + case EcsEnumType: + ops = serialize_enum(world, type, offset, ops); + break; -void flecs_table_set_size( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t size) -{ - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); + case EcsBitmaskType: + ops = serialize_bitmask(world, type, offset, ops); + break; - check_table_sanity(table); + case EcsStructType: + ops = serialize_struct(world, type, offset, ops); + break; - int32_t cur_count = flecs_table_data_count(data); + case EcsArrayType: + ops = serialize_array(world, type, offset, ops); + break; - if (cur_count < size) { - grow_data(world, table, data, 0, size, NULL); - check_table_sanity(table); + case EcsVectorType: + ops = serialize_vector(world, type, offset, ops); + break; } -} -int32_t flecs_table_data_count( - const ecs_data_t *data) -{ - return data ? ecs_vector_count(data->entities) : 0; + return ops; } static -void swap_switch_columns( - ecs_table_t *table, - ecs_data_t *data, - int32_t row_1, - int32_t row_2) +ecs_vector_t* serialize_component( + ecs_world_t *world, + ecs_entity_t type) { - int32_t i = 0, column_count = table->sw_column_count; - if (!column_count) { - return; + const EcsMetaType *ptr = ecs_get(world, type, EcsMetaType); + if (!ptr) { + char *path = ecs_get_fullpath(world, type); + ecs_err("missing EcsMetaType for type %s'", path); + ecs_os_free(path); + return NULL; } - ecs_sw_column_t *columns = data->sw_columns; + ecs_vector_t *ops = NULL; - for (i = 0; i < column_count; i ++) { - ecs_switch_t *sw = columns[i].data; - flecs_switch_swap(sw, row_1, row_2); + switch(ptr->kind) { + case EcsArrayType: + ops = serialize_array_component(world, type); + break; + default: + ops = serialize_type(world, type, 0, NULL); + break; } + + return ops; } -static -void swap_bitset_columns( - ecs_table_t *table, - ecs_data_t *data, - int32_t row_1, - int32_t row_2) +void ecs_meta_type_serialized_init( + ecs_iter_t *it) { - int32_t i = 0, column_count = table->bs_column_count; - if (!column_count) { - return; - } + ecs_world_t *world = it->world; - ecs_bs_column_t *columns = data->bs_columns; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_vector_t *ops = serialize_component(world, e); + ecs_assert(ops != NULL, ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < column_count; i ++) { - ecs_bitset_t *bs = &columns[i].data; - flecs_bitset_swap(bs, row_1, row_2); + EcsMetaTypeSerialized *ptr = ecs_get_mut( + world, e, EcsMetaTypeSerialized, NULL); + if (ptr->ops) { + ecs_meta_dtor_serialized(ptr); + } + + ptr->ops = ops; } } -void flecs_table_swap( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t row_1, - int32_t row_2) -{ - (void)world; - - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(row_1 >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(row_2 >= 0, ECS_INTERNAL_ERROR, NULL); +#endif - check_table_sanity(table); - - if (row_1 == row_2) { - return; - } - /* If the table is monitored indicate that there has been a change */ - mark_table_dirty(world, table, 0); +#ifdef FLECS_META - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - ecs_entity_t e1 = entities[row_1]; - ecs_entity_t e2 = entities[row_2]; +/* EcsMetaTypeSerialized lifecycle */ - ecs_record_t **record_ptrs = ecs_vector_first(data->record_ptrs, ecs_record_t*); - ecs_record_t *record_ptr_1 = record_ptrs[row_1]; - ecs_record_t *record_ptr_2 = record_ptrs[row_2]; - - ecs_assert(record_ptr_1 != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(record_ptr_2 != NULL, ECS_INTERNAL_ERROR, NULL); +void ecs_meta_dtor_serialized( + EcsMetaTypeSerialized *ptr) +{ + int32_t i, count = ecs_vector_count(ptr->ops); + ecs_meta_type_op_t *ops = ecs_vector_first(ptr->ops, ecs_meta_type_op_t); + + for (i = 0; i < count; i ++) { + ecs_meta_type_op_t *op = &ops[i]; + if (op->members) { + flecs_hashmap_fini(op->members); + ecs_os_free(op->members); + } + } - /* Keep track of whether entity is watched */ - uint32_t flags_1 = ECS_RECORD_TO_ROW_FLAGS(record_ptr_1->row); - uint32_t flags_2 = ECS_RECORD_TO_ROW_FLAGS(record_ptr_2->row); + ecs_vector_free(ptr->ops); +} - /* Swap entities & records */ - entities[row_1] = e2; - entities[row_2] = e1; - record_ptr_1->row = ECS_ROW_TO_RECORD(row_2, flags_1); - record_ptr_2->row = ECS_ROW_TO_RECORD(row_1, flags_2); - record_ptrs[row_1] = record_ptr_2; - record_ptrs[row_2] = record_ptr_1; +static ECS_COPY(EcsMetaTypeSerialized, dst, src, { + ecs_meta_dtor_serialized(dst); - swap_switch_columns(table, data, row_1, row_2); - swap_bitset_columns(table, data, row_1, row_2); + dst->ops = ecs_vector_copy(src->ops, ecs_meta_type_op_t); - ecs_column_t *columns = data->columns; - if (!columns) { - check_table_sanity(table); - return; + int32_t o, count = ecs_vector_count(src->ops); + ecs_meta_type_op_t *ops = ecs_vector_first(src->ops, ecs_meta_type_op_t); + + for (o = 0; o < count; o ++) { + ecs_meta_type_op_t *op = &ops[o]; + if (op->members) { + op->members = ecs_os_memdup_t(op->members, ecs_hashmap_t); + flecs_hashmap_copy(op->members, op->members); + } } +}) - /* Swap columns */ - int32_t i, column_count = ecs_vector_count(table->storage_type); - - for (i = 0; i < column_count; i ++) { - int16_t size = columns[i].size; - int16_t alignment = columns[i].alignment; +static ECS_MOVE(EcsMetaTypeSerialized, dst, src, { + ecs_meta_dtor_serialized(dst); + dst->ops = src->ops; + src->ops = NULL; +}) - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); +static ECS_DTOR(EcsMetaTypeSerialized, ptr, { + ecs_meta_dtor_serialized(ptr); +}) - void *ptr = ecs_vector_first_t(columns[i].data, size, alignment); - void *tmp = ecs_os_alloca(size); - void *el_1 = ECS_OFFSET(ptr, size * row_1); - void *el_2 = ECS_OFFSET(ptr, size * row_2); +/* EcsStruct lifecycle */ - ecs_os_memcpy(tmp, el_1, size); - ecs_os_memcpy(el_1, el_2, size); - ecs_os_memcpy(el_2, tmp, size); +static void dtor_struct( + EcsStruct *ptr) +{ + ecs_member_t *members = ecs_vector_first(ptr->members, ecs_member_t); + int32_t i, count = ecs_vector_count(ptr->members); + for (i = 0; i < count; i ++) { + ecs_os_free((char*)members[i].name); } - - check_table_sanity(table); + ecs_vector_free(ptr->members); } -static -void merge_vector( - ecs_vector_t **dst_out, - ecs_vector_t *src, - int16_t size, - int16_t alignment) -{ - ecs_vector_t *dst = *dst_out; - int32_t dst_count = ecs_vector_count(dst); - - if (!dst_count) { - if (dst) { - ecs_vector_free(dst); - } +static ECS_COPY(EcsStruct, dst, src, { + dtor_struct(dst); - *dst_out = src; - - /* If the new table is not empty, copy the contents from the - * src into the dst. */ - } else { - int32_t src_count = ecs_vector_count(src); - ecs_vector_set_count_t(&dst, size, alignment, dst_count + src_count); - - void *dst_ptr = ecs_vector_first_t(dst, size, alignment); - void *src_ptr = ecs_vector_first_t(src, size, alignment); + dst->members = ecs_vector_copy(src->members, ecs_member_t); - dst_ptr = ECS_OFFSET(dst_ptr, size * dst_count); - - ecs_os_memcpy(dst_ptr, src_ptr, size * src_count); + ecs_member_t *members = ecs_vector_first(dst->members, ecs_member_t); + int32_t m, count = ecs_vector_count(dst->members); - ecs_vector_free(src); - *dst_out = dst; + for (m = 0; m < count; m ++) { + members[m].name = ecs_os_strdup(members[m].name); } -} - -static -void merge_column( - ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data, - int32_t column_id, - ecs_vector_t *src) -{ - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - ecs_type_info_t *ti = table->type_info[column_id]; - ecs_column_t *column = &data->columns[column_id]; - ecs_vector_t *dst = column->data; - int16_t size = column->size; - int16_t alignment = column->alignment; - int32_t dst_count = ecs_vector_count(dst); - - if (!dst_count) { - if (dst) { - ecs_vector_free(dst); - } +}) - column->data = src; - - /* If the new table is not empty, copy the contents from the - * src into the dst. */ - } else { - int32_t src_count = ecs_vector_count(src); - ecs_vector_set_count_t(&dst, size, alignment, dst_count + src_count); - column->data = dst; +static ECS_MOVE(EcsStruct, dst, src, { + dtor_struct(dst); + dst->members = src->members; + src->members = NULL; +}) - /* Construct new values */ - if (ti) { - ctor_component(world, ti, column, entities, dst_count, src_count); - } - - void *dst_ptr = ecs_vector_first_t(dst, size, alignment); - void *src_ptr = ecs_vector_first_t(src, size, alignment); +static ECS_DTOR(EcsStruct, ptr, { dtor_struct(ptr); }) - dst_ptr = ECS_OFFSET(dst_ptr, size * dst_count); - - /* Move values into column */ - ecs_move_t move; - if (ti && (move = ti->lifecycle.move)) { - move(world, entities, entities, dst_ptr, src_ptr, src_count, ti); - } else { - ecs_os_memcpy(dst_ptr, src_ptr, size * src_count); - } - ecs_vector_free(src); - } -} +/* EcsEnum lifecycle */ -static -void merge_table_data( - ecs_world_t *world, - ecs_table_t *new_table, - ecs_table_t *old_table, - int32_t old_count, - int32_t new_count, - ecs_data_t *old_data, - ecs_data_t *new_data) +static void dtor_enum( + EcsEnum *ptr) { - ecs_type_t new_type = new_table->storage_type; - ecs_type_t old_type = old_table->storage_type; - int32_t i_new = 0, new_column_count = ecs_vector_count(new_type); - int32_t i_old = 0, old_column_count = ecs_vector_count(old_type); - ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); - ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); - - ecs_column_t *old_columns = old_data->columns; - ecs_column_t *new_columns = new_data->columns; - - if (!new_columns && !new_data->entities) { - new_columns = new_data->columns; - } - - ecs_assert(!new_column_count || new_columns, ECS_INTERNAL_ERROR, NULL); - - if (!old_count) { - return; + ecs_map_iter_t it = ecs_map_iter(ptr->constants); + ecs_enum_constant_t *c; + while ((c = ecs_map_next(&it, ecs_enum_constant_t, NULL))) { + ecs_os_free((char*)c->name); } + ecs_map_free(ptr->constants); +} - /* Merge entities */ - merge_vector(&new_data->entities, old_data->entities, ECS_SIZEOF(ecs_entity_t), - ECS_ALIGNOF(ecs_entity_t)); - old_data->entities = NULL; - ecs_entity_t *entities = ecs_vector_first(new_data->entities, ecs_entity_t); +static ECS_COPY(EcsEnum, dst, src, { + dtor_enum(dst); - ecs_assert(ecs_vector_count(new_data->entities) == old_count + new_count, + dst->constants = ecs_map_copy(src->constants); + ecs_assert(ecs_map_count(dst->constants) == ecs_map_count(src->constants), ECS_INTERNAL_ERROR, NULL); - /* Merge entity index record pointers */ - merge_vector(&new_data->record_ptrs, old_data->record_ptrs, - ECS_SIZEOF(ecs_record_t*), ECS_ALIGNOF(ecs_record_t*)); - old_data->record_ptrs = NULL; - - for (; (i_new < new_column_count) && (i_old < old_column_count); ) { - ecs_entity_t new_component = new_components[i_new]; - ecs_entity_t old_component = old_components[i_old]; - int16_t size = new_columns[i_new].size; - int16_t alignment = new_columns[i_new].alignment; - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); + ecs_map_iter_t it = ecs_map_iter(dst->constants); + ecs_enum_constant_t *c; + while ((c = ecs_map_next(&it, ecs_enum_constant_t, NULL))) { + c->name = ecs_os_strdup(c->name); + } +}) - if (new_component == old_component) { - merge_column(world, new_table, new_data, i_new, - old_columns[i_old].data); - old_columns[i_old].data = NULL; +static ECS_MOVE(EcsEnum, dst, src, { + dtor_enum(dst); + dst->constants = src->constants; + src->constants = NULL; +}) - /* Mark component column as dirty */ - mark_table_dirty(world, new_table, i_new + 1); - - i_new ++; - i_old ++; - } else if (new_component < old_component) { - /* New column does not occur in old table, make sure vector is large - * enough. */ - ecs_column_t *column = &new_columns[i_new]; - ecs_vector_set_count_t(&column->data, size, alignment, - old_count + new_count); +static ECS_DTOR(EcsEnum, ptr, { dtor_enum(ptr); }) - /* Construct new values */ - ecs_type_info_t *c_info = new_table->type_info[i_new]; - if (c_info) { - ctor_component(world, c_info, column, - entities, 0, old_count + new_count); - } - - i_new ++; - } else if (new_component > old_component) { - ecs_column_t *column = &old_columns[i_old]; - - /* Destruct old values */ - ecs_type_info_t *c_info = old_table->type_info[i_old]; - if (c_info) { - dtor_component(world, old_table, c_info, column, - entities, 0, 0, old_count, false); - } - /* Old column does not occur in new table, remove */ - ecs_vector_free(column->data); - column->data = NULL; +/* EcsBitmask lifecycle */ - i_old ++; - } +static void dtor_bitmask( + EcsBitmask *ptr) +{ + ecs_map_iter_t it = ecs_map_iter(ptr->constants); + ecs_bitmask_constant_t *c; + while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, NULL))) { + ecs_os_free((char*)c->name); } + ecs_map_free(ptr->constants); +} - move_switch_columns(new_table, new_data, new_count, old_table, old_data, 0, - old_count, true); - move_bitset_columns(new_table, new_data, new_count, old_table, old_data, 0, - old_count, true); - - /* Initialize remaining columns */ - for (; i_new < new_column_count; i_new ++) { - ecs_column_t *column = &new_columns[i_new]; - int16_t size = column->size; - int16_t alignment = column->alignment; - ecs_assert(size != 0, ECS_INTERNAL_ERROR, NULL); +static ECS_COPY(EcsBitmask, dst, src, { + dtor_bitmask(dst); - ecs_vector_set_count_t(&column->data, size, alignment, - old_count + new_count); + dst->constants = ecs_map_copy(src->constants); + ecs_assert(ecs_map_count(dst->constants) == ecs_map_count(src->constants), + ECS_INTERNAL_ERROR, NULL); - /* Construct new values */ - ecs_type_info_t *c_info = new_table->type_info[i_new]; - if (c_info) { - ctor_component(world, c_info, column, - entities, 0, old_count + new_count); - } + ecs_map_iter_t it = ecs_map_iter(dst->constants); + ecs_bitmask_constant_t *c; + while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, NULL))) { + c->name = ecs_os_strdup(c->name); } +}) - /* Destroy remaining columns */ - for (; i_old < old_column_count; i_old ++) { - ecs_column_t *column = &old_columns[i_old]; +static ECS_MOVE(EcsBitmask, dst, src, { + dtor_bitmask(dst); + dst->constants = src->constants; + src->constants = NULL; +}) - /* Destruct old values */ - ecs_type_info_t *c_info = old_table->type_info[i_old]; - if (c_info) { - dtor_component(world, old_table, c_info, column, entities, 0, - 0, old_count, false); - } +static ECS_DTOR(EcsBitmask, ptr, { dtor_bitmask(ptr); }) - /* Old column does not occur in new table, remove */ - ecs_vector_free(column->data); - column->data = NULL; - } - /* Mark entity column as dirty */ - mark_table_dirty(world, new_table, 0); -} +/* EcsUnit lifecycle */ -int32_t ecs_table_count( - const ecs_table_t *table) +static void dtor_unit( + EcsUnit *ptr) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - return flecs_table_data_count(&table->storage); + ecs_os_free(ptr->symbol); } -void flecs_table_merge( - ecs_world_t *world, - ecs_table_t *new_table, - ecs_table_t *old_table, - ecs_data_t *new_data, - ecs_data_t *old_data) -{ - ecs_assert(old_table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!old_table->lock, ECS_LOCKED_STORAGE, NULL); +static ECS_COPY(EcsUnit, dst, src, { + dtor_unit(dst); + dst->symbol = ecs_os_strdup(src->symbol); + dst->base = src->base; + dst->over = src->over; + dst->prefix = src->prefix; + dst->translation = src->translation; +}) - check_table_sanity(new_table); - check_table_sanity(old_table); - - bool move_data = false; - - /* If there is nothing to merge to, just clear the old table */ - if (!new_table) { - flecs_table_clear_data(world, old_table, old_data); - check_table_sanity(old_table); - return; - } else { - ecs_assert(!new_table->lock, ECS_LOCKED_STORAGE, NULL); - } +static ECS_MOVE(EcsUnit, dst, src, { + dtor_unit(dst); + dst->symbol = src->symbol; + dst->base = src->base; + dst->over = src->over; + dst->prefix = src->prefix; + dst->translation = src->translation; - /* If there is no data to merge, drop out */ - if (!old_data) { - return; - } + src->symbol = NULL; + src->base = 0; + src->over = 0; + src->prefix = 0; + src->translation = (ecs_unit_translation_t){0}; +}) - if (!new_data) { - new_data = &new_table->storage; - if (new_table == old_table) { - move_data = true; - } - } +static ECS_DTOR(EcsUnit, ptr, { dtor_unit(ptr); }) - ecs_entity_t *old_entities = ecs_vector_first(old_data->entities, ecs_entity_t); - int32_t old_count = ecs_vector_count(old_data->entities); - int32_t new_count = ecs_vector_count(new_data->entities); - ecs_record_t **old_records = ecs_vector_first( - old_data->record_ptrs, ecs_record_t*); +/* EcsUnitPrefix lifecycle */ - /* First, update entity index so old entities point to new type */ - int32_t i; - for(i = 0; i < old_count; i ++) { - ecs_record_t *record; - if (new_table != old_table) { - record = old_records[i]; - ecs_assert(record != NULL, ECS_INTERNAL_ERROR, NULL); - } else { - record = ecs_eis_ensure(world, old_entities[i]); - } +static void dtor_unit_prefix( + EcsUnitPrefix *ptr) +{ + ecs_os_free(ptr->symbol); +} - uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(record->row); - record->row = ECS_ROW_TO_RECORD(new_count + i, flags); - record->table = new_table; - } +static ECS_COPY(EcsUnitPrefix, dst, src, { + dtor_unit_prefix(dst); + dst->symbol = ecs_os_strdup(src->symbol); + dst->translation = src->translation; +}) - /* Merge table columns */ - if (move_data) { - *new_data = *old_data; - } else { - merge_table_data(world, new_table, old_table, old_count, new_count, - old_data, new_data); - } +static ECS_MOVE(EcsUnitPrefix, dst, src, { + dtor_unit_prefix(dst); + dst->symbol = src->symbol; + dst->translation = src->translation; - new_table->alloc_count ++; + src->symbol = NULL; + src->translation = (ecs_unit_translation_t){0}; +}) - if (old_count) { - if (!new_count) { - flecs_table_set_empty(world, new_table); - } - flecs_table_set_empty(world, old_table); - } +static ECS_DTOR(EcsUnitPrefix, ptr, { dtor_unit_prefix(ptr); }) - check_table_sanity(old_table); - check_table_sanity(new_table); -} -void flecs_table_replace_data( +/* Type initialization */ + +static +int init_type( ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *data) + ecs_entity_t type, + ecs_type_kind_t kind, + ecs_size_t size, + ecs_size_t alignment) { - int32_t prev_count = 0; - ecs_data_t *table_data = &table->storage; - ecs_assert(!data || data != table_data, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!table->lock, ECS_LOCKED_STORAGE, NULL); - - check_table_sanity(table); + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(type != 0, ECS_INTERNAL_ERROR, NULL); - prev_count = ecs_vector_count(table_data->entities); - run_on_remove(world, table, table_data); - flecs_table_clear_data(world, table, table_data); + bool is_added = false; + EcsMetaType *meta_type = ecs_get_mut(world, type, EcsMetaType, &is_added); + if (is_added) { + meta_type->existing = ecs_has(world, type, EcsComponent); - if (data) { - table->storage = *data; + /* Ensure that component has a default constructor, to prevent crashing + * serializers on uninitialized values. */ + ecs_type_info_t *ti = flecs_ensure_type_info(world, type); + if (!ti->lifecycle.ctor) { + ti->lifecycle.ctor = ecs_default_ctor; + } } else { - flecs_table_init_data(world, table); + if (meta_type->kind != kind) { + ecs_err("type '%s' reregistered with different kind", + ecs_get_name(world, type)); + return -1; + } } - int32_t count = ecs_table_count(table); - - if (!prev_count && count) { - flecs_table_set_empty(world, table); - } else if (prev_count && !count) { - flecs_table_set_empty(world, table); + if (!meta_type->existing) { + EcsComponent *comp = ecs_get_mut(world, type, EcsComponent, NULL); + comp->size = size; + comp->alignment = alignment; + ecs_modified(world, type, EcsComponent); + } else { + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + if (comp->size < size) { + ecs_err("computed size for '%s' is larger than actual type", + ecs_get_name(world, type)); + return -1; + } + if (comp->alignment < alignment) { + ecs_err("computed alignment for '%s' is larger than actual type", + ecs_get_name(world, type)); + return -1; + } + if (comp->size == size && comp->alignment != alignment) { + ecs_err("computed size for '%s' matches with actual type but " + "alignment is different", ecs_get_name(world, type)); + return -1; + } + + meta_type->partial = comp->size != size; } - table->alloc_count ++; - - check_table_sanity(table); -} + meta_type->kind = kind; + meta_type->size = size; + meta_type->alignment = alignment; + ecs_modified(world, type, EcsMetaType); -int32_t* flecs_table_get_dirty_state( - ecs_table_t *table) -{ - if (!table->dirty_state) { - int32_t column_count = ecs_vector_count(table->storage_type); - table->dirty_state = ecs_os_malloc_n( int32_t, column_count + 1); - ecs_assert(table->dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - - for (int i = 0; i < column_count + 1; i ++) { - table->dirty_state[i] = 1; - } - } - return table->dirty_state; + return 0; } -int32_t* flecs_table_get_monitor( - ecs_table_t *table) -{ - int32_t *dirty_state = flecs_table_get_dirty_state(table); - ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t column_count = ecs_vector_count(table->storage_type); - return ecs_os_memdup(dirty_state, (column_count + 1) * ECS_SIZEOF(int32_t)); -} +#define init_type_t(world, type, kind, T) \ + init_type(world, type, kind, ECS_SIZEOF(T), ECS_ALIGNOF(T)) -void flecs_table_notify( - ecs_world_t *world, - ecs_table_t *table, - ecs_table_event_t *event) +static +void set_struct_member( + ecs_member_t *member, + ecs_entity_t entity, + const char *name, + ecs_entity_t type, + int32_t count, + ecs_entity_t unit) { - if (world->is_fini) { - return; - } + member->member = entity; + member->type = type; + member->count = count; + member->unit = unit; - switch(event->kind) { - case EcsTableTriggersForId: - notify_trigger(world, table, event->event); - break; - case EcsTableNoTriggersForId: - break; + if (!count) { + member->count = 1; } -} -void ecs_table_lock( - ecs_world_t *world, - ecs_table_t *table) -{ - if (table) { - if (ecs_poly_is(world, ecs_world_t) && !world->is_readonly) { - table->lock ++; - } - } + ecs_os_strset((char**)&member->name, name); } -void ecs_table_unlock( +static +int add_member_to_struct( ecs_world_t *world, - ecs_table_t *table) -{ - if (table) { - if (ecs_poly_is(world, ecs_world_t) && !world->is_readonly) { - table->lock --; - ecs_assert(table->lock >= 0, ECS_INVALID_OPERATION, NULL); - } - } -} - -bool ecs_table_has_module( - ecs_table_t *table) + ecs_entity_t type, + ecs_entity_t member, + EcsMember *m) { - return table->flags & EcsTableHasModule; -} + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(type != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(member != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(m != NULL, ECS_INTERNAL_ERROR, NULL); -ecs_column_t* ecs_table_column_for_id( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_id_t id) -{ - ecs_table_t *storage_table = table->storage_table; - if (!storage_table) { - return NULL; + const char *name = ecs_get_name(world, member); + if (!name) { + char *path = ecs_get_fullpath(world, type); + ecs_err("member for struct '%s' does not have a name", path); + ecs_os_free(path); + return -1; } - ecs_table_record_t *tr = flecs_get_table_record(world, storage_table, id); - if (tr) { - return &table->storage.columns[tr->column]; + if (!m->type) { + char *path = ecs_get_fullpath(world, member); + ecs_err("member '%s' does not have a type", path); + ecs_os_free(path); + return -1; } - return NULL; -} - -ecs_type_t ecs_table_get_type( - const ecs_table_t *table) -{ - if (table) { - return table->type; - } else { - return NULL; + if (ecs_get_typeid(world, m->type) == 0) { + char *path = ecs_get_fullpath(world, member); + char *ent_path = ecs_get_fullpath(world, m->type); + ecs_err("member '%s.type' is '%s' which is not a type", path, ent_path); + ecs_os_free(path); + ecs_os_free(ent_path); + return -1; } -} -ecs_table_t* ecs_table_get_storage_table( - const ecs_table_t *table) -{ - return table->storage_table; -} + ecs_entity_t unit = m->unit; -int32_t ecs_table_storage_count( - const ecs_table_t *table) -{ - return ecs_vector_count(table->storage_type); -} + if (unit) { + if (!ecs_has(world, unit, EcsUnit)) { + ecs_err("entity '%s' for member '%s' is not a unit", + ecs_get_name(world, unit), name); + return -1; + } -int32_t ecs_table_type_to_storage_index( - const ecs_table_t *table, - int32_t index) -{ - ecs_assert(index >= 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(index < ecs_vector_count(table->type), - ECS_INVALID_PARAMETER, NULL); - int32_t *storage_map = table->storage_map; - if (storage_map) { - return storage_map[index]; + if (ecs_has(world, m->type, EcsUnit) && m->type != unit) { + ecs_err("unit mismatch for type '%s' and unit '%s' for member '%s'", + ecs_get_name(world, m->type), ecs_get_name(world, unit), name); + return -1; + } + } else { + if (ecs_has(world, m->type, EcsUnit)) { + unit = m->type; + m->unit = unit; + } } -error: - return -1; -} -int32_t ecs_table_storage_to_type_index( - const ecs_table_t *table, - int32_t index) -{ - ecs_check(index < ecs_vector_count(table->storage_type), - ECS_INVALID_PARAMETER, NULL); - ecs_check(table->storage_map != NULL, ECS_INVALID_PARAMETER, NULL); - int32_t offset = ecs_vector_count(table->type); - return table->storage_map[offset + index]; -error: - return -1; -} + EcsStruct *s = ecs_get_mut(world, type, EcsStruct, NULL); + ecs_assert(s != NULL, ECS_INTERNAL_ERROR, NULL); -ecs_record_t* ecs_record_find( - const ecs_world_t *world, - ecs_entity_t entity) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(entity != 0, ECS_INVALID_PARAMETER, NULL); + /* First check if member is already added to struct */ + ecs_member_t *members = ecs_vector_first(s->members, ecs_member_t); + int32_t i, count = ecs_vector_count(s->members); + for (i = 0; i < count; i ++) { + if (members[i].member == member) { + set_struct_member( + &members[i], member, name, m->type, m->count, unit); + break; + } + } - world = ecs_get_world(world); + /* If member wasn't added yet, add a new element to vector */ + if (i == count) { + ecs_member_t *elem = ecs_vector_add(&s->members, ecs_member_t); + elem->name = NULL; + set_struct_member(elem, member, name, m->type, m->count, unit); - ecs_record_t *r = ecs_eis_get(world, entity); - if (r) { - return r; + /* Reobtain members array in case it was reallocated */ + members = ecs_vector_first(s->members, ecs_member_t); + count ++; } -error: - return NULL; -} -void* ecs_record_get_column( - ecs_record_t *r, - int32_t column, - size_t c_size) -{ - (void)c_size; - ecs_table_t *table = r->table; + /* Compute member offsets and size & alignment of struct */ + ecs_size_t size = 0; + ecs_size_t alignment = 0; - ecs_check(column < ecs_vector_count(table->storage_type), - ECS_INVALID_PARAMETER, NULL); + for (i = 0; i < count; i ++) { + ecs_member_t *elem = &members[i]; - ecs_column_t *c = &table->storage.columns[column]; - ecs_assert(c != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(elem->name != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(elem->type != 0, ECS_INTERNAL_ERROR, NULL); - ecs_check(!flecs_utosize(c_size) || - flecs_utosize(c_size) == c->size, - ECS_INVALID_PARAMETER, NULL); + /* Get component of member type to get its size & alignment */ + const EcsComponent *mbr_comp = ecs_get(world, elem->type, EcsComponent); + if (!mbr_comp) { + char *path = ecs_get_fullpath(world, member); + ecs_err("member '%s' is not a type", path); + ecs_os_free(path); + return -1; + } - return ecs_vector_get_t(c->data, c->size, c->alignment, - ECS_RECORD_TO_ROW(r->row)); -error: - return NULL; -} + ecs_size_t member_size = mbr_comp->size; + ecs_size_t member_alignment = mbr_comp->alignment; -#include + if (!member_size || !member_alignment) { + char *path = ecs_get_fullpath(world, member); + ecs_err("member '%s' has 0 size/alignment"); + ecs_os_free(path); + return -1; + } -static const char* mixin_kind_str[] = { - [EcsMixinBase] = "base (should never be requested by application)", - [EcsMixinWorld] = "world", - [EcsMixinObservable] = "observable", - [EcsMixinIterable] = "iterable", - [EcsMixinMax] = "max (should never be requested by application)" -}; + member_size *= elem->count; + size = ECS_ALIGN(size, member_alignment); + elem->size = member_size; + elem->offset = size; -ecs_mixins_t ecs_world_t_mixins = { - .type_name = "ecs_world_t", - .elems = { - [EcsMixinWorld] = offsetof(ecs_world_t, self), - [EcsMixinObservable] = offsetof(ecs_world_t, observable), - [EcsMixinIterable] = offsetof(ecs_world_t, iterable) - } -}; + size += member_size; -ecs_mixins_t ecs_stage_t_mixins = { - .type_name = "ecs_stage_t", - .elems = { - [EcsMixinBase] = offsetof(ecs_stage_t, world), - [EcsMixinWorld] = offsetof(ecs_stage_t, world) + if (member_alignment > alignment) { + alignment = member_alignment; + } } -}; -ecs_mixins_t ecs_query_t_mixins = { - .type_name = "ecs_query_t", - .elems = { - [EcsMixinWorld] = offsetof(ecs_query_t, world), - [EcsMixinIterable] = offsetof(ecs_query_t, iterable) + if (size == 0) { + ecs_err("struct '%s' has 0 size", ecs_get_name(world, type)); + return -1; } -}; -ecs_mixins_t ecs_filter_t_mixins = { - .type_name = "ecs_filter_t", - .elems = { - [EcsMixinIterable] = offsetof(ecs_filter_t, iterable) + if (alignment == 0) { + ecs_err("struct '%s' has 0 alignment", ecs_get_name(world, type)); + return -1; } -}; -static -void* get_mixin( - const ecs_poly_t *poly, - ecs_mixin_kind_t kind) -{ - ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(kind < EcsMixinMax, ECS_INVALID_PARAMETER, NULL); - - const ecs_header_t *hdr = poly; - ecs_assert(hdr != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); + /* Align struct size to struct alignment */ + size = ECS_ALIGN(size, alignment); - const ecs_mixins_t *mixins = hdr->mixins; - if (!mixins) { - /* Object has no mixins */ - goto not_found; - } + ecs_modified(world, type, EcsStruct); - ecs_size_t offset = mixins->elems[kind]; - if (offset == 0) { - /* Object has mixins but not the requested one. Try to find the mixin - * in the poly's base */ - goto find_in_base; + /* Do this last as it triggers the update of EcsMetaTypeSerialized */ + if (init_type(world, type, EcsStructType, size, alignment)) { + return -1; } - /* Object has mixin, return its address */ - return ECS_OFFSET(hdr, offset); + /* If current struct is also a member, assign to itself */ + if (ecs_has(world, type, EcsMember)) { + EcsMember *type_mbr = ecs_get_mut(world, type, EcsMember, NULL); + ecs_assert(type_mbr != NULL, ECS_INTERNAL_ERROR, NULL); -find_in_base: - if (offset) { - /* If the poly has a base, try to find the mixin in the base */ - ecs_poly_t *base = *(ecs_poly_t**)ECS_OFFSET(hdr, offset); - if (base) { - return get_mixin(base, kind); - } + type_mbr->type = type; + type_mbr->count = 1; + + ecs_modified(world, type, EcsMember); } - -not_found: - /* Mixin wasn't found for poly */ - return NULL; + + return 0; } static -void* assert_mixin( - const ecs_poly_t *poly, - ecs_mixin_kind_t kind) +int add_constant_to_enum( + ecs_world_t *world, + ecs_entity_t type, + ecs_entity_t e, + ecs_id_t constant_id) { - void *ptr = get_mixin(poly, kind); - if (!ptr) { - const ecs_header_t *header = poly; - const ecs_mixins_t *mixins = header->mixins; - ecs_err("%s not available for type %s", - mixin_kind_str[kind], - mixins ? mixins->type_name : "unknown"); - ecs_os_abort(); + EcsEnum *ptr = ecs_get_mut(world, type, EcsEnum, NULL); + + /* Remove constant from map if it was already added */ + ecs_map_iter_t it = ecs_map_iter(ptr->constants); + ecs_enum_constant_t *c; + ecs_map_key_t key; + while ((c = ecs_map_next(&it, ecs_enum_constant_t, &key))) { + if (c->constant == e) { + ecs_os_free((char*)c->name); + ecs_map_remove(ptr->constants, key); + } } - return ptr; -} - -void* _ecs_poly_init( - ecs_poly_t *poly, - int32_t type, - ecs_size_t size, - ecs_mixins_t *mixins) -{ - ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); + /* Check if constant sets explicit value */ + int32_t value = 0; + bool value_set = false; + if (ecs_id_is_pair(constant_id)) { + if (ecs_pair_second(world, constant_id) != ecs_id(ecs_i32_t)) { + char *path = ecs_get_fullpath(world, e); + ecs_err("expected i32 type for enum constant '%s'", path); + ecs_os_free(path); + return -1; + } - ecs_header_t *hdr = poly; - ecs_os_memset(poly, 0, size); + const int32_t *value_ptr = ecs_get_pair_object( + world, e, EcsConstant, ecs_i32_t); + ecs_assert(value_ptr != NULL, ECS_INTERNAL_ERROR, NULL); + value = *value_ptr; + value_set = true; + } - hdr->magic = ECS_OBJECT_MAGIC; - hdr->type = type; - hdr->mixins = mixins; + /* Make sure constant value doesn't conflict if set / find the next value */ + it = ecs_map_iter(ptr->constants); + while ((c = ecs_map_next(&it, ecs_enum_constant_t, &key))) { + if (value_set) { + if (c->value == value) { + char *path = ecs_get_fullpath(world, e); + ecs_err("conflicting constant value for '%s' (other is '%s')", + path, c->name); + ecs_os_free(path); + return -1; + } + } else { + if (c->value >= value) { + value = c->value + 1; + } + } + } - return poly; -} + if (!ptr->constants) { + ptr->constants = ecs_map_new(ecs_enum_constant_t, 1); + } -void _ecs_poly_fini( - ecs_poly_t *poly, - int32_t type) -{ - ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); - (void)type; + c = ecs_map_ensure(ptr->constants, ecs_enum_constant_t, value); + c->name = ecs_os_strdup(ecs_get_name(world, e)); + c->value = value; + c->constant = e; - ecs_header_t *hdr = poly; + ecs_i32_t *cptr = ecs_get_mut_pair_object( + world, e, EcsConstant, ecs_i32_t, NULL); + ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); + cptr[0] = value; - /* Don't deinit poly that wasn't initialized */ - ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); - ecs_assert(hdr->type == type, ECS_INVALID_PARAMETER, NULL); - hdr->magic = 0; + return 0; } -#define assert_object(cond, file, line)\ - _ecs_assert((cond), ECS_INVALID_PARAMETER, #cond, file, line, NULL);\ - assert(cond) - -#ifndef FLECS_NDEBUG -void _ecs_poly_assert( - const ecs_poly_t *poly, - int32_t type, - const char *file, - int32_t line) +static +int add_constant_to_bitmask( + ecs_world_t *world, + ecs_entity_t type, + ecs_entity_t e, + ecs_id_t constant_id) { - assert_object(poly != NULL, file, line); + EcsBitmask *ptr = ecs_get_mut(world, type, EcsBitmask, NULL); - const ecs_header_t *hdr = poly; - assert_object(hdr->magic == ECS_OBJECT_MAGIC, file, line); - assert_object(hdr->type == type, file, line); -} -#endif - -bool _ecs_poly_is( - const ecs_poly_t *poly, - int32_t type) -{ - ecs_assert(poly != NULL, ECS_INVALID_PARAMETER, NULL); + /* Remove constant from map if it was already added */ + ecs_map_iter_t it = ecs_map_iter(ptr->constants); + ecs_bitmask_constant_t *c; + ecs_map_key_t key; + while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { + if (c->constant == e) { + ecs_os_free((char*)c->name); + ecs_map_remove(ptr->constants, key); + } + } - const ecs_header_t *hdr = poly; - ecs_assert(hdr->magic == ECS_OBJECT_MAGIC, ECS_INVALID_PARAMETER, NULL); - return hdr->type == type; -} + /* Check if constant sets explicit value */ + uint32_t value = 1; + if (ecs_id_is_pair(constant_id)) { + if (ecs_pair_second(world, constant_id) != ecs_id(ecs_u32_t)) { + char *path = ecs_get_fullpath(world, e); + ecs_err("expected u32 type for bitmask constant '%s'", path); + ecs_os_free(path); + return -1; + } -ecs_iterable_t* ecs_get_iterable( - const ecs_poly_t *poly) -{ - return (ecs_iterable_t*)assert_mixin(poly, EcsMixinIterable); -} + const uint32_t *value_ptr = ecs_get_pair_object( + world, e, EcsConstant, ecs_u32_t); + ecs_assert(value_ptr != NULL, ECS_INTERNAL_ERROR, NULL); + value = *value_ptr; + } else { + value = 1u << (ecs_u32_t)ecs_map_count(ptr->constants); + } -ecs_observable_t* ecs_get_observable( - const ecs_poly_t *poly) -{ - return (ecs_observable_t*)assert_mixin(poly, EcsMixinObservable); -} + /* Make sure constant value doesn't conflict */ + it = ecs_map_iter(ptr->constants); + while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { + if (c->value == value) { + char *path = ecs_get_fullpath(world, e); + ecs_err("conflicting constant value for '%s' (other is '%s')", + path, c->name); + ecs_os_free(path); + return -1; + } + } -const ecs_world_t* ecs_get_world( - const ecs_poly_t *poly) -{ - return *(ecs_world_t**)assert_mixin(poly, EcsMixinWorld); -} + if (!ptr->constants) { + ptr->constants = ecs_map_new(ecs_bitmask_constant_t, 1); + } -#include + c = ecs_map_ensure(ptr->constants, ecs_bitmask_constant_t, value); + c->name = ecs_os_strdup(ecs_get_name(world, e)); + c->value = value; + c->constant = e; -#ifndef FLECS_NDEBUG -static int64_t s_min[] = { - [1] = INT8_MIN, [2] = INT16_MIN, [4] = INT32_MIN, [8] = INT64_MIN }; -static int64_t s_max[] = { - [1] = INT8_MAX, [2] = INT16_MAX, [4] = INT32_MAX, [8] = INT64_MAX }; -static uint64_t u_max[] = { - [1] = UINT8_MAX, [2] = UINT16_MAX, [4] = UINT32_MAX, [8] = UINT64_MAX }; + ecs_u32_t *cptr = ecs_get_mut_pair_object( + world, e, EcsConstant, ecs_u32_t, NULL); + ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); + cptr[0] = value; -uint64_t _flecs_ito( - size_t size, - bool is_signed, - bool lt_zero, - uint64_t u, - const char *err) -{ - union { - uint64_t u; - int64_t s; - } v; + return 0; +} - v.u = u; +static +void set_primitive(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsPrimitive *type = ecs_term(it, EcsPrimitive, 1); - if (is_signed) { - ecs_assert(v.s >= s_min[size], ECS_INVALID_CONVERSION, err); - ecs_assert(v.s <= s_max[size], ECS_INVALID_CONVERSION, err); - } else { - ecs_assert(lt_zero == false, ECS_INVALID_CONVERSION, err); - ecs_assert(u <= u_max[size], ECS_INVALID_CONVERSION, err); + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + switch(type->kind) { + case EcsBool: + init_type_t(world, e, EcsPrimitiveType, bool); + break; + case EcsChar: + init_type_t(world, e, EcsPrimitiveType, char); + break; + case EcsByte: + init_type_t(world, e, EcsPrimitiveType, bool); + break; + case EcsU8: + init_type_t(world, e, EcsPrimitiveType, uint8_t); + break; + case EcsU16: + init_type_t(world, e, EcsPrimitiveType, uint16_t); + break; + case EcsU32: + init_type_t(world, e, EcsPrimitiveType, uint32_t); + break; + case EcsU64: + init_type_t(world, e, EcsPrimitiveType, uint64_t); + break; + case EcsI8: + init_type_t(world, e, EcsPrimitiveType, int8_t); + break; + case EcsI16: + init_type_t(world, e, EcsPrimitiveType, int16_t); + break; + case EcsI32: + init_type_t(world, e, EcsPrimitiveType, int32_t); + break; + case EcsI64: + init_type_t(world, e, EcsPrimitiveType, int64_t); + break; + case EcsF32: + init_type_t(world, e, EcsPrimitiveType, float); + break; + case EcsF64: + init_type_t(world, e, EcsPrimitiveType, double); + break; + case EcsUPtr: + init_type_t(world, e, EcsPrimitiveType, uintptr_t); + break; + case EcsIPtr: + init_type_t(world, e, EcsPrimitiveType, intptr_t); + break; + case EcsString: + init_type_t(world, e, EcsPrimitiveType, char*); + break; + case EcsEntity: + init_type_t(world, e, EcsPrimitiveType, ecs_entity_t); + break; + } } - - return u; } -#endif -int32_t flecs_next_pow_of_2( - int32_t n) -{ - n --; - n |= n >> 1; - n |= n >> 2; - n |= n >> 4; - n |= n >> 8; - n |= n >> 16; - n ++; +static +void set_member(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsMember *member = ecs_term(it, EcsMember, 1); - return n; -} + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); + if (!parent) { + ecs_err("missing parent for member '%s'", ecs_get_name(world, e)); + continue; + } -/** Convert time to double */ -double ecs_time_to_double( - ecs_time_t t) -{ - double result; - result = t.sec; - return result + (double)t.nanosec / (double)1000000000; + add_member_to_struct(world, parent, e, &member[i]); + } } -ecs_time_t ecs_time_sub( - ecs_time_t t1, - ecs_time_t t2) -{ - ecs_time_t result; +static +void add_enum(ecs_iter_t *it) { + ecs_world_t *world = it->world; - if (t1.nanosec >= t2.nanosec) { - result.nanosec = t1.nanosec - t2.nanosec; - result.sec = t1.sec - t2.sec; - } else { - result.nanosec = t1.nanosec - t2.nanosec + 1000000000; - result.sec = t1.sec - t2.sec - 1; - } + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; - return result; -} + if (init_type_t(world, e, EcsEnumType, ecs_i32_t)) { + continue; + } -void ecs_sleepf( - double t) -{ - if (t > 0) { - int sec = (int)t; - int nsec = (int)((t - sec) * 1000000000); - ecs_os_sleep(sec, nsec); + ecs_add_id(world, e, EcsExclusive); + ecs_add_id(world, e, EcsTag); } } -double ecs_time_measure( - ecs_time_t *start) -{ - ecs_time_t stop, temp; - ecs_os_get_time(&stop); - temp = stop; - stop = ecs_time_sub(stop, *start); - *start = temp; - return ecs_time_to_double(stop); -} +static +void add_bitmask(ecs_iter_t *it) { + ecs_world_t *world = it->world; -void* ecs_os_memdup( - const void *src, - ecs_size_t size) -{ - if (!src) { - return NULL; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + + if (init_type_t(world, e, EcsBitmaskType, ecs_u32_t)) { + continue; + } } - - void *dst = ecs_os_malloc(size); - ecs_assert(dst != NULL, ECS_OUT_OF_MEMORY, NULL); - ecs_os_memcpy(dst, src, size); - return dst; } -int flecs_entity_compare( - ecs_entity_t e1, - const void *ptr1, - ecs_entity_t e2, - const void *ptr2) -{ - (void)ptr1; - (void)ptr2; - return (e1 > e2) - (e1 < e2); -} +static +void add_constant(ecs_iter_t *it) { + ecs_world_t *world = it->world; -int flecs_entity_compare_qsort( - const void *e1, - const void *e2) -{ - ecs_entity_t v1 = *(ecs_entity_t*)e1; - ecs_entity_t v2 = *(ecs_entity_t*)e2; - return flecs_entity_compare(v1, NULL, v2, NULL); -} + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); + if (!parent) { + ecs_err("missing parent for constant '%s'", ecs_get_name(world, e)); + continue; + } -uint64_t flecs_string_hash( - const void *ptr) -{ - const ecs_hashed_string_t *str = ptr; - ecs_assert(str->hash != 0, ECS_INTERNAL_ERROR, NULL); - return str->hash; + if (ecs_has(world, parent, EcsEnum)) { + add_constant_to_enum(world, parent, e, it->event_id); + } else if (ecs_has(world, parent, EcsBitmask)) { + add_constant_to_bitmask(world, parent, e, it->event_id); + } + } } -/* - This code was taken from sokol_time.h - - zlib/libpng license - Copyright (c) 2018 Andre Weissflog - This software is provided 'as-is', without any express or implied warranty. - In no event will the authors be held liable for any damages arising from the - use of this software. - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software in a - product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not - be misrepresented as being the original software. - 3. This notice may not be removed or altered from any source - distribution. -*/ +static +void set_array(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsArray *array = ecs_term(it, EcsArray, 1); + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_entity_t elem_type = array[i].type; + int32_t elem_count = array[i].count; -static -int32_t type_search( - const ecs_table_t *table, - ecs_id_record_t *idr, - ecs_id_t *ids, - ecs_id_t *id_out, - ecs_table_record_t **tr_out) -{ - ecs_table_record_t *tr = ecs_table_cache_get(&idr->cache, table); - if (tr) { - int32_t r = tr->column; - if (tr_out) tr_out[0] = tr; - if (id_out) id_out[0] = ids[r]; - return r; - } + if (!elem_type) { + ecs_err("array '%s' has no element type", ecs_get_name(world, e)); + continue; + } - return -1; + if (!elem_count) { + ecs_err("array '%s' has size 0", ecs_get_name(world, e)); + continue; + } + + const EcsComponent *elem_ptr = ecs_get(world, elem_type, EcsComponent); + if (init_type(world, e, EcsArrayType, + elem_ptr->size * elem_count, elem_ptr->alignment)) + { + continue; + } + } } static -int32_t type_offset_search( - int32_t offset, - ecs_id_t id, - ecs_id_t *ids, - int32_t count, - ecs_id_t *id_out) -{ - ecs_assert(ids != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(count > 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(offset > 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); - ecs_assert(!ECS_HAS_ROLE(id, CASE), ECS_INVALID_PARAMETER, NULL); +void set_vector(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsVector *array = ecs_term(it, EcsVector, 1); - while (offset < count) { - ecs_id_t type_id = ids[offset ++]; - if (ecs_id_match(type_id, id)) { - if (id_out) id_out[0] = type_id; - return offset - 1; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_entity_t elem_type = array[i].type; + + if (!elem_type) { + ecs_err("vector '%s' has no element type", ecs_get_name(world, e)); + continue; } - } - return -1; + if (init_type_t(world, e, EcsVectorType, ecs_vector_t*)) { + continue; + } + } } -static -bool type_can_inherit_id( - const ecs_world_t *world, - const ecs_table_t *table, - const ecs_id_record_t *idr, - ecs_id_t id) +bool flecs_unit_validate( + ecs_world_t *world, + ecs_entity_t t, + EcsUnit *data) { - if (idr->flags & ECS_ID_DONT_INHERIT) { - return false; + char *derived_symbol = NULL; + const char *symbol = data->symbol; + + ecs_entity_t base = data->base; + ecs_entity_t over = data->over; + ecs_entity_t prefix = data->prefix; + ecs_unit_translation_t translation = data->translation; + + if (base) { + if (!ecs_has(world, base, EcsUnit)) { + ecs_err("entity '%s' for unit '%s' used as base is not a unit", + ecs_get_name(world, base), ecs_get_name(world, t)); + goto error; + } } - if (idr->flags & ECS_ID_EXCLUSIVE) { - if (ECS_HAS_ROLE(id, PAIR)) { - ecs_entity_t er = ECS_PAIR_FIRST(id); - if (flecs_get_table_record( - world, table, ecs_pair(er, EcsWildcard))) - { - return false; - } + + if (over) { + if (!base) { + ecs_err("invalid unit '%s': cannot specify over without base", + ecs_get_name(world, t)); + goto error; + } + if (!ecs_has(world, over, EcsUnit)) { + ecs_err("entity '%s' for unit '%s' used as over is not a unit", + ecs_get_name(world, over), ecs_get_name(world, t)); + goto error; } } - return true; -} -static -int32_t type_search_relation( - const ecs_world_t *world, - const ecs_table_t *table, - int32_t offset, - ecs_id_t id, - ecs_id_record_t *idr, - ecs_id_t rel, - ecs_id_record_t *idr_r, - int32_t min_depth, - int32_t max_depth, - ecs_entity_t *subject_out, - ecs_id_t *id_out, - ecs_table_record_t **tr_out) -{ - ecs_type_t type = table->type; - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t count = ecs_vector_count(type); + if (prefix) { + if (!base) { + ecs_err("invalid unit '%s': cannot specify prefix without base", + ecs_get_name(world, t)); + goto error; + } + const EcsUnitPrefix *prefix_ptr = ecs_get(world, prefix, EcsUnitPrefix); + if (!prefix_ptr) { + ecs_err("entity '%s' for unit '%s' used as prefix is not a prefix", + ecs_get_name(world, over), ecs_get_name(world, t)); + goto error; + } - if (min_depth <= 0) { - if (offset) { - int32_t r = type_offset_search(offset, id, ids, count, id_out); - if (r != -1) { - return r; + if (translation.factor || translation.power) { + if (prefix_ptr->translation.factor != translation.factor || + prefix_ptr->translation.power != translation.power) + { + ecs_err( + "factor for unit '%s' is inconsistent with prefix '%s'", + ecs_get_name(world, t), ecs_get_name(world, prefix)); + goto error; } } else { - int32_t r = type_search(table, idr, ids, id_out, tr_out); - if (r != -1) { - return r; - } + translation = prefix_ptr->translation; } } - ecs_flags32_t flags = table->flags; - if ((flags & EcsTableHasPairs) && max_depth && rel) { - bool is_a = rel == ecs_pair(EcsIsA, EcsWildcard); - if (is_a) { - if (!(flags & EcsTableHasIsA)) { - return -1; - } - if (!type_can_inherit_id(world, table, idr, id)) { - return -1; + if (base) { + bool must_match = false; /* Must base symbol match symbol? */ + ecs_strbuf_t sbuf = ECS_STRBUF_INIT; + if (prefix) { + const EcsUnitPrefix *ptr = ecs_get(world, prefix, EcsUnitPrefix); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + if (ptr->symbol) { + ecs_strbuf_appendstr(&sbuf, ptr->symbol); + must_match = true; } - idr_r = world->idr_isa_wildcard; } - if (!idr_r) { - idr_r = flecs_get_id_record(world, rel); - if (!idr_r) { - return -1; - } + const EcsUnit *uptr = ecs_get(world, base, EcsUnit); + ecs_assert(uptr != NULL, ECS_INTERNAL_ERROR, NULL); + if (uptr->symbol) { + ecs_strbuf_appendstr(&sbuf, uptr->symbol); } - ecs_id_t id_r; - ecs_table_record_t *tr_r; - int32_t r, r_column = type_search(table, idr_r, ids, &id_r, &tr_r); - while (r_column != -1) { - ecs_entity_t obj = ECS_PAIR_SECOND(id_r); - ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); + if (over) { + uptr = ecs_get(world, over, EcsUnit); + ecs_assert(uptr != NULL, ECS_INTERNAL_ERROR, NULL); + if (uptr->symbol) { + ecs_strbuf_appendstr(&sbuf, "/"); + ecs_strbuf_appendstr(&sbuf, uptr->symbol); + must_match = true; + } + } - ecs_record_t *rec = ecs_eis_get_any(world, obj); - ecs_assert(rec != NULL, ECS_INTERNAL_ERROR, NULL); + derived_symbol = ecs_strbuf_get(&sbuf); + if (derived_symbol && !ecs_os_strlen(derived_symbol)) { + ecs_os_free(derived_symbol); + derived_symbol = NULL; + } - ecs_table_t *obj_table = rec->table; - if (obj_table) { - r = type_search_relation(world, obj_table, offset, id, idr, - rel, idr_r, min_depth - 1, max_depth - 1, subject_out, - id_out, tr_out); - if (r != -1) { - if (subject_out && !subject_out[0]) { - subject_out[0] = ecs_get_alive(world, obj); - } - return r; - } - - if (!is_a) { - r = type_search_relation(world, obj_table, offset, id, idr, - ecs_pair(EcsIsA, EcsWildcard), world->idr_isa_wildcard, - 1, INT_MAX, subject_out, id_out, tr_out); - if (r != -1) { - if (subject_out && !subject_out[0]) { - subject_out[0] = ecs_get_alive(world, obj); - } - return r; - } - } + if (derived_symbol && symbol && ecs_os_strcmp(symbol, derived_symbol)) { + if (must_match) { + ecs_err("symbol '%s' for unit '%s' does not match base" + " symbol '%s'", symbol, + ecs_get_name(world, t), derived_symbol); + goto error; } - - r_column = type_offset_search(r_column + 1, rel, ids, count, &id_r); + } + if (!symbol && derived_symbol && (prefix || over)) { + ecs_os_free(data->symbol); + data->symbol = derived_symbol; + } else { + ecs_os_free(derived_symbol); } } - return -1; + data->base = base; + data->over = over; + data->prefix = prefix; + data->translation = translation; + + return true; +error: + ecs_os_free(derived_symbol); + return false; } -int32_t ecs_search_relation( - const ecs_world_t *world, - const ecs_table_t *table, - int32_t offset, - ecs_id_t id, - ecs_entity_t rel, - int32_t min_depth, - int32_t max_depth, - ecs_entity_t *subject_out, - ecs_id_t *id_out, - struct ecs_table_record_t **tr_out) -{ - if (!table) return -1; +static +void set_unit(ecs_iter_t *it) { + EcsUnit *u = ecs_term(it, EcsUnit, 1); - ecs_poly_assert(world, ecs_world_t); - ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); + ecs_world_t *world = it->world; - bool is_case = ECS_HAS_ROLE(id, CASE); - id = is_case * (ECS_SWITCH | ECS_PAIR_FIRST(id)) + !is_case * id; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + flecs_unit_validate(world, e, &u[i]); + } +} - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return -1; +static +void unit_quantity_monitor(ecs_iter_t *it) { + ecs_world_t *world = it->world; + + int i, count = it->count; + if (it->event == EcsOnAdd) { + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_add_pair(world, e, EcsQuantity, e); + } + } else { + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_remove_pair(world, e, EcsQuantity, e); + } } +} - max_depth = INT_MAX * !max_depth + max_depth * !!max_depth; +static +void ecs_meta_type_init_default_ctor(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsMetaType *type = ecs_term(it, EcsMetaType, 1); - int32_t result = type_search_relation(world, table, offset, id, idr, - ecs_pair(rel, EcsWildcard), NULL, min_depth, max_depth, subject_out, - id_out, tr_out); + int i; + for (i = 0; i < it->count; i ++) { + /* If a component is defined from reflection data, configure it with the + * default constructor. This ensures that a new component value does not + * contain uninitialized memory, which could cause serializers to crash + * when for example inspecting string fields. */ + if (!type->existing) { + ecs_set_component_actions_w_id(world, it->entities[i], + &(EcsComponentLifecycle){ + .ctor = ecs_default_ctor + }); + } + } +} - return result; +static +void member_on_set(ecs_iter_t *it) { + EcsMember *mbr = it->ptrs[0]; + if (!mbr->count) { + mbr->count = 1; + } } -int32_t ecs_search( - const ecs_world_t *world, - const ecs_table_t *table, - ecs_id_t id, - ecs_id_t *id_out) +void FlecsMetaImport( + ecs_world_t *world) { - if (!table) return -1; + ECS_MODULE(world, FlecsMeta); - ecs_poly_assert(world, ecs_world_t); - ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); + ecs_set_name_prefix(world, "Ecs"); - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr) { - return -1; - } + flecs_bootstrap_component(world, EcsMetaType); + flecs_bootstrap_component(world, EcsMetaTypeSerialized); + flecs_bootstrap_component(world, EcsPrimitive); + flecs_bootstrap_component(world, EcsEnum); + flecs_bootstrap_component(world, EcsBitmask); + flecs_bootstrap_component(world, EcsMember); + flecs_bootstrap_component(world, EcsStruct); + flecs_bootstrap_component(world, EcsArray); + flecs_bootstrap_component(world, EcsVector); + flecs_bootstrap_component(world, EcsUnit); + flecs_bootstrap_component(world, EcsUnitPrefix); - ecs_type_t type = table->type; - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - return type_search(table, idr, ids, id_out, NULL); -} + flecs_bootstrap_tag(world, EcsConstant); + flecs_bootstrap_tag(world, EcsQuantity); -int32_t ecs_search_offset( - const ecs_world_t *world, - const ecs_table_t *table, - int32_t offset, - ecs_id_t id, - ecs_id_t *id_out) -{ - if (!offset) { - return ecs_search(world, table, id, id_out); - } + ecs_set_component_actions(world, EcsMetaType, { .ctor = ecs_default_ctor }); - if (!table) return -1; + ecs_set_component_actions(world, EcsMetaTypeSerialized, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsMetaTypeSerialized), + .copy = ecs_copy(EcsMetaTypeSerialized), + .dtor = ecs_dtor(EcsMetaTypeSerialized) + }); - ecs_poly_assert(world, ecs_world_t); + ecs_set_component_actions(world, EcsStruct, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsStruct), + .copy = ecs_copy(EcsStruct), + .dtor = ecs_dtor(EcsStruct) + }); - ecs_type_t type = table->type; - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t count = ecs_vector_count(type); - return type_offset_search(offset, id, ids, count, id_out); -} + ecs_set_component_actions(world, EcsMember, { + .ctor = ecs_default_ctor, + .on_set = member_on_set + }); + ecs_set_component_actions(world, EcsEnum, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsEnum), + .copy = ecs_copy(EcsEnum), + .dtor = ecs_dtor(EcsEnum) + }); -#include + ecs_set_component_actions(world, EcsBitmask, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsBitmask), + .copy = ecs_copy(EcsBitmask), + .dtor = ecs_dtor(EcsBitmask) + }); -static -void term_error( - const ecs_world_t *world, - const ecs_term_t *term, - const char *name, - const char *fmt, - ...) -{ - va_list args; - va_start(args, fmt); + ecs_set_component_actions(world, EcsUnit, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsUnit), + .copy = ecs_copy(EcsUnit), + .dtor = ecs_dtor(EcsUnit) + }); - char *expr = ecs_term_str(world, term); - ecs_parser_errorv(name, expr, 0, fmt, args); - ecs_os_free(expr); + ecs_set_component_actions(world, EcsUnitPrefix, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsUnitPrefix), + .copy = ecs_copy(EcsUnitPrefix), + .dtor = ecs_dtor(EcsUnitPrefix) + }); - va_end(args); -} + /* Register triggers to finalize type information from component data */ + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsPrimitive), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = set_primitive + }); -static -int finalize_term_set( - const ecs_world_t *world, - ecs_term_t *term, - ecs_term_id_t *identifier, - const char *name) -{ - if (identifier->set.mask & EcsParent) { - identifier->set.mask |= EcsSuperSet; - identifier->set.relation = EcsChildOf; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsMember), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = set_member + }); - /* Default relation for superset/subset is EcsIsA */ - if (identifier->set.mask & (EcsSuperSet|EcsSubSet)) { - if (!identifier->set.relation) { - identifier->set.relation = EcsIsA; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsEnum), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnAdd}, + .callback = add_enum + }); - if (!(identifier->set.mask & EcsSelf)) { - if (!identifier->set.min_depth) { - identifier->set.min_depth = 1; - } - } - } else { - if (identifier->set.min_depth > 0) { - term_error(world, term, name, - "min depth cannnot be non-zero for Self term"); - return -1; - } - if (identifier->set.max_depth > 1) { - term_error(world, term, name, - "max depth cannnot be larger than 1 for Self term"); - return -1; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsBitmask), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnAdd}, + .callback = add_bitmask + }); - identifier->set.max_depth = 1; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = EcsConstant, + .term.subj.set.mask = EcsSelf, + .events = {EcsOnAdd}, + .callback = add_constant + }); - if ((identifier->set.mask != EcsNothing) && - (identifier->set.mask & EcsNothing)) - { - term_error(world, term, name, "invalid Nothing in set mask"); - return -1; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_pair(EcsConstant, EcsWildcard), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = add_constant + }); - return 0; -} + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsArray), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = set_array + }); -static -int finalize_term_var( - const ecs_world_t *world, - ecs_term_t *term, - ecs_term_id_t *identifier, - const char *name) -{ - if (identifier->var == EcsVarDefault) { - const char *var = ecs_identifier_is_var(identifier->name); - if (var) { - char *var_dup = ecs_os_strdup(var); - ecs_os_free(identifier->name); - identifier->name = var_dup; - identifier->var = EcsVarIsVariable; - } - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsVector), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = set_vector + }); - if (identifier->var == EcsVarDefault && identifier->set.mask != EcsNothing){ - identifier->var = EcsVarIsEntity; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsUnit), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = set_unit + }); - if (!identifier->name) { - return 0; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsMetaType), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = ecs_meta_type_serialized_init + }); - if (identifier->var != EcsVarIsVariable) { - if (ecs_identifier_is_0(identifier->name)) { - identifier->entity = 0; - } else { - ecs_entity_t e = ecs_lookup_symbol(world, identifier->name, true); - if (!e) { - term_error(world, term, name, - "unresolved identifier '%s'", identifier->name); - return -1; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_id(EcsMetaType), + .term.subj.set.mask = EcsSelf, + .events = {EcsOnSet}, + .callback = ecs_meta_type_init_default_ctor + }); - identifier->entity = e; - } - } + ecs_observer_init(world, &(ecs_observer_desc_t) { + .filter.terms = { + { .id = ecs_id(EcsUnit) }, + { .id = EcsQuantity } + }, + .events = { EcsMonitor }, + .callback = unit_quantity_monitor + }); - if ((identifier->set.mask == EcsNothing) && - (identifier->var != EcsVarDefault)) - { - term_error(world, term, name, "Invalid Nothing with entity"); - return -1; - } + /* Initialize primitive types */ + #define ECS_PRIMITIVE(world, type, primitive_kind)\ + ecs_entity_init(world, &(ecs_entity_desc_t) {\ + .entity = ecs_id(ecs_##type##_t),\ + .name = #type,\ + .symbol = #type });\ + ecs_set(world, ecs_id(ecs_##type##_t), EcsPrimitive, {\ + .kind = primitive_kind\ + }); - if (identifier->var == EcsVarIsEntity) { - if (identifier->entity && !ecs_is_alive(world, identifier->entity)) { - term_error(world, term, name, - "cannot use not alive entity %u in query", - (uint32_t)identifier->entity); - return -1; - } - } + ECS_PRIMITIVE(world, bool, EcsBool); + ECS_PRIMITIVE(world, char, EcsChar); + ECS_PRIMITIVE(world, byte, EcsByte); + ECS_PRIMITIVE(world, u8, EcsU8); + ECS_PRIMITIVE(world, u16, EcsU16); + ECS_PRIMITIVE(world, u32, EcsU32); + ECS_PRIMITIVE(world, u64, EcsU64); + ECS_PRIMITIVE(world, uptr, EcsUPtr); + ECS_PRIMITIVE(world, i8, EcsI8); + ECS_PRIMITIVE(world, i16, EcsI16); + ECS_PRIMITIVE(world, i32, EcsI32); + ECS_PRIMITIVE(world, i64, EcsI64); + ECS_PRIMITIVE(world, iptr, EcsIPtr); + ECS_PRIMITIVE(world, f32, EcsF32); + ECS_PRIMITIVE(world, f64, EcsF64); + ECS_PRIMITIVE(world, string, EcsString); + ECS_PRIMITIVE(world, entity, EcsEntity); - return 0; -} + #undef ECS_PRIMITIVE -static -int finalize_term_identifier( - const ecs_world_t *world, - ecs_term_t *term, - ecs_term_id_t *identifier, - const char *name) -{ - if (finalize_term_set(world, term, identifier, name)) { - return -1; - } - if (finalize_term_var(world, term, identifier, name)) { - return -1; - } - return 0; -} + /* Set default child components */ + ecs_add_pair(world, ecs_id(EcsStruct), + EcsDefaultChildComponent, ecs_id(EcsMember)); -static -bool term_can_inherit( - ecs_term_t *term) -{ - /* Hardcoded components that can't be inherited. TODO: replace with - * relationship property. */ - if (term->pred.entity == EcsChildOf || - (term->id == ecs_pair(ecs_id(EcsIdentifier), EcsName)) || - (term->id == EcsPrefab) || - (term->id == EcsDisabled)) - { - return false; - } - return true; -} + ecs_add_pair(world, ecs_id(EcsMember), + EcsDefaultChildComponent, ecs_id(EcsMember)); -static -ecs_entity_t term_id_entity( - const ecs_world_t *world, - ecs_term_id_t *term_id) -{ - if (term_id->entity && term_id->entity != EcsThis && - term_id->entity != EcsWildcard && term_id->entity != EcsAny) - { - if (!(term_id->entity & ECS_ROLE_MASK)) { - return term_id->entity; - } else { - return 0; + ecs_add_pair(world, ecs_id(EcsEnum), + EcsDefaultChildComponent, EcsConstant); + + ecs_add_pair(world, ecs_id(EcsBitmask), + EcsDefaultChildComponent, EcsConstant); + + /* Relationship properties */ + ecs_add_id(world, EcsQuantity, EcsExclusive); + ecs_add_id(world, EcsQuantity, EcsTag); + + /* Initialize reflection data for meta components */ + ecs_entity_t type_kind = ecs_enum_init(world, &(ecs_enum_desc_t) { + .entity.name = "TypeKind", + .constants = { + {.name = "PrimitiveType"}, + {.name = "BitmaskType"}, + {.name = "EnumType"}, + {.name = "StructType"}, + {.name = "ArrayType"}, + {.name = "VectorType"} } - } else if (term_id->name) { - if (term_id->var == EcsVarIsEntity || - (term_id->var == EcsVarDefault && - !ecs_identifier_is_var(term_id->name))) - { - ecs_entity_t e = ecs_lookup_fullpath(world, term_id->name); - if (e != EcsWildcard && e != EcsThis && e != EcsAny) { - return e; - } - return 0; - } else { - return 0; + }); + + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsMetaType), + .members = { + {.name = (char*)"kind", .type = type_kind} } - } else { - return 0; - } -} + }); -static -int finalize_term_vars( - const ecs_world_t *world, - ecs_term_t *term, - const char *name) -{ - if (finalize_term_var(world, term, &term->pred, name)) { - return -1; - } - if (finalize_term_var(world, term, &term->subj, name)) { - return -1; - } - if (finalize_term_var(world, term, &term->obj, name)) { - return -1; - } - return 0; -} + ecs_entity_t primitive_kind = ecs_enum_init(world, &(ecs_enum_desc_t) { + .entity.name = "PrimitiveKind", + .constants = { + {.name = "Bool", 1}, + {.name = "Char"}, + {.name = "Byte"}, + {.name = "U8"}, + {.name = "U16"}, + {.name = "U32"}, + {.name = "U64"}, + {.name = "I8"}, + {.name = "I16"}, + {.name = "I32"}, + {.name = "I64"}, + {.name = "F32"}, + {.name = "F64"}, + {.name = "UPtr"}, + {.name = "IPtr"}, + {.name = "String"}, + {.name = "Entity"} + } + }); -static -bool entity_is_var( - ecs_entity_t e) -{ - if (e == EcsThis || e == EcsWildcard || e == EcsAny) { - return true; - } - return false; -} + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsPrimitive), + .members = { + {.name = (char*)"kind", .type = primitive_kind} + } + }); -static -int finalize_term_identifiers( - const ecs_world_t *world, - ecs_term_t *term, - const char *name) -{ - /* By default select subsets for predicates. For example, when the term - * matches "Tree", also include "Oak", "Pine", "Elm". */ - if (term->pred.set.mask == EcsDefaultSet) { - ecs_entity_t e = term_id_entity(world, &term->pred); + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsMember), + .members = { + {.name = (char*)"type", .type = ecs_id(ecs_entity_t)}, + {.name = (char*)"count", .type = ecs_id(ecs_i32_t)}, + {.name = (char*)"unit", .type = ecs_id(ecs_entity_t)} + } + }); - if (e && !ecs_has_id(world, e, EcsFinal)) { - term->pred.set.mask = EcsSelf|EcsSubSet; - } else { - /* If predicate is final, don't search subsets */ - term->pred.set.mask = EcsSelf; + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsArray), + .members = { + {.name = (char*)"type", .type = ecs_id(ecs_entity_t)}, + {.name = (char*)"count", .type = ecs_id(ecs_i32_t)}, } - } + }); - /* By default select supersets for subjects. For example, when an entity has - * (IsA, SpaceShip), also search the components of SpaceShip. */ - if (term->subj.set.mask == EcsDefaultSet) { - ecs_entity_t e = term_id_entity(world, &term->pred); + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsVector), + .members = { + {.name = (char*)"type", .type = ecs_id(ecs_entity_t)} + } + }); - /* If the component has the DontInherit tag, use EcsSelf */ - if (!e || !ecs_has_id(world, e, EcsDontInherit)) { - term->subj.set.mask = EcsSelf|EcsSuperSet; - } else { - term->subj.set.mask = EcsSelf; + ecs_entity_t ut = ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.name = "unit_translation", + .members = { + {.name = (char*)"factor", .type = ecs_id(ecs_i32_t)}, + {.name = (char*)"power", .type = ecs_id(ecs_i32_t)} } - } + }); - /* By default select self for objects. */ - if (term->obj.set.mask == EcsDefaultSet) { - term->obj.set.mask = EcsSelf; - } + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsUnit), + .members = { + {.name = (char*)"symbol", .type = ecs_id(ecs_string_t)}, + {.name = (char*)"prefix", .type = ecs_id(ecs_entity_t)}, + {.name = (char*)"base", .type = ecs_id(ecs_entity_t)}, + {.name = (char*)"over", .type = ecs_id(ecs_entity_t)}, + {.name = (char*)"translation", .type = ut} + } + }); - if (finalize_term_set(world, term, &term->pred, name)) { - return -1; - } - if (finalize_term_set(world, term, &term->subj, name)) { - return -1; - } - if (finalize_term_set(world, term, &term->obj, name)) { - return -1; - } + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsUnitPrefix), + .members = { + {.name = (char*)"symbol", .type = ecs_id(ecs_string_t)}, + {.name = (char*)"translation", .type = ut} + } + }); +} - if (term->pred.set.mask & EcsNothing) { - term_error(world, term, name, - "invalid Nothing value for predicate set mask"); - return -1; - } +#endif - if (term->obj.set.mask & EcsNothing) { - term_error(world, term, name, - "invalid Nothing value for object set mask"); - return -1; - } - if (!(term->subj.set.mask & EcsNothing) && - !term->subj.entity && - term->subj.var == EcsVarIsEntity) - { - term->subj.entity = EcsThis; - } - - if (entity_is_var(term->pred.entity)) { - term->pred.var = EcsVarIsVariable; - } - if (entity_is_var(term->subj.entity)) { - term->subj.var = EcsVarIsVariable; - } - if (entity_is_var(term->obj.entity)) { - term->obj.var = EcsVarIsVariable; +#ifdef FLECS_META + +static +const char* op_kind_str( + ecs_meta_type_op_kind_t kind) +{ + switch(kind) { + + case EcsOpEnum: return "Enum"; + case EcsOpBitmask: return "Bitmask"; + case EcsOpArray: return "Array"; + case EcsOpVector: return "Vector"; + case EcsOpPush: return "Push"; + case EcsOpPop: return "Pop"; + case EcsOpPrimitive: return "Primitive"; + case EcsOpBool: return "Bool"; + case EcsOpChar: return "Char"; + case EcsOpByte: return "Byte"; + case EcsOpU8: return "U8"; + case EcsOpU16: return "U16"; + case EcsOpU32: return "U32"; + case EcsOpU64: return "U64"; + case EcsOpI8: return "I8"; + case EcsOpI16: return "I16"; + case EcsOpI32: return "I32"; + case EcsOpI64: return "I64"; + case EcsOpF32: return "F32"; + case EcsOpF64: return "F64"; + case EcsOpUPtr: return "UPtr"; + case EcsOpIPtr: return "IPtr"; + case EcsOpString: return "String"; + case EcsOpEntity: return "Entity"; + default: return "<< invalid kind >>"; } +} - return 0; +/* Get current scope */ +static +ecs_meta_scope_t* get_scope( + const ecs_meta_cursor_t *cursor) +{ + ecs_check(cursor != NULL, ECS_INVALID_PARAMETER, NULL); + return (ecs_meta_scope_t*)&cursor->scope[cursor->depth]; +error: + return NULL; } +/* Get previous scope */ static -ecs_entity_t entity_from_identifier( - const ecs_term_id_t *identifier) +ecs_meta_scope_t* get_prev_scope( + ecs_meta_cursor_t *cursor) { - if (identifier->var == EcsVarDefault) { - return 0; - } else if (identifier->var == EcsVarIsEntity) { - return identifier->entity; - } else if (identifier->var == EcsVarIsVariable) { - return EcsWildcard; - } else { - /* This should've been caught earlier */ - ecs_abort(ECS_INTERNAL_ERROR, NULL); + ecs_check(cursor != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(cursor->depth > 0, ECS_INVALID_PARAMETER, NULL); + return &cursor->scope[cursor->depth - 1]; +error: + return NULL; +} + +/* Get current operation for scope */ +static +ecs_meta_type_op_t* get_op( + ecs_meta_scope_t *scope) +{ + return &scope->ops[scope->op_cur]; +} + +/* Get component for type in current scope */ +static +const EcsComponent* get_component_ptr( + const ecs_world_t *world, + ecs_meta_scope_t *scope) +{ + const EcsComponent *comp = scope->comp; + if (!comp) { + comp = scope->comp = ecs_get(world, scope->type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); } + return comp; } +/* Get size for type in current scope */ static -int finalize_term_id( +ecs_size_t get_size( const ecs_world_t *world, - ecs_term_t *term, - const char *name) + ecs_meta_scope_t *scope) { - ecs_entity_t pred = entity_from_identifier(&term->pred); - ecs_entity_t obj = entity_from_identifier(&term->obj); - ecs_id_t role = term->role; + return get_component_ptr(world, scope)->size; +} - if (ECS_HAS_ROLE(pred, PAIR)) { - if (obj) { - term_error(world, term, name, - "cannot set term.pred to a pair and term.obj at the same time"); - return -1; - } +/* Get alignment for type in current scope */ +static +ecs_size_t get_alignment( + const ecs_world_t *world, + ecs_meta_scope_t *scope) +{ + return get_component_ptr(world, scope)->alignment; +} - obj = ECS_PAIR_SECOND(pred); - pred = ECS_PAIR_FIRST(pred); +static +int32_t get_elem_count( + ecs_meta_scope_t *scope) +{ + if (scope->vector) { + return ecs_vector_count(*(scope->vector)); + } - term->pred.entity = pred; - term->obj.entity = obj; + ecs_meta_type_op_t *op = get_op(scope); + return op->count; +} - if (finalize_term_identifier(world, term, &term->obj, name)) { - return -1; - } - } +/* Get pointer to current field/element */ +static +ecs_meta_type_op_t* get_ptr( + const ecs_world_t *world, + ecs_meta_scope_t *scope) +{ + ecs_meta_type_op_t *op = get_op(scope); + ecs_size_t size = get_size(world, scope); - if (!obj && role != ECS_PAIR) { - term->id = pred | role; - } else { - if (role) { - if (role && role != ECS_PAIR && role != ECS_CASE) { - term_error(world, term, name, "invalid role for pair"); - return -1; - } + if (scope->vector) { + ecs_size_t align = get_alignment(world, scope); + ecs_vector_set_min_count_t( + scope->vector, size, align, scope->elem_cur + 1); + scope->ptr = ecs_vector_first_t(*(scope->vector), size, align); + } - term->role = role; - } else { - term->role = ECS_PAIR; - } + return ECS_OFFSET(scope->ptr, size * scope->elem_cur + op->offset); +} - term->id = term->role | ecs_entity_t_comb(obj, pred); +static +int push_type( + const ecs_world_t *world, + ecs_meta_scope_t *scope, + ecs_entity_t type, + void *ptr) +{ + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + if (ser == NULL) { + char *str = ecs_id_str(world, type); + ecs_err("cannot open scope for entity '%s' which is not a type", str); + ecs_os_free(str); + return -1; } + scope[0] = (ecs_meta_scope_t) { + .type = type, + .ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t), + .op_count = ecs_vector_count(ser->ops), + .ptr = ptr + }; + return 0; } -static -int populate_from_term_id( +ecs_meta_cursor_t ecs_meta_cursor( const ecs_world_t *world, - ecs_term_t *term, - const char *name) + ecs_entity_t type, + void *ptr) { - ecs_entity_t pred = 0; - ecs_entity_t obj = 0; - ecs_id_t role = term->id & ECS_ROLE_MASK; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(type != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); - if (!role && term->role) { - role = term->role; - term->id |= role; - } + ecs_meta_cursor_t result = { + .world = world, + .valid = true + }; - if (term->role && term->role != role) { - term_error(world, term, name, "mismatch between term.id & term.role"); - return -1; + if (push_type(world, result.scope, type, ptr) != 0) { + result.valid = false; } - term->role = role; + return result; +error: + return (ecs_meta_cursor_t){ 0 }; +} - if (ECS_HAS_ROLE(term->id, PAIR) || ECS_HAS_ROLE(term->id, CASE)) { - pred = ECS_PAIR_FIRST(term->id); - obj = ECS_PAIR_SECOND(term->id); +void* ecs_meta_get_ptr( + ecs_meta_cursor_t *cursor) +{ + return get_ptr(cursor->world, get_scope(cursor)); +} - if (!pred) { - term_error(world, term, name, "missing predicate in term.id pair"); - return -1; - } - if (!obj) { - if (pred != EcsChildOf) { - term_error(world, term, name, "missing object in term.id pair"); - return -1; - } - } - } else { - pred = term->id & ECS_COMPONENT_MASK; - if (!pred) { - term_error(world, term, name, "missing predicate in term.id"); - return -1; - } - } +int ecs_meta_next( + ecs_meta_cursor_t *cursor) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); - ecs_entity_t term_pred = entity_from_identifier(&term->pred); - if (term_pred) { - if (term_pred != pred) { - term_error(world, term, name, - "mismatch between term.id and term.pred"); - return -1; - } - } else { - term->pred.entity = pred; - if (finalize_term_identifier(world, term, &term->pred, name)) { + if (scope->is_collection) { + scope->elem_cur ++; + scope->op_cur = 0; + if (scope->elem_cur >= get_elem_count(scope)) { + ecs_err("out of collection bounds (%d)", scope->elem_cur); return -1; } + + return 0; } - ecs_entity_t term_obj = entity_from_identifier(&term->obj); - if (term_obj) { - if (ecs_entity_t_lo(term_obj) != obj) { - term_error(world, term, name, - "mismatch between term.id and term.obj"); - return -1; - } - } else { - term->obj.entity = obj; - if (finalize_term_identifier(world, term, &term->obj, name)) { - return -1; - } + scope->op_cur += op->op_count; + if (scope->op_cur >= scope->op_count) { + ecs_err("out of bounds"); + return -1; } return 0; } -static -int verify_term_consistency( - const ecs_world_t *world, - const ecs_term_t *term, +int ecs_meta_member( + ecs_meta_cursor_t *cursor, const char *name) { - ecs_entity_t pred = entity_from_identifier(&term->pred); - ecs_entity_t obj = entity_from_identifier(&term->obj); - ecs_id_t role = term->role; - ecs_id_t id = term->id; - bool wildcard = pred == EcsWildcard || obj == EcsWildcard; - - if (obj && (!role || (role != ECS_PAIR && role != ECS_CASE))) { - term_error(world, term, name, - "invalid role for term with pair (expected ECS_PAIR)"); + if (cursor->depth == 0) { + ecs_err("cannot move to member in root scope"); return -1; } - if (role == ECS_CASE && !obj) { - term_error(world, term, name, - "missing object for term with ECS_CASE role"); - return -1; - } + ecs_meta_scope_t *prev_scope = get_prev_scope(cursor); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *push_op = get_op(prev_scope); + const ecs_world_t *world = cursor->world; - if (!pred) { - term_error(world, term, name, "missing predicate for term"); + ecs_assert(push_op->kind == EcsOpPush, ECS_INTERNAL_ERROR, NULL); + + if (!push_op->members) { + ecs_err("cannot move to member '%s' for non-struct type", name); return -1; } - if (role != (id & ECS_ROLE_MASK)) { - term_error(world, term, name, "mismatch between term.role & term.id"); + const uint64_t *cur_ptr = flecs_name_index_find_ptr(push_op->members, name, 0, 0); + if (!cur_ptr) { + char *path = ecs_get_fullpath(world, scope->type); + ecs_err("unknown member '%s' for type '%s'", name, path); + ecs_os_free(path); return -1; } - if (obj && !ECS_HAS_ROLE(id, PAIR) && !ECS_HAS_ROLE(id, CASE)) { - term_error(world, term, name, "term has object but id is not a pair"); - return -1; - } + scope->op_cur = flecs_uto(int32_t, cur_ptr[0]); - if (ECS_HAS_ROLE(id, PAIR) || ECS_HAS_ROLE(id, CASE)) { - if (!wildcard) { - role = ECS_ROLE_MASK & id; - if (id != (role | ecs_entity_t_comb( - term->obj.entity, term->pred.entity))) - { - char *id_str = ecs_id_str(world, ecs_pair(pred, obj)); - term_error(world, term, name, - "term id does not match pred/obj (%s)", id_str); - ecs_os_free(id_str); - return -1; + return 0; +} + +int ecs_meta_push( + ecs_meta_cursor_t *cursor) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + const ecs_world_t *world = cursor->world; + + if (cursor->depth == 0) { + if (!cursor->is_primitive_scope) { + if (op->kind > EcsOpScope) { + cursor->is_primitive_scope = true; + return 0; } } - } else if (term->pred.entity != (id & ECS_COMPONENT_MASK)) { - if (!wildcard) { - char *pred_str = ecs_get_fullpath(world, term->pred.entity); - term_error(world, term, name, "term id does not match pred '%s'", - pred_str); - ecs_os_free(pred_str); - return -1; - } } - if (term->pred.var == EcsVarIsEntity) { - const ecs_term_id_t *tsubj = &term->subj; - const ecs_term_id_t *tobj = &term->obj; + void *ptr = get_ptr(world, scope); + cursor->depth ++; + ecs_check(cursor->depth < ECS_META_MAX_SCOPE_DEPTH, + ECS_INVALID_PARAMETER, NULL); - if (ecs_term_id_is_set(tsubj) && ecs_term_id_is_set(tobj)) { - if (tsubj->var == tobj->var) { - bool is_same = false; + ecs_meta_scope_t *next_scope = get_scope(cursor); - if (tsubj->var == EcsVarIsEntity) { - is_same = tsubj->entity == tobj->entity; - } else if (tsubj->name && tobj->name) { - is_same = !ecs_os_strcmp(tsubj->name, tobj->name); - } + /* If we're not already in an inline array and this operation is an inline + * array, push a frame for the array. + * Doing this first ensures that inline arrays take precedence over other + * kinds of push operations, such as for a struct element type. */ + if (!scope->is_inline_array && op->count > 1 && !scope->is_collection) { + /* Push a frame just for the element type, with inline_array = true */ + next_scope[0] = (ecs_meta_scope_t){ + .ops = op, + .op_count = op->op_count, + .ptr = scope->ptr, + .type = op->type, + .is_collection = true, + .is_inline_array = true + }; - if (is_same && ecs_has_id(world, term->pred.entity, EcsAcyclic) - && !ecs_has_id(world, term->pred.entity, EcsReflexive)) - { - char *pred_str = ecs_get_fullpath(world, term->pred.entity); - term_error(world, term, name, "term with acyclic relation" - " '%s' cannot have same subject and object", - pred_str); - ecs_os_free(pred_str); - return -1; - } - } - } + /* With 'is_inline_array' set to true we ensure that we can never push + * the same inline array twice */ + + return 0; } - if (term->subj.set.relation && !term->subj.set.max_depth) { - if (!ecs_has_id(world, term->subj.set.relation, EcsAcyclic)) { - char *r_str = ecs_get_fullpath(world, term->subj.set.relation); - term_error(world, term, name, - "relation '%s' is used with SuperSet/SubSet but is not acyclic", - r_str); - ecs_os_free(r_str); - return -1; + switch(op->kind) { + case EcsOpPush: + next_scope[0] = (ecs_meta_scope_t) { + .ops = &op[1], /* op after push */ + .op_count = op->op_count - 1, /* don't include pop */ + .ptr = scope->ptr, + .type = op->type + }; + break; + + case EcsOpArray: { + if (push_type(world, next_scope, op->type, ptr) != 0) { + goto error; } + + const EcsArray *type_ptr = ecs_get(world, op->type, EcsArray); + next_scope->type = type_ptr->type; + next_scope->is_collection = true; + break; } - return 0; -} + case EcsOpVector: + next_scope->vector = ptr; + if (push_type(world, next_scope, op->type, NULL) != 0) { + goto error; + } -bool ecs_identifier_is_0( - const char *id) -{ - return id[0] == '0' && !id[1]; -} + const EcsVector *type_ptr = ecs_get(world, op->type, EcsVector); + next_scope->type = type_ptr->type; + next_scope->is_collection = true; + break; -const char* ecs_identifier_is_var( - const char *id) -{ - if (!id) { - return NULL; + default: { + char *path = ecs_get_fullpath(world, scope->type); + ecs_err("invalid push for type '%s'", path); + ecs_os_free(path); + goto error; } - - /* Variable identifiers cannot start with a number */ - if (isdigit(id[0])) { - return NULL; } - /* Identifiers that start with _ are variables */ - if (id[0] == '_' && id[1] != 0) { - return &id[1]; + if (scope->is_collection) { + next_scope[0].ptr = ECS_OFFSET(next_scope[0].ptr, + scope->elem_cur * get_size(world, scope)); } - return NULL; + return 0; +error: + return -1; } -bool ecs_id_match( - ecs_id_t id, - ecs_id_t pattern) +int ecs_meta_pop( + ecs_meta_cursor_t *cursor) { - if (id == pattern) { - return true; + if (cursor->is_primitive_scope) { + cursor->is_primitive_scope = false; + return 0; } - if (ECS_HAS_ROLE(pattern, PAIR)) { - if (!ECS_HAS_ROLE(id, PAIR)) { - return false; - } + ecs_meta_scope_t *scope = get_scope(cursor); + cursor->depth --; + if (cursor->depth < 0) { + ecs_err("unexpected end of scope"); + return -1; + } - ecs_entity_t id_rel = ECS_PAIR_FIRST(id); - ecs_entity_t id_obj = ECS_PAIR_SECOND(id); - ecs_entity_t pattern_rel = ECS_PAIR_FIRST(pattern); - ecs_entity_t pattern_obj = ECS_PAIR_SECOND(pattern); + ecs_meta_scope_t *next_scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(next_scope); - ecs_check(id_rel != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(id_obj != 0, ECS_INVALID_PARAMETER, NULL); + if (!scope->is_inline_array) { + if (op->kind == EcsOpPush) { + next_scope->op_cur += op->op_count - 1; - ecs_check(pattern_rel != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(pattern_obj != 0, ECS_INVALID_PARAMETER, NULL); - - if (pattern_rel == EcsWildcard) { - if (pattern_obj == EcsWildcard || pattern_obj == id_obj) { - return true; - } - } else if (pattern_obj == EcsWildcard) { - if (pattern_rel == id_rel) { - return true; - } + /* push + op_count should point to the operation after pop */ + op = get_op(next_scope); + ecs_assert(op->kind == EcsOpPop, ECS_INTERNAL_ERROR, NULL); + } else if (op->kind == EcsOpArray || op->kind == EcsOpVector) { + /* Collection type, nothing else to do */ + } else { + /* should not have been able to push if the previous scope was not + * a complex or collection type */ + ecs_assert(false, ECS_INTERNAL_ERROR, NULL); } } else { - if ((id & ECS_ROLE_MASK) != (pattern & ECS_ROLE_MASK)) { - return false; - } - - if ((ECS_COMPONENT_MASK & pattern) == EcsWildcard) { - return true; - } + /* Make sure that this was an inline array */ + ecs_assert(next_scope->op_count > 1, ECS_INTERNAL_ERROR, NULL); } -error: - return false; + return 0; } -bool ecs_id_is_pair( - ecs_id_t id) +bool ecs_meta_is_collection( + const ecs_meta_cursor_t *cursor) { - return ECS_HAS_ROLE(id, PAIR); + ecs_meta_scope_t *scope = get_scope(cursor); + return scope->is_collection; } -bool ecs_id_is_wildcard( - ecs_id_t id) +ecs_entity_t ecs_meta_get_type( + const ecs_meta_cursor_t *cursor) { - return - (id == EcsWildcard) || (ECS_HAS_ROLE(id, PAIR) && ( - (ECS_PAIR_FIRST(id) == EcsWildcard) || - (ECS_PAIR_SECOND(id) == EcsWildcard) - )); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + return op->type; } -bool ecs_term_id_is_set( - const ecs_term_id_t *id) +ecs_entity_t ecs_meta_get_unit( + const ecs_meta_cursor_t *cursor) { - return id->entity != 0 || id->name != NULL; + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + return op->unit; } -bool ecs_term_is_initialized( - const ecs_term_t *term) +const char* ecs_meta_get_member( + const ecs_meta_cursor_t *cursor) { - return term->id != 0 || ecs_term_id_is_set(&term->pred); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + return op->name; } -bool ecs_term_is_trivial( - const ecs_term_t *term) -{ - if (term->inout != EcsInOutDefault) { - return false; - } +/* Utility macro's to let the compiler do the conversion work for us */ +#define set_T(T, ptr, value)\ + ((T*)ptr)[0] = ((T)value) - if (term->subj.entity != EcsThis) { - return false; - } +#define case_T(kind, T, dst, src)\ +case kind:\ + set_T(T, dst, src);\ + break - if (term->subj.set.mask && (term->subj.set.mask != EcsSelf)) { - return false; - } +#define cases_T_float(dst, src)\ + case_T(EcsOpF32, ecs_f32_t, dst, src);\ + case_T(EcsOpF64, ecs_f64_t, dst, src) - if (term->oper != EcsAnd && term->oper != EcsAndFrom) { - return false; - } +#define cases_T_signed(dst, src)\ + case_T(EcsOpChar, ecs_char_t, dst, src);\ + case_T(EcsOpI8, ecs_i8_t, dst, src);\ + case_T(EcsOpI16, ecs_i16_t, dst, src);\ + case_T(EcsOpI32, ecs_i32_t, dst, src);\ + case_T(EcsOpI64, ecs_i64_t, dst, src);\ + case_T(EcsOpIPtr, ecs_iptr_t, dst, src) - if (term->name != NULL) { - return false; - } +#define cases_T_unsigned(dst, src)\ + case_T(EcsOpByte, ecs_byte_t, dst, src);\ + case_T(EcsOpU8, ecs_u8_t, dst, src);\ + case_T(EcsOpU16, ecs_u16_t, dst, src);\ + case_T(EcsOpU32, ecs_u32_t, dst, src);\ + case_T(EcsOpU64, ecs_u64_t, dst, src);\ + case_T(EcsOpUPtr, ecs_uptr_t, dst, src);\ - return true; +#define cases_T_bool(dst, src)\ +case EcsOpBool:\ + set_T(ecs_bool_t, dst, value != 0);\ + break + +static +void conversion_error( + ecs_meta_cursor_t *cursor, + ecs_meta_type_op_t *op, + const char *from) +{ + char *path = ecs_get_fullpath(cursor->world, op->type); + ecs_err("unsupported conversion from %s to '%s'", from, path); + ecs_os_free(path); } -int ecs_term_finalize( - const ecs_world_t *world, - const char *name, - ecs_term_t *term) +int ecs_meta_set_bool( + ecs_meta_cursor_t *cursor, + bool value) { - if (finalize_term_vars(world, term, name)) { + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + + switch(op->kind) { + cases_T_bool(ptr, value); + cases_T_unsigned(ptr, value); + default: + conversion_error(cursor, op, "bool"); return -1; } - if (!term->id) { - if (finalize_term_id(world, term, name)) { - return -1; - } - } else { - if (populate_from_term_id(world, term, name)) { - return -1; - } - } + return 0; +} - if (finalize_term_identifiers(world, term, name)) { +int ecs_meta_set_char( + ecs_meta_cursor_t *cursor, + char value) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + + switch(op->kind) { + cases_T_bool(ptr, value); + cases_T_signed(ptr, value); + default: + conversion_error(cursor, op, "char"); return -1; } - if (!term_can_inherit(term)) { - if (term->subj.set.relation == EcsIsA) { - term->subj.set.relation = 0; - term->subj.set.mask = EcsSelf; - } - } + return 0; +} - if (term->role == ECS_AND || term->role == ECS_OR || term->role == ECS_NOT){ - /* AND/OR terms match >1 component, which is only valid as filter */ - if (term->inout != EcsInOutDefault && term->inout != EcsInOutFilter) { - term_error(world, term, name, "AND/OR terms must be filters"); - return -1; - } +int ecs_meta_set_int( + ecs_meta_cursor_t *cursor, + int64_t value) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); - term->inout = EcsInOutFilter; + switch(op->kind) { + cases_T_bool(ptr, value); + cases_T_signed(ptr, value); + cases_T_float(ptr, value); + default: { + conversion_error(cursor, op, "int"); + return -1; + } + } - /* Translate role to operator */ - if (term->role == ECS_AND) { - term->oper = EcsAndFrom; - } else - if (term->role == ECS_OR) { - term->oper = EcsOrFrom; - } else - if (term->role == ECS_NOT) { - term->oper = EcsNotFrom; - } + return 0; +} - /* Zero out role & strip from id */ - term->id &= ECS_COMPONENT_MASK; - term->role = 0; - } +int ecs_meta_set_uint( + ecs_meta_cursor_t *cursor, + uint64_t value) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); - if (verify_term_consistency(world, term, name)) { + switch(op->kind) { + cases_T_bool(ptr, value); + cases_T_unsigned(ptr, value); + cases_T_float(ptr, value); + case EcsOpEntity: + set_T(ecs_entity_t, ptr, value); + break; + default: + conversion_error(cursor, op, "uint"); return -1; } return 0; } -ecs_term_t ecs_term_copy( - const ecs_term_t *src) +int ecs_meta_set_float( + ecs_meta_cursor_t *cursor, + double value) { - ecs_term_t dst = *src; - dst.name = ecs_os_strdup(src->name); - dst.pred.name = ecs_os_strdup(src->pred.name); - dst.subj.name = ecs_os_strdup(src->subj.name); - dst.obj.name = ecs_os_strdup(src->obj.name); - return dst; -} + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); -ecs_term_t ecs_term_move( - ecs_term_t *src) -{ - if (src->move) { - ecs_term_t dst = *src; - src->name = NULL; - src->pred.name = NULL; - src->subj.name = NULL; - src->obj.name = NULL; - dst.move = false; - return dst; - } else { - ecs_term_t dst = ecs_term_copy(src); - dst.move = false; - return dst; + switch(op->kind) { + cases_T_bool(ptr, value); + cases_T_signed(ptr, value); + cases_T_unsigned(ptr, value); + cases_T_float(ptr, value); + default: + conversion_error(cursor, op, "float"); + return -1; } + + return 0; } -void ecs_term_fini( - ecs_term_t *term) +static +int add_bitmask_constant( + ecs_meta_cursor_t *cursor, + ecs_meta_type_op_t *op, + void *out, + const char *value) { - ecs_os_free(term->pred.name); - ecs_os_free(term->subj.name); - ecs_os_free(term->obj.name); - ecs_os_free(term->name); + ecs_assert(op->type != 0, ECS_INTERNAL_ERROR, NULL); - term->pred.name = NULL; - term->subj.name = NULL; - term->obj.name = NULL; - term->name = NULL; -} + if (!ecs_os_strcmp(value, "0")) { + return 0; + } -int ecs_filter_finalize( - const ecs_world_t *world, - ecs_filter_t *f) -{ - int32_t i, term_count = f->term_count, actual_count = 0; - ecs_term_t *terms = f->terms; - bool is_or = false, prev_or = false; - int32_t filter_terms = 0; + ecs_entity_t c = ecs_lookup_child(cursor->world, op->type, value); + if (!c) { + char *path = ecs_get_fullpath(cursor->world, op->type); + ecs_err("unresolved bitmask constant '%s' for type '%s'", value, path); + ecs_os_free(path); + return -1; + } - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; + const ecs_u32_t *v = ecs_get_pair_object( + cursor->world, c, EcsConstant, ecs_u32_t); + if (v == NULL) { + char *path = ecs_get_fullpath(cursor->world, op->type); + ecs_err("'%s' is not an bitmask constant for type '%s'", value, path); + ecs_os_free(path); + return -1; + } - if (ecs_term_finalize(world, f->name, term)) { - return -1; - } + *(ecs_u32_t*)out |= v[0]; - is_or = term->oper == EcsOr; - actual_count += !(is_or && prev_or); - term->index = actual_count - 1; - prev_or = is_or; + return 0; +} - if (term->subj.entity == EcsThis) { - f->match_this = true; - if (term->subj.set.mask != EcsSelf) { - f->match_only_this = false; - } - } else { - f->match_only_this = false; - } +static +int parse_bitmask( + ecs_meta_cursor_t *cursor, + ecs_meta_type_op_t *op, + void *out, + const char *value) +{ + char token[ECS_MAX_TOKEN_SIZE]; - if (term->id == EcsPrefab) { - f->match_prefab = true; - } - if (term->id == EcsDisabled) { - f->match_disabled = true; - } + const char *prev = value, *ptr = value; - if (f->filter) { - term->inout = EcsInOutFilter; - } + *(ecs_u32_t*)out = 0; - if (term->inout == EcsInOutFilter) { - filter_terms ++; + while ((ptr = strchr(ptr, '|'))) { + ecs_os_memcpy(token, prev, ptr - prev); + token[ptr - prev] = '\0'; + if (add_bitmask_constant(cursor, op, out, token) != 0) { + return -1; } - if (term->oper != EcsNot || term->subj.entity != EcsThis) { - f->match_anything = false; - } + ptr ++; + prev = ptr; } - f->term_count_actual = actual_count; - - if (filter_terms == term_count) { - f->filter = true; - } + if (add_bitmask_constant(cursor, op, out, prev) != 0) { + return -1; + } return 0; } -/* Implementation for iterable mixin */ -static -void filter_iter_init( - const ecs_world_t *world, - const ecs_poly_t *poly, - ecs_iter_t *iter, - ecs_term_t *filter) -{ - ecs_poly_assert(poly, ecs_filter_t); - - if (filter) { - iter[1] = ecs_filter_iter(world, (ecs_filter_t*)poly); - iter[0] = ecs_term_chain_iter(&iter[1], filter); - } else { - iter[0] = ecs_filter_iter(world, (ecs_filter_t*)poly); - } -} - -int ecs_filter_init( - const ecs_world_t *stage, - ecs_filter_t *filter_out, - const ecs_filter_desc_t *desc) +int ecs_meta_set_string( + ecs_meta_cursor_t *cursor, + const char *value) { - ecs_filter_t f; - ecs_poly_init(&f, ecs_filter_t); - - ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(filter_out != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); - - const ecs_world_t *world = ecs_get_world(stage); - - int i, term_count = 0; - ecs_term_t *terms = desc->terms_buffer; - const char *name = desc->name; - const char *expr = desc->expr; - - /* Temporarily set the fields to the values provided in desc, until the - * filter has been validated. */ - f.name = (char*)name; - f.expr = (char*)expr; - f.filter = desc->filter; - f.instanced = desc->instanced; - f.match_empty_tables = desc->match_empty_tables; - f.match_anything = true; - - if (terms) { - term_count = desc->terms_buffer_count; - } else { - terms = (ecs_term_t*)desc->terms; - for (i = 0; i < ECS_TERM_DESC_CACHE_SIZE; i ++) { - if (!ecs_term_is_initialized(&terms[i])) { - break; - } + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); - term_count ++; + switch(op->kind) { + case EcsOpBool: + if (!ecs_os_strcmp(value, "true")) { + set_T(ecs_bool_t, ptr, true); + } else if (!ecs_os_strcmp(value, "false")) { + set_T(ecs_bool_t, ptr, false); + } else { + ecs_err("invalid value for boolean '%s'", value); + return -1; } + break; + case EcsOpI8: + case EcsOpU8: + case EcsOpChar: + case EcsOpByte: + set_T(ecs_i8_t, ptr, atol(value)); + break; + case EcsOpI16: + case EcsOpU16: + set_T(ecs_i16_t, ptr, atol(value)); + break; + case EcsOpI32: + case EcsOpU32: + set_T(ecs_i32_t, ptr, atol(value)); + break; + case EcsOpI64: + case EcsOpU64: + set_T(ecs_i64_t, ptr, atol(value)); + break; + case EcsOpIPtr: + case EcsOpUPtr: + set_T(ecs_iptr_t, ptr, atol(value)); + break; + case EcsOpF32: + set_T(ecs_f32_t, ptr, atof(value)); + break; + case EcsOpF64: + set_T(ecs_f64_t, ptr, atof(value)); + break; + case EcsOpString: { + ecs_os_free(*(char**)ptr); + char *result = ecs_os_strdup(value); + set_T(ecs_string_t, ptr, result); + break; } - - /* Temporarily set array from desc to filter, until the filter has been - * validated. */ - f.terms = terms; - f.term_count = term_count; - - if (expr) { -#ifdef FLECS_PARSER - int32_t buffer_count = 0; - - /* If terms have already been set, copy buffer to allocated one */ - if (terms && term_count) { - terms = ecs_os_memdup(terms, term_count * ECS_SIZEOF(ecs_term_t)); - buffer_count = term_count; - } else { - terms = NULL; + case EcsOpEnum: { + ecs_assert(op->type != 0, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t c = ecs_lookup_child(cursor->world, op->type, value); + if (!c) { + char *path = ecs_get_fullpath(cursor->world, op->type); + ecs_err("unresolved enum constant '%s' for type '%s'", value, path); + ecs_os_free(path); + return -1; } - /* Parse expression into array of terms */ - const char *ptr = desc->expr; - ecs_term_t term = {0}; - while (ptr[0] && (ptr = ecs_parse_term(world, name, expr, ptr, &term))){ - if (!ecs_term_is_initialized(&term)) { - break; - } - - if (term_count == buffer_count) { - buffer_count = buffer_count ? buffer_count * 2 : 8; - terms = ecs_os_realloc(terms, - buffer_count * ECS_SIZEOF(ecs_term_t)); - } - - /* Check for identifiers that have a name that starts with _. If the - * variable kind is left to Default, the kind should be set to - * variable and the _ prefix should be removed. */ - finalize_term_vars(world, &term, name); - - terms[term_count] = term; - term_count ++; - - if (ptr[0] == '\n') { - break; - } + const ecs_i32_t *v = ecs_get_pair_object( + cursor->world, c, EcsConstant, ecs_i32_t); + if (v == NULL) { + char *path = ecs_get_fullpath(cursor->world, op->type); + ecs_err("'%s' is not an enum constant for type '%s'", value, path); + ecs_os_free(path); + return -1; } - f.terms = terms; - f.term_count = term_count; - - if (!ptr) { - goto error; - } -#else - ecs_abort(ECS_UNSUPPORTED, "parser addon is not available"); -#endif + set_T(ecs_i32_t, ptr, v[0]); + break; } + case EcsOpBitmask: + if (parse_bitmask(cursor, op, ptr, value) != 0) { + return -1; + } + break; + case EcsOpEntity: { + ecs_entity_t e = 0; - /* Copy term resources. */ - if (term_count) { - ecs_term_t *dst_terms = terms; - if (!f.expr) { - if (term_count <= ECS_TERM_CACHE_SIZE) { - dst_terms = f.term_cache; - f.term_cache_used = true; + if (ecs_os_strcmp(value, "0")) { + if (cursor->lookup_action) { + e = cursor->lookup_action( + cursor->world, value, + cursor->lookup_ctx); } else { - dst_terms = ecs_os_malloc_n(ecs_term_t, term_count); + e = ecs_lookup_path(cursor->world, 0, value); } - } - for (i = 0; i < term_count; i ++) { - dst_terms[i] = ecs_term_move(&terms[i]); + if (!e) { + ecs_err("unresolved entity identifier '%s'", value); + return -1; + } } - f.terms = dst_terms; - } else { - f.terms = NULL; - } - /* Ensure all fields are consistent and properly filled out */ - if (ecs_filter_finalize(world, &f)) { - goto error; + set_T(ecs_entity_t, ptr, e); + break; } - - *filter_out = f; - if (f.term_cache_used) { - filter_out->terms = filter_out->term_cache; + case EcsOpPop: + ecs_err("excess element '%s' in scope", value); + return -1; + default: + ecs_err("unsupported conversion from string '%s' to '%s'", + value, op_kind_str(op->kind)); + return -1; } - filter_out->name = ecs_os_strdup(desc->name); - filter_out->expr = ecs_os_strdup(desc->expr); - - ecs_assert(!filter_out->term_cache_used || - filter_out->terms == filter_out->term_cache, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(filter_out->term_count == f.term_count, - ECS_INTERNAL_ERROR, NULL); - - filter_out->iterable.init = filter_iter_init; return 0; -error: - /* NULL members that point to non-owned resources */ - if (!f.expr) { - f.terms = NULL; - } - - f.name = NULL; - f.expr = NULL; - - ecs_filter_fini(&f); - - return -1; } -void ecs_filter_copy( - ecs_filter_t *dst, - const ecs_filter_t *src) +int ecs_meta_set_string_literal( + ecs_meta_cursor_t *cursor, + const char *value) { - if (src) { - *dst = *src; - - int32_t term_count = src->term_count; - - if (src->term_cache_used) { - dst->terms = dst->term_cache; - } else { - dst->terms = ecs_os_memdup_n(src->terms, ecs_term_t, term_count); - } + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); - int i; - for (i = 0; i < term_count; i ++) { - dst->terms[i] = ecs_term_copy(&src->terms[i]); - } - } else { - ecs_os_memset_t(dst, 0, ecs_filter_t); + ecs_size_t len = ecs_os_strlen(value); + if (value[0] != '\"' || value[len - 1] != '\"') { + ecs_err("invalid string literal '%s'", value); + return -1; } -} -void ecs_filter_move( - ecs_filter_t *dst, - ecs_filter_t *src) -{ - if (src) { - *dst = *src; + switch(op->kind) { + case EcsOpChar: + set_T(ecs_char_t, ptr, value[1]); + break; + + default: + case EcsOpEntity: + case EcsOpString: + len -= 2; - if (src->term_cache_used) { - dst->terms = dst->term_cache; - } + char *result = ecs_os_malloc(len + 1); + ecs_os_memcpy(result, value + 1, len); + result[len] = '\0'; - if (dst != src) { - src->terms = NULL; - src->term_count = 0; + if (ecs_meta_set_string(cursor, result)) { + ecs_os_free(result); + return -1; } - } else { - ecs_os_memset_t(dst, 0, ecs_filter_t); - } -} -void ecs_filter_fini( - ecs_filter_t *filter) -{ - if (filter->terms) { - int i, count = filter->term_count; - for (i = 0; i < count; i ++) { - ecs_term_fini(&filter->terms[i]); - } + ecs_os_free(result); - if (!filter->term_cache_used) { - ecs_os_free(filter->terms); - } + break; } - ecs_os_free(filter->name); - ecs_os_free(filter->expr); - - filter->terms = NULL; - filter->name = NULL; - filter->expr = NULL; + return 0; } -static -void filter_str_add_id( - const ecs_world_t *world, - ecs_strbuf_t *buf, - const ecs_term_id_t *id, - bool is_subject, - uint8_t default_set_mask) +int ecs_meta_set_entity( + ecs_meta_cursor_t *cursor, + ecs_entity_t value) { - if (id->name) { - ecs_strbuf_appendstr(buf, id->name); - } else if (id->entity) { - bool id_added = false; - if (!is_subject || id->entity != EcsThis) { - char *path = ecs_get_fullpath(world, id->entity); - ecs_strbuf_appendstr(buf, path); - ecs_os_free(path); - id_added = true; - } - - if (id->set.mask != default_set_mask) { - if (id_added) { - ecs_strbuf_list_push(buf, ":", "|"); - } else { - ecs_strbuf_list_push(buf, "", "|"); - } - if (id->set.mask & EcsSelf) { - ecs_strbuf_list_appendstr(buf, "self"); - } - if (id->set.mask & EcsSuperSet) { - ecs_strbuf_list_appendstr(buf, "superset"); - } - if (id->set.mask & EcsSubSet) { - ecs_strbuf_list_appendstr(buf, "subset"); - } - - if (id->set.relation != EcsIsA) { - ecs_strbuf_list_push(buf, "(", ""); - - char *rel_path = ecs_get_fullpath(world, id->set.relation); - ecs_strbuf_appendstr(buf, rel_path); - ecs_os_free(rel_path); - - ecs_strbuf_list_pop(buf, ")"); - } + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); - ecs_strbuf_list_pop(buf, ""); - } - } else { - ecs_strbuf_appendstr(buf, "0"); + switch(op->kind) { + case EcsOpEntity: + set_T(ecs_entity_t, ptr, value); + break; + default: + conversion_error(cursor, op, "entity"); + return -1; } + + return 0; } -static -void term_str_w_strbuf( - const ecs_world_t *world, - const ecs_term_t *term, - ecs_strbuf_t *buf) +int ecs_meta_set_null( + ecs_meta_cursor_t *cursor) { - const ecs_term_id_t *subj = &term->subj; - const ecs_term_id_t *obj = &term->obj; - - const uint8_t def_pred_mask = EcsSelf|EcsSubSet; - const uint8_t def_subj_mask = EcsSelf|EcsSuperSet; - const uint8_t def_obj_mask = EcsSelf; - - bool pred_set = ecs_term_id_is_set(&term->pred); - bool subj_set = ecs_term_id_is_set(subj); - bool obj_set = ecs_term_id_is_set(obj); - - if (term->role && term->role != ECS_PAIR) { - ecs_strbuf_appendstr(buf, ecs_role_str(term->role)); - ecs_strbuf_appendstr(buf, " "); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch (op->kind) { + case EcsOpString: + ecs_os_free(*(char**)ptr); + set_T(ecs_string_t, ptr, NULL); + break; + default: + conversion_error(cursor, op, "null"); + return -1; } - if (term->oper == EcsNot) { - ecs_strbuf_appendstr(buf, "!"); - } else if (term->oper == EcsOptional) { - ecs_strbuf_appendstr(buf, "?"); - } + return 0; +} - if (!subj_set) { - filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); - ecs_strbuf_appendstr(buf, "()"); - } else if (subj_set && subj->entity == EcsThis && subj->set.mask == def_subj_mask) - { - if (term->id) { - char *str = ecs_id_str(world, term->id); - ecs_strbuf_appendstr(buf, str); - ecs_os_free(str); - } else if (pred_set) { - filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); - } - } else { - filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); - ecs_strbuf_appendstr(buf, "("); - filter_str_add_id(world, buf, &term->subj, true, def_subj_mask); - if (obj_set) { - ecs_strbuf_appendstr(buf, ","); - filter_str_add_id(world, buf, &term->obj, false, def_obj_mask); - } - ecs_strbuf_appendstr(buf, ")"); +bool ecs_meta_get_bool( + const ecs_meta_cursor_t *cursor) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpBool: return *(ecs_bool_t*)ptr; + case EcsOpI8: return *(ecs_i8_t*)ptr != 0; + case EcsOpU8: return *(ecs_u8_t*)ptr != 0; + case EcsOpChar: return *(ecs_char_t*)ptr != 0; + case EcsOpByte: return *(ecs_u8_t*)ptr != 0; + case EcsOpI16: return *(ecs_i16_t*)ptr != 0; + case EcsOpU16: return *(ecs_u16_t*)ptr != 0; + case EcsOpI32: return *(ecs_i32_t*)ptr != 0; + case EcsOpU32: return *(ecs_u32_t*)ptr != 0; + case EcsOpI64: return *(ecs_i64_t*)ptr != 0; + case EcsOpU64: return *(ecs_u64_t*)ptr != 0; + case EcsOpIPtr: return *(ecs_iptr_t*)ptr != 0; + case EcsOpUPtr: return *(ecs_uptr_t*)ptr != 0; + case EcsOpF32: return *(ecs_f32_t*)ptr != 0; + case EcsOpF64: return *(ecs_f64_t*)ptr != 0; + case EcsOpString: return *(const char**)ptr != NULL; + case EcsOpEnum: return *(ecs_i32_t*)ptr != 0; + case EcsOpBitmask: return *(ecs_u32_t*)ptr != 0; + case EcsOpEntity: return *(ecs_entity_t*)ptr != 0; + default: ecs_throw(ECS_INVALID_PARAMETER, + "invalid element for bool"); } +error: + return 0; } -char* ecs_term_str( - const ecs_world_t *world, - const ecs_term_t *term) +char ecs_meta_get_char( + const ecs_meta_cursor_t *cursor) { - ecs_strbuf_t buf = ECS_STRBUF_INIT; - term_str_w_strbuf(world, term, &buf); - return ecs_strbuf_get(&buf); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpChar: return *(ecs_char_t*)ptr != 0; + default: ecs_throw(ECS_INVALID_PARAMETER, + "invalid element for char"); + } +error: + return 0; } -char* ecs_filter_str( - const ecs_world_t *world, - const ecs_filter_t *filter) +int64_t ecs_meta_get_int( + const ecs_meta_cursor_t *cursor) { - ecs_strbuf_t buf = ECS_STRBUF_INIT; - - ecs_check(!filter->term_cache_used || filter->terms == filter->term_cache, - ECS_INVALID_PARAMETER, NULL); - - ecs_term_t *terms = filter->terms; - int32_t i, count = filter->term_count; - int32_t or_count = 0; - - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - - if (i) { - if (terms[i - 1].oper == EcsOr && term->oper == EcsOr) { - ecs_strbuf_appendstr(&buf, " || "); - } else { - ecs_strbuf_appendstr(&buf, ", "); - } - } - - if (term->oper != EcsOr) { - or_count = 0; - } - - if (or_count < 1) { - if (term->inout == EcsIn) { - ecs_strbuf_appendstr(&buf, "[in] "); - } else if (term->inout == EcsInOut) { - ecs_strbuf_appendstr(&buf, "[inout] "); - } else if (term->inout == EcsOut) { - ecs_strbuf_appendstr(&buf, "[out] "); - } else if (term->inout == EcsInOutFilter) { - ecs_strbuf_appendstr(&buf, "[filter] "); - } - } - - if (term->oper == EcsOr) { - or_count ++; - } - - term_str_w_strbuf(world, term, &buf); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpBool: return *(ecs_bool_t*)ptr; + case EcsOpI8: return *(ecs_i8_t*)ptr; + case EcsOpU8: return *(ecs_u8_t*)ptr; + case EcsOpChar: return *(ecs_char_t*)ptr; + case EcsOpByte: return *(ecs_u8_t*)ptr; + case EcsOpI16: return *(ecs_i16_t*)ptr; + case EcsOpU16: return *(ecs_u16_t*)ptr; + case EcsOpI32: return *(ecs_i32_t*)ptr; + case EcsOpU32: return *(ecs_u32_t*)ptr; + case EcsOpI64: return *(ecs_i64_t*)ptr; + case EcsOpU64: return flecs_uto(int64_t, *(ecs_u64_t*)ptr); + case EcsOpIPtr: return *(ecs_iptr_t*)ptr; + case EcsOpUPtr: return flecs_uto(int64_t, *(ecs_uptr_t*)ptr); + case EcsOpF32: return (int64_t)*(ecs_f32_t*)ptr; + case EcsOpF64: return (int64_t)*(ecs_f64_t*)ptr; + case EcsOpString: return atoi(*(const char**)ptr); + case EcsOpEnum: return *(ecs_i32_t*)ptr; + case EcsOpBitmask: return *(ecs_u32_t*)ptr; + case EcsOpEntity: + ecs_throw(ECS_INVALID_PARAMETER, + "invalid conversion from entity to int"); + break; + default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for int"); } +error: + return 0; +} - return ecs_strbuf_get(&buf); +uint64_t ecs_meta_get_uint( + const ecs_meta_cursor_t *cursor) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpBool: return *(ecs_bool_t*)ptr; + case EcsOpI8: return flecs_ito(uint64_t, *(ecs_i8_t*)ptr); + case EcsOpU8: return *(ecs_u8_t*)ptr; + case EcsOpChar: return flecs_ito(uint64_t, *(ecs_char_t*)ptr); + case EcsOpByte: return flecs_ito(uint64_t, *(ecs_u8_t*)ptr); + case EcsOpI16: return flecs_ito(uint64_t, *(ecs_i16_t*)ptr); + case EcsOpU16: return *(ecs_u16_t*)ptr; + case EcsOpI32: return flecs_ito(uint64_t, *(ecs_i32_t*)ptr); + case EcsOpU32: return *(ecs_u32_t*)ptr; + case EcsOpI64: return flecs_ito(uint64_t, *(ecs_i64_t*)ptr); + case EcsOpU64: return *(ecs_u64_t*)ptr; + case EcsOpIPtr: return flecs_ito(uint64_t, *(ecs_i64_t*)ptr); + case EcsOpUPtr: return *(ecs_uptr_t*)ptr; + case EcsOpF32: return flecs_ito(uint64_t, *(ecs_f32_t*)ptr); + case EcsOpF64: return flecs_ito(uint64_t, *(ecs_f64_t*)ptr); + case EcsOpString: return flecs_ito(uint64_t, atoi(*(const char**)ptr)); + case EcsOpEnum: return flecs_ito(uint64_t, *(ecs_i32_t*)ptr); + case EcsOpBitmask: return *(ecs_u32_t*)ptr; + case EcsOpEntity: return *(ecs_entity_t*)ptr; + default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for uint"); + } error: - return NULL; + return 0; } -static -ecs_id_t actual_match_id( - ecs_id_t id) +double ecs_meta_get_float( + const ecs_meta_cursor_t *cursor) { - /* Table types don't store CASE, so replace it with corresponding SWITCH */ - if (ECS_HAS_ROLE(id, CASE)) { - return ECS_SWITCH | ECS_PAIR_FIRST(id); + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpBool: return *(ecs_bool_t*)ptr; + case EcsOpI8: return *(ecs_i8_t*)ptr; + case EcsOpU8: return *(ecs_u8_t*)ptr; + case EcsOpChar: return *(ecs_char_t*)ptr; + case EcsOpByte: return *(ecs_u8_t*)ptr; + case EcsOpI16: return *(ecs_i16_t*)ptr; + case EcsOpU16: return *(ecs_u16_t*)ptr; + case EcsOpI32: return *(ecs_i32_t*)ptr; + case EcsOpU32: return *(ecs_u32_t*)ptr; + case EcsOpI64: return (double)*(ecs_i64_t*)ptr; + case EcsOpU64: return (double)*(ecs_u64_t*)ptr; + case EcsOpIPtr: return (double)*(ecs_iptr_t*)ptr; + case EcsOpUPtr: return (double)*(ecs_uptr_t*)ptr; + case EcsOpF32: return (double)*(ecs_f32_t*)ptr; + case EcsOpF64: return *(ecs_f64_t*)ptr; + case EcsOpString: return atof(*(const char**)ptr); + case EcsOpEnum: return *(ecs_i32_t*)ptr; + case EcsOpBitmask: return *(ecs_u32_t*)ptr; + case EcsOpEntity: + ecs_throw(ECS_INVALID_PARAMETER, + "invalid conversion from entity to float"); + break; + default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for float"); } +error: + return 0; +} - return id; +const char* ecs_meta_get_string( + const ecs_meta_cursor_t *cursor) +{ + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpString: return *(const char**)ptr; + default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for string"); + } +error: + return 0; } -static -bool flecs_n_term_match_table( - ecs_world_t *world, - const ecs_term_t *term, - const ecs_table_t *table, - ecs_type_t type, - ecs_id_t *id_out, - int32_t *column_out, - ecs_entity_t *subject_out, - int32_t *match_index_out, - bool first) +ecs_entity_t ecs_meta_get_entity( + const ecs_meta_cursor_t *cursor) { - (void)column_out; - - ecs_entity_t type_id = term->id; - ecs_oper_kind_t oper = term->oper; + ecs_meta_scope_t *scope = get_scope(cursor); + ecs_meta_type_op_t *op = get_op(scope); + void *ptr = get_ptr(cursor->world, scope); + switch(op->kind) { + case EcsOpEntity: return *(ecs_entity_t*)ptr; + default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for entity"); + } +error: + return 0; +} - const EcsType *term_type = ecs_get(world, type_id, EcsType); - ecs_check(term_type != NULL, ECS_INVALID_PARAMETER, NULL); +#endif - ecs_id_t *ids = ecs_vector_first(term_type->normalized->type, ecs_id_t); - int32_t i, count = ecs_vector_count(term_type->normalized->type); - ecs_term_t temp = *term; - temp.oper = EcsAnd; - for (i = 0; i < count; i ++) { - temp.id = ids[i]; - bool result = flecs_term_match_table(world, &temp, table, type, id_out, - 0, subject_out, match_index_out, first); - if (!result && oper == EcsAndFrom) { - return false; - } else - if (result && oper == EcsOrFrom) { - return true; - } - } - if (oper == EcsAndFrom) { - return true; - } else - if (oper == EcsOrFrom) { - return false; - } +#ifdef FLECS_EXPR -error: - return false; +static +int expr_ser_type( + const ecs_world_t *world, + ecs_vector_t *ser, + const void *base, + ecs_strbuf_t *str); + +static +int expr_ser_type_ops( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + ecs_strbuf_t *str); + +static +int expr_ser_type_op( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str); + +static +ecs_primitive_kind_t expr_op_to_primitive_kind(ecs_meta_type_op_kind_t kind) { + return kind - EcsOpPrimitive; } -bool flecs_term_match_table( - ecs_world_t *world, - const ecs_term_t *term, - const ecs_table_t *table, - ecs_type_t type, - ecs_id_t *id_out, - int32_t *column_out, - ecs_entity_t *subject_out, - int32_t *match_index_out, - bool first) +/* Serialize a primitive value */ +static +int expr_ser_primitive( + const ecs_world_t *world, + ecs_primitive_kind_t kind, + const void *base, + ecs_strbuf_t *str) { - const ecs_term_id_t *subj = &term->subj; - ecs_oper_kind_t oper = term->oper; - const ecs_table_t *match_table = table; - ecs_type_t match_type = type; - ecs_id_t id = term->id; + const char *bool_str[] = { "false", "true" }; - ecs_entity_t subj_entity = subj->entity; - if (!subj_entity) { - id_out[0] = id; /* no source corresponds with Nothing set mask */ - return true; + switch(kind) { + case EcsBool: + ecs_strbuf_appendstr(str, bool_str[(int)*(bool*)base]); + break; + case EcsChar: { + char chbuf[3]; + char ch = *(char*)base; + if (ch) { + ecs_chresc(chbuf, *(char*)base, '"'); + ecs_strbuf_appendstrn(str, "\"", 1); + ecs_strbuf_appendstr(str, chbuf); + ecs_strbuf_appendstrn(str, "\"", 1); + } else { + ecs_strbuf_appendstr(str, "0"); + } + break; } - - if (oper == EcsAndFrom || oper == EcsOrFrom) { - return flecs_n_term_match_table(world, term, table, type, id_out, column_out, - subject_out, match_index_out, first); + case EcsByte: + ecs_strbuf_append(str, "%u", *(uint8_t*)base); + break; + case EcsU8: + ecs_strbuf_append(str, "%u", *(uint8_t*)base); + break; + case EcsU16: + ecs_strbuf_append(str, "%u", *(uint16_t*)base); + break; + case EcsU32: + ecs_strbuf_append(str, "%u", *(uint32_t*)base); + break; + case EcsU64: + ecs_strbuf_append(str, "%llu", *(uint64_t*)base); + break; + case EcsI8: + ecs_strbuf_append(str, "%d", *(int8_t*)base); + break; + case EcsI16: + ecs_strbuf_append(str, "%d", *(int16_t*)base); + break; + case EcsI32: + ecs_strbuf_append(str, "%d", *(int32_t*)base); + break; + case EcsI64: + ecs_strbuf_append(str, "%lld", *(int64_t*)base); + break; + case EcsF32: + ecs_strbuf_appendflt(str, (double)*(float*)base, 0); + break; + case EcsF64: + ecs_strbuf_appendflt(str, *(double*)base, 0); + break; + case EcsIPtr: + ecs_strbuf_append(str, "%i", *(intptr_t*)base); + break; + case EcsUPtr: + ecs_strbuf_append(str, "%u", *(uintptr_t*)base); + break; + case EcsString: { + char *value = *(char**)base; + if (value) { + ecs_size_t length = ecs_stresc(NULL, 0, '"', value); + if (length == ecs_os_strlen(value)) { + ecs_strbuf_appendstrn(str, "\"", 1); + ecs_strbuf_appendstr(str, value); + ecs_strbuf_appendstrn(str, "\"", 1); + } else { + char *out = ecs_os_malloc(length + 3); + ecs_stresc(out + 1, length, '"', value); + out[0] = '"'; + out[length + 1] = '"'; + out[length + 2] = '\0'; + ecs_strbuf_appendstr_zerocpy(str, out); + } + } else { + ecs_strbuf_appendstr(str, "null"); + } + break; } - - /* If source is not This, search in table of source */ - if (subj_entity != EcsThis) { - match_table = ecs_get_table(world, subj_entity); - if (match_table) { - match_type = match_table->type; + case EcsEntity: { + ecs_entity_t e = *(ecs_entity_t*)base; + if (!e) { + ecs_strbuf_appendstr(str, "0"); } else { - return false; + char *path = ecs_get_fullpath(world, e); + ecs_assert(path != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_strbuf_appendstr(str, path); + ecs_os_free(path); } - } else { - /* If filter contains This terms, a table must be provided */ - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + break; } - - if (!match_type) { - return false; + default: + ecs_err("invalid primitive kind"); + return -1; } - ecs_entity_t source = 0; + return 0; +} - /* If first = false, we're searching from an offset. This supports returning - * multiple results when using wildcard filters. */ - int32_t column = 0; - if (!first && column_out && column_out[0] != 0) { - column = column_out[0]; - if (column < 0) { - /* In case column is not from This, flip sign */ - column = -column; - } +/* Serialize enumeration */ +static +int expr_ser_enum( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str) +{ + const EcsEnum *enum_type = ecs_get(world, op->type, EcsEnum); + ecs_check(enum_type != NULL, ECS_INVALID_PARAMETER, NULL); - /* Remove base 1 offset */ - column --; + int32_t value = *(int32_t*)base; + + /* Enumeration constants are stored in a map that is keyed on the + * enumeration value. */ + ecs_enum_constant_t *constant = ecs_map_get( + enum_type->constants, ecs_enum_constant_t, value); + if (!constant) { + char *path = ecs_get_fullpath(world, op->type); + ecs_err("value %d is not valid for enum type '%s'", value, path); + ecs_os_free(path); + goto error; } - /* Find location, source and id of match in table type */ - ecs_table_record_t *tr = 0; - column = ecs_search_relation(world, match_table, - column, actual_match_id(id), subj->set.relation, subj->set.min_depth, - subj->set.max_depth, &source, id_out, &tr); - - if (tr && match_index_out) { - match_index_out[0] = tr->count; - } + ecs_strbuf_appendstr(str, ecs_get_name(world, constant->constant)); - bool result = column != -1; + return 0; +error: + return -1; +} - if (oper == EcsNot) { - if (match_index_out) { - match_index_out[0] = 1; - } - result = !result; - } +/* Serialize bitmask */ +static +int expr_ser_bitmask( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + const EcsBitmask *bitmask_type = ecs_get(world, op->type, EcsBitmask); + ecs_check(bitmask_type != NULL, ECS_INVALID_PARAMETER, NULL); - if (oper == EcsOptional) { - result = true; - } + uint32_t value = *(uint32_t*)ptr; + ecs_map_key_t key; + ecs_bitmask_constant_t *constant; + int count = 0; - if (!result) { - return false; - } + ecs_strbuf_list_push(str, "", "|"); - if (subj_entity != EcsThis) { - if (!source) { - source = subj_entity; + /* Multiple flags can be set at a given time. Iterate through all the flags + * and append the ones that are set. */ + ecs_map_iter_t it = ecs_map_iter(bitmask_type->constants); + while ((constant = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { + if ((value & key) == key) { + ecs_strbuf_list_appendstr(str, + ecs_get_name(world, constant->constant)); + count ++; + value -= (uint32_t)key; } } - if (id_out && column < 0) { - id_out[0] = id; + if (value != 0) { + /* All bits must have been matched by a constant */ + char *path = ecs_get_fullpath(world, op->type); + ecs_err( + "value for bitmask %s contains bits (%u) that cannot be mapped to constant", + path, value); + ecs_os_free(path); + goto error; } - if (column_out) { - if (column >= 0) { - column ++; - if (source != 0) { - column *= -1; - } - column_out[0] = column; - } else { - column_out[0] = 0; - } + if (!count) { + ecs_strbuf_list_appendstr(str, "0"); } - if (subject_out) { - subject_out[0] = source; - } + ecs_strbuf_list_pop(str, ""); - return result; + return 0; +error: + return -1; } -bool flecs_filter_match_table( - ecs_world_t *world, - const ecs_filter_t *filter, - const ecs_table_t *table, - ecs_id_t *ids, - int32_t *columns, - ecs_entity_t *subjects, - int32_t *match_indices, - int32_t *matches_left, - bool first, - int32_t skip_term) +/* Serialize elements of a contiguous array */ +static +int expr_ser_elements( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + int32_t elem_count, + int32_t elem_size, + ecs_strbuf_t *str) { - ecs_assert(!filter->term_cache_used || filter->terms == filter->term_cache, - ECS_INTERNAL_ERROR, NULL); + ecs_strbuf_list_push(str, "[", ", "); - ecs_type_t type = NULL; - if (table) { - type = table->type; + const void *ptr = base; + + int i; + for (i = 0; i < elem_count; i ++) { + ecs_strbuf_list_next(str); + if (expr_ser_type_ops(world, ops, op_count, ptr, str)) { + return -1; + } + ptr = ECS_OFFSET(ptr, elem_size); } - ecs_term_t *terms = filter->terms; - int32_t i, count = filter->term_count; + ecs_strbuf_list_pop(str, "]"); - bool is_or = false; - bool or_result = false; - int32_t match_count = 1; - if (matches_left) { - match_count = *matches_left; - } + return 0; +} - for (i = 0; i < count; i ++) { - if (i == skip_term) { - continue; - } +static +int expr_ser_type_elements( + const ecs_world_t *world, + ecs_entity_t type, + const void *base, + int32_t elem_count, + ecs_strbuf_t *str) +{ + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + ecs_assert(ser != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_term_t *term = &terms[i]; - ecs_term_id_t *subj = &term->subj; - ecs_oper_kind_t oper = term->oper; - const ecs_table_t *match_table = table; - ecs_type_t match_type = type; - int32_t t_i = term->index; + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - if (!is_or && oper == EcsOr) { - is_or = true; - or_result = false; - } else if (is_or && oper != EcsOr) { - if (!or_result) { - return false; - } + ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); + int32_t op_count = ecs_vector_count(ser->ops); - is_or = false; - } + return expr_ser_elements( + world, ops, op_count, base, elem_count, comp->size, str); +} - ecs_entity_t subj_entity = subj->entity; - if (!subj_entity) { - if (ids) { - ids[t_i] = term->id; - } - continue; - } +/* Serialize array */ +static +int expr_ser_array( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + const EcsArray *a = ecs_get(world, op->type, EcsArray); + ecs_assert(a != NULL, ECS_INTERNAL_ERROR, NULL); - if (subj_entity != EcsThis) { - match_table = ecs_get_table(world, subj_entity); - if (match_table) { - match_type = match_table->type; - } else { - match_type = NULL; - } - } else { - /* If filter contains This terms, table must be provided */ - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - } + return expr_ser_type_elements( + world, a->type, ptr, a->count, str); +} - int32_t match_index = 0; +/* Serialize vector */ +static +int expr_ser_vector( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str) +{ + ecs_vector_t *value = *(ecs_vector_t**)base; + if (!value) { + ecs_strbuf_appendstr(str, "null"); + return 0; + } - bool result = flecs_term_match_table(world, term, match_table, - match_type, - ids ? &ids[t_i] : NULL, - columns ? &columns[t_i] : NULL, - subjects ? &subjects[t_i] : NULL, - &match_index, - first); + const EcsVector *v = ecs_get(world, op->type, EcsVector); + ecs_assert(v != NULL, ECS_INTERNAL_ERROR, NULL); - if (is_or) { - or_result |= result; - } else if (!result) { - return false; - } + const EcsComponent *comp = ecs_get(world, v->type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - if (first && match_index) { - match_count *= match_index; + int32_t count = ecs_vector_count(value); + void *array = ecs_vector_first_t(value, comp->size, comp->alignment); + + /* Serialize contiguous buffer of vector */ + return expr_ser_type_elements(world, v->type, array, count, str); +} + +/* Forward serialization to the different type kinds */ +static +int expr_ser_type_op( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + switch(op->kind) { + case EcsOpPush: + case EcsOpPop: + /* Should not be parsed as single op */ + ecs_throw(ECS_INVALID_PARAMETER, NULL); + break; + case EcsOpEnum: + if (expr_ser_enum(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; } - if (match_indices) { - match_indices[t_i] = match_index; + break; + case EcsOpBitmask: + if (expr_ser_bitmask(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; } + break; + case EcsOpArray: + if (expr_ser_array(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; + } + break; + case EcsOpVector: + if (expr_ser_vector(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; + } + break; + default: + if (expr_ser_primitive(world, expr_op_to_primitive_kind(op->kind), + ECS_OFFSET(ptr, op->offset), str)) + { + /* Unknown operation */ + ecs_err("unknown serializer operation kind (%d)", op->kind); + goto error; + } + break; } - if (matches_left) { - *matches_left = match_count; - } - - return !is_or || or_result; + return 0; +error: + return -1; } +/* Iterate over a slice of the type ops array */ static -void term_iter_init_no_data( - ecs_term_iter_t *iter) +int expr_ser_type_ops( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + ecs_strbuf_t *str) { - iter->term = (ecs_term_t){ .index = -1 }; - iter->self_index = NULL; - iter->index = 0; + for (int i = 0; i < op_count; i ++) { + ecs_meta_type_op_t *op = &ops[i]; + + if (op != ops) { + if (op->name) { + ecs_strbuf_list_next(str); + ecs_strbuf_append(str, "%s: ", op->name); + } + + int32_t elem_count = op->count; + if (elem_count > 1 && op != ops) { + /* Serialize inline array */ + if (expr_ser_elements(world, op, op->op_count, base, + elem_count, op->size, str)) + { + return -1; + } + + i += op->op_count - 1; + continue; + } + } + + switch(op->kind) { + case EcsOpPush: + ecs_strbuf_list_push(str, "{", ", "); + break; + case EcsOpPop: + ecs_strbuf_list_pop(str, "}"); + break; + default: + if (expr_ser_type_op(world, op, base, str)) { + goto error; + } + break; + } + } + + return 0; +error: + return -1; } +/* Iterate over the type ops of a type */ static -void term_iter_init_wildcard( +int expr_ser_type( const ecs_world_t *world, - ecs_term_iter_t *iter) + ecs_vector_t *v_ops, + const void *base, + ecs_strbuf_t *str) { - iter->term = (ecs_term_t){ .index = -1 }; - iter->self_index = flecs_get_id_record(world, EcsAny); - iter->cur = iter->self_index; - flecs_table_cache_iter(&iter->self_index->cache, &iter->it); - iter->index = 0; + ecs_meta_type_op_t *ops = ecs_vector_first(v_ops, ecs_meta_type_op_t); + int32_t count = ecs_vector_count(v_ops); + return expr_ser_type_ops(world, ops, count, base, str); } -static -void term_iter_init( +int ecs_ptr_to_expr_buf( const ecs_world_t *world, - ecs_term_t *term, - ecs_term_iter_t *iter, - bool empty_tables) -{ - const ecs_term_id_t *subj = &term->subj; - - iter->term = *term; - - if (subj->set.mask == EcsDefaultSet || subj->set.mask & EcsSelf) { - iter->self_index = flecs_get_id_record(world, - actual_match_id(term->id)); + ecs_entity_t type, + const void *ptr, + ecs_strbuf_t *buf_out) +{ + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + if (ser == NULL) { + char *path = ecs_get_fullpath(world, type); + ecs_err("cannot serialize value for type '%s'", path); + ecs_os_free(path); + goto error; } - if (subj->set.mask & EcsSuperSet) { - iter->set_index = flecs_get_id_record(world, - ecs_pair(subj->set.relation, EcsWildcard)); + if (expr_ser_type(world, ser->ops, ptr, buf_out)) { + goto error; } - iter->index = 0; - - ecs_id_record_t *idr; - if (iter->self_index) { - idr = iter->cur = iter->self_index; - } else { - idr = iter->cur = iter->set_index; - } + return 0; +error: + return -1; +} - if (idr) { - if (empty_tables) { - if ((empty_tables = flecs_table_cache_empty_iter( - &idr->cache, &iter->it))) - { - iter->empty_tables = true; - } - } +char* ecs_ptr_to_expr( + const ecs_world_t *world, + ecs_entity_t type, + const void* ptr) +{ + ecs_strbuf_t str = ECS_STRBUF_INIT; - if (!empty_tables) { - flecs_table_cache_iter(&idr->cache, &iter->it); - } - } else { - term_iter_init_no_data(iter); + if (ecs_ptr_to_expr_buf(world, type, ptr, &str) != 0) { + ecs_strbuf_reset(&str); + return NULL; } + + return ecs_strbuf_get(&str); } -ecs_iter_t ecs_term_iter( - const ecs_world_t *stage, - ecs_term_t *term) +int ecs_primitive_to_expr_buf( + const ecs_world_t *world, + ecs_primitive_kind_t kind, + const void *base, + ecs_strbuf_t *str) { - ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(term->id != 0, ECS_INVALID_PARAMETER, NULL); + return expr_ser_primitive(world, kind, base, str); +} - const ecs_world_t *world = ecs_get_world(stage); +#endif - flecs_process_pending_tables(world); - if (ecs_term_finalize(world, NULL, term)) { - ecs_throw(ECS_INVALID_PARAMETER, NULL); - } - ecs_iter_t it = { - .real_world = (ecs_world_t*)world, - .world = (ecs_world_t*)stage, - .term_count = 1, - .next = ecs_term_next - }; +#ifdef FLECS_EXPR - term_iter_init(world, term, &it.priv.iter.term, false); +char* ecs_chresc( + char *out, + char in, + char delimiter) +{ + char *bptr = out; + switch(in) { + case '\a': + *bptr++ = '\\'; + *bptr = 'a'; + break; + case '\b': + *bptr++ = '\\'; + *bptr = 'b'; + break; + case '\f': + *bptr++ = '\\'; + *bptr = 'f'; + break; + case '\n': + *bptr++ = '\\'; + *bptr = 'n'; + break; + case '\r': + *bptr++ = '\\'; + *bptr = 'r'; + break; + case '\t': + *bptr++ = '\\'; + *bptr = 't'; + break; + case '\v': + *bptr++ = '\\'; + *bptr = 'v'; + break; + case '\\': + *bptr++ = '\\'; + *bptr = '\\'; + break; + default: + if (in == delimiter) { + *bptr++ = '\\'; + *bptr = delimiter; + } else { + *bptr = in; + } + break; + } - return it; -error: - return (ecs_iter_t){ 0 }; + *(++bptr) = '\0'; + + return bptr; } -ecs_iter_t ecs_term_chain_iter( - const ecs_iter_t *chain_it, - ecs_term_t *term) +const char* ecs_chrparse( + const char *in, + char *out) { - ecs_check(chain_it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); + const char *result = in + 1; + char ch; - ecs_world_t *world = chain_it->real_world; - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + if (in[0] == '\\') { + result ++; - if (ecs_term_finalize(world, NULL, term)) { - ecs_throw(ECS_INVALID_PARAMETER, NULL); + switch(in[1]) { + case 'a': + ch = '\a'; + break; + case 'b': + ch = '\b'; + break; + case 'f': + ch = '\f'; + break; + case 'n': + ch = '\n'; + break; + case 'r': + ch = '\r'; + break; + case 't': + ch = '\t'; + break; + case 'v': + ch = '\v'; + break; + case '\\': + ch = '\\'; + break; + case '"': + ch = '"'; + break; + case '0': + ch = '\0'; + break; + case ' ': + ch = ' '; + break; + case '$': + ch = '$'; + break; + default: + goto error; + } + } else { + ch = in[0]; } - ecs_iter_t it = { - .real_world = (ecs_world_t*)world, - .world = chain_it->world, - .terms = term, - .term_count = 1, - .chain_it = (ecs_iter_t*)chain_it, - .next = ecs_term_next - }; - - term_iter_init(world, term, &it.priv.iter.term, false); + if (out) { + *out = ch; + } - return it; + return result; error: - return (ecs_iter_t){ 0 }; + return NULL; } -static -const ecs_table_record_t *next_table( - ecs_term_iter_t *iter) +ecs_size_t ecs_stresc( + char *out, + ecs_size_t n, + char delimiter, + const char *in) { - ecs_id_record_t *idr = iter->cur; - if (!idr) { - return NULL; + const char *ptr = in; + char ch, *bptr = out, buff[3]; + ecs_size_t written = 0; + while ((ch = *ptr++)) { + if ((written += (ecs_size_t)(ecs_chresc( + buff, ch, delimiter) - buff)) <= n) + { + /* If size != 0, an out buffer must be provided. */ + ecs_check(out != NULL, ECS_INVALID_PARAMETER, NULL); + *bptr++ = buff[0]; + if ((ch = buff[1])) { + *bptr = ch; + bptr++; + } + } } - const ecs_table_record_t *tr; - if (!(tr = flecs_table_cache_next(&iter->it, ecs_table_record_t))) { - if (iter->empty_tables) { - iter->empty_tables = false; - flecs_table_cache_iter(&idr->cache, &iter->it); - tr = flecs_table_cache_next(&iter->it, ecs_table_record_t); + if (bptr) { + while (written < n) { + *bptr = '\0'; + bptr++; + written++; } } - - return tr; + return written; +error: + return 0; } -static -bool term_iter_next( - ecs_world_t *world, - ecs_term_iter_t *iter, - bool match_prefab, - bool match_disabled) +char* ecs_astresc( + char delimiter, + const char *in) { - ecs_table_t *table = iter->table; - ecs_entity_t source = 0; - const ecs_table_record_t *tr; - ecs_term_t *term = &iter->term; + if (!in) { + return NULL; + } - do { - if (table) { - iter->cur_match ++; - if (iter->cur_match >= iter->match_count) { - table = NULL; - } else { - iter->last_column = ecs_search_offset( - world, table, iter->last_column + 1, term->id, 0); - iter->column = iter->last_column + 1; - if (iter->last_column >= 0) { - iter->id = ecs_vector_get( - table->type, ecs_id_t, iter->last_column)[0]; - } - } - } - - if (!table) { - if (!(tr = next_table(iter))) { - if (iter->cur != iter->set_index && iter->set_index != NULL) { - iter->cur = iter->set_index; - flecs_table_cache_iter(&iter->set_index->cache, &iter->it); - iter->index = 0; - tr = next_table(iter); - } - - if (!tr) { - return false; - } - } - - table = tr->hdr.table; - - if (!match_prefab && (table->flags & EcsTableIsPrefab)) { - continue; - } - - if (!match_disabled && (table->flags & EcsTableIsDisabled)) { - continue; - } - - iter->table = table; - iter->match_count = tr->count; - iter->cur_match = 0; - iter->last_column = tr->column; - iter->column = tr->column + 1; - iter->id = ecs_vector_get(table->type, ecs_id_t, tr->column)[0]; - } + ecs_size_t len = ecs_stresc(NULL, 0, delimiter, in); + char *out = ecs_os_malloc_n(char, len + 1); + ecs_stresc(out, len, delimiter, in); + out[len] = '\0'; + return out; +} - if (iter->cur == iter->set_index) { - const ecs_term_id_t *subj = &term->subj; +#endif - if (iter->self_index) { - if (flecs_id_record_table(iter->self_index, table) != NULL) { - /* If the table has the id itself and this term matched Self - * we already matched it */ - continue; - } - } - /* Test if following the relation finds the id */ - int32_t index = ecs_search_relation(world, table, 0, - term->id, subj->set.relation, subj->set.min_depth, - subj->set.max_depth, &source, &iter->id, NULL); - if (index == -1) { - source = 0; - continue; - } +#ifdef FLECS_EXPR - ecs_assert(source != 0, ECS_INTERNAL_ERROR, NULL); +const char *ecs_parse_expr_token( + const char *name, + const char *expr, + const char *ptr, + char *token) +{ + const char *start = ptr; + char *token_ptr = token; - iter->column = (index + 1) * -1; + while ((ptr = ecs_parse_token(name, expr, ptr, token_ptr))) { + if (ptr[0] == '|') { + token_ptr = &token_ptr[ptr - start]; + token_ptr[0] = '|'; + token_ptr[1] = '\0'; + token_ptr ++; + ptr ++; + start = ptr; + } else { + break; } + } - break; - } while (true); - - iter->subject = source; - - return true; + return ptr; } -bool ecs_term_next( - ecs_iter_t *it) +const char* ecs_parse_expr( + const ecs_world_t *world, + const char *ptr, + ecs_entity_t type, + void *data_out, + const ecs_parse_expr_desc_t *desc) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_term_next, ECS_INVALID_PARAMETER, NULL); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + char token[ECS_MAX_TOKEN_SIZE]; + int depth = 0; - ecs_term_iter_t *iter = &it->priv.iter.term; - ecs_term_t *term = &iter->term; - ecs_world_t *world = it->real_world; - ecs_table_t *table; + const char *name = NULL; + const char *expr = NULL; - it->ids = &iter->id; - it->subjects = &iter->subject; - it->columns = &iter->column; - it->terms = &iter->term; + ptr = ecs_parse_fluff(ptr, NULL); - if (term->inout != EcsInOutFilter) { - it->sizes = &iter->size; - it->ptrs = &iter->ptr; - } else { - it->sizes = NULL; - it->ptrs = NULL; + ecs_meta_cursor_t cur = ecs_meta_cursor(world, type, data_out); + if (cur.valid == false) { + return NULL; } - ecs_iter_t *chain_it = it->chain_it; - if (chain_it) { - ecs_iter_next_action_t next = chain_it->next; - bool match; + if (desc) { + name = desc->name; + expr = desc->expr; + cur.lookup_action = desc->lookup_action; + cur.lookup_ctx = desc->lookup_ctx; + } - do { - if (!next(chain_it)) { - goto done; - } + while ((ptr = ecs_parse_expr_token(name, expr, ptr, token))) { - table = chain_it->table; - match = flecs_term_match_table(world, term, table, table->type, - it->ids, it->columns, it->subjects, it->match_indices, true); - } while (!match); - goto yield; + if (!ecs_os_strcmp(token, "{")) { + ecs_entity_t scope_type = ecs_meta_get_type(&cur); + depth ++; + if (ecs_meta_push(&cur) != 0) { + goto error; + } - } else { - if (!term_iter_next(world, iter, false, false)) { - goto done; + if (ecs_meta_is_collection(&cur)) { + char *path = ecs_get_fullpath(world, scope_type); + ecs_parser_error(name, expr, ptr - expr, + "expected '[' for collection type '%s'", path); + ecs_os_free(path); + return NULL; + } } - table = iter->table; - - /* Source must either be 0 (EcsThis) or nonzero in case of substitution */ - ecs_assert(iter->subject || iter->cur != iter->set_index, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(iter->table != NULL, ECS_INTERNAL_ERROR, NULL); - } - -yield: - flecs_iter_populate_data(world, it, table, 0, 0, it->ptrs, it->sizes); - it->is_valid = true; - return true; -done: -error: - return false; -} - -static -const ecs_filter_t* init_filter_iter( - const ecs_world_t *world, - ecs_iter_t *it, - const ecs_filter_t *filter) -{ - ecs_filter_iter_t *iter = &it->priv.iter.filter; + else if (!ecs_os_strcmp(token, "}")) { + depth --; - if (filter) { - iter->filter = *filter; + if (ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected ']'"); + return NULL; + } - if (filter->term_cache_used) { - iter->filter.terms = iter->filter.term_cache; + if (ecs_meta_pop(&cur) != 0) { + goto error; + } } - ecs_filter_finalize(world, &iter->filter); - - ecs_assert(!filter->term_cache_used || - filter->terms == filter->term_cache, ECS_INTERNAL_ERROR, NULL); - } else { - ecs_filter_init(world, &iter->filter, &(ecs_filter_desc_t) { - .terms = {{ .id = EcsAny }} - }); - - filter = &iter->filter; - } + else if (!ecs_os_strcmp(token, "[")) { + depth ++; + if (ecs_meta_push(&cur) != 0) { + goto error; + } - it->term_count = filter->term_count_actual; + if (!ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected '{'"); + return NULL; + } + } - return filter; -} + else if (!ecs_os_strcmp(token, "]")) { + depth --; -int32_t ecs_filter_pivot_term( - const ecs_world_t *world, - const ecs_filter_t *filter) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(filter != NULL, ECS_INVALID_PARAMETER, NULL); + if (!ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected '}'"); + return NULL; + } - ecs_term_t *terms = filter->terms; - int32_t i, term_count = filter->term_count; - int32_t pivot_term = -1, min_count = -1; + if (ecs_meta_pop(&cur) != 0) { + goto error; + } + } - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_id_t id = term->id; + else if (!ecs_os_strcmp(token, ",")) { + if (ecs_meta_next(&cur) != 0) { + goto error; + } + } - if (term->oper != EcsAnd) { - continue; + else if (!ecs_os_strcmp(token, "null")) { + if (ecs_meta_set_null(&cur) != 0) { + goto error; + } } - if (term->subj.entity != EcsThis) { - continue; + else if (token[0] == '\"') { + if (ecs_meta_set_string_literal(&cur, token) != 0) { + goto error; + } } - ecs_id_record_t *idr = flecs_get_id_record(world, - actual_match_id(id)); - if (!idr) { - /* If one of the terms does not match with any data, iterator - * should not return anything */ - return -2; /* -2 indicates filter doesn't match anything */ + else { + ptr = ecs_parse_fluff(ptr, NULL); + + if (ptr[0] == ':') { + /* Member assignment */ + ptr ++; + if (ecs_meta_member(&cur, token) != 0) { + goto error; + } + } else { + if (ecs_meta_set_string(&cur, token) != 0) { + goto error; + } + } } - int32_t table_count = ecs_table_cache_count(&idr->cache); - if (min_count == -1 || table_count < min_count) { - min_count = table_count; - pivot_term = i; + if (!depth) { + break; } + + ptr = ecs_parse_fluff(ptr, NULL); } - return pivot_term; + return ptr; error: - return -2; + return NULL; } -ecs_iter_t ecs_filter_iter( - const ecs_world_t *stage, - const ecs_filter_t *filter) -{ - ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); - - const ecs_world_t *world = ecs_get_world(stage); - - flecs_process_pending_tables(world); - - ecs_iter_t it = { - .real_world = (ecs_world_t*)world, - .world = (ecs_world_t*)stage, - .terms = filter ? filter->terms : NULL, - .next = ecs_filter_next, - .is_instanced = filter ? filter->instanced : false - }; - - ecs_filter_iter_t *iter = &it.priv.iter.filter; +#endif - filter = init_filter_iter(world, &it, filter); - /* Find term that represents smallest superset */ - if (filter->match_this) { - ecs_term_t *terms = filter->terms; - int32_t pivot_term = -1; - ecs_check(terms != NULL, ECS_INVALID_PARAMETER, NULL); - iter->kind = EcsIterEvalIndex; +#ifdef FLECS_SYSTEM +#endif - pivot_term = ecs_filter_pivot_term(world, filter); +#ifdef FLECS_PIPELINE +#endif - if (pivot_term == -2) { - /* One or more terms have no matching results */ - term_iter_init_no_data(&iter->term_iter); - return it; - } else if (pivot_term == -1) { - /* No terms meet the criteria to be a pivot term, evaluate filter - * against all tables */ - term_iter_init_wildcard(world, &iter->term_iter); - } else { - ecs_assert(pivot_term >= 0, ECS_INTERNAL_ERROR, NULL); - term_iter_init(world, &terms[pivot_term], &iter->term_iter, - filter->match_empty_tables); - } +#ifdef FLECS_STATS - iter->term_iter.empty_tables = filter->match_empty_tables; - } else { - if (!filter->match_anything) { - iter->kind = EcsIterEvalCondition; - term_iter_init_no_data(&iter->term_iter); - } else { - iter->kind = EcsIterEvalNone; - } - } +#include - if (filter->terms == filter->term_cache) { - /* Because we're returning the iterator by value, the address of the - * term cache changes. The ecs_filter_next function will set the correct - * address when it detects that terms is set to NULL */ - iter->filter.terms = NULL; - } +static +int32_t t_next( + int32_t t) +{ + return (t + 1) % ECS_STAT_WINDOW; +} - it.is_filter = filter->filter; +static +int32_t t_prev( + int32_t t) +{ + return (t - 1 + ECS_STAT_WINDOW) % ECS_STAT_WINDOW; +} - return it; -error: - return (ecs_iter_t){ 0 }; +static +void _record_gauge( + ecs_gauge_t *m, + int32_t t, + float value) +{ + m->avg[t] = value; + m->min[t] = value; + m->max[t] = value; } -ecs_iter_t ecs_filter_chain_iter( - const ecs_iter_t *chain_it, - const ecs_filter_t *filter) +static +float _record_counter( + ecs_counter_t *m, + int32_t t, + float value) { - ecs_iter_t it = { - .terms = filter->terms, - .term_count = filter->term_count, - .world = chain_it->world, - .real_world = chain_it->real_world, - .chain_it = (ecs_iter_t*)chain_it, - .next = ecs_filter_next - }; + int32_t tp = t_prev(t); + float prev = m->value[tp]; + m->value[t] = value; + _record_gauge((ecs_gauge_t*)m, t, value - prev); + return value - prev; +} - ecs_filter_iter_t *iter = &it.priv.iter.filter; - init_filter_iter(it.world, &it, filter); +/* Macro's to silence conversion warnings without adding casts everywhere */ +#define record_gauge(m, t, value)\ + _record_gauge(m, t, (float)value) - iter->kind = EcsIterEvalChain; +#define record_counter(m, t, value)\ + _record_counter(m, t, (float)value) - if (filter->terms == filter->term_cache) { - /* See ecs_filter_iter */ - iter->filter.terms = NULL; - } +static +void print_value( + const char *name, + float value) +{ + ecs_size_t len = ecs_os_strlen(name); + printf("%s: %*s %.2f\n", name, 32 - len, "", (double)value); +} - return it; +static +void print_gauge( + const char *name, + int32_t t, + const ecs_gauge_t *m) +{ + print_value(name, m->avg[t]); } -bool ecs_filter_next( - ecs_iter_t *it) +static +void print_counter( + const char *name, + int32_t t, + const ecs_counter_t *m) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_filter_next, ECS_INVALID_PARAMETER, NULL); + print_value(name, m->rate.avg[t]); +} - if (flecs_iter_next_row(it)) { - return true; - } +void ecs_gauge_reduce( + ecs_gauge_t *dst, + int32_t t_dst, + ecs_gauge_t *src, + int32_t t_src) +{ + ecs_check(dst != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(src != NULL, ECS_INVALID_PARAMETER, NULL); - return flecs_iter_next_instanced(it, ecs_filter_next_instanced(it)); + bool min_set = false; + dst->min[t_dst] = 0; + dst->avg[t_dst] = 0; + dst->max[t_dst] = 0; + + int32_t i; + for (i = 0; i < ECS_STAT_WINDOW; i ++) { + int32_t t = (t_src + i) % ECS_STAT_WINDOW; + dst->avg[t_dst] += src->avg[t] / (float)ECS_STAT_WINDOW; + if (!min_set || (src->min[t] < dst->min[t_dst])) { + dst->min[t_dst] = src->min[t]; + min_set = true; + } + if ((src->max[t] > dst->max[t_dst])) { + dst->max[t_dst] = src->max[t]; + } + } error: - return false; + return; } -bool ecs_filter_next_instanced( - ecs_iter_t *it) +void ecs_get_world_stats( + const ecs_world_t *world, + ecs_world_stats_t *s) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_filter_next, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->chain_it != it, ECS_INVALID_PARAMETER, NULL); + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_filter_iter_t *iter = &it->priv.iter.filter; - ecs_filter_t *filter = &iter->filter; - ecs_world_t *world = it->real_world; - ecs_table_t *table = NULL; - bool match; + world = ecs_get_world(world); - if (!filter->terms) { - filter->terms = filter->term_cache; - } + int32_t t = s->t = t_next(s->t); - flecs_iter_init(it); + float delta_world_time = record_counter(&s->world_time_total_raw, t, world->stats.world_time_total_raw); + record_counter(&s->world_time_total, t, world->stats.world_time_total); + record_counter(&s->frame_time_total, t, world->stats.frame_time_total); + record_counter(&s->system_time_total, t, world->stats.system_time_total); + record_counter(&s->merge_time_total, t, world->stats.merge_time_total); - ecs_iter_t *chain_it = it->chain_it; - ecs_iter_kind_t kind = iter->kind; + float delta_frame_count = record_counter(&s->frame_count_total, t, world->stats.frame_count_total); + record_counter(&s->merge_count_total, t, world->stats.merge_count_total); + record_counter(&s->pipeline_build_count_total, t, world->stats.pipeline_build_count_total); + record_counter(&s->systems_ran_frame, t, world->stats.systems_ran_frame); - if (chain_it) { - ecs_assert(kind == EcsIterEvalChain, ECS_INVALID_PARAMETER, NULL); - - ecs_iter_next_action_t next = chain_it->next; - do { - if (!next(chain_it)) { - goto done; - } + if (delta_world_time != 0.0f && delta_frame_count != 0.0f) { + record_gauge( + &s->fps, t, 1.0f / (delta_world_time / (float)delta_frame_count)); + } else { + record_gauge(&s->fps, t, 0); + } - table = chain_it->table; - match = flecs_filter_match_table(world, filter, table, - it->ids, it->columns, it->subjects, it->match_indices, NULL, - true, -1); - } while (!match); + record_gauge(&s->entity_count, t, flecs_sparse_count(ecs_eis(world))); + record_gauge(&s->component_count, t, ecs_count_id(world, ecs_id(EcsComponent))); + record_gauge(&s->query_count, t, flecs_sparse_count(world->queries)); + record_gauge(&s->system_count, t, ecs_count_id(world, ecs_id(EcsSystem))); - goto yield; - } else if (kind == EcsIterEvalIndex || kind == EcsIterEvalCondition) { - ecs_term_iter_t *term_iter = &iter->term_iter; - ecs_term_t *term = &term_iter->term; - int32_t pivot_term = term->index; - bool first; + record_counter(&s->new_count, t, world->new_count); + record_counter(&s->bulk_new_count, t, world->bulk_new_count); + record_counter(&s->delete_count, t, world->delete_count); + record_counter(&s->clear_count, t, world->clear_count); + record_counter(&s->add_count, t, world->add_count); + record_counter(&s->remove_count, t, world->remove_count); + record_counter(&s->set_count, t, world->set_count); + record_counter(&s->discard_count, t, world->discard_count); - do { - first = iter->matches_left == 0; + /* Compute table statistics */ + int32_t empty_table_count = 0; + int32_t singleton_table_count = 0; + int32_t matched_table_count = 0, matched_entity_count = 0; - if (first) { - if (kind != EcsIterEvalCondition) { - /* Find new match, starting with the leading term */ - if (!term_iter_next(world, term_iter, - filter->match_prefab, filter->match_disabled)) - { - goto done; - } + int32_t i, count = flecs_sparse_count(&world->store.tables); + for (i = 0; i < count; i ++) { + ecs_table_t *table = flecs_sparse_get_dense(&world->store.tables, + ecs_table_t, i); + int32_t entity_count = ecs_table_count(table); - ecs_assert(term_iter->match_count != 0, - ECS_INTERNAL_ERROR, NULL); + if (!entity_count) { + empty_table_count ++; + } - if (pivot_term == -1) { - /* Without a pivot term, we're iterating all tables with - * a wildcard, so the match count is meaningless. */ - term_iter->match_count = 1; - } + /* Singleton tables are tables that have just one entity that also has + * itself in the table type. */ + if (entity_count == 1) { + ecs_entity_t *entities = ecs_vector_first( + table->storage.entities, ecs_entity_t); + if (ecs_search_relation(world, table, 0, entities[0], EcsIsA, + 0, 0, 0, 0, 0) != -1) + { + singleton_table_count ++; + } + } + } - iter->matches_left = term_iter->match_count; + record_gauge(&s->matched_table_count, t, matched_table_count); + record_gauge(&s->matched_entity_count, t, matched_entity_count); + + record_gauge(&s->table_count, t, count); + record_gauge(&s->empty_table_count, t, empty_table_count); + record_gauge(&s->singleton_table_count, t, singleton_table_count); - /* Filter iterator takes control over iterating all the - * permutations that match the wildcard. */ - term_iter->match_count = 1; +error: + return; +} - table = term_iter->table; - if (pivot_term != -1) { - it->ids[pivot_term] = term_iter->id; - it->subjects[pivot_term] = term_iter->subject; - it->columns[pivot_term] = term_iter->column; - } - } else { - /* Progress iterator to next match for table, if any */ - table = it->table; - if (term_iter->index == 0) { - iter->matches_left = 1; - term_iter->index = 1; /* prevents looping again */ - } else { - goto done; - } - } +void ecs_get_query_stats( + const ecs_world_t *world, + const ecs_query_t *query, + ecs_query_stats_t *s) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); + (void)world; - /* Match the remainder of the terms */ - match = flecs_filter_match_table(world, filter, table, - it->ids, it->columns, it->subjects, - it->match_indices, &iter->matches_left, first, - pivot_term); - if (!match) { - iter->matches_left = 0; - continue; - } - - ecs_assert(iter->matches_left != 0, ECS_INTERNAL_ERROR, NULL); - } + int32_t t = s->t = t_next(s->t); - /* If this is not the first result for the table, and the table - * is matched more than once, iterate remaining matches */ - if (!first && (iter->matches_left > 0)) { - table = it->table; - - /* Find first term that still has matches left */ - int32_t i, j, count = it->term_count; - for (i = count - 1; i >= 0; i --) { - int32_t mi = -- it->match_indices[i]; - if (mi) { - break; - } - } + ecs_iter_t it = ecs_query_iter(world, (ecs_query_t*)query); + record_gauge(&s->matched_entity_count, t, ecs_iter_count(&it)); + record_gauge(&s->matched_table_count, t, ecs_query_table_count(query)); + record_gauge(&s->matched_empty_table_count, t, + ecs_query_empty_table_count(query)); +error: + return; +} - /* Progress first term to next match (must be at least one) */ - it->columns[i] ++; - flecs_term_match_table(world, &filter->terms[i], table, - table->type, &it->ids[i], &it->columns[i], &it->subjects[i], - &it->match_indices[i], false); +#ifdef FLECS_SYSTEM +bool ecs_get_system_stats( + const ecs_world_t *world, + ecs_entity_t system, + ecs_system_stats_t *s) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); - /* Reset remaining terms (if any) to first match */ - for (j = i + 1; j < count; j ++) { - flecs_term_match_table(world, &filter->terms[j], table, - table->type, &it->ids[j], &it->columns[j], - &it->subjects[j], &it->match_indices[j], true); - } - } + world = ecs_get_world(world); - match = iter->matches_left != 0; - iter->matches_left --; + const EcsSystem *ptr = ecs_get(world, system, EcsSystem); + if (!ptr) { + return false; + } - ecs_assert(iter->matches_left >= 0, ECS_INTERNAL_ERROR, NULL); - } while (!match); + ecs_get_query_stats(world, ptr->query, &s->query_stats); + int32_t t = s->query_stats.t; - goto yield; - } + record_counter(&s->time_spent, t, ptr->time_spent); + record_counter(&s->invoke_count, t, ptr->invoke_count); + record_gauge(&s->active, t, !ecs_has_id(world, system, EcsInactive)); + record_gauge(&s->enabled, t, !ecs_has_id(world, system, EcsDisabled)); -done: + return true; error: - ecs_iter_fini(it); return false; - -yield: - it->offset = 0; - flecs_iter_populate_data(world, it, table, 0, 0, it->ptrs, it->sizes); - it->is_valid = true; - return true; } +#endif -#ifdef FLECS_TIMER +#ifdef FLECS_PIPELINE -static -void AddTickSource(ecs_iter_t *it) { - int32_t i; - for (i = 0; i < it->count; i ++) { - ecs_set(it->world, it->entities[i], EcsTickSource, {0}); - } -} +static +ecs_system_stats_t* get_system_stats( + ecs_map_t *systems, + ecs_entity_t system) +{ + ecs_check(systems != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); -static -void ProgressTimers(ecs_iter_t *it) { - EcsTimer *timer = ecs_term(it, EcsTimer, 1); - EcsTickSource *tick_source = ecs_term(it, EcsTickSource, 2); + ecs_system_stats_t *s = ecs_map_get(systems, ecs_system_stats_t, system); + if (!s) { + s = ecs_map_ensure(systems, ecs_system_stats_t, system); + } - ecs_assert(timer != NULL, ECS_INTERNAL_ERROR, NULL); + return s; +error: + return NULL; +} - int i; - for (i = 0; i < it->count; i ++) { - tick_source[i].tick = false; +bool ecs_get_pipeline_stats( + ecs_world_t *stage, + ecs_entity_t pipeline, + ecs_pipeline_stats_t *s) +{ + ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(pipeline != 0, ECS_INVALID_PARAMETER, NULL); - if (!timer[i].active) { - continue; - } + const ecs_world_t *world = ecs_get_world(stage); - const ecs_world_info_t *info = ecs_get_world_info(it->world); - FLECS_FLOAT time_elapsed = timer[i].time + info->delta_time_raw; - FLECS_FLOAT timeout = timer[i].timeout; - - if (time_elapsed >= timeout) { - FLECS_FLOAT t = time_elapsed - timeout; - if (t > timeout) { - t = 0; - } + const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); + if (!pq) { + return false; + } - timer[i].time = t; /* Initialize with remainder */ - tick_source[i].tick = true; - tick_source[i].time_elapsed = time_elapsed; + int32_t sys_count = 0, active_sys_count = 0; - if (timer[i].single_shot) { - timer[i].active = false; - } - } else { - timer[i].time = time_elapsed; - } + /* Count number of active systems */ + ecs_iter_t it = ecs_query_iter(stage, pq->query); + while (ecs_query_next(&it)) { + active_sys_count += it.count; } -} -static -void ProgressRateFilters(ecs_iter_t *it) { - EcsRateFilter *filter = ecs_term(it, EcsRateFilter, 1); - EcsTickSource *tick_dst = ecs_term(it, EcsTickSource, 2); + /* Count total number of systems in pipeline */ + it = ecs_query_iter(stage, pq->build_query); + while (ecs_query_next(&it)) { + sys_count += it.count; + } - int i; - for (i = 0; i < it->count; i ++) { - ecs_entity_t src = filter[i].src; - bool inc = false; + /* Also count synchronization points */ + ecs_vector_t *ops = pq->ops; + ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); + ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); + int32_t pip_count = active_sys_count + ecs_vector_count(ops); - filter[i].time_elapsed += it->delta_time; + if (!sys_count) { + return false; + } - if (src) { - const EcsTickSource *tick_src = ecs_get(it->world, src, EcsTickSource); - if (tick_src) { - inc = tick_src->tick; - } else { - inc = true; - } - } else { - inc = true; - } + if (s->system_stats && !sys_count) { + ecs_map_free(s->system_stats); + } + if (!s->system_stats && sys_count) { + s->system_stats = ecs_map_new(ecs_system_stats_t, sys_count); + } + if (!sys_count) { + s->system_stats = NULL; + } - if (inc) { - filter[i].tick_count ++; - bool triggered = !(filter[i].tick_count % filter[i].rate); - tick_dst[i].tick = triggered; - tick_dst[i].time_elapsed = filter[i].time_elapsed; + /* Make sure vector is large enough to store all systems & sync points */ + ecs_entity_t *systems = NULL; + if (pip_count) { + ecs_vector_set_count(&s->systems, ecs_entity_t, pip_count); + systems = ecs_vector_first(s->systems, ecs_entity_t); - if (triggered) { - filter[i].time_elapsed = 0; - } - } else { - tick_dst[i].tick = false; + /* Populate systems vector, keep track of sync points */ + it = ecs_query_iter(stage, pq->query); + + int32_t i, i_system = 0, ran_since_merge = 0; + while (ecs_query_next(&it)) { + for (i = 0; i < it.count; i ++) { + systems[i_system ++] = it.entities[i]; + ran_since_merge ++; + if (op != op_last && ran_since_merge == op->count) { + ran_since_merge = 0; + op++; + systems[i_system ++] = 0; /* 0 indicates a merge point */ + } + } } - } -} - -static -void ProgressTickSource(ecs_iter_t *it) { - EcsTickSource *tick_src = ecs_term(it, EcsTickSource, 1); - /* If tick source has no filters, tick unconditionally */ - int i; - for (i = 0; i < it->count; i ++) { - tick_src[i].tick = true; - tick_src[i].time_elapsed = it->delta_time; + systems[i_system ++] = 0; /* Last merge */ + ecs_assert(pip_count == i_system, ECS_INTERNAL_ERROR, NULL); + } else { + ecs_vector_free(s->systems); + s->systems = NULL; } -} - -ecs_entity_t ecs_set_timeout( - ecs_world_t *world, - ecs_entity_t timer, - FLECS_FLOAT timeout) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - - timer = ecs_set(world, timer, EcsTimer, { - .timeout = timeout, - .single_shot = true, - .active = true - }); - EcsSystem *system_data = ecs_get_mut(world, timer, EcsSystem, NULL); - if (system_data) { - system_data->tick_source = timer; + /* Separately populate system stats map from build query, which includes + * systems that aren't currently active */ + it = ecs_query_iter(stage, pq->build_query); + while (ecs_query_next(&it)) { + int i; + for (i = 0; i < it.count; i ++) { + ecs_system_stats_t *sys_stats = get_system_stats( + s->system_stats, it.entities[i]); + ecs_get_system_stats(world, it.entities[i], sys_stats); + } } + return true; error: - return timer; + return false; } -FLECS_FLOAT ecs_get_timeout( - const ecs_world_t *world, - ecs_entity_t timer) +void ecs_pipeline_stats_fini( + ecs_pipeline_stats_t *stats) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(timer != 0, ECS_INVALID_PARAMETER, NULL); - - const EcsTimer *value = ecs_get(world, timer, EcsTimer); - if (value) { - return value->timeout; - } -error: - return 0; + ecs_map_free(stats->system_stats); + ecs_vector_free(stats->systems); } -ecs_entity_t ecs_set_interval( - ecs_world_t *world, - ecs_entity_t timer, - FLECS_FLOAT interval) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - - timer = ecs_set(world, timer, EcsTimer, { - .timeout = interval, - .active = true - }); - - EcsSystem *system_data = ecs_get_mut(world, timer, EcsSystem, NULL); - if (system_data) { - system_data->tick_source = timer; - } -error: - return timer; -} +#endif -FLECS_FLOAT ecs_get_interval( +void ecs_dump_world_stats( const ecs_world_t *world, - ecs_entity_t timer) + const ecs_world_stats_t *s) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - - if (!timer) { - return 0; - } + int32_t t = s->t; - const EcsTimer *value = ecs_get(world, timer, EcsTimer); - if (value) { - return value->timeout; - } -error: - return 0; -} + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); -void ecs_start_timer( - ecs_world_t *world, - ecs_entity_t timer) -{ - EcsTimer *ptr = ecs_get_mut(world, timer, EcsTimer, NULL); - ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ptr->active = true; - ptr->time = 0; + world = ecs_get_world(world); + + print_counter("Frame", t, &s->frame_count_total); + printf("-------------------------------------\n"); + print_counter("pipeline rebuilds", t, &s->pipeline_build_count_total); + print_counter("systems ran last frame", t, &s->systems_ran_frame); + printf("\n"); + print_value("target FPS", world->stats.target_fps); + print_value("time scale", world->stats.time_scale); + printf("\n"); + print_gauge("actual FPS", t, &s->fps); + print_counter("frame time", t, &s->frame_time_total); + print_counter("system time", t, &s->system_time_total); + print_counter("merge time", t, &s->merge_time_total); + print_counter("simulation time elapsed", t, &s->world_time_total); + printf("\n"); + print_gauge("entity count", t, &s->entity_count); + print_gauge("component count", t, &s->component_count); + print_gauge("query count", t, &s->query_count); + print_gauge("system count", t, &s->system_count); + print_gauge("table count", t, &s->table_count); + print_gauge("singleton table count", t, &s->singleton_table_count); + print_gauge("empty table count", t, &s->empty_table_count); + printf("\n"); + print_counter("deferred new operations", t, &s->new_count); + print_counter("deferred bulk_new operations", t, &s->bulk_new_count); + print_counter("deferred delete operations", t, &s->delete_count); + print_counter("deferred clear operations", t, &s->clear_count); + print_counter("deferred add operations", t, &s->add_count); + print_counter("deferred remove operations", t, &s->remove_count); + print_counter("deferred set operations", t, &s->set_count); + print_counter("discarded operations", t, &s->discard_count); + printf("\n"); + error: return; } -void ecs_stop_timer( - ecs_world_t *world, - ecs_entity_t timer) -{ - EcsTimer *ptr = ecs_get_mut(world, timer, EcsTimer, NULL); - ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ptr->active = false; -error: - return; -} +#endif -ecs_entity_t ecs_set_rate( - ecs_world_t *world, - ecs_entity_t filter, - int32_t rate, - ecs_entity_t source) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - filter = ecs_set(world, filter, EcsRateFilter, { - .rate = rate, - .src = source - }); - EcsSystem *system_data = ecs_get_mut(world, filter, EcsSystem, NULL); - if (system_data) { - system_data->tick_source = filter; - } +#ifdef FLECS_UNITS -error: - return filter; -} - -void ecs_set_tick_source( - ecs_world_t *world, - ecs_entity_t system, - ecs_entity_t tick_source) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(tick_source != 0, ECS_INVALID_PARAMETER, NULL); - - EcsSystem *system_data = ecs_get_mut(world, system, EcsSystem, NULL); - ecs_check(system_data != NULL, ECS_INVALID_PARAMETER, NULL); - - system_data->tick_source = tick_source; -error: - return; -} - -void FlecsTimerImport( - ecs_world_t *world) -{ - ECS_MODULE(world, FlecsTimer); - - ECS_IMPORT(world, FlecsPipeline); - - ecs_set_name_prefix(world, "Ecs"); - - flecs_bootstrap_component(world, EcsTimer); - flecs_bootstrap_component(world, EcsRateFilter); - - /* Add EcsTickSource to timers and rate filters */ - ecs_system_init(world, &(ecs_system_desc_t) { - .entity = { .name = "AddTickSource", .add = { EcsPreFrame } }, - .query.filter.terms = { - { .id = ecs_id(EcsTimer), .oper = EcsOr, .inout = EcsIn }, - { .id = ecs_id(EcsRateFilter), .oper = EcsOr, .inout = EcsIn }, - { .id = ecs_id(EcsTickSource), .oper = EcsNot, .inout = EcsOut} - }, - .callback = AddTickSource - }); - - /* Timer handling */ - ecs_system_init(world, &(ecs_system_desc_t) { - .entity = { .name = "ProgressTimers", .add = { EcsPreFrame } }, - .query.filter.terms = { - { .id = ecs_id(EcsTimer) }, - { .id = ecs_id(EcsTickSource) } - }, - .callback = ProgressTimers - }); - - /* Rate filter handling */ - ecs_system_init(world, &(ecs_system_desc_t) { - .entity = { .name = "ProgressRateFilters", .add = { EcsPreFrame } }, - .query.filter.terms = { - { .id = ecs_id(EcsRateFilter), .inout = EcsIn }, - { .id = ecs_id(EcsTickSource), .inout = EcsOut } - }, - .callback = ProgressRateFilters - }); - - /* TickSource without a timer or rate filter just increases each frame */ - ecs_system_init(world, &(ecs_system_desc_t) { - .entity = { .name = "ProgressTickSource", .add = { EcsPreFrame } }, - .query.filter.terms = { - { .id = ecs_id(EcsTickSource), .inout = EcsOut }, - { .id = ecs_id(EcsRateFilter), .oper = EcsNot }, - { .id = ecs_id(EcsTimer), .oper = EcsNot } - }, - .callback = ProgressTickSource - }); -} - -#endif - - - -#ifdef FLECS_EXPR - -static -int expr_ser_type( - const ecs_world_t *world, - ecs_vector_t *ser, - const void *base, - ecs_strbuf_t *str); - -static -int expr_ser_type_ops( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - ecs_strbuf_t *str); - -static -int expr_ser_type_op( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str); - -static -ecs_primitive_kind_t expr_op_to_primitive_kind(ecs_meta_type_op_kind_t kind) { - return kind - EcsOpPrimitive; -} - -/* Serialize a primitive value */ -static -int expr_ser_primitive( - const ecs_world_t *world, - ecs_primitive_kind_t kind, - const void *base, - ecs_strbuf_t *str) -{ - const char *bool_str[] = { "false", "true" }; - - switch(kind) { - case EcsBool: - ecs_strbuf_appendstr(str, bool_str[(int)*(bool*)base]); - break; - case EcsChar: { - char chbuf[3]; - char ch = *(char*)base; - if (ch) { - ecs_chresc(chbuf, *(char*)base, '"'); - ecs_strbuf_appendstrn(str, "\"", 1); - ecs_strbuf_appendstr(str, chbuf); - ecs_strbuf_appendstrn(str, "\"", 1); - } else { - ecs_strbuf_appendstr(str, "0"); - } - break; - } - case EcsByte: - ecs_strbuf_append(str, "%u", *(uint8_t*)base); - break; - case EcsU8: - ecs_strbuf_append(str, "%u", *(uint8_t*)base); - break; - case EcsU16: - ecs_strbuf_append(str, "%u", *(uint16_t*)base); - break; - case EcsU32: - ecs_strbuf_append(str, "%u", *(uint32_t*)base); - break; - case EcsU64: - ecs_strbuf_append(str, "%llu", *(uint64_t*)base); - break; - case EcsI8: - ecs_strbuf_append(str, "%d", *(int8_t*)base); - break; - case EcsI16: - ecs_strbuf_append(str, "%d", *(int16_t*)base); - break; - case EcsI32: - ecs_strbuf_append(str, "%d", *(int32_t*)base); - break; - case EcsI64: - ecs_strbuf_append(str, "%lld", *(int64_t*)base); - break; - case EcsF32: - ecs_strbuf_appendflt(str, (double)*(float*)base, 0); - break; - case EcsF64: - ecs_strbuf_appendflt(str, *(double*)base, 0); - break; - case EcsIPtr: - ecs_strbuf_append(str, "%i", *(intptr_t*)base); - break; - case EcsUPtr: - ecs_strbuf_append(str, "%u", *(uintptr_t*)base); - break; - case EcsString: { - char *value = *(char**)base; - if (value) { - ecs_size_t length = ecs_stresc(NULL, 0, '"', value); - if (length == ecs_os_strlen(value)) { - ecs_strbuf_appendstrn(str, "\"", 1); - ecs_strbuf_appendstr(str, value); - ecs_strbuf_appendstrn(str, "\"", 1); - } else { - char *out = ecs_os_malloc(length + 3); - ecs_stresc(out + 1, length, '"', value); - out[0] = '"'; - out[length + 1] = '"'; - out[length + 2] = '\0'; - ecs_strbuf_appendstr_zerocpy(str, out); - } - } else { - ecs_strbuf_appendstr(str, "null"); - } - break; - } - case EcsEntity: { - ecs_entity_t e = *(ecs_entity_t*)base; - if (!e) { - ecs_strbuf_appendstr(str, "0"); - } else { - char *path = ecs_get_fullpath(world, e); - ecs_assert(path != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_strbuf_appendstr(str, path); - ecs_os_free(path); - } - break; - } - default: - ecs_err("invalid primitive kind"); - return -1; - } - - return 0; -} - -/* Serialize enumeration */ -static -int expr_ser_enum( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str) -{ - const EcsEnum *enum_type = ecs_get(world, op->type, EcsEnum); - ecs_check(enum_type != NULL, ECS_INVALID_PARAMETER, NULL); - - int32_t value = *(int32_t*)base; - - /* Enumeration constants are stored in a map that is keyed on the - * enumeration value. */ - ecs_enum_constant_t *constant = ecs_map_get( - enum_type->constants, ecs_enum_constant_t, value); - if (!constant) { - char *path = ecs_get_fullpath(world, op->type); - ecs_err("value %d is not valid for enum type '%s'", value, path); - ecs_os_free(path); - goto error; - } - - ecs_strbuf_appendstr(str, ecs_get_name(world, constant->constant)); - - return 0; -error: - return -1; -} - -/* Serialize bitmask */ -static -int expr_ser_bitmask( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) -{ - const EcsBitmask *bitmask_type = ecs_get(world, op->type, EcsBitmask); - ecs_check(bitmask_type != NULL, ECS_INVALID_PARAMETER, NULL); - - uint32_t value = *(uint32_t*)ptr; - ecs_map_key_t key; - ecs_bitmask_constant_t *constant; - int count = 0; - - ecs_strbuf_list_push(str, "", "|"); - - /* Multiple flags can be set at a given time. Iterate through all the flags - * and append the ones that are set. */ - ecs_map_iter_t it = ecs_map_iter(bitmask_type->constants); - while ((constant = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { - if ((value & key) == key) { - ecs_strbuf_list_appendstr(str, - ecs_get_name(world, constant->constant)); - count ++; - value -= (uint32_t)key; - } - } - - if (value != 0) { - /* All bits must have been matched by a constant */ - char *path = ecs_get_fullpath(world, op->type); - ecs_err( - "value for bitmask %s contains bits (%u) that cannot be mapped to constant", - path, value); - ecs_os_free(path); - goto error; - } - - if (!count) { - ecs_strbuf_list_appendstr(str, "0"); - } - - ecs_strbuf_list_pop(str, ""); - - return 0; -error: - return -1; -} - -/* Serialize elements of a contiguous array */ -static -int expr_ser_elements( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - int32_t elem_count, - int32_t elem_size, - ecs_strbuf_t *str) -{ - ecs_strbuf_list_push(str, "[", ", "); - - const void *ptr = base; - - int i; - for (i = 0; i < elem_count; i ++) { - ecs_strbuf_list_next(str); - if (expr_ser_type_ops(world, ops, op_count, ptr, str)) { - return -1; - } - ptr = ECS_OFFSET(ptr, elem_size); - } - - ecs_strbuf_list_pop(str, "]"); - - return 0; -} - -static -int expr_ser_type_elements( - const ecs_world_t *world, - ecs_entity_t type, - const void *base, - int32_t elem_count, - ecs_strbuf_t *str) -{ - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - ecs_assert(ser != NULL, ECS_INTERNAL_ERROR, NULL); - - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); - int32_t op_count = ecs_vector_count(ser->ops); - - return expr_ser_elements( - world, ops, op_count, base, elem_count, comp->size, str); -} - -/* Serialize array */ -static -int expr_ser_array( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) -{ - const EcsArray *a = ecs_get(world, op->type, EcsArray); - ecs_assert(a != NULL, ECS_INTERNAL_ERROR, NULL); - - return expr_ser_type_elements( - world, a->type, ptr, a->count, str); -} - -/* Serialize vector */ -static -int expr_ser_vector( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str) -{ - ecs_vector_t *value = *(ecs_vector_t**)base; - if (!value) { - ecs_strbuf_appendstr(str, "null"); - return 0; - } - - const EcsVector *v = ecs_get(world, op->type, EcsVector); - ecs_assert(v != NULL, ECS_INTERNAL_ERROR, NULL); - - const EcsComponent *comp = ecs_get(world, v->type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t count = ecs_vector_count(value); - void *array = ecs_vector_first_t(value, comp->size, comp->alignment); - - /* Serialize contiguous buffer of vector */ - return expr_ser_type_elements(world, v->type, array, count, str); -} - -/* Forward serialization to the different type kinds */ -static -int expr_ser_type_op( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) -{ - switch(op->kind) { - case EcsOpPush: - case EcsOpPop: - /* Should not be parsed as single op */ - ecs_throw(ECS_INVALID_PARAMETER, NULL); - break; - case EcsOpEnum: - if (expr_ser_enum(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpBitmask: - if (expr_ser_bitmask(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpArray: - if (expr_ser_array(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpVector: - if (expr_ser_vector(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - default: - if (expr_ser_primitive(world, expr_op_to_primitive_kind(op->kind), - ECS_OFFSET(ptr, op->offset), str)) - { - /* Unknown operation */ - ecs_err("unknown serializer operation kind (%d)", op->kind); - goto error; - } - break; - } - - return 0; -error: - return -1; -} - -/* Iterate over a slice of the type ops array */ -static -int expr_ser_type_ops( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - ecs_strbuf_t *str) -{ - for (int i = 0; i < op_count; i ++) { - ecs_meta_type_op_t *op = &ops[i]; - - if (op != ops) { - if (op->name) { - ecs_strbuf_list_next(str); - ecs_strbuf_append(str, "%s: ", op->name); - } - - int32_t elem_count = op->count; - if (elem_count > 1 && op != ops) { - /* Serialize inline array */ - if (expr_ser_elements(world, op, op->op_count, base, - elem_count, op->size, str)) - { - return -1; - } - - i += op->op_count - 1; - continue; - } - } - - switch(op->kind) { - case EcsOpPush: - ecs_strbuf_list_push(str, "{", ", "); - break; - case EcsOpPop: - ecs_strbuf_list_pop(str, "}"); - break; - default: - if (expr_ser_type_op(world, op, base, str)) { - goto error; - } - break; - } - } - - return 0; -error: - return -1; -} - -/* Iterate over the type ops of a type */ -static -int expr_ser_type( - const ecs_world_t *world, - ecs_vector_t *v_ops, - const void *base, - ecs_strbuf_t *str) -{ - ecs_meta_type_op_t *ops = ecs_vector_first(v_ops, ecs_meta_type_op_t); - int32_t count = ecs_vector_count(v_ops); - return expr_ser_type_ops(world, ops, count, base, str); -} - -int ecs_ptr_to_expr_buf( - const ecs_world_t *world, - ecs_entity_t type, - const void *ptr, - ecs_strbuf_t *buf_out) -{ - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - if (ser == NULL) { - char *path = ecs_get_fullpath(world, type); - ecs_err("cannot serialize value for type '%s'", path); - ecs_os_free(path); - goto error; - } - - if (expr_ser_type(world, ser->ops, ptr, buf_out)) { - goto error; - } - - return 0; -error: - return -1; -} - -char* ecs_ptr_to_expr( - const ecs_world_t *world, - ecs_entity_t type, - const void* ptr) -{ - ecs_strbuf_t str = ECS_STRBUF_INIT; - - if (ecs_ptr_to_expr_buf(world, type, ptr, &str) != 0) { - ecs_strbuf_reset(&str); - return NULL; - } - - return ecs_strbuf_get(&str); -} - -int ecs_primitive_to_expr_buf( - const ecs_world_t *world, - ecs_primitive_kind_t kind, - const void *base, - ecs_strbuf_t *str) -{ - return expr_ser_primitive(world, kind, base, str); -} - -#endif - - - -#ifdef FLECS_EXPR - -char* ecs_chresc( - char *out, - char in, - char delimiter) -{ - char *bptr = out; - switch(in) { - case '\a': - *bptr++ = '\\'; - *bptr = 'a'; - break; - case '\b': - *bptr++ = '\\'; - *bptr = 'b'; - break; - case '\f': - *bptr++ = '\\'; - *bptr = 'f'; - break; - case '\n': - *bptr++ = '\\'; - *bptr = 'n'; - break; - case '\r': - *bptr++ = '\\'; - *bptr = 'r'; - break; - case '\t': - *bptr++ = '\\'; - *bptr = 't'; - break; - case '\v': - *bptr++ = '\\'; - *bptr = 'v'; - break; - case '\\': - *bptr++ = '\\'; - *bptr = '\\'; - break; - default: - if (in == delimiter) { - *bptr++ = '\\'; - *bptr = delimiter; - } else { - *bptr = in; - } - break; - } - - *(++bptr) = '\0'; - - return bptr; -} - -const char* ecs_chrparse( - const char *in, - char *out) -{ - const char *result = in + 1; - char ch; - - if (in[0] == '\\') { - result ++; - - switch(in[1]) { - case 'a': - ch = '\a'; - break; - case 'b': - ch = '\b'; - break; - case 'f': - ch = '\f'; - break; - case 'n': - ch = '\n'; - break; - case 'r': - ch = '\r'; - break; - case 't': - ch = '\t'; - break; - case 'v': - ch = '\v'; - break; - case '\\': - ch = '\\'; - break; - case '"': - ch = '"'; - break; - case '0': - ch = '\0'; - break; - case ' ': - ch = ' '; - break; - case '$': - ch = '$'; - break; - default: - goto error; - } - } else { - ch = in[0]; - } - - if (out) { - *out = ch; - } - - return result; -error: - return NULL; -} - -ecs_size_t ecs_stresc( - char *out, - ecs_size_t n, - char delimiter, - const char *in) -{ - const char *ptr = in; - char ch, *bptr = out, buff[3]; - ecs_size_t written = 0; - while ((ch = *ptr++)) { - if ((written += (ecs_size_t)(ecs_chresc( - buff, ch, delimiter) - buff)) <= n) - { - /* If size != 0, an out buffer must be provided. */ - ecs_check(out != NULL, ECS_INVALID_PARAMETER, NULL); - *bptr++ = buff[0]; - if ((ch = buff[1])) { - *bptr = ch; - bptr++; - } - } - } - - if (bptr) { - while (written < n) { - *bptr = '\0'; - bptr++; - written++; - } - } - return written; -error: - return 0; -} - -char* ecs_astresc( - char delimiter, - const char *in) -{ - if (!in) { - return NULL; - } - - ecs_size_t len = ecs_stresc(NULL, 0, delimiter, in); - char *out = ecs_os_malloc_n(char, len + 1); - ecs_stresc(out, len, delimiter, in); - out[len] = '\0'; - return out; -} - -#endif - - - -#ifdef FLECS_EXPR - -const char *ecs_parse_expr_token( - const char *name, - const char *expr, - const char *ptr, - char *token) -{ - const char *start = ptr; - char *token_ptr = token; - - while ((ptr = ecs_parse_token(name, expr, ptr, token_ptr))) { - if (ptr[0] == '|') { - token_ptr = &token_ptr[ptr - start]; - token_ptr[0] = '|'; - token_ptr[1] = '\0'; - token_ptr ++; - ptr ++; - start = ptr; - } else { - break; - } - } - - return ptr; -} - -const char* ecs_parse_expr( - const ecs_world_t *world, - const char *ptr, - ecs_entity_t type, - void *data_out, - const ecs_parse_expr_desc_t *desc) -{ - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - char token[ECS_MAX_TOKEN_SIZE]; - int depth = 0; - - const char *name = NULL; - const char *expr = NULL; - - ptr = ecs_parse_fluff(ptr, NULL); - - ecs_meta_cursor_t cur = ecs_meta_cursor(world, type, data_out); - if (cur.valid == false) { - return NULL; - } - - if (desc) { - name = desc->name; - expr = desc->expr; - cur.lookup_action = desc->lookup_action; - cur.lookup_ctx = desc->lookup_ctx; - } - - while ((ptr = ecs_parse_expr_token(name, expr, ptr, token))) { - - if (!ecs_os_strcmp(token, "{")) { - ecs_entity_t scope_type = ecs_meta_get_type(&cur); - depth ++; - if (ecs_meta_push(&cur) != 0) { - goto error; - } - - if (ecs_meta_is_collection(&cur)) { - char *path = ecs_get_fullpath(world, scope_type); - ecs_parser_error(name, expr, ptr - expr, - "expected '[' for collection type '%s'", path); - ecs_os_free(path); - return NULL; - } - } - - else if (!ecs_os_strcmp(token, "}")) { - depth --; - - if (ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected ']'"); - return NULL; - } - - if (ecs_meta_pop(&cur) != 0) { - goto error; - } - } - - else if (!ecs_os_strcmp(token, "[")) { - depth ++; - if (ecs_meta_push(&cur) != 0) { - goto error; - } - - if (!ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected '{'"); - return NULL; - } - } - - else if (!ecs_os_strcmp(token, "]")) { - depth --; - - if (!ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected '}'"); - return NULL; - } - - if (ecs_meta_pop(&cur) != 0) { - goto error; - } - } - - else if (!ecs_os_strcmp(token, ",")) { - if (ecs_meta_next(&cur) != 0) { - goto error; - } - } - - else if (!ecs_os_strcmp(token, "null")) { - if (ecs_meta_set_null(&cur) != 0) { - goto error; - } - } - - else if (token[0] == '\"') { - if (ecs_meta_set_string_literal(&cur, token) != 0) { - goto error; - } - } - - else { - ptr = ecs_parse_fluff(ptr, NULL); - - if (ptr[0] == ':') { - /* Member assignment */ - ptr ++; - if (ecs_meta_member(&cur, token) != 0) { - goto error; - } - } else { - if (ecs_meta_set_string(&cur, token) != 0) { - goto error; - } - } - } - - if (!depth) { - break; - } - - ptr = ecs_parse_fluff(ptr, NULL); - } - - return ptr; -error: - return NULL; -} - -#endif - -#include - -/* Utilities for C++ API */ - -#ifdef FLECS_CPP - -/* Convert compiler-specific typenames extracted from __PRETTY_FUNCTION__ to - * a uniform identifier */ - -#define ECS_CONST_PREFIX "const " -#define ECS_STRUCT_PREFIX "struct " -#define ECS_CLASS_PREFIX "class " -#define ECS_ENUM_PREFIX "enum " - -#define ECS_CONST_LEN (-1 + (ecs_size_t)sizeof(ECS_CONST_PREFIX)) -#define ECS_STRUCT_LEN (-1 + (ecs_size_t)sizeof(ECS_STRUCT_PREFIX)) -#define ECS_CLASS_LEN (-1 + (ecs_size_t)sizeof(ECS_CLASS_PREFIX)) -#define ECS_ENUM_LEN (-1 + (ecs_size_t)sizeof(ECS_ENUM_PREFIX)) - -static -ecs_size_t ecs_cpp_strip_prefix( - char *typeName, - ecs_size_t len, - const char *prefix, - ecs_size_t prefix_len) -{ - if ((len > prefix_len) && !ecs_os_strncmp(typeName, prefix, prefix_len)) { - ecs_os_memmove(typeName, typeName + prefix_len, len - prefix_len); - typeName[len - prefix_len] = '\0'; - len -= prefix_len; - } - return len; -} - -static -void ecs_cpp_trim_type_name( - char *typeName) -{ - ecs_size_t len = ecs_os_strlen(typeName); - - len = ecs_cpp_strip_prefix(typeName, len, ECS_CONST_PREFIX, ECS_CONST_LEN); - len = ecs_cpp_strip_prefix(typeName, len, ECS_STRUCT_PREFIX, ECS_STRUCT_LEN); - len = ecs_cpp_strip_prefix(typeName, len, ECS_CLASS_PREFIX, ECS_CLASS_LEN); - len = ecs_cpp_strip_prefix(typeName, len, ECS_ENUM_PREFIX, ECS_ENUM_LEN); - - while (typeName[len - 1] == ' ' || - typeName[len - 1] == '&' || - typeName[len - 1] == '*') - { - len --; - typeName[len] = '\0'; - } - - /* Remove const at end of string */ - if (len > ECS_CONST_LEN) { - if (!ecs_os_strncmp(&typeName[len - ECS_CONST_LEN], " const", ECS_CONST_LEN)) { - typeName[len - ECS_CONST_LEN] = '\0'; - } - len -= ECS_CONST_LEN; - } - - /* Check if there are any remaining "struct " strings, which can happen - * if this is a template type on msvc. */ - if (len > ECS_STRUCT_LEN) { - char *ptr = typeName; - while ((ptr = strstr(ptr + 1, ECS_STRUCT_PREFIX)) != 0) { - /* Make sure we're not matched with part of a longer identifier - * that contains 'struct' */ - if (ptr[-1] == '<' || ptr[-1] == ',' || isspace(ptr[-1])) { - ecs_os_memmove(ptr, ptr + ECS_STRUCT_LEN, - ecs_os_strlen(ptr + ECS_STRUCT_LEN) + 1); - len -= ECS_STRUCT_LEN; - } - } - } -} - -char* ecs_cpp_get_type_name( - char *type_name, - const char *func_name, - size_t len) -{ - memcpy(type_name, func_name + ECS_FUNC_NAME_FRONT(const char*, type_name), len); - type_name[len] = '\0'; - ecs_cpp_trim_type_name(type_name); - return type_name; -} - -char* ecs_cpp_get_symbol_name( - char *symbol_name, - const char *type_name, - size_t len) -{ - // Symbol is same as name, but with '::' replaced with '.' - ecs_os_strcpy(symbol_name, type_name); - - char *ptr; - size_t i; - for (i = 0, ptr = symbol_name; i < len && *ptr; i ++, ptr ++) { - if (*ptr == ':') { - symbol_name[i] = '.'; - ptr ++; - } else { - symbol_name[i] = *ptr; - } - } - - symbol_name[i] = '\0'; - - return symbol_name; -} - -static -const char* cpp_func_rchr( - const char *func_name, - ecs_size_t func_name_len, - char ch) -{ - const char *r = strrchr(func_name, ch); - if ((r - func_name) >= (func_name_len - flecs_uto(ecs_size_t, ECS_FUNC_NAME_BACK))) { - return NULL; - } - return r; -} - -static -const char* cpp_func_max( - const char *a, - const char *b) -{ - if (a > b) return a; - return b; -} - -char* ecs_cpp_get_constant_name( - char *constant_name, - const char *func_name, - size_t func_name_len) -{ - ecs_size_t f_len = flecs_uto(ecs_size_t, func_name_len); - const char *start = cpp_func_rchr(func_name, f_len, ' '); - start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ')')); - start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ':')); - start = cpp_func_max(start, cpp_func_rchr(func_name, f_len, ',')); - ecs_assert(start != NULL, ECS_INVALID_PARAMETER, func_name); - start ++; - - ecs_size_t len = flecs_uto(ecs_size_t, - (f_len - (start - func_name) - flecs_uto(ecs_size_t, ECS_FUNC_NAME_BACK))); - ecs_os_memcpy_n(constant_name, start, char, len); - constant_name[len] = '\0'; - return constant_name; -} - -// Names returned from the name_helper class do not start with :: -// but are relative to the root. If the namespace of the type -// overlaps with the namespace of the current module, strip it from -// the implicit identifier. -// This allows for registration of component types that are not in the -// module namespace to still be registered under the module scope. -const char* ecs_cpp_trim_module( - ecs_world_t *world, - const char *type_name) -{ - ecs_entity_t scope = ecs_get_scope(world); - if (!scope) { - return type_name; - } - - char *path = ecs_get_path_w_sep(world, 0, scope, "::", NULL); - if (path) { - const char *ptr = strrchr(type_name, ':'); - ecs_assert(ptr != type_name, ECS_INTERNAL_ERROR, NULL); - if (ptr) { - ptr --; - ecs_assert(ptr[0] == ':', ECS_INTERNAL_ERROR, NULL); - ecs_size_t name_path_len = (ecs_size_t)(ptr - type_name); - if (name_path_len <= ecs_os_strlen(path)) { - if (!ecs_os_strncmp(type_name, path, name_path_len)) { - type_name = &type_name[name_path_len + 2]; - } - } - } - } - ecs_os_free(path); - - return type_name; -} - -// Validate registered component -void ecs_cpp_component_validate( - ecs_world_t *world, - ecs_entity_t id, - const char *name, - size_t size, - size_t alignment, - bool implicit_name) -{ - /* If entity has a name check if it matches */ - if (ecs_is_valid(world, id) && ecs_get_name(world, id) != NULL) { - if (!implicit_name && id >= EcsFirstUserComponentId) { -# ifndef FLECS_NDEBUG - char *path = ecs_get_path_w_sep( - world, 0, id, "::", NULL); - if (ecs_os_strcmp(path, name)) { - ecs_err( - "component '%s' already registered with name '%s'", - name, path); - ecs_abort(ECS_INCONSISTENT_NAME, NULL); - } - ecs_os_free(path); -# endif - } - } else { - /* Ensure that the entity id valid */ - if (!ecs_is_alive(world, id)) { - ecs_ensure(world, id); - } - - /* Register name with entity, so that when the entity is created the - * correct id will be resolved from the name. Only do this when the - * entity is empty. */ - ecs_add_path_w_sep(world, id, 0, name, "::", "::"); - } - - /* If a component was already registered with this id but with a - * different size, the ecs_component_init function will fail. */ - - /* We need to explicitly call ecs_component_init here again. Even though - * the component was already registered, it may have been registered - * with a different world. This ensures that the component is registered - * with the same id for the current world. - * If the component was registered already, nothing will change. */ - ecs_entity_t ent = ecs_component_init(world, &(ecs_component_desc_t) { - .entity.entity = id, - .size = size, - .alignment = alignment - }); - (void)ent; - ecs_assert(ent == id, ECS_INTERNAL_ERROR, NULL); -} - -ecs_entity_t ecs_cpp_component_register( - ecs_world_t *world, - ecs_entity_t id, - const char *name, - const char *symbol, - ecs_size_t size, - ecs_size_t alignment) -{ - (void)size; - (void)alignment; - - /* If the component is not yet registered, ensure no other component - * or entity has been registered with this name. Ensure component is - * looked up from root. */ - ecs_entity_t prev_scope = ecs_set_scope(world, 0); - ecs_entity_t ent; - if (id) { - ent = id; - } else { - ent = ecs_lookup_path_w_sep(world, 0, name, "::", "::", false); - } - ecs_set_scope(world, prev_scope); - - /* If entity exists, compare symbol name to ensure that the component - * we are trying to register under this name is the same */ - if (ent) { - if (!id && ecs_has(world, ent, EcsComponent)) { - const char *sym = ecs_get_symbol(world, ent); - ecs_assert(sym != NULL, ECS_MISSING_SYMBOL, - ecs_get_name(world, ent)); - (void)sym; - -# ifndef FLECS_NDEBUG - if (ecs_os_strcmp(sym, symbol)) { - ecs_err( - "component with name '%s' is already registered for"\ - " type '%s' (trying to register for type '%s')", - name, sym, symbol); - ecs_abort(ECS_NAME_IN_USE, NULL); - } -# endif - - /* If an existing id was provided, it's possible that this id was - * registered with another type. Make sure that in this case at - * least the component size/alignment matches. - * This allows applications to alias two different types to the same - * id, which enables things like redefining a C type in C++ by - * inheriting from it & adding utility functions etc. */ - } else { - const EcsComponent *comp = ecs_get(world, ent, EcsComponent); - if (comp) { - ecs_assert(comp->size == size, - ECS_INVALID_COMPONENT_SIZE, NULL); - ecs_assert(comp->alignment == alignment, - ECS_INVALID_COMPONENT_ALIGNMENT, NULL); - } else { - /* If the existing id is not a component, no checking is - * needed. */ - } - } - - /* If no entity is found, lookup symbol to check if the component was - * registered under a different name. */ - } else { - ent = ecs_lookup_symbol(world, symbol, false); - ecs_assert(ent == 0, ECS_INCONSISTENT_COMPONENT_ID, symbol); - } - - return id; -} - -ecs_entity_t ecs_cpp_component_register_explicit( - ecs_world_t *world, - ecs_entity_t s_id, - ecs_entity_t id, - const char *name, - const char *type_name, - const char *symbol, - size_t size, - size_t alignment, - bool is_component) -{ - // If an explicit id is provided, it is possible that the symbol and - // name differ from the actual type, as the application may alias - // one type to another. - if (!id) { - if (!name) { - // If no name was provided, retrieve the name implicitly from - // the name_helper class. - name = ecs_cpp_trim_module(world, type_name); - } - } else { - // If an explicit id is provided but it has no name, inherit - // the name from the type. - if (!ecs_is_valid(world, id) || !ecs_get_name(world, id)) { - name = ecs_cpp_trim_module(world, type_name); - } - } - - ecs_entity_t entity; - if (is_component || size != 0) { - entity = ecs_component_init(world, &(ecs_component_desc_t){ - .entity.entity = s_id, - .entity.name = name, - .entity.sep = "::", - .entity.root_sep = "::", - .entity.symbol = symbol, - .size = size, - .alignment = alignment - }); - } else { - entity = ecs_entity_init(world, &(ecs_entity_desc_t){ - .entity = s_id, - .name = name, - .sep = "::", - .root_sep = "::", - .symbol = symbol - }); - } - - ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(!s_id || s_id == entity, ECS_INTERNAL_ERROR, NULL); - - return entity; -} - -ecs_entity_t ecs_cpp_enum_constant_register( - ecs_world_t *world, - ecs_entity_t parent, - ecs_entity_t id, - const char *name, - int value) -{ - ecs_suspend_readonly_state_t readonly_state; - world = flecs_suspend_readonly(world, &readonly_state); - - const char *parent_name = ecs_get_name(world, parent); - ecs_size_t parent_name_len = ecs_os_strlen(parent_name); - if (!ecs_os_strncmp(name, parent_name, parent_name_len)) { - name += parent_name_len; - if (name[0] == '_') { - name ++; - } - } - - ecs_entity_t prev = ecs_set_scope(world, parent); - id = ecs_entity_init(world, &(ecs_entity_desc_t) { - .entity = id, - .name = name - }); - ecs_assert(id != 0, ECS_INVALID_OPERATION, name); - ecs_set_scope(world, prev); +ECS_DECLARE(EcsUnitPrefixes); - ecs_set_id(world, id, parent, sizeof(int), &value); +ECS_DECLARE(EcsYocto); +ECS_DECLARE(EcsZepto); +ECS_DECLARE(EcsAtto); +ECS_DECLARE(EcsFemto); +ECS_DECLARE(EcsPico); +ECS_DECLARE(EcsNano); +ECS_DECLARE(EcsMicro); +ECS_DECLARE(EcsMilli); +ECS_DECLARE(EcsCenti); +ECS_DECLARE(EcsDeci); +ECS_DECLARE(EcsDeca); +ECS_DECLARE(EcsHecto); +ECS_DECLARE(EcsKilo); +ECS_DECLARE(EcsMega); +ECS_DECLARE(EcsGiga); +ECS_DECLARE(EcsTera); +ECS_DECLARE(EcsPeta); +ECS_DECLARE(EcsExa); +ECS_DECLARE(EcsZetta); +ECS_DECLARE(EcsYotta); - flecs_resume_readonly(world, &readonly_state); +ECS_DECLARE(EcsKibi); +ECS_DECLARE(EcsMebi); +ECS_DECLARE(EcsGibi); +ECS_DECLARE(EcsTebi); +ECS_DECLARE(EcsPebi); +ECS_DECLARE(EcsExbi); +ECS_DECLARE(EcsZebi); +ECS_DECLARE(EcsYobi); - ecs_trace("#[green]constant#[reset] %s.%s created with value %d", - ecs_get_name(world, parent), name, value); +ECS_DECLARE(EcsDuration); + ECS_DECLARE(EcsPicoSeconds); + ECS_DECLARE(EcsNanoSeconds); + ECS_DECLARE(EcsMicroSeconds); + ECS_DECLARE(EcsMilliSeconds); + ECS_DECLARE(EcsSeconds); + ECS_DECLARE(EcsMinutes); + ECS_DECLARE(EcsHours); + ECS_DECLARE(EcsDays); - return id; -} +ECS_DECLARE(EcsTime); + ECS_DECLARE(EcsDate); -static int32_t flecs_reset_count = 0; +ECS_DECLARE(EcsMass); + ECS_DECLARE(EcsGrams); + ECS_DECLARE(EcsKiloGrams); -int32_t ecs_cpp_reset_count_get(void) { - return flecs_reset_count; -} +ECS_DECLARE(EcsElectricCurrent); + ECS_DECLARE(EcsAmpere); -int32_t ecs_cpp_reset_count_inc(void) { - return ++flecs_reset_count; -} +ECS_DECLARE(EcsAmount); + ECS_DECLARE(EcsMole); -#endif +ECS_DECLARE(EcsLuminousIntensity); + ECS_DECLARE(EcsCandela); +ECS_DECLARE(EcsForce); + ECS_DECLARE(EcsNewton); -#ifdef FLECS_REST +ECS_DECLARE(EcsLength); + ECS_DECLARE(EcsMeters); + ECS_DECLARE(EcsPicoMeters); + ECS_DECLARE(EcsNanoMeters); + ECS_DECLARE(EcsMicroMeters); + ECS_DECLARE(EcsMilliMeters); + ECS_DECLARE(EcsCentiMeters); + ECS_DECLARE(EcsKiloMeters); + ECS_DECLARE(EcsMiles); -typedef struct { - ecs_world_t *world; - ecs_entity_t entity; - ecs_http_server_t *srv; - int32_t rc; -} ecs_rest_ctx_t; +ECS_DECLARE(EcsPressure); + ECS_DECLARE(EcsPascal); + ECS_DECLARE(EcsBar); -static ECS_COPY(EcsRest, dst, src, { - ecs_rest_ctx_t *impl = src->impl; - if (impl) { - impl->rc ++; - } +ECS_DECLARE(EcsSpeed); + ECS_DECLARE(EcsMetersPerSecond); + ECS_DECLARE(EcsKiloMetersPerSecond); + ECS_DECLARE(EcsKiloMetersPerHour); + ECS_DECLARE(EcsMilesPerHour); - ecs_os_strset(&dst->ipaddr, src->ipaddr); - dst->port = src->port; - dst->impl = impl; -}) +ECS_DECLARE(EcsAcceleration); -static ECS_MOVE(EcsRest, dst, src, { - *dst = *src; - src->ipaddr = NULL; - src->impl = NULL; -}) +ECS_DECLARE(EcsTemperature); + ECS_DECLARE(EcsKelvin); + ECS_DECLARE(EcsCelsius); + ECS_DECLARE(EcsFahrenheit); -static ECS_DTOR(EcsRest, ptr, { - ecs_rest_ctx_t *impl = ptr->impl; - if (impl) { - impl->rc --; - if (!impl->rc) { - ecs_http_server_fini(impl->srv); - ecs_os_free(impl); - } - } - ecs_os_free(ptr->ipaddr); -}) +ECS_DECLARE(EcsData); + ECS_DECLARE(EcsBits); + ECS_DECLARE(EcsKiloBits); + ECS_DECLARE(EcsMegaBits); + ECS_DECLARE(EcsGigaBits); + ECS_DECLARE(EcsBytes); + ECS_DECLARE(EcsKiloBytes); + ECS_DECLARE(EcsMegaBytes); + ECS_DECLARE(EcsGigaBytes); + ECS_DECLARE(EcsKibiBytes); + ECS_DECLARE(EcsGibiBytes); + ECS_DECLARE(EcsMebiBytes); -static char *rest_last_err; +ECS_DECLARE(EcsDataRate); + ECS_DECLARE(EcsBitsPerSecond); + ECS_DECLARE(EcsKiloBitsPerSecond); + ECS_DECLARE(EcsMegaBitsPerSecond); + ECS_DECLARE(EcsGigaBitsPerSecond); + ECS_DECLARE(EcsBytesPerSecond); + ECS_DECLARE(EcsKiloBytesPerSecond); + ECS_DECLARE(EcsMegaBytesPerSecond); + ECS_DECLARE(EcsGigaBytesPerSecond); -static -void rest_capture_log( - int32_t level, - const char *file, - int32_t line, - const char *msg) -{ - (void)file; (void)line; +ECS_DECLARE(EcsPercentage); - if (!rest_last_err && level < 0) { - rest_last_err = ecs_os_strdup(msg); - } -} +ECS_DECLARE(EcsAngle); + ECS_DECLARE(EcsRadians); + ECS_DECLARE(EcsDegrees); -static -char* rest_get_captured_log(void) { - char *result = rest_last_err; - rest_last_err = NULL; - return result; -} +ECS_DECLARE(EcsBel); +ECS_DECLARE(EcsDeciBel); -static -void reply_verror( - ecs_http_reply_t *reply, - const char *fmt, - va_list args) +void FlecsUnitsImport( + ecs_world_t *world) { - ecs_strbuf_appendstr(&reply->body, "{\"error\":\""); - ecs_strbuf_vappend(&reply->body, fmt, args); - ecs_strbuf_appendstr(&reply->body, "\"}"); -} + ECS_MODULE(world, FlecsUnits); -static -void reply_error( - ecs_http_reply_t *reply, - const char *fmt, - ...) -{ - va_list args; - va_start(args, fmt); - reply_verror(reply, fmt, args); - va_end(args); -} + ecs_set_name_prefix(world, "Ecs"); -static -void rest_bool_param( - const ecs_http_request_t *req, - const char *name, - bool *value_out) -{ - const char *value = ecs_http_get_param(req, name); - if (value) { - if (!ecs_os_strcmp(value, "true")) { - value_out[0] = true; - } else { - value_out[0] = false; - } - } -} + EcsUnitPrefixes = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = "prefixes", + .add = { EcsModule } + }); -static -void rest_int_param( - const ecs_http_request_t *req, - const char *name, - int32_t *value_out) -{ - const char *value = ecs_http_get_param(req, name); - if (value) { - *value_out = atoi(value); - } -} + /* Initialize unit prefixes */ -static -void rest_parse_json_ser_entity_params( - ecs_entity_to_json_desc_t *desc, - const ecs_http_request_t *req) -{ - rest_bool_param(req, "path", &desc->serialize_path); - rest_bool_param(req, "label", &desc->serialize_label); - rest_bool_param(req, "brief", &desc->serialize_brief); - rest_bool_param(req, "link", &desc->serialize_link); - rest_bool_param(req, "id_labels", &desc->serialize_id_labels); - rest_bool_param(req, "base", &desc->serialize_base); - rest_bool_param(req, "values", &desc->serialize_values); - rest_bool_param(req, "private", &desc->serialize_private); - rest_bool_param(req, "type_info", &desc->serialize_type_info); -} + ecs_entity_t prev_scope = ecs_set_scope(world, EcsUnitPrefixes); -static -void rest_parse_json_ser_iter_params( - ecs_iter_to_json_desc_t *desc, - const ecs_http_request_t *req) -{ - rest_bool_param(req, "term_ids", &desc->serialize_term_ids); - rest_bool_param(req, "ids", &desc->serialize_ids); - rest_bool_param(req, "subjects", &desc->serialize_subjects); - rest_bool_param(req, "variables", &desc->serialize_variables); - rest_bool_param(req, "is_set", &desc->serialize_is_set); - rest_bool_param(req, "values", &desc->serialize_values); - rest_bool_param(req, "entities", &desc->serialize_entities); - rest_bool_param(req, "entity_labels", &desc->serialize_entity_labels); - rest_bool_param(req, "variable_labels", &desc->serialize_variable_labels); - rest_bool_param(req, "duration", &desc->measure_eval_duration); - rest_bool_param(req, "type_info", &desc->serialize_type_info); -} + EcsYocto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Yocto", + .symbol = "y", + .translation = { .factor = 10, .power = -24 } + }); + EcsZepto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Zepto", + .symbol = "z", + .translation = { .factor = 10, .power = -21 } + }); + EcsAtto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Atto", + .symbol = "a", + .translation = { .factor = 10, .power = -18 } + }); + EcsFemto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Femto", + .symbol = "a", + .translation = { .factor = 10, .power = -15 } + }); + EcsPico = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Pico", + .symbol = "p", + .translation = { .factor = 10, .power = -12 } + }); + EcsNano = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Nano", + .symbol = "n", + .translation = { .factor = 10, .power = -9 } + }); + EcsMicro = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Micro", + .symbol = "μ", + .translation = { .factor = 10, .power = -6 } + }); + EcsMilli = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Milli", + .symbol = "m", + .translation = { .factor = 10, .power = -3 } + }); + EcsCenti = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Centi", + .symbol = "c", + .translation = { .factor = 10, .power = -2 } + }); + EcsDeci = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Deci", + .symbol = "d", + .translation = { .factor = 10, .power = -1 } + }); + EcsDeca = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Deca", + .symbol = "da", + .translation = { .factor = 10, .power = 1 } + }); + EcsHecto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Hecto", + .symbol = "h", + .translation = { .factor = 10, .power = 2 } + }); + EcsKilo = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Kilo", + .symbol = "k", + .translation = { .factor = 10, .power = 3 } + }); + EcsMega = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Mega", + .symbol = "M", + .translation = { .factor = 10, .power = 6 } + }); + EcsGiga = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Giga", + .symbol = "G", + .translation = { .factor = 10, .power = 9 } + }); + EcsTera = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Tera", + .symbol = "T", + .translation = { .factor = 10, .power = 12 } + }); + EcsPeta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Peta", + .symbol = "P", + .translation = { .factor = 10, .power = 15 } + }); + EcsExa = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Exa", + .symbol = "E", + .translation = { .factor = 10, .power = 18 } + }); + EcsZetta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Zetta", + .symbol = "Z", + .translation = { .factor = 10, .power = 21 } + }); + EcsYotta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Yotta", + .symbol = "Y", + .translation = { .factor = 10, .power = 24 } + }); -static -bool rest_reply( - const ecs_http_request_t* req, - ecs_http_reply_t *reply, - void *ctx) -{ - ecs_rest_ctx_t *impl = ctx; - ecs_world_t *world = impl->world; + EcsKibi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Kibi", + .symbol = "Ki", + .translation = { .factor = 1024, .power = 1 } + }); + EcsMebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Mebi", + .symbol = "Mi", + .translation = { .factor = 1024, .power = 2 } + }); + EcsGibi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Gibi", + .symbol = "Gi", + .translation = { .factor = 1024, .power = 3 } + }); + EcsTebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Tebi", + .symbol = "Ti", + .translation = { .factor = 1024, .power = 4 } + }); + EcsPebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Pebi", + .symbol = "Pi", + .translation = { .factor = 1024, .power = 5 } + }); + EcsExbi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Exbi", + .symbol = "Ei", + .translation = { .factor = 1024, .power = 6 } + }); + EcsZebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Zebi", + .symbol = "Zi", + .translation = { .factor = 1024, .power = 7 } + }); + EcsYobi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { + .entity.name = "Yobi", + .symbol = "Yi", + .translation = { .factor = 1024, .power = 8 } + }); - if (req->path == NULL) { - ecs_dbg("rest: bad request (missing path)"); - reply_error(reply, "bad request (missing path)"); - reply->code = 400; - return false; - } + ecs_set_scope(world, prev_scope); - ecs_strbuf_appendstr(&reply->headers, "Access-Control-Allow-Origin: *\r\n"); + /* Duration units */ - if (req->method == EcsHttpGet) { - /* Entity endpoint */ - if (!ecs_os_strncmp(req->path, "entity/", 7)) { - char *path = &req->path[7]; - ecs_dbg_2("rest: request entity '%s'", path); + EcsDuration = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Duration" }); + prev_scope = ecs_set_scope(world, EcsDuration); - ecs_entity_t e = ecs_lookup_path_w_sep( - world, 0, path, "/", NULL, false); - if (!e) { - ecs_dbg_2("rest: entity '%s' not found", path); - reply_error(reply, "entity '%s' not found", path); - reply->code = 404; - return true; - } + EcsSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Seconds", + .quantity = EcsDuration, + .symbol = "s" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsSeconds, + .kind = EcsF32 + }); + EcsPicoSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "PicoSeconds", + .quantity = EcsDuration, + .base = EcsSeconds, + .prefix = EcsPico }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsPicoSeconds, + .kind = EcsF32 + }); - ecs_entity_to_json_desc_t desc = ECS_ENTITY_TO_JSON_INIT; - rest_parse_json_ser_entity_params(&desc, req); - ecs_entity_to_json_buf(world, e, &reply->body, &desc); - return true; - - /* Query endpoint */ - } else if (!ecs_os_strcmp(req->path, "query")) { - const char *q = ecs_http_get_param(req, "q"); - if (!q) { - ecs_strbuf_appendstr(&reply->body, "Missing parameter 'q'"); - reply->code = 400; /* bad request */ - return true; - } + EcsNanoSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "NanoSeconds", + .quantity = EcsDuration, + .base = EcsSeconds, + .prefix = EcsNano }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsNanoSeconds, + .kind = EcsF32 + }); - ecs_dbg_2("rest: request query '%s'", q); - bool prev_color = ecs_log_enable_colors(false); - ecs_os_api_log_t prev_log_ = ecs_os_api.log_; - ecs_os_api.log_ = rest_capture_log; + EcsMicroSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MicroSeconds", + .quantity = EcsDuration, + .base = EcsSeconds, + .prefix = EcsMicro }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMicroSeconds, + .kind = EcsF32 + }); - ecs_rule_t *r = ecs_rule_init(world, &(ecs_filter_desc_t) { - .expr = q + EcsMilliSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MilliSeconds", + .quantity = EcsDuration, + .base = EcsSeconds, + .prefix = EcsMilli }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMilliSeconds, + .kind = EcsF32 }); - if (!r) { - char *err = rest_get_captured_log(); - char *escaped_err = ecs_astresc('"', err); - reply_error(reply, escaped_err); - reply->code = 400; /* bad request */ - ecs_os_free(escaped_err); - ecs_os_free(err); - } else { - ecs_iter_to_json_desc_t desc = ECS_ITER_TO_JSON_INIT; - rest_parse_json_ser_iter_params(&desc, req); - int32_t offset = 0; - int32_t limit = 100; + EcsMinutes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Minutes", + .quantity = EcsDuration, + .base = EcsSeconds, + .symbol = "min", + .translation = { .factor = 60, .power = 1 } }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMinutes, + .kind = EcsU32 + }); - rest_int_param(req, "offset", &offset); - rest_int_param(req, "limit", &limit); + EcsHours = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Hours", + .quantity = EcsDuration, + .base = EcsMinutes, + .symbol = "h", + .translation = { .factor = 60, .power = 1 } }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsHours, + .kind = EcsU32 + }); + + EcsDays = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Days", + .quantity = EcsDuration, + .base = EcsHours, + .symbol = "d", + .translation = { .factor = 24, .power = 1 } }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsDays, + .kind = EcsU32 + }); + ecs_set_scope(world, prev_scope); - ecs_iter_t it = ecs_rule_iter(world, r); - ecs_iter_t pit = ecs_page_iter(&it, offset, limit); - ecs_iter_to_json_buf(world, &pit, &reply->body, &desc); - ecs_rule_fini(r); - } + /* Time units */ - ecs_os_api.log_ = prev_log_; - ecs_log_enable_colors(prev_color); + EcsTime = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Time" }); + prev_scope = ecs_set_scope(world, EcsTime); - return true; - } - } - if (req->method == EcsHttpOptions) { - return true; - } + EcsDate = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Date", + .quantity = EcsTime }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsDate, + .kind = EcsU32 + }); + ecs_set_scope(world, prev_scope); - return false; -} + /* Mass units */ -static -void on_set_rest(ecs_iter_t *it) -{ - EcsRest *rest = it->ptrs[0]; + EcsMass = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Mass" }); + prev_scope = ecs_set_scope(world, EcsMass); + EcsGrams = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Grams", + .quantity = EcsMass, + .symbol = "g" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGrams, + .kind = EcsF32 + }); + EcsKiloGrams = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloGrams", + .quantity = EcsMass, + .prefix = EcsKilo, + .base = EcsGrams }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloGrams, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); - int i; - for(i = 0; i < it->count; i ++) { - if (!rest[i].port) { - rest[i].port = ECS_REST_DEFAULT_PORT; - } + /* Electric current units */ - ecs_rest_ctx_t *srv_ctx = ecs_os_malloc_t(ecs_rest_ctx_t); - ecs_http_server_t *srv = ecs_http_server_init(&(ecs_http_server_desc_t){ - .ipaddr = rest[i].ipaddr, - .port = rest[i].port, - .callback = rest_reply, - .ctx = srv_ctx + EcsElectricCurrent = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "ElectricCurrent" }); + prev_scope = ecs_set_scope(world, EcsElectricCurrent); + EcsAmpere = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Ampere", + .quantity = EcsElectricCurrent, + .symbol = "A" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsAmpere, + .kind = EcsF32 }); + ecs_set_scope(world, prev_scope); - if (!srv) { - const char *ipaddr = rest[i].ipaddr ? rest[i].ipaddr : "0.0.0.0"; - ecs_err("failed to create REST server on %s:%u", - ipaddr, rest[i].port); - ecs_os_free(srv_ctx); - continue; - } + /* Amount of substance units */ - srv_ctx->world = it->world; - srv_ctx->entity = it->entities[i]; - srv_ctx->srv = srv; - srv_ctx->rc = 1; + EcsAmount = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Amount" }); + prev_scope = ecs_set_scope(world, EcsAmount); + EcsMole = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Mole", + .quantity = EcsAmount, + .symbol = "mol" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMole, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); - rest[i].impl = srv_ctx; + /* Luminous intensity units */ - ecs_http_server_start(srv_ctx->srv); - } -} + EcsLuminousIntensity = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "LuminousIntensity" }); + prev_scope = ecs_set_scope(world, EcsLuminousIntensity); + EcsCandela = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Candela", + .quantity = EcsLuminousIntensity, + .symbol = "cd" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsCandela, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); -static -void DequeueRest(ecs_iter_t *it) { - EcsRest *rest = ecs_term(it, EcsRest, 1); + /* Force units */ - if (it->delta_system_time > (FLECS_FLOAT)1.0) { - ecs_warn( - "detected large progress interval (%.2fs), REST request may timeout", - (double)it->delta_system_time); - } + EcsForce = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Force" }); + prev_scope = ecs_set_scope(world, EcsForce); + EcsNewton = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Newton", + .quantity = EcsForce, + .symbol = "N" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsNewton, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); - int32_t i; - for(i = 0; i < it->count; i ++) { - ecs_rest_ctx_t *ctx = rest[i].impl; - if (ctx) { - ecs_http_server_dequeue(ctx->srv, it->delta_time); - } - } -} + /* Length units */ -void FlecsRestImport( - ecs_world_t *world) -{ - ECS_MODULE(world, FlecsRest); + EcsLength = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Length" }); + prev_scope = ecs_set_scope(world, EcsLength); + EcsMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Meters", + .quantity = EcsLength, + .symbol = "m" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMeters, + .kind = EcsF32 + }); - ecs_set_name_prefix(world, "Ecs"); + EcsPicoMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "PicoMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsPico }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsPicoMeters, + .kind = EcsF32 + }); - flecs_bootstrap_component(world, EcsRest); + EcsNanoMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "NanoMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsNano }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsNanoMeters, + .kind = EcsF32 + }); - ecs_set_component_actions(world, EcsRest, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsRest), - .copy = ecs_copy(EcsRest), - .dtor = ecs_dtor(EcsRest), - .on_set = on_set_rest - }); + EcsMicroMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MicroMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsMicro }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMicroMeters, + .kind = EcsF32 + }); - ECS_SYSTEM(world, DequeueRest, EcsPostFrame, EcsRest); -} + EcsMilliMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MilliMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsMilli }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMilliMeters, + .kind = EcsF32 + }); -#endif + EcsCentiMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "CentiMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsCenti }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsCentiMeters, + .kind = EcsF32 + }); -#ifndef FLECS_META_PRIVATE_H -#define FLECS_META_PRIVATE_H + EcsKiloMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloMeters", + .quantity = EcsLength, + .base = EcsMeters, + .prefix = EcsKilo }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloMeters, + .kind = EcsF32 + }); + + EcsMiles = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Miles", + .quantity = EcsLength, + .symbol = "mi" + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMiles, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); + /* Pressure units */ -#ifdef FLECS_META + EcsPressure = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Pressure" }); + prev_scope = ecs_set_scope(world, EcsPressure); + EcsPascal = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Pascal", + .quantity = EcsPressure, + .symbol = "Pa" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsPascal, + .kind = EcsF32 + }); + EcsBar = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Bar", + .quantity = EcsPressure, + .symbol = "bar" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBar, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); -void ecs_meta_type_serialized_init( - ecs_iter_t *it); + /* Speed units */ -void ecs_meta_dtor_serialized( - EcsMetaTypeSerialized *ptr); + EcsSpeed = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Speed" }); + prev_scope = ecs_set_scope(world, EcsSpeed); + EcsMetersPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MetersPerSecond", + .quantity = EcsSpeed, + .base = EcsMeters, + .over = EcsSeconds }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMetersPerSecond, + .kind = EcsF32 + }); + EcsKiloMetersPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloMetersPerSecond", + .quantity = EcsSpeed, + .base = EcsKiloMeters, + .over = EcsSeconds }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloMetersPerSecond, + .kind = EcsF32 + }); + EcsKiloMetersPerHour = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloMetersPerHour", + .quantity = EcsSpeed, + .base = EcsKiloMeters, + .over = EcsHours }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloMetersPerHour, + .kind = EcsF32 + }); + EcsMilesPerHour = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MilesPerHour", + .quantity = EcsSpeed, + .base = EcsMiles, + .over = EcsHours }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMilesPerHour, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); + + /* Acceleration */ + EcsAcceleration = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Acceleration", + .base = EcsMetersPerSecond, + .over = EcsSeconds }); + ecs_quantity_init(world, &(ecs_entity_desc_t) { + .entity = EcsAcceleration + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsAcceleration, + .kind = EcsF32 + }); -bool flecs_unit_validate( - ecs_world_t *world, - ecs_entity_t t, - EcsUnit *data); + /* Temperature units */ -#endif - -#endif + EcsTemperature = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Temperature" }); + prev_scope = ecs_set_scope(world, EcsTemperature); + EcsKelvin = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Kelvin", + .quantity = EcsTemperature, + .symbol = "K" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKelvin, + .kind = EcsF32 + }); + EcsCelsius = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Celsius", + .quantity = EcsTemperature, + .symbol = "°C" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsCelsius, + .kind = EcsF32 + }); + EcsFahrenheit = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Fahrenheit", + .quantity = EcsTemperature, + .symbol = "F" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsFahrenheit, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); + /* Data units */ -#ifdef FLECS_META + EcsData = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Data" }); + prev_scope = ecs_set_scope(world, EcsData); -static -const char* op_kind_str( - ecs_meta_type_op_kind_t kind) -{ - switch(kind) { + EcsBits = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Bits", + .quantity = EcsData, + .symbol = "bit" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBits, + .kind = EcsU64 + }); - case EcsOpEnum: return "Enum"; - case EcsOpBitmask: return "Bitmask"; - case EcsOpArray: return "Array"; - case EcsOpVector: return "Vector"; - case EcsOpPush: return "Push"; - case EcsOpPop: return "Pop"; - case EcsOpPrimitive: return "Primitive"; - case EcsOpBool: return "Bool"; - case EcsOpChar: return "Char"; - case EcsOpByte: return "Byte"; - case EcsOpU8: return "U8"; - case EcsOpU16: return "U16"; - case EcsOpU32: return "U32"; - case EcsOpU64: return "U64"; - case EcsOpI8: return "I8"; - case EcsOpI16: return "I16"; - case EcsOpI32: return "I32"; - case EcsOpI64: return "I64"; - case EcsOpF32: return "F32"; - case EcsOpF64: return "F64"; - case EcsOpUPtr: return "UPtr"; - case EcsOpIPtr: return "IPtr"; - case EcsOpString: return "String"; - case EcsOpEntity: return "Entity"; - default: return "<< invalid kind >>"; - } -} + EcsKiloBits = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloBits", + .quantity = EcsData, + .base = EcsBits, + .prefix = EcsKilo }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloBits, + .kind = EcsU64 + }); -/* Get current scope */ -static -ecs_meta_scope_t* get_scope( - const ecs_meta_cursor_t *cursor) -{ - ecs_check(cursor != NULL, ECS_INVALID_PARAMETER, NULL); - return (ecs_meta_scope_t*)&cursor->scope[cursor->depth]; -error: - return NULL; -} + EcsMegaBits = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MegaBits", + .quantity = EcsData, + .base = EcsBits, + .prefix = EcsMega }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMegaBits, + .kind = EcsU64 + }); -/* Get previous scope */ -static -ecs_meta_scope_t* get_prev_scope( - ecs_meta_cursor_t *cursor) -{ - ecs_check(cursor != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(cursor->depth > 0, ECS_INVALID_PARAMETER, NULL); - return &cursor->scope[cursor->depth - 1]; -error: - return NULL; -} + EcsGigaBits = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "GigaBits", + .quantity = EcsData, + .base = EcsBits, + .prefix = EcsGiga }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGigaBits, + .kind = EcsU64 + }); -/* Get current operation for scope */ -static -ecs_meta_type_op_t* get_op( - ecs_meta_scope_t *scope) -{ - return &scope->ops[scope->op_cur]; -} + EcsBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Bytes", + .quantity = EcsData, + .symbol = "B", + .base = EcsBits, + .translation = { .factor = 8, .power = 1 } }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBytes, + .kind = EcsU64 + }); -/* Get component for type in current scope */ -static -const EcsComponent* get_component_ptr( - const ecs_world_t *world, - ecs_meta_scope_t *scope) -{ - const EcsComponent *comp = scope->comp; - if (!comp) { - comp = scope->comp = ecs_get(world, scope->type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - } - return comp; -} + EcsKiloBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsKilo }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloBytes, + .kind = EcsU64 + }); -/* Get size for type in current scope */ -static -ecs_size_t get_size( - const ecs_world_t *world, - ecs_meta_scope_t *scope) -{ - return get_component_ptr(world, scope)->size; -} + EcsMegaBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MegaBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsMega }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMegaBytes, + .kind = EcsU64 + }); -/* Get alignment for type in current scope */ -static -ecs_size_t get_alignment( - const ecs_world_t *world, - ecs_meta_scope_t *scope) -{ - return get_component_ptr(world, scope)->alignment; -} + EcsGigaBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "GigaBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsGiga }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGigaBytes, + .kind = EcsU64 + }); -static -int32_t get_elem_count( - ecs_meta_scope_t *scope) -{ - if (scope->vector) { - return ecs_vector_count(*(scope->vector)); - } + EcsKibiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KibiBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsKibi }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKibiBytes, + .kind = EcsU64 + }); - ecs_meta_type_op_t *op = get_op(scope); - return op->count; -} + EcsMebiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MebiBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsMebi }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMebiBytes, + .kind = EcsU64 + }); -/* Get pointer to current field/element */ -static -ecs_meta_type_op_t* get_ptr( - const ecs_world_t *world, - ecs_meta_scope_t *scope) -{ - ecs_meta_type_op_t *op = get_op(scope); - ecs_size_t size = get_size(world, scope); + EcsGibiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "GibiBytes", + .quantity = EcsData, + .base = EcsBytes, + .prefix = EcsGibi }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGibiBytes, + .kind = EcsU64 + }); - if (scope->vector) { - ecs_size_t align = get_alignment(world, scope); - ecs_vector_set_min_count_t( - scope->vector, size, align, scope->elem_cur + 1); - scope->ptr = ecs_vector_first_t(*(scope->vector), size, align); - } + ecs_set_scope(world, prev_scope); - return ECS_OFFSET(scope->ptr, size * scope->elem_cur + op->offset); -} + /* DataRate units */ -static -int push_type( - const ecs_world_t *world, - ecs_meta_scope_t *scope, - ecs_entity_t type, - void *ptr) -{ - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - if (ser == NULL) { - char *str = ecs_id_str(world, type); - ecs_err("cannot open scope for entity '%s' which is not a type", str); - ecs_os_free(str); - return -1; - } + EcsDataRate = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "DataRate" }); + prev_scope = ecs_set_scope(world, EcsDataRate); - scope[0] = (ecs_meta_scope_t) { - .type = type, - .ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t), - .op_count = ecs_vector_count(ser->ops), - .ptr = ptr - }; + EcsBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "BitsPerSecond", + .quantity = EcsDataRate, + .base = EcsBits, + .over = EcsSeconds }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBitsPerSecond, + .kind = EcsU64 + }); - return 0; -} + EcsKiloBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloBitsPerSecond", + .quantity = EcsDataRate, + .base = EcsKiloBits, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloBitsPerSecond, + .kind = EcsU64 + }); -ecs_meta_cursor_t ecs_meta_cursor( - const ecs_world_t *world, - ecs_entity_t type, - void *ptr) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(type != 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); + EcsMegaBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MegaBitsPerSecond", + .quantity = EcsDataRate, + .base = EcsMegaBits, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMegaBitsPerSecond, + .kind = EcsU64 + }); - ecs_meta_cursor_t result = { - .world = world, - .valid = true - }; + EcsGigaBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "GigaBitsPerSecond", + .quantity = EcsDataRate, + .base = EcsGigaBits, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGigaBitsPerSecond, + .kind = EcsU64 + }); - if (push_type(world, result.scope, type, ptr) != 0) { - result.valid = false; - } + EcsBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "BytesPerSecond", + .quantity = EcsDataRate, + .base = EcsBytes, + .over = EcsSeconds }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBytesPerSecond, + .kind = EcsU64 + }); - return result; -error: - return (ecs_meta_cursor_t){ 0 }; -} + EcsKiloBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "KiloBytesPerSecond", + .quantity = EcsDataRate, + .base = EcsKiloBytes, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsKiloBytesPerSecond, + .kind = EcsU64 + }); -void* ecs_meta_get_ptr( - ecs_meta_cursor_t *cursor) -{ - return get_ptr(cursor->world, get_scope(cursor)); -} + EcsMegaBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "MegaBytesPerSecond", + .quantity = EcsDataRate, + .base = EcsMegaBytes, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsMegaBytesPerSecond, + .kind = EcsU64 + }); -int ecs_meta_next( - ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); + EcsGigaBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "GigaBytesPerSecond", + .quantity = EcsDataRate, + .base = EcsGigaBytes, + .over = EcsSeconds + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsGigaBytesPerSecond, + .kind = EcsU64 + }); - if (scope->is_collection) { - scope->elem_cur ++; - scope->op_cur = 0; - if (scope->elem_cur >= get_elem_count(scope)) { - ecs_err("out of collection bounds (%d)", scope->elem_cur); - return -1; - } - - return 0; - } + ecs_set_scope(world, prev_scope); - scope->op_cur += op->op_count; - if (scope->op_cur >= scope->op_count) { - ecs_err("out of bounds"); - return -1; - } + /* Percentage */ - return 0; -} + EcsPercentage = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Percentage" }); + ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.entity = EcsPercentage, + .symbol = "%" + }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsPercentage, + .kind = EcsF32 + }); -int ecs_meta_member( - ecs_meta_cursor_t *cursor, - const char *name) -{ - if (cursor->depth == 0) { - ecs_err("cannot move to member in root scope"); - return -1; - } + /* Angles */ - ecs_meta_scope_t *prev_scope = get_prev_scope(cursor); - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *push_op = get_op(prev_scope); - const ecs_world_t *world = cursor->world; + EcsAngle = ecs_quantity_init(world, &(ecs_entity_desc_t) { + .name = "Angle" }); + prev_scope = ecs_set_scope(world, EcsAngle); + EcsRadians = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Radians", + .quantity = EcsAngle, + .symbol = "rad" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsRadians, + .kind = EcsF32 + }); - ecs_assert(push_op->kind == EcsOpPush, ECS_INTERNAL_ERROR, NULL); - - if (!push_op->members) { - ecs_err("cannot move to member '%s' for non-struct type", name); - return -1; - } + EcsDegrees = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Degrees", + .quantity = EcsAngle, + .symbol = "°" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsDegrees, + .kind = EcsF32 + }); + ecs_set_scope(world, prev_scope); - const uint64_t *cur_ptr = flecs_name_index_find_ptr(push_op->members, name, 0, 0); - if (!cur_ptr) { - char *path = ecs_get_fullpath(world, scope->type); - ecs_err("unknown member '%s' for type '%s'", name, path); - ecs_os_free(path); - return -1; - } + /* DeciBel */ - scope->op_cur = flecs_uto(int32_t, cur_ptr[0]); + EcsBel = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "Bel", + .symbol = "B" }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsBel, + .kind = EcsF32 + }); + EcsDeciBel = ecs_unit_init(world, &(ecs_unit_desc_t) { + .entity.name = "DeciBel", + .prefix = EcsDeci, + .base = EcsBel }); + ecs_primitive_init(world, &(ecs_primitive_desc_t) { + .entity.entity = EcsDeciBel, + .kind = EcsF32 + }); - return 0; -} + /* Documentation */ +#ifdef FLECS_DOC + ECS_IMPORT(world, FlecsDoc); -int ecs_meta_push( - ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - const ecs_world_t *world = cursor->world; + ecs_doc_set_brief(world, EcsDuration, + "Time amount (e.g. \"20 seconds\", \"2 hours\")"); + ecs_doc_set_brief(world, EcsSeconds, "Time amount in seconds"); + ecs_doc_set_brief(world, EcsMinutes, "60 seconds"); + ecs_doc_set_brief(world, EcsHours, "60 minutes"); + ecs_doc_set_brief(world, EcsDays, "24 hours"); - if (cursor->depth == 0) { - if (!cursor->is_primitive_scope) { - if (op->kind > EcsOpScope) { - cursor->is_primitive_scope = true; - return 0; - } - } - } + ecs_doc_set_brief(world, EcsTime, + "Time passed since an epoch (e.g. \"5pm\", \"March 3rd 2022\")"); + ecs_doc_set_brief(world, EcsDate, + "Seconds passed since January 1st 1970"); - void *ptr = get_ptr(world, scope); - cursor->depth ++; - ecs_check(cursor->depth < ECS_META_MAX_SCOPE_DEPTH, - ECS_INVALID_PARAMETER, NULL); + ecs_doc_set_brief(world, EcsMass, "Units of mass (e.g. \"5 kilograms\")"); - ecs_meta_scope_t *next_scope = get_scope(cursor); + ecs_doc_set_brief(world, EcsElectricCurrent, + "Units of electrical current (e.g. \"2 ampere\")"); - /* If we're not already in an inline array and this operation is an inline - * array, push a frame for the array. - * Doing this first ensures that inline arrays take precedence over other - * kinds of push operations, such as for a struct element type. */ - if (!scope->is_inline_array && op->count > 1 && !scope->is_collection) { - /* Push a frame just for the element type, with inline_array = true */ - next_scope[0] = (ecs_meta_scope_t){ - .ops = op, - .op_count = op->op_count, - .ptr = scope->ptr, - .type = op->type, - .is_collection = true, - .is_inline_array = true - }; + ecs_doc_set_brief(world, EcsAmount, + "Units of amount of substance (e.g. \"2 mole\")"); - /* With 'is_inline_array' set to true we ensure that we can never push - * the same inline array twice */ + ecs_doc_set_brief(world, EcsLuminousIntensity, + "Units of luminous intensity (e.g. \"1 candela\")"); - return 0; - } + ecs_doc_set_brief(world, EcsForce, "Units of force (e.g. \"10 newton\")"); - switch(op->kind) { - case EcsOpPush: - next_scope[0] = (ecs_meta_scope_t) { - .ops = &op[1], /* op after push */ - .op_count = op->op_count - 1, /* don't include pop */ - .ptr = scope->ptr, - .type = op->type - }; - break; + ecs_doc_set_brief(world, EcsLength, + "Units of length (e.g. \"5 meters\", \"20 miles\")"); - case EcsOpArray: { - if (push_type(world, next_scope, op->type, ptr) != 0) { - goto error; - } + ecs_doc_set_brief(world, EcsPressure, + "Units of pressure (e.g. \"1 bar\", \"1000 pascal\")"); - const EcsArray *type_ptr = ecs_get(world, op->type, EcsArray); - next_scope->type = type_ptr->type; - next_scope->is_collection = true; - break; - } + ecs_doc_set_brief(world, EcsSpeed, + "Units of movement (e.g. \"5 meters/second\")"); - case EcsOpVector: - next_scope->vector = ptr; - if (push_type(world, next_scope, op->type, NULL) != 0) { - goto error; - } + ecs_doc_set_brief(world, EcsAcceleration, + "Unit of speed increase (e.g. \"5 meters/second/second\")"); - const EcsVector *type_ptr = ecs_get(world, op->type, EcsVector); - next_scope->type = type_ptr->type; - next_scope->is_collection = true; - break; + ecs_doc_set_brief(world, EcsTemperature, + "Units of temperature (e.g. \"5 degrees Celsius\")"); - default: { - char *path = ecs_get_fullpath(world, scope->type); - ecs_err("invalid push for type '%s'", path); - ecs_os_free(path); - goto error; - } - } + ecs_doc_set_brief(world, EcsData, + "Units of information (e.g. \"8 bits\", \"100 megabytes\")"); - if (scope->is_collection) { - next_scope[0].ptr = ECS_OFFSET(next_scope[0].ptr, - scope->elem_cur * get_size(world, scope)); - } + ecs_doc_set_brief(world, EcsDataRate, + "Units of data transmission (e.g. \"100 megabits/second\")"); - return 0; -error: - return -1; + ecs_doc_set_brief(world, EcsAngle, + "Units of rotation (e.g. \"1.2 radians\", \"180 degrees\")"); + +#endif } -int ecs_meta_pop( - ecs_meta_cursor_t *cursor) -{ - if (cursor->is_primitive_scope) { - cursor->is_primitive_scope = false; - return 0; - } +#endif - ecs_meta_scope_t *scope = get_scope(cursor); - cursor->depth --; - if (cursor->depth < 0) { - ecs_err("unexpected end of scope"); - return -1; - } - ecs_meta_scope_t *next_scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(next_scope); +#ifdef FLECS_SNAPSHOT - if (!scope->is_inline_array) { - if (op->kind == EcsOpPush) { - next_scope->op_cur += op->op_count - 1; - /* push + op_count should point to the operation after pop */ - op = get_op(next_scope); - ecs_assert(op->kind == EcsOpPop, ECS_INTERNAL_ERROR, NULL); - } else if (op->kind == EcsOpArray || op->kind == EcsOpVector) { - /* Collection type, nothing else to do */ - } else { - /* should not have been able to push if the previous scope was not - * a complex or collection type */ - ecs_assert(false, ECS_INTERNAL_ERROR, NULL); - } - } else { - /* Make sure that this was an inline array */ - ecs_assert(next_scope->op_count > 1, ECS_INTERNAL_ERROR, NULL); - } +/* World snapshot */ +struct ecs_snapshot_t { + ecs_world_t *world; + ecs_sparse_t *entity_index; + ecs_vector_t *tables; + ecs_entity_t last_id; + ecs_filter_t filter; +}; - return 0; -} +/** Small footprint data structure for storing data associated with a table. */ +typedef struct ecs_table_leaf_t { + ecs_table_t *table; + ecs_vector_t *type; + ecs_data_t *data; +} ecs_table_leaf_t; -bool ecs_meta_is_collection( - const ecs_meta_cursor_t *cursor) +static +ecs_data_t* duplicate_data( + const ecs_world_t *world, + ecs_table_t *table, + ecs_data_t *main_data) { - ecs_meta_scope_t *scope = get_scope(cursor); - return scope->is_collection; -} + if (!ecs_table_count(table)) { + return NULL; + } -ecs_entity_t ecs_meta_get_type( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - return op->type; -} + ecs_data_t *result = ecs_os_calloc(ECS_SIZEOF(ecs_data_t)); -ecs_entity_t ecs_meta_get_unit( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - return op->unit; -} + ecs_type_t storage_type = table->storage_type; + int32_t i, column_count = ecs_vector_count(storage_type); + ecs_entity_t *components = ecs_vector_first(storage_type, ecs_entity_t); -const char* ecs_meta_get_member( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - return op->name; -} + result->columns = ecs_os_memdup( + main_data->columns, ECS_SIZEOF(ecs_column_t) * column_count); -/* Utility macro's to let the compiler do the conversion work for us */ -#define set_T(T, ptr, value)\ - ((T*)ptr)[0] = ((T)value) + /* Copy entities */ + result->entities = ecs_vector_copy(main_data->entities, ecs_entity_t); + ecs_entity_t *entities = ecs_vector_first(result->entities, ecs_entity_t); -#define case_T(kind, T, dst, src)\ -case kind:\ - set_T(T, dst, src);\ - break + /* Copy record ptrs */ + result->record_ptrs = ecs_vector_copy( + main_data->record_ptrs, ecs_record_t*); -#define cases_T_float(dst, src)\ - case_T(EcsOpF32, ecs_f32_t, dst, src);\ - case_T(EcsOpF64, ecs_f64_t, dst, src) + ecs_size_t to_alloc = ecs_vector_size(result->entities); -#define cases_T_signed(dst, src)\ - case_T(EcsOpChar, ecs_char_t, dst, src);\ - case_T(EcsOpI8, ecs_i8_t, dst, src);\ - case_T(EcsOpI16, ecs_i16_t, dst, src);\ - case_T(EcsOpI32, ecs_i32_t, dst, src);\ - case_T(EcsOpI64, ecs_i64_t, dst, src);\ - case_T(EcsOpIPtr, ecs_iptr_t, dst, src) + /* Copy each column */ + for (i = 0; i < column_count; i ++) { + ecs_entity_t component = components[i]; + ecs_column_t *column = &result->columns[i]; -#define cases_T_unsigned(dst, src)\ - case_T(EcsOpByte, ecs_byte_t, dst, src);\ - case_T(EcsOpU8, ecs_u8_t, dst, src);\ - case_T(EcsOpU16, ecs_u16_t, dst, src);\ - case_T(EcsOpU32, ecs_u32_t, dst, src);\ - case_T(EcsOpU64, ecs_u64_t, dst, src);\ - case_T(EcsOpUPtr, ecs_uptr_t, dst, src);\ + component = ecs_get_typeid(world, component); -#define cases_T_bool(dst, src)\ -case EcsOpBool:\ - set_T(ecs_bool_t, dst, value != 0);\ - break + const ecs_type_info_t *ti = flecs_get_type_info(world, component); + int16_t size = column->size; + int16_t alignment = column->alignment; + ecs_copy_t copy; -static -void conversion_error( - ecs_meta_cursor_t *cursor, - ecs_meta_type_op_t *op, - const char *from) -{ - char *path = ecs_get_fullpath(cursor->world, op->type); - ecs_err("unsupported conversion from %s to '%s'", from, path); - ecs_os_free(path); -} + if (ti && (copy = ti->lifecycle.copy)) { + int32_t count = ecs_vector_count(column->data); + ecs_vector_t *dst_vec = ecs_vector_new_t(size, alignment, to_alloc); + ecs_vector_set_count_t(&dst_vec, size, alignment, count); + void *dst_ptr = ecs_vector_first_t(dst_vec, size, alignment); + + ecs_xtor_t ctor = ti->lifecycle.ctor; + if (ctor) { + ctor((ecs_world_t*)world, entities, dst_ptr, count, ti); + } -int ecs_meta_set_bool( - ecs_meta_cursor_t *cursor, - bool value) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + void *src_ptr = ecs_vector_first_t(column->data, size, alignment); + copy((ecs_world_t*)world, entities, entities, dst_ptr, + src_ptr, count, ti); - switch(op->kind) { - cases_T_bool(ptr, value); - cases_T_unsigned(ptr, value); - default: - conversion_error(cursor, op, "bool"); - return -1; + column->data = dst_vec; + } else { + column->data = ecs_vector_copy_t(column->data, size, alignment); + } } - return 0; + return result; } -int ecs_meta_set_char( - ecs_meta_cursor_t *cursor, - char value) +static +void snapshot_table( + const ecs_world_t *world, + ecs_snapshot_t *snapshot, + ecs_table_t *table) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - - switch(op->kind) { - cases_T_bool(ptr, value); - cases_T_signed(ptr, value); - default: - conversion_error(cursor, op, "char"); - return -1; + if (table->flags & EcsTableHasBuiltins) { + return; } - - return 0; + + ecs_table_leaf_t *l = ecs_vector_get( + snapshot->tables, ecs_table_leaf_t, (int32_t)table->id); + ecs_assert(l != NULL, ECS_INTERNAL_ERROR, NULL); + + l->table = table; + l->type = ecs_vector_copy(table->type, ecs_id_t); + l->data = duplicate_data(world, table, &table->storage); } -int ecs_meta_set_int( - ecs_meta_cursor_t *cursor, - int64_t value) +static +ecs_snapshot_t* snapshot_create( + const ecs_world_t *world, + const ecs_sparse_t *entity_index, + ecs_iter_t *iter, + ecs_iter_next_action_t next) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + ecs_snapshot_t *result = ecs_os_calloc_t(ecs_snapshot_t); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - switch(op->kind) { - cases_T_bool(ptr, value); - cases_T_signed(ptr, value); - cases_T_float(ptr, value); - default: { - conversion_error(cursor, op, "int"); - return -1; + ecs_force_aperiodic((ecs_world_t*)world); + + result->world = (ecs_world_t*)world; + + /* If no iterator is provided, the snapshot will be taken of the entire + * world, and we can simply copy the entity index as it will be restored + * entirely upon snapshote restore. */ + if (!iter && entity_index) { + result->entity_index = flecs_sparse_copy(entity_index); } + + /* Create vector with as many elements as tables, so we can store the + * snapshot tables at their element ids. When restoring a snapshot, the code + * will run a diff between the tables in the world and the snapshot, to see + * which of the world tables still exist, no longer exist, or need to be + * deleted. */ + uint64_t t, table_count = flecs_sparse_last_id(&world->store.tables) + 1; + result->tables = ecs_vector_new(ecs_table_leaf_t, (int32_t)table_count); + ecs_vector_set_count(&result->tables, ecs_table_leaf_t, (int32_t)table_count); + ecs_table_leaf_t *arr = ecs_vector_first(result->tables, ecs_table_leaf_t); + + /* Array may have holes, so initialize with 0 */ + ecs_os_memset_n(arr, 0, ecs_table_leaf_t, table_count); + + /* Iterate tables in iterator */ + if (iter) { + while (next(iter)) { + ecs_table_t *table = iter->table; + snapshot_table(world, result, table); + } + } else { + for (t = 0; t < table_count; t ++) { + ecs_table_t *table = flecs_sparse_get( + &world->store.tables, ecs_table_t, t); + snapshot_table(world, result, table); + } } - return 0; + return result; } -int ecs_meta_set_uint( - ecs_meta_cursor_t *cursor, - uint64_t value) +/** Create a snapshot */ +ecs_snapshot_t* ecs_snapshot_take( + ecs_world_t *stage) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + const ecs_world_t *world = ecs_get_world(stage); - switch(op->kind) { - cases_T_bool(ptr, value); - cases_T_unsigned(ptr, value); - cases_T_float(ptr, value); - case EcsOpEntity: - set_T(ecs_entity_t, ptr, value); - break; - default: - conversion_error(cursor, op, "uint"); - return -1; - } + ecs_snapshot_t *result = snapshot_create( + world, ecs_eis(world), NULL, NULL); - return 0; + result->last_id = world->stats.last_id; + + return result; } -int ecs_meta_set_float( - ecs_meta_cursor_t *cursor, - double value) +/** Create a filtered snapshot */ +ecs_snapshot_t* ecs_snapshot_take_w_iter( + ecs_iter_t *iter) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + ecs_world_t *world = iter->world; + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - switch(op->kind) { - cases_T_bool(ptr, value); - cases_T_signed(ptr, value); - cases_T_unsigned(ptr, value); - cases_T_float(ptr, value); - default: - conversion_error(cursor, op, "float"); - return -1; - } + ecs_snapshot_t *result = snapshot_create( + world, ecs_eis(world), iter, iter ? iter->next : NULL); - return 0; + result->last_id = world->stats.last_id; + + return result; } +/* Restoring an unfiltered snapshot restores the world to the exact state it was + * when the snapshot was taken. */ static -int add_bitmask_constant( - ecs_meta_cursor_t *cursor, - ecs_meta_type_op_t *op, - void *out, - const char *value) +void restore_unfiltered( + ecs_world_t *world, + ecs_snapshot_t *snapshot) { - ecs_assert(op->type != 0, ECS_INTERNAL_ERROR, NULL); + flecs_sparse_restore(ecs_eis(world), snapshot->entity_index); + flecs_sparse_free(snapshot->entity_index); + + world->stats.last_id = snapshot->last_id; - if (!ecs_os_strcmp(value, "0")) { - return 0; - } + ecs_table_leaf_t *leafs = ecs_vector_first( + snapshot->tables, ecs_table_leaf_t); + int32_t i, count = (int32_t)flecs_sparse_last_id(&world->store.tables); + int32_t snapshot_count = ecs_vector_count(snapshot->tables); - ecs_entity_t c = ecs_lookup_child(cursor->world, op->type, value); - if (!c) { - char *path = ecs_get_fullpath(cursor->world, op->type); - ecs_err("unresolved bitmask constant '%s' for type '%s'", value, path); - ecs_os_free(path); - return -1; - } + for (i = 0; i <= count; i ++) { + ecs_table_t *world_table = flecs_sparse_get( + &world->store.tables, ecs_table_t, (uint32_t)i); - const ecs_u32_t *v = ecs_get_pair_object( - cursor->world, c, EcsConstant, ecs_u32_t); - if (v == NULL) { - char *path = ecs_get_fullpath(cursor->world, op->type); - ecs_err("'%s' is not an bitmask constant for type '%s'", value, path); - ecs_os_free(path); - return -1; + if (world_table && (world_table->flags & EcsTableHasBuiltins)) { + continue; + } + + ecs_table_leaf_t *snapshot_table = NULL; + if (i < snapshot_count) { + snapshot_table = &leafs[i]; + if (!snapshot_table->table) { + snapshot_table = NULL; + } + } + + /* If the world table no longer exists but the snapshot table does, + * reinsert it */ + if (!world_table && snapshot_table) { + ecs_ids_t type = { + .array = ecs_vector_first(snapshot_table->type, ecs_id_t), + .count = ecs_vector_count(snapshot_table->type) + }; + + ecs_table_t *table = flecs_table_find_or_create(world, &type); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + + if (snapshot_table->data) { + flecs_table_replace_data(world, table, snapshot_table->data); + } + + /* If the world table still exists, replace its data */ + } else if (world_table && snapshot_table) { + ecs_assert(snapshot_table->table == world_table, + ECS_INTERNAL_ERROR, NULL); + + if (snapshot_table->data) { + flecs_table_replace_data( + world, world_table, snapshot_table->data); + } else { + flecs_table_clear_data( + world, world_table, &world_table->storage); + flecs_table_init_data(world, world_table); + } + + /* If the snapshot table doesn't exist, this table was created after the + * snapshot was taken and needs to be deleted */ + } else if (world_table && !snapshot_table) { + /* Deleting a table invokes OnRemove triggers & updates the entity + * index. That is not what we want, since entities may no longer be + * valid (if they don't exist in the snapshot) or may have been + * restored in a different table. Therefore first clear the data + * from the table (which doesn't invoke triggers), and then delete + * the table. */ + flecs_table_clear_data(world, world_table, &world_table->storage); + flecs_delete_table(world, world_table); + + /* If there is no world & snapshot table, nothing needs to be done */ + } else { } + + if (snapshot_table) { + ecs_os_free(snapshot_table->data); + ecs_os_free(snapshot_table->type); + } } - *(ecs_u32_t*)out |= v[0]; + /* Now that all tables have been restored and world is in a consistent + * state, run OnSet systems */ + int32_t world_count = flecs_sparse_count(&world->store.tables); + for (i = 0; i < world_count; i ++) { + ecs_table_t *table = flecs_sparse_get_dense( + &world->store.tables, ecs_table_t, i); + if (table->flags & EcsTableHasBuiltins) { + continue; + } - return 0; + int32_t tcount = ecs_table_count(table); + if (tcount) { + flecs_notify_on_set(world, table, 0, tcount, NULL, true); + } + } } +/* Restoring a filtered snapshots only restores the entities in the snapshot + * to their previous state. */ static -int parse_bitmask( - ecs_meta_cursor_t *cursor, - ecs_meta_type_op_t *op, - void *out, - const char *value) +void restore_filtered( + ecs_world_t *world, + ecs_snapshot_t *snapshot) { - char token[ECS_MAX_TOKEN_SIZE]; + ecs_table_leaf_t *leafs = ecs_vector_first( + snapshot->tables, ecs_table_leaf_t); + int32_t l = 0, snapshot_count = ecs_vector_count(snapshot->tables); - const char *prev = value, *ptr = value; + for (l = 0; l < snapshot_count; l ++) { + ecs_table_leaf_t *snapshot_table = &leafs[l]; + ecs_table_t *table = snapshot_table->table; - *(ecs_u32_t*)out = 0; + if (!table) { + continue; + } - while ((ptr = strchr(ptr, '|'))) { - ecs_os_memcpy(token, prev, ptr - prev); - token[ptr - prev] = '\0'; - if (add_bitmask_constant(cursor, op, out, token) != 0) { - return -1; + ecs_data_t *data = snapshot_table->data; + if (!data) { + ecs_vector_free(snapshot_table->type); + continue; } - ptr ++; - prev = ptr; + /* Delete entity from storage first, so that when we restore it to the + * current table we can be sure that there won't be any duplicates */ + int32_t i, entity_count = ecs_vector_count(data->entities); + ecs_entity_t *entities = ecs_vector_first( + snapshot_table->data->entities, ecs_entity_t); + for (i = 0; i < entity_count; i ++) { + ecs_entity_t e = entities[i]; + ecs_record_t *r = ecs_eis_get(world, e); + if (r && r->table) { + flecs_table_delete(world, r->table, &r->table->storage, + ECS_RECORD_TO_ROW(r->row), true); + } else { + /* Make sure that the entity has the same generation count */ + ecs_eis_set_generation(world, e); + } + } + + /* Merge data from snapshot table with world table */ + int32_t old_count = ecs_table_count(snapshot_table->table); + int32_t new_count = flecs_table_data_count(snapshot_table->data); + + flecs_table_merge(world, table, table, &table->storage, snapshot_table->data); + + /* Run OnSet systems for merged entities */ + if (new_count) { + flecs_notify_on_set( + world, table, old_count, new_count, NULL, true); + } + + ecs_os_free(snapshot_table->data->columns); + ecs_os_free(snapshot_table->data); + ecs_vector_free(snapshot_table->type); } +} - if (add_bitmask_constant(cursor, op, out, prev) != 0) { - return -1; +/** Restore a snapshot */ +void ecs_snapshot_restore( + ecs_world_t *world, + ecs_snapshot_t *snapshot) +{ + ecs_force_aperiodic(world); + + if (snapshot->entity_index) { + /* Unfiltered snapshots have a copy of the entity index which is + * copied back entirely when the snapshot is restored */ + restore_unfiltered(world, snapshot); + } else { + restore_filtered(world, snapshot); } - return 0; + ecs_vector_free(snapshot->tables); + + ecs_os_free(snapshot); } -int ecs_meta_set_string( - ecs_meta_cursor_t *cursor, - const char *value) +ecs_iter_t ecs_snapshot_iter( + ecs_snapshot_t *snapshot) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - - switch(op->kind) { - case EcsOpBool: - if (!ecs_os_strcmp(value, "true")) { - set_T(ecs_bool_t, ptr, true); - } else if (!ecs_os_strcmp(value, "false")) { - set_T(ecs_bool_t, ptr, false); - } else { - ecs_err("invalid value for boolean '%s'", value); - return -1; - } - break; - case EcsOpI8: - case EcsOpU8: - case EcsOpChar: - case EcsOpByte: - set_T(ecs_i8_t, ptr, atol(value)); - break; - case EcsOpI16: - case EcsOpU16: - set_T(ecs_i16_t, ptr, atol(value)); - break; - case EcsOpI32: - case EcsOpU32: - set_T(ecs_i32_t, ptr, atol(value)); - break; - case EcsOpI64: - case EcsOpU64: - set_T(ecs_i64_t, ptr, atol(value)); - break; - case EcsOpIPtr: - case EcsOpUPtr: - set_T(ecs_iptr_t, ptr, atol(value)); - break; - case EcsOpF32: - set_T(ecs_f32_t, ptr, atof(value)); - break; - case EcsOpF64: - set_T(ecs_f64_t, ptr, atof(value)); - break; - case EcsOpString: { - ecs_os_free(*(char**)ptr); - char *result = ecs_os_strdup(value); - set_T(ecs_string_t, ptr, result); - break; - } - case EcsOpEnum: { - ecs_assert(op->type != 0, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t c = ecs_lookup_child(cursor->world, op->type, value); - if (!c) { - char *path = ecs_get_fullpath(cursor->world, op->type); - ecs_err("unresolved enum constant '%s' for type '%s'", value, path); - ecs_os_free(path); - return -1; - } + ecs_snapshot_iter_t iter = { + .tables = snapshot->tables, + .index = 0 + }; - const ecs_i32_t *v = ecs_get_pair_object( - cursor->world, c, EcsConstant, ecs_i32_t); - if (v == NULL) { - char *path = ecs_get_fullpath(cursor->world, op->type); - ecs_err("'%s' is not an enum constant for type '%s'", value, path); - ecs_os_free(path); - return -1; - } + return (ecs_iter_t){ + .world = snapshot->world, + .table_count = ecs_vector_count(snapshot->tables), + .priv.iter.snapshot = iter, + .next = ecs_snapshot_next + }; +} - set_T(ecs_i32_t, ptr, v[0]); - break; - } - case EcsOpBitmask: - if (parse_bitmask(cursor, op, ptr, value) != 0) { - return -1; +bool ecs_snapshot_next( + ecs_iter_t *it) +{ + ecs_snapshot_iter_t *iter = &it->priv.iter.snapshot; + ecs_table_leaf_t *tables = ecs_vector_first(iter->tables, ecs_table_leaf_t); + int32_t count = ecs_vector_count(iter->tables); + int32_t i; + + for (i = iter->index; i < count; i ++) { + ecs_table_t *table = tables[i].table; + if (!table) { + continue; } - break; - case EcsOpEntity: { - ecs_entity_t e = 0; - if (ecs_os_strcmp(value, "0")) { - if (cursor->lookup_action) { - e = cursor->lookup_action( - cursor->world, value, - cursor->lookup_ctx); - } else { - e = ecs_lookup_path(cursor->world, 0, value); - } + ecs_data_t *data = tables[i].data; - if (!e) { - ecs_err("unresolved entity identifier '%s'", value); - return -1; - } + it->table = table; + it->count = ecs_table_count(table); + if (data) { + it->entities = ecs_vector_first(data->entities, ecs_entity_t); + } else { + it->entities = NULL; } - set_T(ecs_entity_t, ptr, e); - break; - } - case EcsOpPop: - ecs_err("excess element '%s' in scope", value); - return -1; - default: - ecs_err("unsupported conversion from string '%s' to '%s'", - value, op_kind_str(op->kind)); - return -1; + it->is_valid = true; + iter->index = i + 1; + + goto yield; } - return 0; + it->is_valid = false; + return false; + +yield: + it->is_valid = true; + return true; } -int ecs_meta_set_string_literal( - ecs_meta_cursor_t *cursor, - const char *value) +/** Cleanup snapshot */ +void ecs_snapshot_free( + ecs_snapshot_t *snapshot) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + flecs_sparse_free(snapshot->entity_index); - ecs_size_t len = ecs_os_strlen(value); - if (value[0] != '\"' || value[len - 1] != '\"') { - ecs_err("invalid string literal '%s'", value); - return -1; - } + ecs_table_leaf_t *tables = ecs_vector_first(snapshot->tables, ecs_table_leaf_t); + int32_t i, count = ecs_vector_count(snapshot->tables); + for (i = 0; i < count; i ++) { + ecs_table_leaf_t *snapshot_table = &tables[i]; + ecs_table_t *table = snapshot_table->table; + if (table) { + ecs_data_t *data = snapshot_table->data; + if (data) { + flecs_table_clear_data(snapshot->world, table, data); + ecs_os_free(data); + } + ecs_vector_free(snapshot_table->type); + } + } - switch(op->kind) { - case EcsOpChar: - set_T(ecs_char_t, ptr, value[1]); - break; - - default: - case EcsOpEntity: - case EcsOpString: - len -= 2; + ecs_vector_free(snapshot->tables); + ecs_os_free(snapshot); +} - char *result = ecs_os_malloc(len + 1); - ecs_os_memcpy(result, value + 1, len); - result[len] = '\0'; +#endif - if (ecs_meta_set_string(cursor, result)) { - ecs_os_free(result); - return -1; - } - ecs_os_free(result); +#ifdef FLECS_SYSTEM - break; - } - return 0; +static +void invoke_status_action( + ecs_world_t *world, + ecs_entity_t system, + const EcsSystem *system_data, + ecs_system_status_t status) +{ + ecs_system_status_action_t action = system_data->status_action; + if (action) { + action(world, system, status, system_data->status_ctx); + } } -int ecs_meta_set_entity( - ecs_meta_cursor_t *cursor, - ecs_entity_t value) +/* Invoked when system becomes active or inactive */ +void ecs_system_activate( + ecs_world_t *world, + ecs_entity_t system, + bool activate, + const EcsSystem *system_data) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); + ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); - switch(op->kind) { - case EcsOpEntity: - set_T(ecs_entity_t, ptr, value); - break; - default: - conversion_error(cursor, op, "entity"); - return -1; + if (activate) { + /* If activating system, ensure that it doesn't have the Inactive tag. + * Systems are implicitly activated so they are kept out of the main + * loop as long as they aren't used. They are not implicitly deactivated + * to prevent overhead in case of oscillating app behavior. + * After activation, systems that aren't matched with anything can be + * deactivated again by explicitly calling ecs_deactivate_systems. + */ + ecs_remove_id(world, system, EcsInactive); } - return 0; -} + if (!system_data) { + system_data = ecs_get(world, system, EcsSystem); + } + if (!system_data || !system_data->query) { + return; + } -int ecs_meta_set_null( - ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch (op->kind) { - case EcsOpString: - ecs_os_free(*(char**)ptr); - set_T(ecs_string_t, ptr, NULL); - break; - default: - conversion_error(cursor, op, "null"); - return -1; + if (!activate) { + if (ecs_has_id(world, system, EcsDisabled)) { + if (!ecs_query_table_count(system_data->query)) { + /* If deactivating a disabled system that isn't matched with + * any active tables, there is nothing to deactivate. */ + return; + } + } } - return 0; + /* Invoke system status action */ + invoke_status_action(world, system, system_data, + activate ? EcsSystemActivated : EcsSystemDeactivated); + + ecs_dbg_1("#[green]system#[reset] %s %s", + ecs_get_name(world, system), + activate ? "activated" : "deactivated"); } -bool ecs_meta_get_bool( - const ecs_meta_cursor_t *cursor) +/* Actually enable or disable system */ +static +void ecs_enable_system( + ecs_world_t *world, + ecs_entity_t system, + EcsSystem *system_data, + bool enabled) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpBool: return *(ecs_bool_t*)ptr; - case EcsOpI8: return *(ecs_i8_t*)ptr != 0; - case EcsOpU8: return *(ecs_u8_t*)ptr != 0; - case EcsOpChar: return *(ecs_char_t*)ptr != 0; - case EcsOpByte: return *(ecs_u8_t*)ptr != 0; - case EcsOpI16: return *(ecs_i16_t*)ptr != 0; - case EcsOpU16: return *(ecs_u16_t*)ptr != 0; - case EcsOpI32: return *(ecs_i32_t*)ptr != 0; - case EcsOpU32: return *(ecs_u32_t*)ptr != 0; - case EcsOpI64: return *(ecs_i64_t*)ptr != 0; - case EcsOpU64: return *(ecs_u64_t*)ptr != 0; - case EcsOpIPtr: return *(ecs_iptr_t*)ptr != 0; - case EcsOpUPtr: return *(ecs_uptr_t*)ptr != 0; - case EcsOpF32: return *(ecs_f32_t*)ptr != 0; - case EcsOpF64: return *(ecs_f64_t*)ptr != 0; - case EcsOpString: return *(const char**)ptr != NULL; - case EcsOpEnum: return *(ecs_i32_t*)ptr != 0; - case EcsOpBitmask: return *(ecs_u32_t*)ptr != 0; - case EcsOpEntity: return *(ecs_entity_t*)ptr != 0; - default: ecs_throw(ECS_INVALID_PARAMETER, - "invalid element for bool"); + ecs_poly_assert(world, ecs_world_t); + ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); + + ecs_query_t *query = system_data->query; + if (!query) { + return; } -error: - return 0; -} -char ecs_meta_get_char( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpChar: return *(ecs_char_t*)ptr != 0; - default: ecs_throw(ECS_INVALID_PARAMETER, - "invalid element for char"); + if (ecs_query_table_count(query)) { + /* Only (de)activate system if it has non-empty tables. */ + ecs_system_activate(world, system, enabled, system_data); + system_data = ecs_get_mut(world, system, EcsSystem, NULL); } -error: - return 0; + + /* Invoke action for enable/disable status */ + invoke_status_action( + world, system, system_data, + enabled ? EcsSystemEnabled : EcsSystemDisabled); } -int64_t ecs_meta_get_int( - const ecs_meta_cursor_t *cursor) +/* -- Public API -- */ + +ecs_entity_t ecs_run_intern( + ecs_world_t *world, + ecs_stage_t *stage, + ecs_entity_t system, + EcsSystem *system_data, + int32_t stage_current, + int32_t stage_count, + FLECS_FLOAT delta_time, + int32_t offset, + int32_t limit, + void *param) { - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpBool: return *(ecs_bool_t*)ptr; - case EcsOpI8: return *(ecs_i8_t*)ptr; - case EcsOpU8: return *(ecs_u8_t*)ptr; - case EcsOpChar: return *(ecs_char_t*)ptr; - case EcsOpByte: return *(ecs_u8_t*)ptr; - case EcsOpI16: return *(ecs_i16_t*)ptr; - case EcsOpU16: return *(ecs_u16_t*)ptr; - case EcsOpI32: return *(ecs_i32_t*)ptr; - case EcsOpU32: return *(ecs_u32_t*)ptr; - case EcsOpI64: return *(ecs_i64_t*)ptr; - case EcsOpU64: return flecs_uto(int64_t, *(ecs_u64_t*)ptr); - case EcsOpIPtr: return *(ecs_iptr_t*)ptr; - case EcsOpUPtr: return flecs_uto(int64_t, *(ecs_uptr_t*)ptr); - case EcsOpF32: return (int64_t)*(ecs_f32_t*)ptr; - case EcsOpF64: return (int64_t)*(ecs_f64_t*)ptr; - case EcsOpString: return atoi(*(const char**)ptr); - case EcsOpEnum: return *(ecs_i32_t*)ptr; - case EcsOpBitmask: return *(ecs_u32_t*)ptr; - case EcsOpEntity: - ecs_throw(ECS_INVALID_PARAMETER, - "invalid conversion from entity to int"); - break; - default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for int"); + FLECS_FLOAT time_elapsed = delta_time; + ecs_entity_t tick_source = system_data->tick_source; + + /* Support legacy behavior */ + if (!param) { + param = system_data->ctx; } -error: - return 0; -} -uint64_t ecs_meta_get_uint( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpBool: return *(ecs_bool_t*)ptr; - case EcsOpI8: return flecs_ito(uint64_t, *(ecs_i8_t*)ptr); - case EcsOpU8: return *(ecs_u8_t*)ptr; - case EcsOpChar: return flecs_ito(uint64_t, *(ecs_char_t*)ptr); - case EcsOpByte: return flecs_ito(uint64_t, *(ecs_u8_t*)ptr); - case EcsOpI16: return flecs_ito(uint64_t, *(ecs_i16_t*)ptr); - case EcsOpU16: return *(ecs_u16_t*)ptr; - case EcsOpI32: return flecs_ito(uint64_t, *(ecs_i32_t*)ptr); - case EcsOpU32: return *(ecs_u32_t*)ptr; - case EcsOpI64: return flecs_ito(uint64_t, *(ecs_i64_t*)ptr); - case EcsOpU64: return *(ecs_u64_t*)ptr; - case EcsOpIPtr: return flecs_ito(uint64_t, *(ecs_i64_t*)ptr); - case EcsOpUPtr: return *(ecs_uptr_t*)ptr; - case EcsOpF32: return flecs_ito(uint64_t, *(ecs_f32_t*)ptr); - case EcsOpF64: return flecs_ito(uint64_t, *(ecs_f64_t*)ptr); - case EcsOpString: return flecs_ito(uint64_t, atoi(*(const char**)ptr)); - case EcsOpEnum: return flecs_ito(uint64_t, *(ecs_i32_t*)ptr); - case EcsOpBitmask: return *(ecs_u32_t*)ptr; - case EcsOpEntity: return *(ecs_entity_t*)ptr; - default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for uint"); + if (tick_source) { + const EcsTickSource *tick = ecs_get( + world, tick_source, EcsTickSource); + + if (tick) { + time_elapsed = tick->time_elapsed; + + /* If timer hasn't fired we shouldn't run the system */ + if (!tick->tick) { + return 0; + } + } else { + /* If a timer has been set but the timer entity does not have the + * EcsTimer component, don't run the system. This can be the result + * of a single-shot timer that has fired already. Not resetting the + * timer field of the system will ensure that the system won't be + * ran after the timer has fired. */ + return 0; + } } -error: - return 0; -} -double ecs_meta_get_float( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpBool: return *(ecs_bool_t*)ptr; - case EcsOpI8: return *(ecs_i8_t*)ptr; - case EcsOpU8: return *(ecs_u8_t*)ptr; - case EcsOpChar: return *(ecs_char_t*)ptr; - case EcsOpByte: return *(ecs_u8_t*)ptr; - case EcsOpI16: return *(ecs_i16_t*)ptr; - case EcsOpU16: return *(ecs_u16_t*)ptr; - case EcsOpI32: return *(ecs_i32_t*)ptr; - case EcsOpU32: return *(ecs_u32_t*)ptr; - case EcsOpI64: return (double)*(ecs_i64_t*)ptr; - case EcsOpU64: return (double)*(ecs_u64_t*)ptr; - case EcsOpIPtr: return (double)*(ecs_iptr_t*)ptr; - case EcsOpUPtr: return (double)*(ecs_uptr_t*)ptr; - case EcsOpF32: return (double)*(ecs_f32_t*)ptr; - case EcsOpF64: return *(ecs_f64_t*)ptr; - case EcsOpString: return atof(*(const char**)ptr); - case EcsOpEnum: return *(ecs_i32_t*)ptr; - case EcsOpBitmask: return *(ecs_u32_t*)ptr; - case EcsOpEntity: - ecs_throw(ECS_INVALID_PARAMETER, - "invalid conversion from entity to float"); - break; - default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for float"); + ecs_time_t time_start; + bool measure_time = world->measure_system_time; + if (measure_time) { + ecs_os_get_time(&time_start); } -error: - return 0; -} -const char* ecs_meta_get_string( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpString: return *(const char**)ptr; - default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for string"); + ecs_world_t *thread_ctx = world; + if (stage) { + thread_ctx = stage->thread_ctx; } -error: - return 0; -} -ecs_entity_t ecs_meta_get_entity( - const ecs_meta_cursor_t *cursor) -{ - ecs_meta_scope_t *scope = get_scope(cursor); - ecs_meta_type_op_t *op = get_op(scope); - void *ptr = get_ptr(cursor->world, scope); - switch(op->kind) { - case EcsOpEntity: return *(ecs_entity_t*)ptr; - default: ecs_throw(ECS_INVALID_PARAMETER, "invalid element for entity"); + ecs_defer_begin(thread_ctx); + + /* Prepare the query iterator */ + ecs_iter_t pit, wit, qit = ecs_query_iter(thread_ctx, system_data->query); + ecs_iter_t *it = &qit; + + if (offset || limit) { + pit = ecs_page_iter(it, offset, limit); + it = &pit; } -error: - return 0; -} -#endif + if (stage_count > 1 && system_data->multi_threaded) { + wit = ecs_worker_iter(it, stage_current, stage_count); + it = &wit; + } + qit.system = system; + qit.self = system_data->self; + qit.delta_time = delta_time; + qit.delta_system_time = time_elapsed; + qit.frame_offset = offset; + qit.param = param; + qit.ctx = system_data->ctx; + qit.binding_ctx = system_data->binding_ctx; -#ifdef FLECS_META + ecs_iter_action_t action = system_data->action; + it->callback = action; + + ecs_run_action_t run = system_data->run; + if (run) { + run(it); + } else { + if (it == &qit) { + while (ecs_query_next(&qit)) { + action(&qit); + } + } else { + while (ecs_iter_next(it)) { + action(it); + } + } + } -static -ecs_vector_t* serialize_type( - ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops); + if (measure_time) { + system_data->time_spent += (float)ecs_time_measure(&time_start); + } -static -ecs_meta_type_op_kind_t primitive_to_op_kind(ecs_primitive_kind_t kind) { - return EcsOpPrimitive + kind; -} + system_data->invoke_count ++; -static -ecs_size_t type_size(ecs_world_t *world, ecs_entity_t type) { - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - return comp->size; -} + ecs_defer_end(thread_ctx); -static -ecs_meta_type_op_t* ops_add(ecs_vector_t **ops, ecs_meta_type_op_kind_t kind) { - ecs_meta_type_op_t *op = ecs_vector_add(ops, ecs_meta_type_op_t); - op->kind = kind; - op->offset = 0; - op->count = 1; - op->op_count = 1; - op->size = 0; - op->name = NULL; - op->members = NULL; - op->type = 0; - op->unit = 0; - return op; + return it->interrupted_by; } -static -ecs_meta_type_op_t* ops_get(ecs_vector_t *ops, int32_t index) { - ecs_meta_type_op_t* op = ecs_vector_get(ops, ecs_meta_type_op_t, index); - ecs_assert(op != NULL, ECS_INTERNAL_ERROR, NULL); - return op; +/* -- Public API -- */ + +ecs_entity_t ecs_run_w_filter( + ecs_world_t *world, + ecs_entity_t system, + FLECS_FLOAT delta_time, + int32_t offset, + int32_t limit, + void *param) +{ + ecs_stage_t *stage = flecs_stage_from_world(&world); + + EcsSystem *system_data = (EcsSystem*)ecs_get( + world, system, EcsSystem); + assert(system_data != NULL); + + return ecs_run_intern(world, stage, system, system_data, 0, 0, delta_time, + offset, limit, param); } -static -ecs_vector_t* serialize_primitive( +ecs_entity_t ecs_run_worker( ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) + ecs_entity_t system, + int32_t stage_current, + int32_t stage_count, + FLECS_FLOAT delta_time, + void *param) { - const EcsPrimitive *ptr = ecs_get(world, type, EcsPrimitive); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_stage_t *stage = flecs_stage_from_world(&world); - ecs_meta_type_op_t *op = ops_add(&ops, primitive_to_op_kind(ptr->kind)); - op->offset = offset, - op->type = type; - op->size = type_size(world, type); + EcsSystem *system_data = (EcsSystem*)ecs_get( + world, system, EcsSystem); + assert(system_data != NULL); - return ops; + return ecs_run_intern( + world, stage, system, system_data, stage_current, stage_count, + delta_time, 0, 0, param); } -static -ecs_vector_t* serialize_enum( +ecs_entity_t ecs_run( ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) + ecs_entity_t system, + FLECS_FLOAT delta_time, + void *param) { - (void)world; - - ecs_meta_type_op_t *op = ops_add(&ops, EcsOpEnum); - op->offset = offset, - op->type = type; - op->size = ECS_SIZEOF(ecs_i32_t); + return ecs_run_w_filter(world, system, delta_time, 0, 0, param); +} - return ops; +ecs_query_t* ecs_system_get_query( + const ecs_world_t *world, + ecs_entity_t system) +{ + const EcsQuery *q = ecs_get(world, system, EcsQuery); + if (q) { + return q->query; + } else { + const EcsSystem *s = ecs_get(world, system, EcsSystem); + if (s) { + return s->query; + } else { + return NULL; + } + } } -static -ecs_vector_t* serialize_bitmask( - ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) +void* ecs_get_system_ctx( + const ecs_world_t *world, + ecs_entity_t system) { - (void)world; - - ecs_meta_type_op_t *op = ops_add(&ops, EcsOpBitmask); - op->offset = offset, - op->type = type; - op->size = ECS_SIZEOF(ecs_u32_t); + const EcsSystem *s = ecs_get(world, system, EcsSystem); + if (s) { + return s->ctx; + } else { + return NULL; + } +} - return ops; +void* ecs_get_system_binding_ctx( + const ecs_world_t *world, + ecs_entity_t system) +{ + const EcsSystem *s = ecs_get(world, system, EcsSystem); + if (s) { + return s->binding_ctx; + } else { + return NULL; + } } +/* System destructor */ static -ecs_vector_t* serialize_array( - ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) -{ - (void)world; +ECS_DTOR(EcsSystem, ptr, { + if (!ecs_is_alive(world, entity)) { + /* This can happen when a set is deferred while a system is being + * cleaned up. The operation will be discarded, but the destructor + * still needs to be invoked for the value */ + continue; + } - ecs_meta_type_op_t *op = ops_add(&ops, EcsOpArray); - op->offset = offset; - op->type = type; - op->size = type_size(world, type); + /* Invoke Deactivated action for active systems */ + if (ptr->query && ecs_query_table_count(ptr->query)) { + invoke_status_action(world, entity, ptr, EcsSystemDeactivated); + } - return ops; -} + /* Invoke Disabled action for enabled systems */ + if (!ecs_has_id(world, entity, EcsDisabled)) { + invoke_status_action(world, entity, ptr, EcsSystemDisabled); + } -static -ecs_vector_t* serialize_array_component( - ecs_world_t *world, - ecs_entity_t type) -{ - const EcsArray *ptr = ecs_get(world, type, EcsArray); - if (!ptr) { - return NULL; /* Should never happen, will trigger internal error */ + if (ptr->ctx_free) { + ptr->ctx_free(ptr->ctx); } - ecs_vector_t *ops = serialize_type(world, ptr->type, 0, NULL); - ecs_assert(ops != NULL, ECS_INTERNAL_ERROR, NULL); + if (ptr->status_ctx_free) { + ptr->status_ctx_free(ptr->status_ctx); + } - ecs_meta_type_op_t *first = ecs_vector_first(ops, ecs_meta_type_op_t); - first->count = ptr->count; + if (ptr->binding_ctx_free) { + ptr->binding_ctx_free(ptr->binding_ctx); + } - return ops; -} + if (ptr->query) { + ecs_query_fini(ptr->query); + } +}) static -ecs_vector_t* serialize_vector( - ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) +void EnableMonitor( + ecs_iter_t *it) { - (void)world; + if (ecs_is_fini(it->world)) { + return; + } - ecs_meta_type_op_t *op = ops_add(&ops, EcsOpVector); - op->offset = offset; - op->type = type; - op->size = type_size(world, type); + EcsSystem *sys = ecs_term(it, EcsSystem, 1); - return ops; + int32_t i; + for (i = 0; i < it->count; i ++) { + if (it->event == EcsOnAdd) { + ecs_enable_system(it->world, it->entities[i], &sys[i], true); + } else if (it->event == EcsOnRemove) { + ecs_enable_system(it->world, it->entities[i], &sys[i], false); + } + } } -static -ecs_vector_t* serialize_struct( +ecs_entity_t ecs_system_init( ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) + const ecs_system_desc_t *desc) { - const EcsStruct *ptr = ecs_get(world, type, EcsStruct); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t cur, first = ecs_vector_count(ops); - ecs_meta_type_op_t *op = ops_add(&ops, EcsOpPush); - op->offset = offset; - op->type = type; - op->size = type_size(world, type); - - ecs_member_t *members = ecs_vector_first(ptr->members, ecs_member_t); - int32_t i, count = ecs_vector_count(ptr->members); + ecs_poly_assert(world, ecs_world_t); + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); - ecs_hashmap_t *member_index = NULL; - if (count) { - op->members = member_index = flecs_name_index_new(); + ecs_entity_t existing = desc->entity.entity; + ecs_entity_t result = ecs_entity_init(world, &desc->entity); + if (!result) { + return 0; } - for (i = 0; i < count; i ++) { - ecs_member_t *member = &members[i]; + bool added = false; + EcsSystem *system = ecs_get_mut(world, result, EcsSystem, &added); + if (added) { + ecs_check(desc->callback != NULL, ECS_INVALID_PARAMETER, NULL); - cur = ecs_vector_count(ops); - ops = serialize_type(world, member->type, offset + member->offset, ops); + memset(system, 0, sizeof(EcsSystem)); - op = ops_get(ops, cur); - if (!op->type) { - op->type = member->type; + ecs_query_desc_t query_desc = desc->query; + query_desc.filter.name = desc->entity.name; + query_desc.system = result; + + ecs_query_t *query = ecs_query_init(world, &query_desc); + if (!query) { + ecs_delete(world, result); + return 0; } - if (op->count <= 1) { - op->count = member->count; + /* Re-obtain pointer, as query may have added components */ + system = ecs_get_mut(world, result, EcsSystem, &added); + ecs_assert(added == false, ECS_INTERNAL_ERROR, NULL); + + /* Prevent the system from moving while we're initializing */ + ecs_defer_begin(world); + + system->entity = result; + system->query = query; + + system->run = desc->run; + system->action = desc->callback; + system->status_action = desc->status_callback; + + system->self = desc->self; + system->ctx = desc->ctx; + system->status_ctx = desc->status_ctx; + system->binding_ctx = desc->binding_ctx; + + system->ctx_free = desc->ctx_free; + system->status_ctx_free = desc->status_ctx_free; + system->binding_ctx_free = desc->binding_ctx_free; + + system->tick_source = desc->tick_source; + + system->multi_threaded = desc->multi_threaded; + system->no_staging = desc->no_staging; + + /* If tables have been matched with this system it is active, and we + * should activate the in terms, if any. This will ensure that any + * OnDemand systems get enabled. */ + if (ecs_query_table_count(query)) { + ecs_system_activate(world, result, true, system); + } else { + /* If system isn't matched with any tables, mark it as inactive. This + * causes it to be ignored by the main loop. When the system matches + * with a table it will be activated. */ + ecs_add_id(world, result, EcsInactive); } - const char *member_name = member->name; - op->name = member_name; - op->unit = member->unit; - op->op_count = ecs_vector_count(ops) - cur; + if (!ecs_has_id(world, result, EcsDisabled)) { + /* If system is already enabled, generate enable status. The API + * should guarantee that it exactly matches enable-disable + * notifications and activate-deactivate notifications. */ + invoke_status_action(world, result, system, EcsSystemEnabled); - flecs_name_index_ensure( - member_index, flecs_ito(uint64_t, cur - first - 1), - member_name, 0, 0); - } + /* If column system has active (non-empty) tables, also generate the + * activate status. */ + if (ecs_query_table_count(system->query)) { + invoke_status_action(world, result, system, EcsSystemActivated); + } + } - ops_add(&ops, EcsOpPop); - ops_get(ops, first)->op_count = ecs_vector_count(ops) - first; + if (desc->interval != 0 || desc->rate != 0 || desc->tick_source != 0) { +#ifdef FLECS_TIMER + if (desc->interval != 0) { + ecs_set_interval(world, result, desc->interval); + } - return ops; -} + if (desc->rate) { + ecs_set_rate(world, result, desc->rate, desc->tick_source); + } else if (desc->tick_source) { + ecs_set_tick_source(world, result, desc->tick_source); + } +#else + ecs_abort(ECS_UNSUPPORTED, "timer module not available"); +#endif + } -static -ecs_vector_t* serialize_type( - ecs_world_t *world, - ecs_entity_t type, - ecs_size_t offset, - ecs_vector_t *ops) -{ - const EcsMetaType *ptr = ecs_get(world, type, EcsMetaType); - if (!ptr) { - char *path = ecs_get_fullpath(world, type); - ecs_err("missing EcsMetaType for type %s'", path); - ecs_os_free(path); - return NULL; - } + ecs_modified(world, result, EcsSystem); - switch(ptr->kind) { - case EcsPrimitiveType: - ops = serialize_primitive(world, type, offset, ops); - break; + if (desc->entity.name) { + ecs_trace("#[green]system#[reset] %s created", + ecs_get_name(world, result)); + } - case EcsEnumType: - ops = serialize_enum(world, type, offset, ops); - break; + ecs_defer_end(world); + } else { + const char *expr_desc = desc->query.filter.expr; + const char *expr_sys = system->query->filter.expr; - case EcsBitmaskType: - ops = serialize_bitmask(world, type, offset, ops); - break; + /* Only check expression if it's set */ + if (expr_desc) { + if (expr_sys && !strcmp(expr_sys, "0")) expr_sys = NULL; + if (expr_desc && !strcmp(expr_desc, "0")) expr_desc = NULL; - case EcsStructType: - ops = serialize_struct(world, type, offset, ops); - break; + if (expr_sys && expr_desc) { + if (strcmp(expr_sys, expr_desc)) { + ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); + } + } else { + if (expr_sys != expr_desc) { + ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); + } + } - case EcsArrayType: - ops = serialize_array(world, type, offset, ops); - break; + /* If expr_desc is not set, and this is an existing system, don't throw + * an error because we could be updating existing parameters of the + * system such as the context or system callback. However, if no + * entity handle was provided, we have to assume that the application is + * trying to redeclare the system. */ + } else if (!existing) { + if (expr_sys) { + ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); + } + } - case EcsVectorType: - ops = serialize_vector(world, type, offset, ops); - break; + if (desc->run) { + system->run = desc->run; + } + if (desc->callback) { + system->action = desc->callback; + } + if (desc->ctx) { + system->ctx = desc->ctx; + } + if (desc->binding_ctx) { + system->binding_ctx = desc->binding_ctx; + } + if (desc->query.filter.instanced) { + system->query->filter.instanced = true; + } + if (desc->multi_threaded) { + system->multi_threaded = desc->multi_threaded; + } + if (desc->no_staging) { + system->no_staging = desc->no_staging; + } } - return ops; + return result; +error: + return 0; } -static -ecs_vector_t* serialize_component( - ecs_world_t *world, - ecs_entity_t type) +void FlecsSystemImport( + ecs_world_t *world) { - const EcsMetaType *ptr = ecs_get(world, type, EcsMetaType); - if (!ptr) { - char *path = ecs_get_fullpath(world, type); - ecs_err("missing EcsMetaType for type %s'", path); - ecs_os_free(path); - return NULL; - } + ECS_MODULE(world, FlecsSystem); - ecs_vector_t *ops = NULL; + ecs_set_name_prefix(world, "Ecs"); - switch(ptr->kind) { - case EcsArrayType: - ops = serialize_array_component(world, type); - break; - default: - ops = serialize_type(world, type, 0, NULL); - break; - } + flecs_bootstrap_component(world, EcsSystem); + flecs_bootstrap_component(world, EcsTickSource); - return ops; + /* Put following tags in flecs.core so they can be looked up + * without using the flecs.systems prefix. */ + ecs_entity_t old_scope = ecs_set_scope(world, EcsFlecsCore); + flecs_bootstrap_tag(world, EcsInactive); + flecs_bootstrap_tag(world, EcsMonitor); + ecs_set_scope(world, old_scope); + + /* Bootstrap ctor and dtor for EcsSystem */ + ecs_set_component_actions_w_id(world, ecs_id(EcsSystem), + &(EcsComponentLifecycle) { + .ctor = ecs_default_ctor, + .dtor = ecs_dtor(EcsSystem) + }); + + ecs_observer_init(world, &(ecs_observer_desc_t) { + .entity.name = "EnableMonitor", + .filter.terms = { + { .id = ecs_id(EcsSystem) }, + { .id = EcsDisabled, .oper = EcsNot }, + }, + .events = {EcsMonitor}, + .callback = EnableMonitor + }); } -void ecs_meta_type_serialized_init( - ecs_iter_t *it) -{ - ecs_world_t *world = it->world; +#endif - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_vector_t *ops = serialize_component(world, e); - ecs_assert(ops != NULL, ECS_INTERNAL_ERROR, NULL); - EcsMetaTypeSerialized *ptr = ecs_get_mut( - world, e, EcsMetaTypeSerialized, NULL); - if (ptr->ops) { - ecs_meta_dtor_serialized(ptr); - } +#ifdef FLECS_JSON - ptr->ops = ops; - } -} +void json_next( + ecs_strbuf_t *buf); + +void json_literal( + ecs_strbuf_t *buf, + const char *value); + +void json_number( + ecs_strbuf_t *buf, + double value); + +void json_true( + ecs_strbuf_t *buf); + +void json_false( + ecs_strbuf_t *buf); + +void json_bool( + ecs_strbuf_t *buf, + bool value); + +void json_array_push( + ecs_strbuf_t *buf); + +void json_array_pop( + ecs_strbuf_t *buf); + +void json_object_push( + ecs_strbuf_t *buf); + +void json_object_pop( + ecs_strbuf_t *buf); + +void json_string( + ecs_strbuf_t *buf, + const char *value); + +void json_member( + ecs_strbuf_t *buf, + const char *name); + +void json_path( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_entity_t e); + +void json_label( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_entity_t e); + +void json_id( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_id_t id); + +ecs_primitive_kind_t json_op_to_primitive_kind( + ecs_meta_type_op_kind_t kind); #endif -#ifdef FLECS_META +#ifdef FLECS_JSON -/* EcsMetaTypeSerialized lifecycle */ +void json_next( + ecs_strbuf_t *buf) +{ + ecs_strbuf_list_next(buf); +} -void ecs_meta_dtor_serialized( - EcsMetaTypeSerialized *ptr) +void json_literal( + ecs_strbuf_t *buf, + const char *value) { - int32_t i, count = ecs_vector_count(ptr->ops); - ecs_meta_type_op_t *ops = ecs_vector_first(ptr->ops, ecs_meta_type_op_t); - - for (i = 0; i < count; i ++) { - ecs_meta_type_op_t *op = &ops[i]; - if (op->members) { - flecs_hashmap_fini(op->members); - ecs_os_free(op->members); - } - } + ecs_strbuf_appendstr(buf, value); +} - ecs_vector_free(ptr->ops); +void json_number( + ecs_strbuf_t *buf, + double value) +{ + ecs_strbuf_appendflt(buf, value, '"'); } -static ECS_COPY(EcsMetaTypeSerialized, dst, src, { - ecs_meta_dtor_serialized(dst); +void json_true( + ecs_strbuf_t *buf) +{ + json_literal(buf, "true"); +} - dst->ops = ecs_vector_copy(src->ops, ecs_meta_type_op_t); +void json_false( + ecs_strbuf_t *buf) +{ + json_literal(buf, "false"); +} - int32_t o, count = ecs_vector_count(src->ops); - ecs_meta_type_op_t *ops = ecs_vector_first(src->ops, ecs_meta_type_op_t); - - for (o = 0; o < count; o ++) { - ecs_meta_type_op_t *op = &ops[o]; - if (op->members) { - op->members = ecs_os_memdup_t(op->members, ecs_hashmap_t); - flecs_hashmap_copy(op->members, op->members); - } +void json_bool( + ecs_strbuf_t *buf, + bool value) +{ + if (value) { + json_true(buf); + } else { + json_false(buf); } -}) +} -static ECS_MOVE(EcsMetaTypeSerialized, dst, src, { - ecs_meta_dtor_serialized(dst); - dst->ops = src->ops; - src->ops = NULL; -}) +void json_array_push( + ecs_strbuf_t *buf) +{ + ecs_strbuf_list_push(buf, "[", ", "); +} -static ECS_DTOR(EcsMetaTypeSerialized, ptr, { - ecs_meta_dtor_serialized(ptr); -}) +void json_array_pop( + ecs_strbuf_t *buf) +{ + ecs_strbuf_list_pop(buf, "]"); +} +void json_object_push( + ecs_strbuf_t *buf) +{ + ecs_strbuf_list_push(buf, "{", ", "); +} -/* EcsStruct lifecycle */ +void json_object_pop( + ecs_strbuf_t *buf) +{ + ecs_strbuf_list_pop(buf, "}"); +} -static void dtor_struct( - EcsStruct *ptr) +void json_string( + ecs_strbuf_t *buf, + const char *value) { - ecs_member_t *members = ecs_vector_first(ptr->members, ecs_member_t); - int32_t i, count = ecs_vector_count(ptr->members); - for (i = 0; i < count; i ++) { - ecs_os_free((char*)members[i].name); - } - ecs_vector_free(ptr->members); + ecs_strbuf_appendch(buf, '"'); + ecs_strbuf_appendstr(buf, value); + ecs_strbuf_appendch(buf, '"'); } -static ECS_COPY(EcsStruct, dst, src, { - dtor_struct(dst); +void json_member( + ecs_strbuf_t *buf, + const char *name) +{ + ecs_strbuf_list_appendstr(buf, "\""); + ecs_strbuf_appendstr(buf, name); + ecs_strbuf_appendstr(buf, "\":"); +} - dst->members = ecs_vector_copy(src->members, ecs_member_t); +void json_path( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_entity_t e) +{ + ecs_strbuf_appendch(buf, '"'); + ecs_get_path_w_sep_buf(world, 0, e, ".", "", buf); + ecs_strbuf_appendch(buf, '"'); +} - ecs_member_t *members = ecs_vector_first(dst->members, ecs_member_t); - int32_t m, count = ecs_vector_count(dst->members); +void json_label( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_entity_t e) +{ + const char *lbl = NULL; +#ifdef FLECS_DOC + lbl = ecs_doc_get_name(world, e); +#else + lbl = ecs_get_name(world, e); +#endif - for (m = 0; m < count; m ++) { - members[m].name = ecs_os_strdup(members[m].name); + if (lbl) { + ecs_strbuf_appendch(buf, '"'); + ecs_strbuf_appendstr(buf, lbl); + ecs_strbuf_appendch(buf, '"'); + } else { + ecs_strbuf_appendstr(buf, "0"); } -}) - -static ECS_MOVE(EcsStruct, dst, src, { - dtor_struct(dst); - dst->members = src->members; - src->members = NULL; -}) - -static ECS_DTOR(EcsStruct, ptr, { dtor_struct(ptr); }) - +} -/* EcsEnum lifecycle */ +void json_id( + ecs_strbuf_t *buf, + const ecs_world_t *world, + ecs_id_t id) +{ + ecs_strbuf_appendch(buf, '"'); + ecs_id_str_buf(world, id, buf); + ecs_strbuf_appendch(buf, '"'); +} -static void dtor_enum( - EcsEnum *ptr) +ecs_primitive_kind_t json_op_to_primitive_kind( + ecs_meta_type_op_kind_t kind) { - ecs_map_iter_t it = ecs_map_iter(ptr->constants); - ecs_enum_constant_t *c; - while ((c = ecs_map_next(&it, ecs_enum_constant_t, NULL))) { - ecs_os_free((char*)c->name); - } - ecs_map_free(ptr->constants); + return kind - EcsOpPrimitive; } -static ECS_COPY(EcsEnum, dst, src, { - dtor_enum(dst); +#endif - dst->constants = ecs_map_copy(src->constants); - ecs_assert(ecs_map_count(dst->constants) == ecs_map_count(src->constants), - ECS_INTERNAL_ERROR, NULL); - ecs_map_iter_t it = ecs_map_iter(dst->constants); - ecs_enum_constant_t *c; - while ((c = ecs_map_next(&it, ecs_enum_constant_t, NULL))) { - c->name = ecs_os_strdup(c->name); - } -}) +#include -static ECS_MOVE(EcsEnum, dst, src, { - dtor_enum(dst); - dst->constants = src->constants; - src->constants = NULL; -}) +#ifdef FLECS_JSON -static ECS_DTOR(EcsEnum, ptr, { dtor_enum(ptr); }) +static +int json_ser_type( + const ecs_world_t *world, + ecs_vector_t *ser, + const void *base, + ecs_strbuf_t *str); +static +int json_ser_type_ops( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + ecs_strbuf_t *str); -/* EcsBitmask lifecycle */ +static +int json_ser_type_op( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str); -static void dtor_bitmask( - EcsBitmask *ptr) +/* Serialize enumeration */ +static +int json_ser_enum( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str) { - ecs_map_iter_t it = ecs_map_iter(ptr->constants); - ecs_bitmask_constant_t *c; - while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, NULL))) { - ecs_os_free((char*)c->name); + const EcsEnum *enum_type = ecs_get(world, op->type, EcsEnum); + ecs_check(enum_type != NULL, ECS_INVALID_PARAMETER, NULL); + + int32_t value = *(int32_t*)base; + + /* Enumeration constants are stored in a map that is keyed on the + * enumeration value. */ + ecs_enum_constant_t *constant = ecs_map_get( + enum_type->constants, ecs_enum_constant_t, value); + if (!constant) { + goto error; } - ecs_map_free(ptr->constants); + + ecs_strbuf_appendch(str, '"'); + ecs_strbuf_appendstr(str, ecs_get_name(world, constant->constant)); + ecs_strbuf_appendch(str, '"'); + + return 0; +error: + return -1; } -static ECS_COPY(EcsBitmask, dst, src, { - dtor_bitmask(dst); +/* Serialize bitmask */ +static +int json_ser_bitmask( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + const EcsBitmask *bitmask_type = ecs_get(world, op->type, EcsBitmask); + ecs_check(bitmask_type != NULL, ECS_INVALID_PARAMETER, NULL); - dst->constants = ecs_map_copy(src->constants); - ecs_assert(ecs_map_count(dst->constants) == ecs_map_count(src->constants), - ECS_INTERNAL_ERROR, NULL); + uint32_t value = *(uint32_t*)ptr; + ecs_map_key_t key; + ecs_bitmask_constant_t *constant; - ecs_map_iter_t it = ecs_map_iter(dst->constants); - ecs_bitmask_constant_t *c; - while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, NULL))) { - c->name = ecs_os_strdup(c->name); + if (!value) { + ecs_strbuf_appendch(str, '0'); + return 0; } -}) -static ECS_MOVE(EcsBitmask, dst, src, { - dtor_bitmask(dst); - dst->constants = src->constants; - src->constants = NULL; -}) + ecs_strbuf_list_push(str, "\"", "|"); -static ECS_DTOR(EcsBitmask, ptr, { dtor_bitmask(ptr); }) + /* Multiple flags can be set at a given time. Iterate through all the flags + * and append the ones that are set. */ + ecs_map_iter_t it = ecs_map_iter(bitmask_type->constants); + while ((constant = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { + if ((value & key) == key) { + ecs_strbuf_list_appendstr(str, + ecs_get_name(world, constant->constant)); + value -= (uint32_t)key; + } + } + if (value != 0) { + /* All bits must have been matched by a constant */ + goto error; + } -/* EcsUnit lifecycle */ + ecs_strbuf_list_pop(str, "\""); -static void dtor_unit( - EcsUnit *ptr) -{ - ecs_os_free(ptr->symbol); + return 0; +error: + return -1; } -static ECS_COPY(EcsUnit, dst, src, { - dtor_unit(dst); - dst->symbol = ecs_os_strdup(src->symbol); - dst->base = src->base; - dst->over = src->over; - dst->prefix = src->prefix; - dst->translation = src->translation; -}) - -static ECS_MOVE(EcsUnit, dst, src, { - dtor_unit(dst); - dst->symbol = src->symbol; - dst->base = src->base; - dst->over = src->over; - dst->prefix = src->prefix; - dst->translation = src->translation; - - src->symbol = NULL; - src->base = 0; - src->over = 0; - src->prefix = 0; - src->translation = (ecs_unit_translation_t){0}; -}) +/* Serialize elements of a contiguous array */ +static +int json_ser_elements( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + int32_t elem_count, + int32_t elem_size, + ecs_strbuf_t *str) +{ + json_array_push(str); -static ECS_DTOR(EcsUnit, ptr, { dtor_unit(ptr); }) + const void *ptr = base; + int i; + for (i = 0; i < elem_count; i ++) { + ecs_strbuf_list_next(str); + if (json_ser_type_ops(world, ops, op_count, ptr, str)) { + return -1; + } + ptr = ECS_OFFSET(ptr, elem_size); + } -/* EcsUnitPrefix lifecycle */ + json_array_pop(str); -static void dtor_unit_prefix( - EcsUnitPrefix *ptr) -{ - ecs_os_free(ptr->symbol); + return 0; } -static ECS_COPY(EcsUnitPrefix, dst, src, { - dtor_unit_prefix(dst); - dst->symbol = ecs_os_strdup(src->symbol); - dst->translation = src->translation; -}) +static +int json_ser_type_elements( + const ecs_world_t *world, + ecs_entity_t type, + const void *base, + int32_t elem_count, + ecs_strbuf_t *str) +{ + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + ecs_assert(ser != NULL, ECS_INTERNAL_ERROR, NULL); -static ECS_MOVE(EcsUnitPrefix, dst, src, { - dtor_unit_prefix(dst); - dst->symbol = src->symbol; - dst->translation = src->translation; + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - src->symbol = NULL; - src->translation = (ecs_unit_translation_t){0}; -}) + ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); + int32_t op_count = ecs_vector_count(ser->ops); -static ECS_DTOR(EcsUnitPrefix, ptr, { dtor_unit_prefix(ptr); }) + return json_ser_elements( + world, ops, op_count, base, elem_count, comp->size, str); +} +/* Serialize array */ +static +int json_ser_array( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + const EcsArray *a = ecs_get(world, op->type, EcsArray); + ecs_assert(a != NULL, ECS_INTERNAL_ERROR, NULL); -/* Type initialization */ + return json_ser_type_elements( + world, a->type, ptr, a->count, str); +} +/* Serialize vector */ static -int init_type( - ecs_world_t *world, - ecs_entity_t type, - ecs_type_kind_t kind, - ecs_size_t size, - ecs_size_t alignment) +int json_ser_vector( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *base, + ecs_strbuf_t *str) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(type != 0, ECS_INTERNAL_ERROR, NULL); + ecs_vector_t *value = *(ecs_vector_t**)base; + if (!value) { + ecs_strbuf_appendstr(str, "null"); + return 0; + } - bool is_added = false; - EcsMetaType *meta_type = ecs_get_mut(world, type, EcsMetaType, &is_added); - if (is_added) { - meta_type->existing = ecs_has(world, type, EcsComponent); + const EcsVector *v = ecs_get(world, op->type, EcsVector); + ecs_assert(v != NULL, ECS_INTERNAL_ERROR, NULL); - /* Ensure that component has a default constructor, to prevent crashing - * serializers on uninitialized values. */ - ecs_type_info_t *ti = flecs_ensure_type_info(world, type); - if (!ti->lifecycle.ctor) { - ti->lifecycle.ctor = ecs_default_ctor; + const EcsComponent *comp = ecs_get(world, v->type, EcsComponent); + ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); + + int32_t count = ecs_vector_count(value); + void *array = ecs_vector_first_t(value, comp->size, comp->alignment); + + /* Serialize contiguous buffer of vector */ + return json_ser_type_elements(world, v->type, array, count, str); +} + +/* Forward serialization to the different type kinds */ +static +int json_ser_type_op( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + const void *ptr, + ecs_strbuf_t *str) +{ + switch(op->kind) { + case EcsOpPush: + case EcsOpPop: + /* Should not be parsed as single op */ + ecs_throw(ECS_INVALID_PARAMETER, NULL); + break; + case EcsOpF32: + ecs_strbuf_appendflt(str, + (ecs_f64_t)*(ecs_f32_t*)ECS_OFFSET(ptr, op->offset), '"'); + break; + case EcsOpF64: + ecs_strbuf_appendflt(str, + *(ecs_f64_t*)ECS_OFFSET(ptr, op->offset), '"'); + break; + case EcsOpEnum: + if (json_ser_enum(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; } - } else { - if (meta_type->kind != kind) { - ecs_err("type '%s' reregistered with different kind", - ecs_get_name(world, type)); - return -1; + break; + case EcsOpBitmask: + if (json_ser_bitmask(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; } - } - - if (!meta_type->existing) { - EcsComponent *comp = ecs_get_mut(world, type, EcsComponent, NULL); - comp->size = size; - comp->alignment = alignment; - ecs_modified(world, type, EcsComponent); - } else { - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - if (comp->size < size) { - ecs_err("computed size for '%s' is larger than actual type", - ecs_get_name(world, type)); - return -1; + break; + case EcsOpArray: + if (json_ser_array(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; } - if (comp->alignment < alignment) { - ecs_err("computed alignment for '%s' is larger than actual type", - ecs_get_name(world, type)); - return -1; + break; + case EcsOpVector: + if (json_ser_vector(world, op, ECS_OFFSET(ptr, op->offset), str)) { + goto error; + } + break; + case EcsOpEntity: { + ecs_entity_t e = *(ecs_entity_t*)ECS_OFFSET(ptr, op->offset); + if (!e) { + ecs_strbuf_appendch(str, '0'); + } else { + json_path(str, world, e); } - if (comp->size == size && comp->alignment != alignment) { - ecs_err("computed size for '%s' matches with actual type but " - "alignment is different", ecs_get_name(world, type)); + break; + } + + default: + if (ecs_primitive_to_expr_buf(world, + json_op_to_primitive_kind(op->kind), + ECS_OFFSET(ptr, op->offset), str)) + { + /* Unknown operation */ + ecs_throw(ECS_INTERNAL_ERROR, NULL); return -1; } - - meta_type->partial = comp->size != size; + break; } - meta_type->kind = kind; - meta_type->size = size; - meta_type->alignment = alignment; - ecs_modified(world, type, EcsMetaType); - return 0; +error: + return -1; } -#define init_type_t(world, type, kind, T) \ - init_type(world, type, kind, ECS_SIZEOF(T), ECS_ALIGNOF(T)) - -static -void set_struct_member( - ecs_member_t *member, - ecs_entity_t entity, - const char *name, - ecs_entity_t type, - int32_t count, - ecs_entity_t unit) -{ - member->member = entity; - member->type = type; - member->count = count; - member->unit = unit; - - if (!count) { - member->count = 1; - } - - ecs_os_strset((char**)&member->name, name); -} - +/* Iterate over a slice of the type ops array */ static -int add_member_to_struct( - ecs_world_t *world, - ecs_entity_t type, - ecs_entity_t member, - EcsMember *m) +int json_ser_type_ops( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + const void *base, + ecs_strbuf_t *str) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(type != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(member != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(m != NULL, ECS_INTERNAL_ERROR, NULL); - - const char *name = ecs_get_name(world, member); - if (!name) { - char *path = ecs_get_fullpath(world, type); - ecs_err("member for struct '%s' does not have a name", path); - ecs_os_free(path); - return -1; - } - - if (!m->type) { - char *path = ecs_get_fullpath(world, member); - ecs_err("member '%s' does not have a type", path); - ecs_os_free(path); - return -1; - } - - if (ecs_get_typeid(world, m->type) == 0) { - char *path = ecs_get_fullpath(world, member); - char *ent_path = ecs_get_fullpath(world, m->type); - ecs_err("member '%s.type' is '%s' which is not a type", path, ent_path); - ecs_os_free(path); - ecs_os_free(ent_path); - return -1; - } + for (int i = 0; i < op_count; i ++) { + ecs_meta_type_op_t *op = &ops[i]; - ecs_entity_t unit = m->unit; + if (op != ops) { + if (op->name) { + json_member(str, op->name); + } - if (unit) { - if (!ecs_has(world, unit, EcsUnit)) { - ecs_err("entity '%s' for member '%s' is not a unit", - ecs_get_name(world, unit), name); - return -1; - } + int32_t elem_count = op->count; + if (elem_count > 1 && op != ops) { + /* Serialize inline array */ + if (json_ser_elements(world, op, op->op_count, base, + elem_count, op->size, str)) + { + return -1; + } - if (ecs_has(world, m->type, EcsUnit) && m->type != unit) { - ecs_err("unit mismatch for type '%s' and unit '%s' for member '%s'", - ecs_get_name(world, m->type), ecs_get_name(world, unit), name); - return -1; - } - } else { - if (ecs_has(world, m->type, EcsUnit)) { - unit = m->type; - m->unit = unit; + i += op->op_count - 1; + continue; + } } - } - - EcsStruct *s = ecs_get_mut(world, type, EcsStruct, NULL); - ecs_assert(s != NULL, ECS_INTERNAL_ERROR, NULL); - - /* First check if member is already added to struct */ - ecs_member_t *members = ecs_vector_first(s->members, ecs_member_t); - int32_t i, count = ecs_vector_count(s->members); - for (i = 0; i < count; i ++) { - if (members[i].member == member) { - set_struct_member( - &members[i], member, name, m->type, m->count, unit); + + switch(op->kind) { + case EcsOpPush: + json_object_push(str); + break; + case EcsOpPop: + json_object_pop(str); + break; + default: + if (json_ser_type_op(world, op, base, str)) { + goto error; + } break; } } - /* If member wasn't added yet, add a new element to vector */ - if (i == count) { - ecs_member_t *elem = ecs_vector_add(&s->members, ecs_member_t); - elem->name = NULL; - set_struct_member(elem, member, name, m->type, m->count, unit); - - /* Reobtain members array in case it was reallocated */ - members = ecs_vector_first(s->members, ecs_member_t); - count ++; - } + return 0; +error: + return -1; +} - /* Compute member offsets and size & alignment of struct */ - ecs_size_t size = 0; - ecs_size_t alignment = 0; +/* Iterate over the type ops of a type */ +static +int json_ser_type( + const ecs_world_t *world, + ecs_vector_t *v_ops, + const void *base, + ecs_strbuf_t *str) +{ + ecs_meta_type_op_t *ops = ecs_vector_first(v_ops, ecs_meta_type_op_t); + int32_t count = ecs_vector_count(v_ops); + return json_ser_type_ops(world, ops, count, base, str); +} - for (i = 0; i < count; i ++) { - ecs_member_t *elem = &members[i]; +static +int array_to_json_buf_w_type_data( + const ecs_world_t *world, + const void *ptr, + int32_t count, + ecs_strbuf_t *buf, + const EcsComponent *comp, + const EcsMetaTypeSerialized *ser) +{ + if (count) { + ecs_size_t size = comp->size; - ecs_assert(elem->name != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(elem->type != 0, ECS_INTERNAL_ERROR, NULL); + json_array_push(buf); - /* Get component of member type to get its size & alignment */ - const EcsComponent *mbr_comp = ecs_get(world, elem->type, EcsComponent); - if (!mbr_comp) { - char *path = ecs_get_fullpath(world, member); - ecs_err("member '%s' is not a type", path); - ecs_os_free(path); - return -1; - } + do { + ecs_strbuf_list_next(buf); + if (json_ser_type(world, ser->ops, ptr, buf)) { + return -1; + } - ecs_size_t member_size = mbr_comp->size; - ecs_size_t member_alignment = mbr_comp->alignment; + ptr = ECS_OFFSET(ptr, size); + } while (-- count); - if (!member_size || !member_alignment) { - char *path = ecs_get_fullpath(world, member); - ecs_err("member '%s' has 0 size/alignment"); - ecs_os_free(path); + json_array_pop(buf); + } else { + if (json_ser_type(world, ser->ops, ptr, buf)) { return -1; } - - member_size *= elem->count; - size = ECS_ALIGN(size, member_alignment); - elem->size = member_size; - elem->offset = size; - - size += member_size; - - if (member_alignment > alignment) { - alignment = member_alignment; - } } - if (size == 0) { - ecs_err("struct '%s' has 0 size", ecs_get_name(world, type)); - return -1; - } + return 0; +} - if (alignment == 0) { - ecs_err("struct '%s' has 0 alignment", ecs_get_name(world, type)); +int ecs_array_to_json_buf( + const ecs_world_t *world, + ecs_entity_t type, + const void *ptr, + int32_t count, + ecs_strbuf_t *buf) +{ + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + if (!comp) { + char *path = ecs_get_fullpath(world, type); + ecs_err("cannot serialize to JSON, '%s' is not a component", path); + ecs_os_free(path); return -1; } - /* Align struct size to struct alignment */ - size = ECS_ALIGN(size, alignment); - - ecs_modified(world, type, EcsStruct); - - /* Do this last as it triggers the update of EcsMetaTypeSerialized */ - if (init_type(world, type, EcsStructType, size, alignment)) { + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + if (!ser) { + char *path = ecs_get_fullpath(world, type); + ecs_err("cannot serialize to JSON, '%s' has no reflection data", path); + ecs_os_free(path); return -1; } - /* If current struct is also a member, assign to itself */ - if (ecs_has(world, type, EcsMember)) { - EcsMember *type_mbr = ecs_get_mut(world, type, EcsMember, NULL); - ecs_assert(type_mbr != NULL, ECS_INTERNAL_ERROR, NULL); - - type_mbr->type = type; - type_mbr->count = 1; - - ecs_modified(world, type, EcsMember); - } - - return 0; + return array_to_json_buf_w_type_data(world, ptr, count, buf, comp, ser); } -static -int add_constant_to_enum( - ecs_world_t *world, +char* ecs_array_to_json( + const ecs_world_t *world, ecs_entity_t type, - ecs_entity_t e, - ecs_id_t constant_id) + const void* ptr, + int32_t count) { - EcsEnum *ptr = ecs_get_mut(world, type, EcsEnum, NULL); - - /* Remove constant from map if it was already added */ - ecs_map_iter_t it = ecs_map_iter(ptr->constants); - ecs_enum_constant_t *c; - ecs_map_key_t key; - while ((c = ecs_map_next(&it, ecs_enum_constant_t, &key))) { - if (c->constant == e) { - ecs_os_free((char*)c->name); - ecs_map_remove(ptr->constants, key); - } - } - - /* Check if constant sets explicit value */ - int32_t value = 0; - bool value_set = false; - if (ecs_id_is_pair(constant_id)) { - if (ecs_pair_second(world, constant_id) != ecs_id(ecs_i32_t)) { - char *path = ecs_get_fullpath(world, e); - ecs_err("expected i32 type for enum constant '%s'", path); - ecs_os_free(path); - return -1; - } - - const int32_t *value_ptr = ecs_get_pair_object( - world, e, EcsConstant, ecs_i32_t); - ecs_assert(value_ptr != NULL, ECS_INTERNAL_ERROR, NULL); - value = *value_ptr; - value_set = true; - } - - /* Make sure constant value doesn't conflict if set / find the next value */ - it = ecs_map_iter(ptr->constants); - while ((c = ecs_map_next(&it, ecs_enum_constant_t, &key))) { - if (value_set) { - if (c->value == value) { - char *path = ecs_get_fullpath(world, e); - ecs_err("conflicting constant value for '%s' (other is '%s')", - path, c->name); - ecs_os_free(path); - return -1; - } - } else { - if (c->value >= value) { - value = c->value + 1; - } - } - } + ecs_strbuf_t str = ECS_STRBUF_INIT; - if (!ptr->constants) { - ptr->constants = ecs_map_new(ecs_enum_constant_t, 1); + if (ecs_array_to_json_buf(world, type, ptr, count, &str) != 0) { + ecs_strbuf_reset(&str); + return NULL; } - c = ecs_map_ensure(ptr->constants, ecs_enum_constant_t, value); - c->name = ecs_os_strdup(ecs_get_name(world, e)); - c->value = value; - c->constant = e; - - ecs_i32_t *cptr = ecs_get_mut_pair_object( - world, e, EcsConstant, ecs_i32_t, NULL); - ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); - cptr[0] = value; + return ecs_strbuf_get(&str); +} - return 0; +int ecs_ptr_to_json_buf( + const ecs_world_t *world, + ecs_entity_t type, + const void *ptr, + ecs_strbuf_t *buf) +{ + return ecs_array_to_json_buf(world, type, ptr, 0, buf); } -static -int add_constant_to_bitmask( - ecs_world_t *world, +char* ecs_ptr_to_json( + const ecs_world_t *world, ecs_entity_t type, - ecs_entity_t e, - ecs_id_t constant_id) + const void* ptr) { - EcsBitmask *ptr = ecs_get_mut(world, type, EcsBitmask, NULL); - - /* Remove constant from map if it was already added */ - ecs_map_iter_t it = ecs_map_iter(ptr->constants); - ecs_bitmask_constant_t *c; - ecs_map_key_t key; - while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { - if (c->constant == e) { - ecs_os_free((char*)c->name); - ecs_map_remove(ptr->constants, key); - } - } + return ecs_array_to_json(world, type, ptr, 0); +} - /* Check if constant sets explicit value */ - uint32_t value = 1; - if (ecs_id_is_pair(constant_id)) { - if (ecs_pair_second(world, constant_id) != ecs_id(ecs_u32_t)) { - char *path = ecs_get_fullpath(world, e); - ecs_err("expected u32 type for bitmask constant '%s'", path); - ecs_os_free(path); - return -1; - } +static +bool skip_id( + const ecs_world_t *world, + ecs_id_t id, + const ecs_entity_to_json_desc_t *desc, + ecs_entity_t ent, + ecs_entity_t inst, + ecs_entity_t *pred_out, + ecs_entity_t *obj_out, + ecs_entity_t *role_out, + bool *hidden_out) +{ + bool is_base = ent != inst; + ecs_entity_t pred = 0, obj = 0, role = 0; + bool hidden = false; - const uint32_t *value_ptr = ecs_get_pair_object( - world, e, EcsConstant, ecs_u32_t); - ecs_assert(value_ptr != NULL, ECS_INTERNAL_ERROR, NULL); - value = *value_ptr; + if (ECS_HAS_ROLE(id, PAIR)) { + pred = ecs_pair_first(world, id); + obj = ecs_pair_second(world, id); } else { - value = 1u << (ecs_u32_t)ecs_map_count(ptr->constants); + pred = id & ECS_COMPONENT_MASK; + if (id & ECS_ROLE_MASK) { + role = id & ECS_ROLE_MASK; + } } - /* Make sure constant value doesn't conflict */ - it = ecs_map_iter(ptr->constants); - while ((c = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { - if (c->value == value) { - char *path = ecs_get_fullpath(world, e); - ecs_err("conflicting constant value for '%s' (other is '%s')", - path, c->name); - ecs_os_free(path); - return -1; + if (!desc || !desc->serialize_meta_ids) { + if (pred == EcsIsA || pred == EcsChildOf || + pred == ecs_id(EcsIdentifier)) + { + return true; } +#ifdef FLECS_DOC + if (pred == ecs_id(EcsDocDescription)) { + return true; + } +#endif } - if (!ptr->constants) { - ptr->constants = ecs_map_new(ecs_bitmask_constant_t, 1); + if (is_base) { + if (ecs_has_id(world, pred, EcsDontInherit)) { + return true; + } } - - c = ecs_map_ensure(ptr->constants, ecs_bitmask_constant_t, value); - c->name = ecs_os_strdup(ecs_get_name(world, e)); - c->value = value; - c->constant = e; - - ecs_u32_t *cptr = ecs_get_mut_pair_object( - world, e, EcsConstant, ecs_u32_t, NULL); - ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); - cptr[0] = value; - - return 0; -} - -static -void set_primitive(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsPrimitive *type = ecs_term(it, EcsPrimitive, 1); - - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - switch(type->kind) { - case EcsBool: - init_type_t(world, e, EcsPrimitiveType, bool); - break; - case EcsChar: - init_type_t(world, e, EcsPrimitiveType, char); - break; - case EcsByte: - init_type_t(world, e, EcsPrimitiveType, bool); - break; - case EcsU8: - init_type_t(world, e, EcsPrimitiveType, uint8_t); - break; - case EcsU16: - init_type_t(world, e, EcsPrimitiveType, uint16_t); - break; - case EcsU32: - init_type_t(world, e, EcsPrimitiveType, uint32_t); - break; - case EcsU64: - init_type_t(world, e, EcsPrimitiveType, uint64_t); - break; - case EcsI8: - init_type_t(world, e, EcsPrimitiveType, int8_t); - break; - case EcsI16: - init_type_t(world, e, EcsPrimitiveType, int16_t); - break; - case EcsI32: - init_type_t(world, e, EcsPrimitiveType, int32_t); - break; - case EcsI64: - init_type_t(world, e, EcsPrimitiveType, int64_t); - break; - case EcsF32: - init_type_t(world, e, EcsPrimitiveType, float); - break; - case EcsF64: - init_type_t(world, e, EcsPrimitiveType, double); - break; - case EcsUPtr: - init_type_t(world, e, EcsPrimitiveType, uintptr_t); - break; - case EcsIPtr: - init_type_t(world, e, EcsPrimitiveType, intptr_t); - break; - case EcsString: - init_type_t(world, e, EcsPrimitiveType, char*); - break; - case EcsEntity: - init_type_t(world, e, EcsPrimitiveType, ecs_entity_t); - break; + if (!desc || !desc->serialize_private) { + if (ecs_has_id(world, pred, EcsPrivate)) { + return true; } } + if (is_base) { + if (ecs_get_object_for_id(world, inst, EcsIsA, id) != ent) { + hidden = true; + } + } + if (hidden && (!desc || !desc->serialize_hidden)) { + return true; + } + + *pred_out = pred; + *obj_out = obj; + *role_out = role; + if (hidden_out) *hidden_out = hidden; + + return false; } static -void set_member(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsMember *member = ecs_term(it, EcsMember, 1); +int append_type_labels( + const ecs_world_t *world, + ecs_strbuf_t *buf, + const ecs_id_t *ids, + int32_t count, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + (void)world; (void)buf; (void)ids; (void)count; (void)ent; (void)inst; + (void)desc; + +#ifdef FLECS_DOC + if (!desc || !desc->serialize_id_labels) { + return 0; + } - int i, count = it->count; + json_member(buf, "id_labels"); + json_array_push(buf); + + int32_t i; for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); - if (!parent) { - ecs_err("missing parent for member '%s'", ecs_get_name(world, e)); + ecs_entity_t pred = 0, obj = 0, role = 0; + if (skip_id(world, ids[i], desc, ent, inst, &pred, &obj, &role, 0)) { continue; } - add_member_to_struct(world, parent, e, &member[i]); + if (desc && desc->serialize_id_labels) { + json_next(buf); + + json_array_push(buf); + json_next(buf); + json_label(buf, world, pred); + if (obj) { + json_next(buf); + json_label(buf, world, obj); + } + + json_array_pop(buf); + } } + + json_array_pop(buf); +#endif + return 0; } static -void add_enum(ecs_iter_t *it) { - ecs_world_t *world = it->world; +int append_type_values( + const ecs_world_t *world, + ecs_strbuf_t *buf, + const ecs_id_t *ids, + int32_t count, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + if (!desc || !desc->serialize_values) { + return 0; + } - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; + json_member(buf, "values"); + json_array_push(buf); - if (init_type_t(world, e, EcsEnumType, ecs_i32_t)) { + int32_t i; + for (i = 0; i < count; i ++) { + bool hidden; + ecs_entity_t pred = 0, obj = 0, role = 0; + ecs_id_t id = ids[i]; + if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, + &hidden)) + { continue; } - ecs_add_id(world, e, EcsExclusive); - ecs_add_id(world, e, EcsTag); + if (!hidden) { + bool serialized = false; + ecs_entity_t typeid = ecs_get_typeid(world, id); + if (typeid) { + const EcsMetaTypeSerialized *ser = ecs_get( + world, typeid, EcsMetaTypeSerialized); + if (ser) { + const void *ptr = ecs_get_id(world, ent, id); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + + json_next(buf); + if (json_ser_type(world, ser->ops, ptr, buf) != 0) { + /* Entity contains invalid value */ + return -1; + } + serialized = true; + } + } + if (!serialized) { + json_next(buf); + json_number(buf, 0); + } + } else { + if (!desc || desc->serialize_hidden) { + json_next(buf); + json_number(buf, 0); + } + } } + + json_array_pop(buf); + + return 0; } static -void add_bitmask(ecs_iter_t *it) { - ecs_world_t *world = it->world; +int append_type_info( + const ecs_world_t *world, + ecs_strbuf_t *buf, + const ecs_id_t *ids, + int32_t count, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + if (!desc || !desc->serialize_type_info) { + return 0; + } - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; + json_member(buf, "type_info"); + json_array_push(buf); - if (init_type_t(world, e, EcsBitmaskType, ecs_u32_t)) { + int32_t i; + for (i = 0; i < count; i ++) { + bool hidden; + ecs_entity_t pred = 0, obj = 0, role = 0; + ecs_id_t id = ids[i]; + if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, + &hidden)) + { continue; } + + if (!hidden) { + ecs_entity_t typeid = ecs_get_typeid(world, id); + if (typeid) { + json_next(buf); + if (ecs_type_info_to_json_buf(world, typeid, buf) != 0) { + return -1; + } + } else { + json_next(buf); + json_number(buf, 0); + } + } else { + if (!desc || desc->serialize_hidden) { + json_next(buf); + json_number(buf, 0); + } + } } + + json_array_pop(buf); + + return 0; } static -void add_constant(ecs_iter_t *it) { - ecs_world_t *world = it->world; +int append_type_hidden( + const ecs_world_t *world, + ecs_strbuf_t *buf, + const ecs_id_t *ids, + int32_t count, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + if (!desc || !desc->serialize_hidden) { + return 0; + } - int i, count = it->count; + if (ent == inst) { + return 0; /* if this is not a base, components are never hidden */ + } + + json_member(buf, "hidden"); + json_array_push(buf); + + int32_t i; for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); - if (!parent) { - ecs_err("missing parent for constant '%s'", ecs_get_name(world, e)); + bool hidden; + ecs_entity_t pred = 0, obj = 0, role = 0; + ecs_id_t id = ids[i]; + if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, + &hidden)) + { continue; } - if (ecs_has(world, parent, EcsEnum)) { - add_constant_to_enum(world, parent, e, it->event_id); - } else if (ecs_has(world, parent, EcsBitmask)) { - add_constant_to_bitmask(world, parent, e, it->event_id); - } + json_next(buf); + json_bool(buf, hidden); } + + json_array_pop(buf); + + return 0; } + static -void set_array(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsArray *array = ecs_term(it, EcsArray, 1); +int append_type( + const ecs_world_t *world, + ecs_strbuf_t *buf, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + ecs_type_t type = ecs_get_type(world, ent); + const ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t i, count = ecs_vector_count(type); - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_entity_t elem_type = array[i].type; - int32_t elem_count = array[i].count; + json_member(buf, "ids"); + json_array_push(buf); - if (!elem_type) { - ecs_err("array '%s' has no element type", ecs_get_name(world, e)); + for (i = 0; i < count; i ++) { + ecs_entity_t pred = 0, obj = 0, role = 0; + if (skip_id(world, ids[i], desc, ent, inst, &pred, &obj, &role, 0)) { continue; } - if (!elem_count) { - ecs_err("array '%s' has size 0", ecs_get_name(world, e)); - continue; - } - const EcsComponent *elem_ptr = ecs_get(world, elem_type, EcsComponent); - if (init_type(world, e, EcsArrayType, - elem_ptr->size * elem_count, elem_ptr->alignment)) - { - continue; + json_next(buf); + json_array_push(buf); + json_next(buf); + json_path(buf, world, pred); + if (obj || role) { + json_next(buf); + if (obj) { + json_path(buf, world, obj); + } else { + json_number(buf, 0); + } + if (role) { + json_next(buf); + json_string(buf, ecs_role_str(role)); + } } + json_array_pop(buf); + } + + json_array_pop(buf); + + if (append_type_labels(world, buf, ids, count, ent, inst, desc)) { + return -1; + } + + if (append_type_values(world, buf, ids, count, ent, inst, desc)) { + return -1; + } + + if (append_type_info(world, buf, ids, count, ent, inst, desc)) { + return -1; + } + + if (append_type_hidden(world, buf, ids, count, ent, inst, desc)) { + return -1; } + + return 0; } static -void set_vector(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsVector *array = ecs_term(it, EcsVector, 1); +int append_base( + const ecs_world_t *world, + ecs_strbuf_t *buf, + ecs_entity_t ent, + ecs_entity_t inst, + const ecs_entity_to_json_desc_t *desc) +{ + ecs_type_t type = ecs_get_type(world, ent); + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t i, count = ecs_vector_count(type); - int i, count = it->count; for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_entity_t elem_type = array[i].type; - - if (!elem_type) { - ecs_err("vector '%s' has no element type", ecs_get_name(world, e)); - continue; + ecs_id_t id = ids[i]; + if (ECS_HAS_RELATION(id, EcsIsA)) { + if (append_base(world, buf, ecs_pair_second(world, id), inst, desc)) + { + return -1; + } } + } - if (init_type_t(world, e, EcsVectorType, ecs_vector_t*)) { - continue; - } + json_object_push(buf); + json_member(buf, "path"); + json_path(buf, world, ent); + + if (append_type(world, buf, ent, inst, desc)) { + return -1; } + + json_object_pop(buf); + + return 0; } -bool flecs_unit_validate( - ecs_world_t *world, - ecs_entity_t t, - EcsUnit *data) +int ecs_entity_to_json_buf( + const ecs_world_t *world, + ecs_entity_t entity, + ecs_strbuf_t *buf, + const ecs_entity_to_json_desc_t *desc) { - char *derived_symbol = NULL; - const char *symbol = data->symbol; + if (!entity || !ecs_is_valid(world, entity)) { + return -1; + } - ecs_entity_t base = data->base; - ecs_entity_t over = data->over; - ecs_entity_t prefix = data->prefix; - ecs_unit_translation_t translation = data->translation; + json_object_push(buf); - if (base) { - if (!ecs_has(world, base, EcsUnit)) { - ecs_err("entity '%s' for unit '%s' used as base is not a unit", - ecs_get_name(world, base), ecs_get_name(world, t)); - goto error; - } + if (!desc || desc->serialize_path) { + char *path = ecs_get_fullpath(world, entity); + json_member(buf, "path"); + json_string(buf, path); + ecs_os_free(path); } - if (over) { - if (!base) { - ecs_err("invalid unit '%s': cannot specify over without base", - ecs_get_name(world, t)); - goto error; - } - if (!ecs_has(world, over, EcsUnit)) { - ecs_err("entity '%s' for unit '%s' used as over is not a unit", - ecs_get_name(world, over), ecs_get_name(world, t)); - goto error; +#ifdef FLECS_DOC + if (desc && desc->serialize_label) { + json_member(buf, "label"); + const char *doc_name = ecs_doc_get_name(world, entity); + if (doc_name) { + json_string(buf, doc_name); + } else { + char num_buf[20]; + ecs_os_sprintf(num_buf, "%u", (uint32_t)entity); + json_string(buf, num_buf); } } - if (prefix) { - if (!base) { - ecs_err("invalid unit '%s': cannot specify prefix without base", - ecs_get_name(world, t)); - goto error; - } - const EcsUnitPrefix *prefix_ptr = ecs_get(world, prefix, EcsUnitPrefix); - if (!prefix_ptr) { - ecs_err("entity '%s' for unit '%s' used as prefix is not a prefix", - ecs_get_name(world, over), ecs_get_name(world, t)); - goto error; + if (desc && desc->serialize_brief) { + const char *doc_brief = ecs_doc_get_brief(world, entity); + if (doc_brief) { + json_member(buf, "brief"); + json_string(buf, doc_brief); } + } - if (translation.factor || translation.power) { - if (prefix_ptr->translation.factor != translation.factor || - prefix_ptr->translation.power != translation.power) - { - ecs_err( - "factor for unit '%s' is inconsistent with prefix '%s'", - ecs_get_name(world, t), ecs_get_name(world, prefix)); - goto error; - } - } else { - translation = prefix_ptr->translation; + if (desc && desc->serialize_link) { + const char *doc_link = ecs_doc_get_link(world, entity); + if (doc_link) { + json_member(buf, "link"); + json_string(buf, doc_link); } } +#endif - if (base) { - bool must_match = false; /* Must base symbol match symbol? */ - ecs_strbuf_t sbuf = ECS_STRBUF_INIT; - if (prefix) { - const EcsUnitPrefix *ptr = ecs_get(world, prefix, EcsUnitPrefix); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - if (ptr->symbol) { - ecs_strbuf_appendstr(&sbuf, ptr->symbol); - must_match = true; - } - } + ecs_type_t type = ecs_get_type(world, entity); + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t i, count = ecs_vector_count(type); - const EcsUnit *uptr = ecs_get(world, base, EcsUnit); - ecs_assert(uptr != NULL, ECS_INTERNAL_ERROR, NULL); - if (uptr->symbol) { - ecs_strbuf_appendstr(&sbuf, uptr->symbol); - } + if (!desc || desc->serialize_base) { + if (ecs_has_pair(world, entity, EcsIsA, EcsWildcard)) { + json_member(buf, "is_a"); + json_array_push(buf); - if (over) { - uptr = ecs_get(world, over, EcsUnit); - ecs_assert(uptr != NULL, ECS_INTERNAL_ERROR, NULL); - if (uptr->symbol) { - ecs_strbuf_appendstr(&sbuf, "/"); - ecs_strbuf_appendstr(&sbuf, uptr->symbol); - must_match = true; + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; + if (ECS_HAS_RELATION(id, EcsIsA)) { + if (append_base( + world, buf, ecs_pair_second(world, id), entity, desc)) + { + return -1; + } + } } - } - derived_symbol = ecs_strbuf_get(&sbuf); - if (derived_symbol && !ecs_os_strlen(derived_symbol)) { - ecs_os_free(derived_symbol); - derived_symbol = NULL; + json_array_pop(buf); } + } - if (derived_symbol && symbol && ecs_os_strcmp(symbol, derived_symbol)) { - if (must_match) { - ecs_err("symbol '%s' for unit '%s' does not match base" - " symbol '%s'", symbol, - ecs_get_name(world, t), derived_symbol); - goto error; - } - } - if (!symbol && derived_symbol && (prefix || over)) { - ecs_os_free(data->symbol); - data->symbol = derived_symbol; - } else { - ecs_os_free(derived_symbol); - } + if (append_type(world, buf, entity, entity, desc)) { + goto error; } - data->base = base; - data->over = over; - data->prefix = prefix; - data->translation = translation; + json_object_pop(buf); + + return 0; +error: + return -1; +} + +char* ecs_entity_to_json( + const ecs_world_t *world, + ecs_entity_t entity, + const ecs_entity_to_json_desc_t *desc) +{ + ecs_strbuf_t buf = ECS_STRBUF_INIT; + + if (ecs_entity_to_json_buf(world, entity, &buf, desc) != 0) { + ecs_strbuf_reset(&buf); + return NULL; + } + + return ecs_strbuf_get(&buf); +} + +static +bool skip_variable( + const char *name) +{ + if (!name || name[0] == '_' || name[0] == '.') { + return true; + } else { + return false; + } +} - return true; -error: - ecs_os_free(derived_symbol); - return false; +static +void serialize_id( + const ecs_world_t *world, + ecs_id_t id, + ecs_strbuf_t *buf) +{ + json_id(buf, world, id); } static -void set_unit(ecs_iter_t *it) { - EcsUnit *u = ecs_term(it, EcsUnit, 1); +void serialize_iter_ids( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + int32_t term_count = it->term_count; + if (!term_count) { + return; + } - ecs_world_t *world = it->world; + json_member(buf, "ids"); + json_array_push(buf); - int i, count = it->count; - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - flecs_unit_validate(world, e, &u[i]); + for (int i = 0; i < term_count; i ++) { + json_next(buf); + serialize_id(world, it->terms[i].id, buf); } + + json_array_pop(buf); } static -void unit_quantity_monitor(ecs_iter_t *it) { - ecs_world_t *world = it->world; +void serialize_type_info( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + int32_t term_count = it->term_count; + if (!term_count) { + return; + } - int i, count = it->count; - if (it->event == EcsOnAdd) { - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_add_pair(world, e, EcsQuantity, e); - } - } else { - for (i = 0; i < count; i ++) { - ecs_entity_t e = it->entities[i]; - ecs_remove_pair(world, e, EcsQuantity, e); + json_member(buf, "type_info"); + json_object_push(buf); + + for (int i = 0; i < term_count; i ++) { + json_next(buf); + ecs_entity_t typeid = ecs_get_typeid(world, it->terms[i].id); + if (typeid) { + serialize_id(world, typeid, buf); + ecs_strbuf_appendstr(buf, ":"); + ecs_type_info_to_json_buf(world, typeid, buf); + } else { + serialize_id(world, it->terms[i].id, buf); + ecs_strbuf_appendstr(buf, ":"); + ecs_strbuf_appendstr(buf, "0"); } } + + json_object_pop(buf); } static -void ecs_meta_type_init_default_ctor(ecs_iter_t *it) { - ecs_world_t *world = it->world; - EcsMetaType *type = ecs_term(it, EcsMetaType, 1); +void serialize_iter_variables(ecs_iter_t *it, ecs_strbuf_t *buf) { + char **variable_names = it->variable_names; + int32_t var_count = it->variable_count; + int32_t actual_count = 0; - int i; - for (i = 0; i < it->count; i ++) { - /* If a component is defined from reflection data, configure it with the - * default constructor. This ensures that a new component value does not - * contain uninitialized memory, which could cause serializers to crash - * when for example inspecting string fields. */ - if (!type->existing) { - ecs_set_component_actions_w_id(world, it->entities[i], - &(EcsComponentLifecycle){ - .ctor = ecs_default_ctor - }); + for (int i = 0; i < var_count; i ++) { + const char *var_name = variable_names[i]; + if (skip_variable(var_name)) continue; + + if (!actual_count) { + json_member(buf, "vars"); + json_array_push(buf); + actual_count ++; } + + ecs_strbuf_list_next(buf); + json_string(buf, var_name); } -} -static -void member_on_set(ecs_iter_t *it) { - EcsMember *mbr = it->ptrs[0]; - if (!mbr->count) { - mbr->count = 1; + if (actual_count) { + json_array_pop(buf); } } -void FlecsMetaImport( - ecs_world_t *world) +static +void serialize_iter_result_ids( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) { - ECS_MODULE(world, FlecsMeta); - - ecs_set_name_prefix(world, "Ecs"); + json_member(buf, "ids"); + json_array_push(buf); - flecs_bootstrap_component(world, EcsMetaType); - flecs_bootstrap_component(world, EcsMetaTypeSerialized); - flecs_bootstrap_component(world, EcsPrimitive); - flecs_bootstrap_component(world, EcsEnum); - flecs_bootstrap_component(world, EcsBitmask); - flecs_bootstrap_component(world, EcsMember); - flecs_bootstrap_component(world, EcsStruct); - flecs_bootstrap_component(world, EcsArray); - flecs_bootstrap_component(world, EcsVector); - flecs_bootstrap_component(world, EcsUnit); - flecs_bootstrap_component(world, EcsUnitPrefix); + for (int i = 0; i < it->term_count; i ++) { + json_next(buf); + serialize_id(world, ecs_term_id(it, i + 1), buf); + } - flecs_bootstrap_tag(world, EcsConstant); - flecs_bootstrap_tag(world, EcsQuantity); + json_array_pop(buf); +} - ecs_set_component_actions(world, EcsMetaType, { .ctor = ecs_default_ctor }); +static +void serialize_iter_result_subjects( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + json_member(buf, "subjects"); + json_array_push(buf); - ecs_set_component_actions(world, EcsMetaTypeSerialized, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsMetaTypeSerialized), - .copy = ecs_copy(EcsMetaTypeSerialized), - .dtor = ecs_dtor(EcsMetaTypeSerialized) - }); + for (int i = 0; i < it->term_count; i ++) { + json_next(buf); + ecs_entity_t subj = it->subjects[i]; + if (subj) { + json_path(buf, world, subj); + } else { + json_literal(buf, "0"); + } + } - ecs_set_component_actions(world, EcsStruct, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsStruct), - .copy = ecs_copy(EcsStruct), - .dtor = ecs_dtor(EcsStruct) - }); + json_array_pop(buf); +} - ecs_set_component_actions(world, EcsMember, { - .ctor = ecs_default_ctor, - .on_set = member_on_set - }); +static +void serialize_iter_result_is_set( + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + json_member(buf, "is_set"); + json_array_push(buf); - ecs_set_component_actions(world, EcsEnum, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsEnum), - .copy = ecs_copy(EcsEnum), - .dtor = ecs_dtor(EcsEnum) - }); + for (int i = 0; i < it->term_count; i ++) { + ecs_strbuf_list_next(buf); + if (ecs_term_is_set(it, i + 1)) { + json_true(buf); + } else { + json_false(buf); + } + } - ecs_set_component_actions(world, EcsBitmask, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsBitmask), - .copy = ecs_copy(EcsBitmask), - .dtor = ecs_dtor(EcsBitmask) - }); + json_array_pop(buf); +} - ecs_set_component_actions(world, EcsUnit, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsUnit), - .copy = ecs_copy(EcsUnit), - .dtor = ecs_dtor(EcsUnit) - }); +static +void serialize_iter_result_variables( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + char **variable_names = it->variable_names; + ecs_entity_t *variables = it->variables; + int32_t var_count = it->variable_count; + int32_t actual_count = 0; - ecs_set_component_actions(world, EcsUnitPrefix, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsUnitPrefix), - .copy = ecs_copy(EcsUnitPrefix), - .dtor = ecs_dtor(EcsUnitPrefix) - }); + for (int i = 0; i < var_count; i ++) { + const char *var_name = variable_names[i]; + if (skip_variable(var_name)) continue; - /* Register triggers to finalize type information from component data */ - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsPrimitive), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = set_primitive - }); + if (!actual_count) { + json_member(buf, "vars"); + json_array_push(buf); + actual_count ++; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsMember), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = set_member - }); + ecs_strbuf_list_next(buf); + json_path(buf, world, variables[i]); + } - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsEnum), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnAdd}, - .callback = add_enum - }); + if (actual_count) { + json_array_pop(buf); + } +} - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsBitmask), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnAdd}, - .callback = add_bitmask - }); +static +void serialize_iter_result_variable_labels( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + char **variable_names = it->variable_names; + ecs_entity_t *variables = it->variables; + int32_t var_count = it->variable_count; + int32_t actual_count = 0; - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = EcsConstant, - .term.subj.set.mask = EcsSelf, - .events = {EcsOnAdd}, - .callback = add_constant - }); + for (int i = 0; i < var_count; i ++) { + const char *var_name = variable_names[i]; + if (skip_variable(var_name)) continue; - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_pair(EcsConstant, EcsWildcard), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = add_constant - }); + if (!actual_count) { + json_member(buf, "var_labels"); + json_array_push(buf); + actual_count ++; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsArray), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = set_array - }); + ecs_strbuf_list_next(buf); + json_label(buf, world, variables[i]); + } - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsVector), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = set_vector - }); + if (actual_count) { + json_array_pop(buf); + } +} - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsUnit), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = set_unit - }); +static +void serialize_iter_result_entities( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + int32_t count = it->count; + if (!it->count) { + return; + } - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsMetaType), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = ecs_meta_type_serialized_init - }); + json_member(buf, "entities"); + json_array_push(buf); - ecs_trigger_init(world, &(ecs_trigger_desc_t) { - .term.id = ecs_id(EcsMetaType), - .term.subj.set.mask = EcsSelf, - .events = {EcsOnSet}, - .callback = ecs_meta_type_init_default_ctor - }); + ecs_entity_t *entities = it->entities; - ecs_observer_init(world, &(ecs_observer_desc_t) { - .filter.terms = { - { .id = ecs_id(EcsUnit) }, - { .id = EcsQuantity } - }, - .events = { EcsMonitor }, - .callback = unit_quantity_monitor - }); + for (int i = 0; i < count; i ++) { + json_next(buf); + json_path(buf, world, entities[i]); + } - /* Initialize primitive types */ - #define ECS_PRIMITIVE(world, type, primitive_kind)\ - ecs_entity_init(world, &(ecs_entity_desc_t) {\ - .entity = ecs_id(ecs_##type##_t),\ - .name = #type,\ - .symbol = #type });\ - ecs_set(world, ecs_id(ecs_##type##_t), EcsPrimitive, {\ - .kind = primitive_kind\ - }); + json_array_pop(buf); +} - ECS_PRIMITIVE(world, bool, EcsBool); - ECS_PRIMITIVE(world, char, EcsChar); - ECS_PRIMITIVE(world, byte, EcsByte); - ECS_PRIMITIVE(world, u8, EcsU8); - ECS_PRIMITIVE(world, u16, EcsU16); - ECS_PRIMITIVE(world, u32, EcsU32); - ECS_PRIMITIVE(world, u64, EcsU64); - ECS_PRIMITIVE(world, uptr, EcsUPtr); - ECS_PRIMITIVE(world, i8, EcsI8); - ECS_PRIMITIVE(world, i16, EcsI16); - ECS_PRIMITIVE(world, i32, EcsI32); - ECS_PRIMITIVE(world, i64, EcsI64); - ECS_PRIMITIVE(world, iptr, EcsIPtr); - ECS_PRIMITIVE(world, f32, EcsF32); - ECS_PRIMITIVE(world, f64, EcsF64); - ECS_PRIMITIVE(world, string, EcsString); - ECS_PRIMITIVE(world, entity, EcsEntity); +static +void serialize_iter_result_entity_labels( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + int32_t count = it->count; + if (!it->count) { + return; + } - #undef ECS_PRIMITIVE + json_member(buf, "entity_labels"); + json_array_push(buf); - /* Set default child components */ - ecs_add_pair(world, ecs_id(EcsStruct), - EcsDefaultChildComponent, ecs_id(EcsMember)); + ecs_entity_t *entities = it->entities; - ecs_add_pair(world, ecs_id(EcsMember), - EcsDefaultChildComponent, ecs_id(EcsMember)); + for (int i = 0; i < count; i ++) { + json_next(buf); + json_label(buf, world, entities[i]); + } - ecs_add_pair(world, ecs_id(EcsEnum), - EcsDefaultChildComponent, EcsConstant); + json_array_pop(buf); +} - ecs_add_pair(world, ecs_id(EcsBitmask), - EcsDefaultChildComponent, EcsConstant); +static +void serialize_iter_result_values( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf) +{ + int32_t count = it->count; + if (!it->count) { + return; + } - /* Relationship properties */ - ecs_add_id(world, EcsQuantity, EcsExclusive); - ecs_add_id(world, EcsQuantity, EcsTag); + json_member(buf, "values"); + json_array_push(buf); - /* Initialize reflection data for meta components */ - ecs_entity_t type_kind = ecs_enum_init(world, &(ecs_enum_desc_t) { - .entity.name = "TypeKind", - .constants = { - {.name = "PrimitiveType"}, - {.name = "BitmaskType"}, - {.name = "EnumType"}, - {.name = "StructType"}, - {.name = "ArrayType"}, - {.name = "VectorType"} - } - }); + int32_t i, term_count = it->term_count; + for (i = 0; i < term_count; i ++) { + ecs_strbuf_list_next(buf); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsMetaType), - .members = { - {.name = (char*)"kind", .type = type_kind} + const void *ptr = NULL; + if (it->ptrs) { + ptr = it->ptrs[i]; } - }); - - ecs_entity_t primitive_kind = ecs_enum_init(world, &(ecs_enum_desc_t) { - .entity.name = "PrimitiveKind", - .constants = { - {.name = "Bool", 1}, - {.name = "Char"}, - {.name = "Byte"}, - {.name = "U8"}, - {.name = "U16"}, - {.name = "U32"}, - {.name = "U64"}, - {.name = "I8"}, - {.name = "I16"}, - {.name = "I32"}, - {.name = "I64"}, - {.name = "F32"}, - {.name = "F64"}, - {.name = "UPtr"}, - {.name = "IPtr"}, - {.name = "String"}, - {.name = "Entity"} + if (!ptr) { + /* No data in column. Append 0 if this is not an optional term */ + if (ecs_term_is_set(it, i + 1)) { + json_literal(buf, "0"); + continue; + } } - }); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsPrimitive), - .members = { - {.name = (char*)"kind", .type = primitive_kind} + if (ecs_term_is_writeonly(it, i + 1)) { + json_literal(buf, "0"); + continue; } - }); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsMember), - .members = { - {.name = (char*)"type", .type = ecs_id(ecs_entity_t)}, - {.name = (char*)"count", .type = ecs_id(ecs_i32_t)}, - {.name = (char*)"unit", .type = ecs_id(ecs_entity_t)} + /* Get component id (can be different in case of pairs) */ + ecs_entity_t type = ecs_get_typeid(world, it->ids[i]); + if (!type) { + /* Odd, we have a ptr but no Component? Not the place of the + * serializer to complain about that. */ + json_literal(buf, "0"); + continue; } - }); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsArray), - .members = { - {.name = (char*)"type", .type = ecs_id(ecs_entity_t)}, - {.name = (char*)"count", .type = ecs_id(ecs_i32_t)}, + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + if (!comp) { + /* Also odd, typeid but not a component? */ + json_literal(buf, "0"); + continue; } - }); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsVector), - .members = { - {.name = (char*)"type", .type = ecs_id(ecs_entity_t)} + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + if (!ser) { + /* Not odd, component just has no reflection data */ + json_literal(buf, "0"); + continue; } - }); - ecs_entity_t ut = ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.name = "unit_translation", - .members = { - {.name = (char*)"factor", .type = ecs_id(ecs_i32_t)}, - {.name = (char*)"power", .type = ecs_id(ecs_i32_t)} + /* If term is not set, append empty array. This indicates that the term + * could have had data but doesn't */ + if (!ecs_term_is_set(it, i + 1)) { + ecs_assert(ptr == NULL, ECS_INTERNAL_ERROR, NULL); + json_array_push(buf); + json_array_pop(buf); + continue; } - }); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsUnit), - .members = { - {.name = (char*)"symbol", .type = ecs_id(ecs_string_t)}, - {.name = (char*)"prefix", .type = ecs_id(ecs_entity_t)}, - {.name = (char*)"base", .type = ecs_id(ecs_entity_t)}, - {.name = (char*)"over", .type = ecs_id(ecs_entity_t)}, - {.name = (char*)"translation", .type = ut} + if (ecs_term_is_owned(it, i + 1)) { + array_to_json_buf_w_type_data(world, ptr, count, buf, comp, ser); + } else { + array_to_json_buf_w_type_data(world, ptr, 0, buf, comp, ser); } - }); + } - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsUnitPrefix), - .members = { - {.name = (char*)"symbol", .type = ecs_id(ecs_string_t)}, - {.name = (char*)"translation", .type = ut} - } - }); + json_array_pop(buf); } -#endif +static +void serialize_iter_result( + const ecs_world_t *world, + const ecs_iter_t *it, + ecs_strbuf_t *buf, + const ecs_iter_to_json_desc_t *desc) +{ + json_next(buf); + json_object_push(buf); + /* Each result can be matched with different component ids. Add them to + * the result so clients know with which component an entity was matched */ + if (!desc || desc->serialize_ids) { + serialize_iter_result_ids(world, it, buf); + } -#ifdef FLECS_META + /* Include information on which entity the term is matched with */ + if (!desc || desc->serialize_ids) { + serialize_iter_result_subjects(world, it, buf); + } -ecs_entity_t ecs_primitive_init( - ecs_world_t *world, - const ecs_primitive_desc_t *desc) -{ - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; + /* Write variable values for current result */ + if (!desc || desc->serialize_variables) { + serialize_iter_result_variables(world, it, buf); } - ecs_set(world, t, EcsPrimitive, { desc->kind }); + /* Write labels for variables */ + if (desc && desc->serialize_variable_labels) { + serialize_iter_result_variable_labels(world, it, buf); + } - return t; + /* Include information on which terms are set, to support optional terms */ + if (!desc || desc->serialize_is_set) { + serialize_iter_result_is_set(it, buf); + } + + /* Write entity ids for current result (for queries with This terms) */ + if (!desc || desc->serialize_entities) { + serialize_iter_result_entities(world, it, buf); + } + + /* Write labels for entities */ + if (desc && desc->serialize_entity_labels) { + serialize_iter_result_entity_labels(world, it, buf); + } + + /* Serialize component values */ + if (!desc || desc->serialize_values) { + serialize_iter_result_values(world, it, buf); + } + + json_object_pop(buf); } -ecs_entity_t ecs_enum_init( - ecs_world_t *world, - const ecs_enum_desc_t *desc) +int ecs_iter_to_json_buf( + const ecs_world_t *world, + ecs_iter_t *it, + ecs_strbuf_t *buf, + const ecs_iter_to_json_desc_t *desc) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; + ecs_time_t duration = {0}; + if (desc && desc->measure_eval_duration) { + ecs_time_measure(&duration); } - ecs_add(world, t, EcsEnum); + json_object_push(buf); - ecs_entity_t old_scope = ecs_set_scope(world, t); + /* Serialize component ids of the terms (usually provided by query) */ + if (!desc || desc->serialize_term_ids) { + serialize_iter_ids(world, it, buf); + } - int i; - for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { - const ecs_enum_constant_t *m_desc = &desc->constants[i]; - if (!m_desc->name) { - break; - } + /* Serialize type info if enabled */ + if (desc && desc->serialize_type_info) { + serialize_type_info(world, it, buf); + } - ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = m_desc->name - }); + /* Serialize variable names, if iterator has any */ + serialize_iter_variables(it, buf); - if (!m_desc->value) { - ecs_add_id(world, c, EcsConstant); - } else { - ecs_set_pair_object(world, c, EcsConstant, ecs_i32_t, - {m_desc->value}); - } + /* Serialize results */ + json_member(buf, "results"); + json_array_push(buf); + + /* Use instancing for improved performance */ + it->is_instanced = true; + + ecs_iter_next_action_t next = it->next; + while (next(it)) { + serialize_iter_result(world, it, buf, desc); } - ecs_set_scope(world, old_scope); + json_array_pop(buf); - if (i == 0) { - ecs_err("enum '%s' has no constants", ecs_get_name(world, t)); - ecs_delete(world, t); - return 0; + if (desc && desc->measure_eval_duration) { + double dt = ecs_time_measure(&duration); + json_member(buf, "eval_duration"); + json_number(buf, dt); } - return t; + json_object_pop(buf); + + return 0; } -ecs_entity_t ecs_bitmask_init( - ecs_world_t *world, - const ecs_bitmask_desc_t *desc) +char* ecs_iter_to_json( + const ecs_world_t *world, + ecs_iter_t *it, + const ecs_iter_to_json_desc_t *desc) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; - } + ecs_strbuf_t buf = ECS_STRBUF_INIT; - ecs_add(world, t, EcsBitmask); + if (ecs_iter_to_json_buf(world, it, &buf, desc)) { + ecs_strbuf_reset(&buf); + return NULL; + } - ecs_entity_t old_scope = ecs_set_scope(world, t); + return ecs_strbuf_get(&buf); +} - int i; - for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { - const ecs_bitmask_constant_t *m_desc = &desc->constants[i]; - if (!m_desc->name) { - break; - } +#endif - ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = m_desc->name - }); - if (!m_desc->value) { - ecs_add_id(world, c, EcsConstant); - } else { - ecs_set_pair_object(world, c, EcsConstant, ecs_u32_t, - {m_desc->value}); - } - } +#ifdef FLECS_JSON - ecs_set_scope(world, old_scope); +static +int json_typeinfo_ser_type( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *buf); - if (i == 0) { - ecs_err("bitmask '%s' has no constants", ecs_get_name(world, t)); - ecs_delete(world, t); - return 0; +static +int json_typeinfo_ser_primitive( + ecs_primitive_kind_t kind, + ecs_strbuf_t *str) +{ + switch(kind) { + case EcsBool: + json_string(str, "bool"); + break; + case EcsChar: + case EcsString: + json_string(str, "text"); + break; + case EcsByte: + json_string(str, "byte"); + break; + case EcsU8: + case EcsU16: + case EcsU32: + case EcsU64: + case EcsI8: + case EcsI16: + case EcsI32: + case EcsI64: + case EcsIPtr: + case EcsUPtr: + json_string(str, "int"); + break; + case EcsF32: + case EcsF64: + json_string(str, "float"); + break; + case EcsEntity: + json_string(str, "entity"); + break; + default: + return -1; } - return t; + return 0; } -ecs_entity_t ecs_array_init( - ecs_world_t *world, - const ecs_array_desc_t *desc) +static +void json_typeinfo_ser_constants( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *str) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; + ecs_iter_t it = ecs_term_iter(world, &(ecs_term_t) { + .id = ecs_pair(EcsChildOf, type) + }); + + while (ecs_term_next(&it)) { + int32_t i, count = it.count; + for (i = 0; i < count; i ++) { + json_next(str); + json_string(str, ecs_get_name(world, it.entities[i])); + } } +} - ecs_set(world, t, EcsArray, { - .type = desc->type, - .count = desc->count - }); +static +void json_typeinfo_ser_enum( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *str) +{ + ecs_strbuf_list_appendstr(str, "\"enum\""); + json_typeinfo_ser_constants(world, type, str); +} - return t; +static +void json_typeinfo_ser_bitmask( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *str) +{ + ecs_strbuf_list_appendstr(str, "\"bitmask\""); + json_typeinfo_ser_constants(world, type, str); } -ecs_entity_t ecs_vector_init( - ecs_world_t *world, - const ecs_vector_desc_t *desc) +static +int json_typeinfo_ser_array( + const ecs_world_t *world, + ecs_entity_t elem_type, + int32_t count, + ecs_strbuf_t *str) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; + ecs_strbuf_list_appendstr(str, "\"array\""); + + json_next(str); + if (json_typeinfo_ser_type(world, elem_type, str)) { + goto error; } - ecs_set(world, t, EcsVector, { - .type = desc->type - }); + ecs_strbuf_list_append(str, "%u", count); + return 0; +error: + return -1; +} - return t; +static +int json_typeinfo_ser_array_type( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *str) +{ + const EcsArray *arr = ecs_get(world, type, EcsArray); + ecs_assert(arr != NULL, ECS_INTERNAL_ERROR, NULL); + if (json_typeinfo_ser_array(world, arr->type, arr->count, str)) { + goto error; + } + + return 0; +error: + return -1; } -ecs_entity_t ecs_struct_init( - ecs_world_t *world, - const ecs_struct_desc_t *desc) +static +int json_typeinfo_ser_vector( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *str) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - return 0; + const EcsVector *arr = ecs_get(world, type, EcsVector); + ecs_assert(arr != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_strbuf_list_appendstr(str, "\"vector\""); + + json_next(str); + if (json_typeinfo_ser_type(world, arr->type, str)) { + goto error; } - ecs_entity_t old_scope = ecs_set_scope(world, t); + return 0; +error: + return -1; +} - int i; - for (i = 0; i < ECS_MEMBER_DESC_CACHE_SIZE; i ++) { - const ecs_member_t *m_desc = &desc->members[i]; - if (!m_desc->type) { - break; - } +/* Serialize unit information */ +static +int json_typeinfo_ser_unit( + const ecs_world_t *world, + ecs_strbuf_t *str, + ecs_entity_t unit) +{ + json_member(str, "unit"); + json_path(str, world, unit); - if (!m_desc->name) { - ecs_err("member %d of struct '%s' does not have a name", i, - ecs_get_name(world, t)); - ecs_delete(world, t); - return 0; + const EcsUnit *uptr = ecs_get(world, unit, EcsUnit); + if (uptr) { + if (uptr->symbol) { + json_member(str, "symbol"); + json_string(str, uptr->symbol); } + ecs_entity_t quantity = ecs_get_object(world, unit, EcsQuantity, 0); + if (quantity) { + json_member(str, "quantity"); + json_path(str, world, quantity); + } + } - ecs_entity_t m = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = m_desc->name - }); + return 0; +} - ecs_set(world, m, EcsMember, { - .type = m_desc->type, - .count = m_desc->count, - .unit = m_desc->unit - }); +/* Forward serialization to the different type kinds */ +static +int json_typeinfo_ser_type_op( + const ecs_world_t *world, + ecs_meta_type_op_t *op, + ecs_strbuf_t *str) +{ + json_array_push(str); + + switch(op->kind) { + case EcsOpPush: + case EcsOpPop: + /* Should not be parsed as single op */ + ecs_throw(ECS_INVALID_PARAMETER, NULL); + break; + case EcsOpEnum: + json_typeinfo_ser_enum(world, op->type, str); + break; + case EcsOpBitmask: + json_typeinfo_ser_bitmask(world, op->type, str); + break; + case EcsOpArray: + json_typeinfo_ser_array_type(world, op->type, str); + break; + case EcsOpVector: + json_typeinfo_ser_vector(world, op->type, str); + break; + default: + if (json_typeinfo_ser_primitive( + json_op_to_primitive_kind(op->kind), str)) + { + /* Unknown operation */ + ecs_throw(ECS_INTERNAL_ERROR, NULL); + return -1; + } + break; } - ecs_set_scope(world, old_scope); + ecs_entity_t unit = op->unit; + if (unit) { + json_next(str); + json_next(str); - if (i == 0) { - ecs_err("struct '%s' has no members", ecs_get_name(world, t)); - ecs_delete(world, t); - return 0; + json_object_push(str); + json_typeinfo_ser_unit(world, str, unit); + json_object_pop(str); } - if (!ecs_has(world, t, EcsStruct)) { - /* Invalid members */ - ecs_delete(world, t); - return 0; - } + json_array_pop(str); - return t; + return 0; +error: + return -1; } -ecs_entity_t ecs_unit_init( - ecs_world_t *world, - const ecs_unit_desc_t *desc) +/* Iterate over a slice of the type ops array */ +static +int json_typeinfo_ser_type_ops( + const ecs_world_t *world, + ecs_meta_type_op_t *ops, + int32_t op_count, + ecs_strbuf_t *str) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { - goto error; - } + for (int i = 0; i < op_count; i ++) { + ecs_meta_type_op_t *op = &ops[i]; - ecs_entity_t quantity = desc->quantity; - if (quantity) { - if (!ecs_has_id(world, quantity, EcsQuantity)) { - ecs_err("entity '%s' for unit '%s' is not a quantity", - ecs_get_name(world, quantity), ecs_get_name(world, t)); - goto error; + if (op != ops) { + if (op->name) { + json_member(str, op->name); + } + + int32_t elem_count = op->count; + if (elem_count > 1 && op != ops) { + json_array_push(str); + json_typeinfo_ser_array(world, op->type, op->count, str); + json_array_pop(str); + i += op->op_count - 1; + continue; + } + } + + switch(op->kind) { + case EcsOpPush: + json_object_push(str); + break; + case EcsOpPop: + json_object_pop(str); + break; + default: + if (json_typeinfo_ser_type_op(world, op, str)) { + goto error; + } + break; } - - ecs_add_pair(world, t, EcsQuantity, desc->quantity); - } else { - ecs_remove_pair(world, t, EcsQuantity, EcsWildcard); - } - - EcsUnit *value = ecs_get_mut(world, t, EcsUnit, 0); - value->base = desc->base; - value->over = desc->over; - value->translation = desc->translation; - value->prefix = desc->prefix; - ecs_os_strset(&value->symbol, desc->symbol); - - if (!flecs_unit_validate(world, t, value)) { - goto error; } - ecs_modified(world, t, EcsUnit); - - return t; -error: - if (t) { - ecs_delete(world, t); - } return 0; +error: + return -1; } -ecs_entity_t ecs_unit_prefix_init( - ecs_world_t *world, - const ecs_unit_prefix_desc_t *desc) +static +int json_typeinfo_ser_type( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *buf) { - ecs_entity_t t = ecs_entity_init(world, &desc->entity); - if (!t) { + const EcsComponent *comp = ecs_get(world, type, EcsComponent); + if (!comp) { + ecs_strbuf_appendstr(buf, "0"); return 0; } - ecs_set(world, t, EcsUnitPrefix, { - .symbol = (char*)desc->symbol, - .translation = desc->translation - }); - - return t; -} - -ecs_entity_t ecs_quantity_init( - ecs_world_t *world, - const ecs_entity_desc_t *desc) -{ - ecs_entity_t t = ecs_entity_init(world, desc); - if (!t) { + const EcsMetaTypeSerialized *ser = ecs_get( + world, type, EcsMetaTypeSerialized); + if (!ser) { + ecs_strbuf_appendstr(buf, "0"); return 0; } - ecs_add_id(world, t, EcsQuantity); + ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); + int32_t count = ecs_vector_count(ser->ops); - return t; + return json_typeinfo_ser_type_ops(world, ops, count, buf); } -#endif - - -#ifdef FLECS_MODULE - -#include +int ecs_type_info_to_json_buf( + const ecs_world_t *world, + ecs_entity_t type, + ecs_strbuf_t *buf) +{ + return json_typeinfo_ser_type(world, type, buf); +} -char* ecs_module_path_from_c( - const char *c_name) +char* ecs_type_info_to_json( + const ecs_world_t *world, + ecs_entity_t type) { ecs_strbuf_t str = ECS_STRBUF_INIT; - const char *ptr; - char ch; - - for (ptr = c_name; (ch = *ptr); ptr++) { - if (isupper(ch)) { - ch = flecs_ito(char, tolower(ch)); - if (ptr != c_name) { - ecs_strbuf_appendstrn(&str, ".", 1); - } - } - ecs_strbuf_appendstrn(&str, &ch, 1); + if (ecs_type_info_to_json_buf(world, type, &str) != 0) { + ecs_strbuf_reset(&str); + return NULL; } return ecs_strbuf_get(&str); } -ecs_entity_t ecs_import( - ecs_world_t *world, - ecs_module_action_t init_action, - const char *module_name) -{ - ecs_check(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); +#endif - ecs_entity_t old_scope = ecs_set_scope(world, 0); - const char *old_name_prefix = world->name_prefix; - char *path = ecs_module_path_from_c(module_name); - ecs_entity_t e = ecs_lookup_fullpath(world, path); - ecs_os_free(path); - - if (!e) { - ecs_trace("#[magenta]import#[reset] %s", module_name); - ecs_log_push(); - /* Load module */ - init_action(world); +#ifdef FLECS_JSON - /* Lookup module entity (must be registered by module) */ - e = ecs_lookup_fullpath(world, module_name); - ecs_check(e != 0, ECS_MODULE_UNDEFINED, module_name); +const char* ecs_parse_json( + const ecs_world_t *world, + const char *ptr, + ecs_entity_t type, + void *data_out, + const ecs_parse_json_desc_t *desc) +{ + char token[ECS_MAX_TOKEN_SIZE]; + int depth = 0; - ecs_log_pop(); - } + const char *name = NULL; + const char *expr = NULL; - /* Restore to previous state */ - ecs_set_scope(world, old_scope); - world->name_prefix = old_name_prefix; + ptr = ecs_parse_fluff(ptr, NULL); - return e; -error: - return 0; -} + ecs_meta_cursor_t cur = ecs_meta_cursor(world, type, data_out); + if (cur.valid == false) { + return NULL; + } -ecs_entity_t ecs_import_from_library( - ecs_world_t *world, - const char *library_name, - const char *module_name) -{ - ecs_check(library_name != NULL, ECS_INVALID_PARAMETER, NULL); + if (desc) { + name = desc->name; + expr = desc->expr; + } - char *import_func = (char*)module_name; /* safe */ - char *module = (char*)module_name; + while ((ptr = ecs_parse_expr_token(name, expr, ptr, token))) { - if (!ecs_os_has_modules() || !ecs_os_has_dl()) { - ecs_err( - "library loading not supported, set module_to_dl, dlopen, dlclose " - "and dlproc os API callbacks first"); - return 0; - } + ptr = ecs_parse_fluff(ptr, NULL); - /* If no module name is specified, try default naming convention for loading - * the main module from the library */ - if (!import_func) { - import_func = ecs_os_malloc(ecs_os_strlen(library_name) + ECS_SIZEOF("Import")); - ecs_assert(import_func != NULL, ECS_OUT_OF_MEMORY, NULL); - - const char *ptr; - char ch, *bptr = import_func; - bool capitalize = true; - for (ptr = library_name; (ch = *ptr); ptr ++) { - if (ch == '.') { - capitalize = true; - } else { - if (capitalize) { - *bptr = flecs_ito(char, toupper(ch)); - bptr ++; - capitalize = false; - } else { - *bptr = flecs_ito(char, tolower(ch)); - bptr ++; - } + if (!ecs_os_strcmp(token, "{")) { + depth ++; + if (ecs_meta_push(&cur) != 0) { + goto error; } - } - *bptr = '\0'; + if (ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected '['"); + return NULL; + } + } - module = ecs_os_strdup(import_func); - ecs_assert(module != NULL, ECS_OUT_OF_MEMORY, NULL); + else if (!ecs_os_strcmp(token, "}")) { + depth --; - ecs_os_strcat(bptr, "Import"); - } + if (ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected ']'"); + return NULL; + } - char *library_filename = ecs_os_module_to_dl(library_name); - if (!library_filename) { - ecs_err("failed to find library file for '%s'", library_name); - if (module != module_name) { - ecs_os_free(module); + if (ecs_meta_pop(&cur) != 0) { + goto error; + } } - return 0; - } else { - ecs_trace("found file '%s' for library '%s'", - library_filename, library_name); - } - - ecs_os_dl_t dl = ecs_os_dlopen(library_filename); - if (!dl) { - ecs_err("failed to load library '%s' ('%s')", - library_name, library_filename); - - ecs_os_free(library_filename); - if (module != module_name) { - ecs_os_free(module); - } - - return 0; - } else { - ecs_trace("library '%s' ('%s') loaded", - library_name, library_filename); - } + else if (!ecs_os_strcmp(token, "[")) { + depth ++; + if (ecs_meta_push(&cur) != 0) { + goto error; + } - ecs_module_action_t action = (ecs_module_action_t) - ecs_os_dlproc(dl, import_func); - if (!action) { - ecs_err("failed to load import function %s from library %s", - import_func, library_name); - ecs_os_free(library_filename); - ecs_os_dlclose(dl); - return 0; - } else { - ecs_trace("found import function '%s' in library '%s' for module '%s'", - import_func, library_name, module); - } + if (!ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected '{'"); + return NULL; + } + } - /* Do not free id, as it will be stored as the component identifier */ - ecs_entity_t result = ecs_import(world, action, module); + else if (!ecs_os_strcmp(token, "]")) { + depth --; - if (import_func != module_name) { - ecs_os_free(import_func); - } + if (!ecs_meta_is_collection(&cur)) { + ecs_parser_error(name, expr, ptr - expr, "expected '}'"); + return NULL; + } - if (module != module_name) { - ecs_os_free(module); - } + if (ecs_meta_pop(&cur) != 0) { + goto error; + } + } - ecs_os_free(library_filename); + else if (!ecs_os_strcmp(token, ",")) { + if (ecs_meta_next(&cur) != 0) { + goto error; + } + } - return result; -error: - return 0; -} + else if (!ecs_os_strcmp(token, "null")) { + if (ecs_meta_set_null(&cur) != 0) { + goto error; + } + } -ecs_entity_t ecs_module_init( - ecs_world_t *world, - const ecs_component_desc_t *desc) -{ - ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_poly_assert(world, ecs_world_t); + else if (token[0] == '\"') { + if (ptr[0] == ':') { + /* Member assignment */ + ptr ++; - const char *name = desc->entity.name; + /* Strip trailing " */ + ecs_size_t len = ecs_os_strlen(token); + if (token[len - 1] != '"') { + ecs_parser_error(name, expr, ptr - expr, "expected \""); + return NULL; + } else { + token[len - 1] = '\0'; + } - char *module_path = ecs_module_path_from_c(name); - ecs_entity_t e = ecs_new_from_fullpath(world, module_path); - ecs_set_symbol(world, e, module_path); - ecs_os_free(module_path); + if (ecs_meta_member(&cur, token + 1) != 0) { + goto error; + } + } else { + if (ecs_meta_set_string_literal(&cur, token) != 0) { + goto error; + } + } + } - ecs_component_desc_t private_desc = *desc; - private_desc.entity.entity = e; - private_desc.entity.name = NULL; + else { + if (ecs_meta_set_string(&cur, token) != 0) { + goto error; + } + } - if (desc->size) { - ecs_entity_t result = ecs_component_init(world, &private_desc); - ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result == e, ECS_INTERNAL_ERROR, NULL); - (void)result; - } else { - ecs_entity_t result = ecs_entity_init(world, &private_desc.entity); - ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result == e, ECS_INTERNAL_ERROR, NULL); - (void)result; + if (!depth) { + break; + } } - return e; + return ptr; error: - return 0; + return NULL; } #endif -#ifdef FLECS_META_C +#ifdef FLECS_REST -#include +typedef struct { + ecs_world_t *world; + ecs_entity_t entity; + ecs_http_server_t *srv; + int32_t rc; +} ecs_rest_ctx_t; -#define ECS_META_IDENTIFIER_LENGTH (256) +static ECS_COPY(EcsRest, dst, src, { + ecs_rest_ctx_t *impl = src->impl; + if (impl) { + impl->rc ++; + } -#define ecs_meta_error(ctx, ptr, ...)\ - ecs_parser_error((ctx)->name, (ctx)->desc, ptr - (ctx)->desc, __VA_ARGS__); + ecs_os_strset(&dst->ipaddr, src->ipaddr); + dst->port = src->port; + dst->impl = impl; +}) -typedef char ecs_meta_token_t[ECS_META_IDENTIFIER_LENGTH]; +static ECS_MOVE(EcsRest, dst, src, { + *dst = *src; + src->ipaddr = NULL; + src->impl = NULL; +}) -typedef struct meta_parse_ctx_t { - const char *name; - const char *desc; -} meta_parse_ctx_t; +static ECS_DTOR(EcsRest, ptr, { + ecs_rest_ctx_t *impl = ptr->impl; + if (impl) { + impl->rc --; + if (!impl->rc) { + ecs_http_server_fini(impl->srv); + ecs_os_free(impl); + } + } + ecs_os_free(ptr->ipaddr); +}) -typedef struct meta_type_t { - ecs_meta_token_t type; - ecs_meta_token_t params; - bool is_const; - bool is_ptr; -} meta_type_t; +static char *rest_last_err; -typedef struct meta_member_t { - meta_type_t type; - ecs_meta_token_t name; - int64_t count; - bool is_partial; -} meta_member_t; +static +void rest_capture_log( + int32_t level, + const char *file, + int32_t line, + const char *msg) +{ + (void)file; (void)line; -typedef struct meta_constant_t { - ecs_meta_token_t name; - int64_t value; - bool is_value_set; -} meta_constant_t; + if (!rest_last_err && level < 0) { + rest_last_err = ecs_os_strdup(msg); + } +} -typedef struct meta_params_t { - meta_type_t key_type; - meta_type_t type; - int64_t count; - bool is_key_value; - bool is_fixed_size; -} meta_params_t; +static +char* rest_get_captured_log(void) { + char *result = rest_last_err; + rest_last_err = NULL; + return result; +} static -const char* skip_scope(const char *ptr, meta_parse_ctx_t *ctx) { - /* Keep track of which characters were used to open the scope */ - char stack[256]; - int32_t sp = 0; - char ch; +void reply_verror( + ecs_http_reply_t *reply, + const char *fmt, + va_list args) +{ + ecs_strbuf_appendstr(&reply->body, "{\"error\":\""); + ecs_strbuf_vappend(&reply->body, fmt, args); + ecs_strbuf_appendstr(&reply->body, "\"}"); +} - while ((ch = *ptr)) { - if (ch == '(' || ch == '<') { - stack[sp] = ch; +static +void reply_error( + ecs_http_reply_t *reply, + const char *fmt, + ...) +{ + va_list args; + va_start(args, fmt); + reply_verror(reply, fmt, args); + va_end(args); +} - sp ++; - if (sp >= 256) { - ecs_meta_error(ctx, ptr, "maximum level of nesting reached"); - goto error; - } - } else if (ch == ')' || ch == '>') { - sp --; - if ((sp < 0) || (ch == '>' && stack[sp] != '<') || - (ch == ')' && stack[sp] != '(')) - { - ecs_meta_error(ctx, ptr, "mismatching %c in identifier", ch); - goto error; - } +static +void rest_bool_param( + const ecs_http_request_t *req, + const char *name, + bool *value_out) +{ + const char *value = ecs_http_get_param(req, name); + if (value) { + if (!ecs_os_strcmp(value, "true")) { + value_out[0] = true; + } else { + value_out[0] = false; } + } +} - ptr ++; - - if (!sp) { - break; - } +static +void rest_int_param( + const ecs_http_request_t *req, + const char *name, + int32_t *value_out) +{ + const char *value = ecs_http_get_param(req, name); + if (value) { + *value_out = atoi(value); } +} + +static +void rest_parse_json_ser_entity_params( + ecs_entity_to_json_desc_t *desc, + const ecs_http_request_t *req) +{ + rest_bool_param(req, "path", &desc->serialize_path); + rest_bool_param(req, "label", &desc->serialize_label); + rest_bool_param(req, "brief", &desc->serialize_brief); + rest_bool_param(req, "link", &desc->serialize_link); + rest_bool_param(req, "id_labels", &desc->serialize_id_labels); + rest_bool_param(req, "base", &desc->serialize_base); + rest_bool_param(req, "values", &desc->serialize_values); + rest_bool_param(req, "private", &desc->serialize_private); + rest_bool_param(req, "type_info", &desc->serialize_type_info); +} - return ptr; -error: - return NULL; +static +void rest_parse_json_ser_iter_params( + ecs_iter_to_json_desc_t *desc, + const ecs_http_request_t *req) +{ + rest_bool_param(req, "term_ids", &desc->serialize_term_ids); + rest_bool_param(req, "ids", &desc->serialize_ids); + rest_bool_param(req, "subjects", &desc->serialize_subjects); + rest_bool_param(req, "variables", &desc->serialize_variables); + rest_bool_param(req, "is_set", &desc->serialize_is_set); + rest_bool_param(req, "values", &desc->serialize_values); + rest_bool_param(req, "entities", &desc->serialize_entities); + rest_bool_param(req, "entity_labels", &desc->serialize_entity_labels); + rest_bool_param(req, "variable_labels", &desc->serialize_variable_labels); + rest_bool_param(req, "duration", &desc->measure_eval_duration); + rest_bool_param(req, "type_info", &desc->serialize_type_info); } static -const char* parse_c_digit( - const char *ptr, - int64_t *value_out) +bool rest_reply( + const ecs_http_request_t* req, + ecs_http_reply_t *reply, + void *ctx) { - char token[24]; - ptr = ecs_parse_eol_and_whitespace(ptr); - ptr = ecs_parse_digit(ptr, token); - if (!ptr) { - goto error; + ecs_rest_ctx_t *impl = ctx; + ecs_world_t *world = impl->world; + + if (req->path == NULL) { + ecs_dbg("rest: bad request (missing path)"); + reply_error(reply, "bad request (missing path)"); + reply->code = 400; + return false; } - *value_out = strtol(token, NULL, 0); + ecs_strbuf_appendstr(&reply->headers, "Access-Control-Allow-Origin: *\r\n"); - return ecs_parse_eol_and_whitespace(ptr); -error: - return NULL; -} + if (req->method == EcsHttpGet) { + /* Entity endpoint */ + if (!ecs_os_strncmp(req->path, "entity/", 7)) { + char *path = &req->path[7]; + ecs_dbg_2("rest: request entity '%s'", path); -static -const char* parse_c_identifier( - const char *ptr, - char *buff, - char *params, - meta_parse_ctx_t *ctx) -{ - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(buff != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ctx != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t e = ecs_lookup_path_w_sep( + world, 0, path, "/", NULL, false); + if (!e) { + ecs_dbg_2("rest: entity '%s' not found", path); + reply_error(reply, "entity '%s' not found", path); + reply->code = 404; + return true; + } - char *bptr = buff, ch; + ecs_entity_to_json_desc_t desc = ECS_ENTITY_TO_JSON_INIT; + rest_parse_json_ser_entity_params(&desc, req); - if (params) { - params[0] = '\0'; - } + ecs_entity_to_json_buf(world, e, &reply->body, &desc); + return true; + + /* Query endpoint */ + } else if (!ecs_os_strcmp(req->path, "query")) { + const char *q = ecs_http_get_param(req, "q"); + if (!q) { + ecs_strbuf_appendstr(&reply->body, "Missing parameter 'q'"); + reply->code = 400; /* bad request */ + return true; + } - /* Ignore whitespaces */ - ptr = ecs_parse_eol_and_whitespace(ptr); + ecs_dbg_2("rest: request query '%s'", q); + bool prev_color = ecs_log_enable_colors(false); + ecs_os_api_log_t prev_log_ = ecs_os_api.log_; + ecs_os_api.log_ = rest_capture_log; - if (!isalpha(*ptr)) { - ecs_meta_error(ctx, ptr, - "invalid identifier (starts with '%c')", *ptr); - goto error; - } + ecs_rule_t *r = ecs_rule_init(world, &(ecs_filter_desc_t) { + .expr = q + }); + if (!r) { + char *err = rest_get_captured_log(); + char *escaped_err = ecs_astresc('"', err); + reply_error(reply, escaped_err); + reply->code = 400; /* bad request */ + ecs_os_free(escaped_err); + ecs_os_free(err); + } else { + ecs_iter_to_json_desc_t desc = ECS_ITER_TO_JSON_INIT; + rest_parse_json_ser_iter_params(&desc, req); - while ((ch = *ptr) && !isspace(ch) && ch != ';' && ch != ',' && ch != ')' && ch != '>' && ch != '}') { - /* Type definitions can contain macro's or templates */ - if (ch == '(' || ch == '<') { - if (!params) { - ecs_meta_error(ctx, ptr, "unexpected %c", *ptr); - goto error; + int32_t offset = 0; + int32_t limit = 100; + + rest_int_param(req, "offset", &offset); + rest_int_param(req, "limit", &limit); + + ecs_iter_t it = ecs_rule_iter(world, r); + ecs_iter_t pit = ecs_page_iter(&it, offset, limit); + ecs_iter_to_json_buf(world, &pit, &reply->body, &desc); + ecs_rule_fini(r); } - const char *end = skip_scope(ptr, ctx); - ecs_os_strncpy(params, ptr, (ecs_size_t)(end - ptr)); - params[end - ptr] = '\0'; + ecs_os_api.log_ = prev_log_; + ecs_log_enable_colors(prev_color); - ptr = end; - } else { - *bptr = ch; - bptr ++; - ptr ++; + return true; } } - - *bptr = '\0'; - - if (!ch) { - ecs_meta_error(ctx, ptr, "unexpected end of token"); - goto error; + if (req->method == EcsHttpOptions) { + return true; } - return ptr; -error: - return NULL; + return false; } static -const char * meta_open_scope( - const char *ptr, - meta_parse_ctx_t *ctx) +void on_set_rest(ecs_iter_t *it) { - /* Skip initial whitespaces */ - ptr = ecs_parse_eol_and_whitespace(ptr); + EcsRest *rest = it->ptrs[0]; - /* Is this the start of the type definition? */ - if (ctx->desc == ptr) { - if (*ptr != '{') { - ecs_meta_error(ctx, ptr, "missing '{' in struct definition"); - goto error; + int i; + for(i = 0; i < it->count; i ++) { + if (!rest[i].port) { + rest[i].port = ECS_REST_DEFAULT_PORT; } - ptr ++; - ptr = ecs_parse_eol_and_whitespace(ptr); - } - - /* Is this the end of the type definition? */ - if (!*ptr) { - ecs_meta_error(ctx, ptr, "missing '}' at end of struct definition"); - goto error; - } + ecs_rest_ctx_t *srv_ctx = ecs_os_malloc_t(ecs_rest_ctx_t); + ecs_http_server_t *srv = ecs_http_server_init(&(ecs_http_server_desc_t){ + .ipaddr = rest[i].ipaddr, + .port = rest[i].port, + .callback = rest_reply, + .ctx = srv_ctx + }); - /* Is this the end of the type definition? */ - if (*ptr == '}') { - ptr = ecs_parse_eol_and_whitespace(ptr + 1); - if (*ptr) { - ecs_meta_error(ctx, ptr, - "stray characters after struct definition"); - goto error; + if (!srv) { + const char *ipaddr = rest[i].ipaddr ? rest[i].ipaddr : "0.0.0.0"; + ecs_err("failed to create REST server on %s:%u", + ipaddr, rest[i].port); + ecs_os_free(srv_ctx); + continue; } - return NULL; - } - return ptr; -error: - return NULL; + srv_ctx->world = it->world; + srv_ctx->entity = it->entities[i]; + srv_ctx->srv = srv; + srv_ctx->rc = 1; + + rest[i].impl = srv_ctx; + + ecs_http_server_start(srv_ctx->srv); + } } static -const char* meta_parse_constant( - const char *ptr, - meta_constant_t *token, - meta_parse_ctx_t *ctx) -{ - ptr = meta_open_scope(ptr, ctx); - if (!ptr) { - return NULL; +void DequeueRest(ecs_iter_t *it) { + EcsRest *rest = ecs_term(it, EcsRest, 1); + + if (it->delta_system_time > (FLECS_FLOAT)1.0) { + ecs_warn( + "detected large progress interval (%.2fs), REST request may timeout", + (double)it->delta_system_time); } - token->is_value_set = false; + int32_t i; + for(i = 0; i < it->count; i ++) { + ecs_rest_ctx_t *ctx = rest[i].impl; + if (ctx) { + ecs_http_server_dequeue(ctx->srv, it->delta_time); + } + } +} - /* Parse token, constant identifier */ - ptr = parse_c_identifier(ptr, token->name, NULL, ctx); - if (!ptr) { - return NULL; - } +void FlecsRestImport( + ecs_world_t *world) +{ + ECS_MODULE(world, FlecsRest); - ptr = ecs_parse_eol_and_whitespace(ptr); - if (!ptr) { - return NULL; - } + ecs_set_name_prefix(world, "Ecs"); - /* Explicit value assignment */ - if (*ptr == '=') { - int64_t value = 0; - ptr = parse_c_digit(ptr + 1, &value); - token->value = value; - token->is_value_set = true; - } + flecs_bootstrap_component(world, EcsRest); - /* Expect a ',' or '}' */ - if (*ptr != ',' && *ptr != '}') { - ecs_meta_error(ctx, ptr, "missing , after enum constant"); - goto error; - } + ecs_set_component_actions(world, EcsRest, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsRest), + .copy = ecs_copy(EcsRest), + .dtor = ecs_dtor(EcsRest), + .on_set = on_set_rest + }); - if (*ptr == ',') { - return ptr + 1; - } else { - return ptr; - } -error: - return NULL; + ECS_SYSTEM(world, DequeueRest, EcsPostFrame, EcsRest); } -static -const char* meta_parse_type( - const char *ptr, - meta_type_t *token, - meta_parse_ctx_t *ctx) -{ - token->is_ptr = false; - token->is_const = false; +#endif - ptr = ecs_parse_eol_and_whitespace(ptr); - /* Parse token, expect type identifier or ECS_PROPERTY */ - ptr = parse_c_identifier(ptr, token->type, token->params, ctx); - if (!ptr) { - goto error; - } - if (!strcmp(token->type, "ECS_PRIVATE")) { - /* Members from this point are not stored in metadata */ - ptr += ecs_os_strlen(ptr); - goto done; - } +#ifdef FLECS_COREDOC - /* If token is const, set const flag and continue parsing type */ - if (!strcmp(token->type, "const")) { - token->is_const = true; +#define URL_ROOT "https://flecs.docsforge.com/master/relations-manual/" - /* Parse type after const */ - ptr = parse_c_identifier(ptr + 1, token->type, token->params, ctx); - } +void FlecsCoreDocImport( + ecs_world_t *world) +{ + ECS_MODULE(world, FlecsCoreDoc); - /* Check if type is a pointer */ - ptr = ecs_parse_eol_and_whitespace(ptr); - if (*ptr == '*') { - token->is_ptr = true; - ptr ++; - } + ECS_IMPORT(world, FlecsMeta); + ECS_IMPORT(world, FlecsDoc); -done: - return ptr; -error: - return NULL; -} + ecs_set_name_prefix(world, "Ecs"); -static -const char* meta_parse_member( - const char *ptr, - meta_member_t *token, - meta_parse_ctx_t *ctx) -{ - ptr = meta_open_scope(ptr, ctx); - if (!ptr) { - return NULL; - } + /* Initialize reflection data for core components */ - token->count = 1; - token->is_partial = false; + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsComponent), + .members = { + {.name = (char*)"size", .type = ecs_id(ecs_i32_t)}, + {.name = (char*)"alignment", .type = ecs_id(ecs_i32_t)} + } + }); - /* Parse member type */ - ptr = meta_parse_type(ptr, &token->type, ctx); - if (!ptr) { - token->is_partial = true; - goto error; - } + ecs_struct_init(world, &(ecs_struct_desc_t) { + .entity.entity = ecs_id(EcsDocDescription), + .members = { + {.name = "value", .type = ecs_id(ecs_string_t)} + } + }); - /* Next token is the identifier */ - ptr = parse_c_identifier(ptr, token->name, NULL, ctx); - if (!ptr) { - goto error; - } + /* Initialize documentation data for core components */ + ecs_doc_set_brief(world, EcsFlecs, "Flecs root module"); + ecs_doc_set_link(world, EcsFlecs, "https://github.com/SanderMertens/flecs"); - /* Skip whitespace between member and [ or ; */ - ptr = ecs_parse_eol_and_whitespace(ptr); + ecs_doc_set_brief(world, EcsFlecsCore, "Flecs module with builtin components"); + ecs_doc_set_brief(world, EcsFlecsHidden, "Flecs module with internal/anonymous entities"); - /* Check if this is an array */ - char *array_start = strchr(token->name, '['); - if (!array_start) { - /* If the [ was separated by a space, it will not be parsed as part of - * the name */ - if (*ptr == '[') { - array_start = (char*)ptr; /* safe, will not be modified */ - } - } + ecs_doc_set_brief(world, EcsWorld, "Entity associated with world"); - if (array_start) { - /* Check if the [ matches with a ] */ - char *array_end = strchr(array_start, ']'); - if (!array_end) { - ecs_meta_error(ctx, ptr, "missing ']'"); - goto error; + ecs_doc_set_brief(world, ecs_id(EcsComponent), "Component that is added to all components"); + ecs_doc_set_brief(world, EcsModule, "Tag that is added to modules"); + ecs_doc_set_brief(world, EcsPrefab, "Tag that is added to prefabs"); + ecs_doc_set_brief(world, EcsDisabled, "Tag that is added to disabled entities"); - } else if (array_end - array_start == 0) { - ecs_meta_error(ctx, ptr, "dynamic size arrays are not supported"); - goto error; - } + ecs_doc_set_brief(world, ecs_id(EcsIdentifier), "Component used for entity names"); + ecs_doc_set_brief(world, EcsName, "Tag used with EcsIdentifier to signal entity name"); + ecs_doc_set_brief(world, EcsSymbol, "Tag used with EcsIdentifier to signal entity symbol"); - token->count = atoi(array_start + 1); + ecs_doc_set_brief(world, ecs_id(EcsComponentLifecycle), "Callbacks for component constructors, destructors, copy and move operations"); - if (array_start == ptr) { - /* If [ was found after name, continue parsing after ] */ - ptr = array_end + 1; - } else { - /* If [ was fonud in name, replace it with 0 terminator */ - array_start[0] = '\0'; - } - } + ecs_doc_set_brief(world, EcsTransitive, "Transitive relation property"); + ecs_doc_set_brief(world, EcsReflexive, "Reflexive relation property"); + ecs_doc_set_brief(world, EcsFinal, "Final relation property"); + ecs_doc_set_brief(world, EcsDontInherit, "DontInherit relation property"); + ecs_doc_set_brief(world, EcsTag, "Tag relation property"); + ecs_doc_set_brief(world, EcsAcyclic, "Acyclic relation property"); + ecs_doc_set_brief(world, EcsExclusive, "Exclusive relation property"); + ecs_doc_set_brief(world, EcsSymmetric, "Symmetric relation property"); + ecs_doc_set_brief(world, EcsWith, "With relation property"); + ecs_doc_set_brief(world, EcsOnDelete, "OnDelete relation cleanup property"); + ecs_doc_set_brief(world, EcsOnDeleteObject, "OnDeleteObject relation cleanup property"); + ecs_doc_set_brief(world, EcsDefaultChildComponent, "Sets default component hint for children of entity"); + ecs_doc_set_brief(world, EcsRemove, "Remove relation cleanup property"); + ecs_doc_set_brief(world, EcsDelete, "Delete relation cleanup property"); + ecs_doc_set_brief(world, EcsThrow, "Throw relation cleanup property"); + ecs_doc_set_brief(world, EcsIsA, "Builtin IsA relation"); + ecs_doc_set_brief(world, EcsChildOf, "Builtin ChildOf relation"); + ecs_doc_set_brief(world, EcsOnAdd, "Builtin OnAdd event"); + ecs_doc_set_brief(world, EcsOnRemove, "Builtin OnRemove event"); + ecs_doc_set_brief(world, EcsOnSet, "Builtin OnSet event"); + ecs_doc_set_brief(world, EcsUnSet, "Builtin UnSet event"); - /* Expect a ; */ - if (*ptr != ';') { - ecs_meta_error(ctx, ptr, "missing ; after member declaration"); - goto error; - } + ecs_doc_set_link(world, EcsTransitive, URL_ROOT "#transitive-property"); + ecs_doc_set_link(world, EcsReflexive, URL_ROOT "#reflexive-property"); + ecs_doc_set_link(world, EcsFinal, URL_ROOT "#final-property"); + ecs_doc_set_link(world, EcsDontInherit, URL_ROOT "#dontinherit-property"); + ecs_doc_set_link(world, EcsTag, URL_ROOT "#tag-property"); + ecs_doc_set_link(world, EcsAcyclic, URL_ROOT "#acyclic-property"); + ecs_doc_set_link(world, EcsExclusive, URL_ROOT "#exclusive-property"); + ecs_doc_set_link(world, EcsSymmetric, URL_ROOT "#symmetric-property"); + ecs_doc_set_link(world, EcsWith, URL_ROOT "#with-property"); + ecs_doc_set_link(world, EcsOnDelete, URL_ROOT "#cleanup-properties"); + ecs_doc_set_link(world, EcsOnDeleteObject, URL_ROOT "#cleanup-properties"); + ecs_doc_set_link(world, EcsRemove, URL_ROOT "#cleanup-properties"); + ecs_doc_set_link(world, EcsDelete, URL_ROOT "#cleanup-properties"); + ecs_doc_set_link(world, EcsThrow, URL_ROOT "#cleanup-properties"); + ecs_doc_set_link(world, EcsIsA, URL_ROOT "#the-isa-relation"); + ecs_doc_set_link(world, EcsChildOf, URL_ROOT "#the-childof-relation"); + + /* Initialize documentation for meta components */ + ecs_entity_t meta = ecs_lookup_fullpath(world, "flecs.meta"); + ecs_doc_set_brief(world, meta, "Flecs module with reflection components"); - return ptr + 1; -error: - return NULL; + ecs_doc_set_brief(world, ecs_id(EcsMetaType), "Component added to types"); + ecs_doc_set_brief(world, ecs_id(EcsMetaTypeSerialized), "Component that stores reflection data in an optimized format"); + ecs_doc_set_brief(world, ecs_id(EcsPrimitive), "Component added to primitive types"); + ecs_doc_set_brief(world, ecs_id(EcsEnum), "Component added to enumeration types"); + ecs_doc_set_brief(world, ecs_id(EcsBitmask), "Component added to bitmask types"); + ecs_doc_set_brief(world, ecs_id(EcsMember), "Component added to struct members"); + ecs_doc_set_brief(world, ecs_id(EcsStruct), "Component added to struct types"); + ecs_doc_set_brief(world, ecs_id(EcsArray), "Component added to array types"); + ecs_doc_set_brief(world, ecs_id(EcsVector), "Component added to vector types"); + + ecs_doc_set_brief(world, ecs_id(ecs_bool_t), "bool component"); + ecs_doc_set_brief(world, ecs_id(ecs_char_t), "char component"); + ecs_doc_set_brief(world, ecs_id(ecs_byte_t), "byte component"); + ecs_doc_set_brief(world, ecs_id(ecs_u8_t), "8 bit unsigned int component"); + ecs_doc_set_brief(world, ecs_id(ecs_u16_t), "16 bit unsigned int component"); + ecs_doc_set_brief(world, ecs_id(ecs_u32_t), "32 bit unsigned int component"); + ecs_doc_set_brief(world, ecs_id(ecs_u64_t), "64 bit unsigned int component"); + ecs_doc_set_brief(world, ecs_id(ecs_uptr_t), "word sized unsigned int component"); + ecs_doc_set_brief(world, ecs_id(ecs_i8_t), "8 bit signed int component"); + ecs_doc_set_brief(world, ecs_id(ecs_i16_t), "16 bit signed int component"); + ecs_doc_set_brief(world, ecs_id(ecs_i32_t), "32 bit signed int component"); + ecs_doc_set_brief(world, ecs_id(ecs_i64_t), "64 bit signed int component"); + ecs_doc_set_brief(world, ecs_id(ecs_iptr_t), "word sized signed int component"); + ecs_doc_set_brief(world, ecs_id(ecs_f32_t), "32 bit floating point component"); + ecs_doc_set_brief(world, ecs_id(ecs_f64_t), "64 bit floating point component"); + ecs_doc_set_brief(world, ecs_id(ecs_string_t), "string component"); + ecs_doc_set_brief(world, ecs_id(ecs_entity_t), "entity component"); + + /* Initialize documentation for doc components */ + ecs_entity_t doc = ecs_lookup_fullpath(world, "flecs.doc"); + ecs_doc_set_brief(world, doc, "Flecs module with documentation components"); + + ecs_doc_set_brief(world, ecs_id(EcsDocDescription), "Component used to add documentation"); + ecs_doc_set_brief(world, EcsDocBrief, "Used as (Description, Brief) to add a brief description"); + ecs_doc_set_brief(world, EcsDocDetail, "Used as (Description, Detail) to add a detailed description"); + ecs_doc_set_brief(world, EcsDocLink, "Used as (Description, Link) to add a link"); } -static -int meta_parse_desc( - const char *ptr, - meta_params_t *token, - meta_parse_ctx_t *ctx) -{ - token->is_key_value = false; - token->is_fixed_size = false; +#endif + +/* This is a heavily modified version of the EmbeddableWebServer (see copyright + * below). This version has been stripped from everything not strictly necessary + * for receiving/replying to simple HTTP requests, and has been modified to use + * the Flecs OS API. */ + +/* EmbeddableWebServer Copyright (c) 2016, 2019, 2020 Forrest Heller, and + * CONTRIBUTORS (see below) - All rights reserved. + * + * CONTRIBUTORS: + * Martin Pulec - bug fixes, warning fixes, IPv6 support + * Daniel Barry - bug fix (ifa_addr != NULL) + * + * Released under the BSD 2-clause license: + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. THIS SOFTWARE IS + * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN + * NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + - ptr = ecs_parse_eol_and_whitespace(ptr); - if (*ptr != '(' && *ptr != '<') { - ecs_meta_error(ctx, ptr, - "expected '(' at start of collection definition"); - goto error; - } +#ifdef FLECS_HTTP - ptr ++; +#if defined(ECS_TARGET_WINDOWS) +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#pragma comment(lib, "Ws2_32.lib") +#include +#include +#include +typedef SOCKET ecs_http_socket_t; +#else +#include +#include +#include +#include +#include +#include +typedef int ecs_http_socket_t; +#endif - /* Parse type identifier */ - ptr = meta_parse_type(ptr, &token->type, ctx); - if (!ptr) { - goto error; - } +/* Max length of request method */ +#define ECS_HTTP_METHOD_LEN_MAX (8) - ptr = ecs_parse_eol_and_whitespace(ptr); +/* Timeout (s) before connection purge */ +#define ECS_HTTP_CONNECTION_PURGE_TIMEOUT (1.0) - /* If next token is a ',' the first type was a key type */ - if (*ptr == ',') { - ptr = ecs_parse_eol_and_whitespace(ptr + 1); - - if (isdigit(*ptr)) { - int64_t value; - ptr = parse_c_digit(ptr, &value); - if (!ptr) { - goto error; - } +/* Number of dequeues before purging */ +#define ECS_HTTP_CONNECTION_PURGE_RETRY_COUNT (5) - token->count = value; - token->is_fixed_size = true; - } else { - token->key_type = token->type; +/* Minimum interval between dequeueing requests (ms) */ +#define ECS_HTTP_MIN_DEQUEUE_INTERVAL (100) - /* Parse element type */ - ptr = meta_parse_type(ptr, &token->type, ctx); - ptr = ecs_parse_eol_and_whitespace(ptr); +/* Minimum interval between printing statistics (ms) */ +#define ECS_HTTP_MIN_STATS_INTERVAL (10 * 1000) - token->is_key_value = true; - } - } +/* Max length of headers in reply */ +#define ECS_HTTP_REPLY_HEADER_SIZE (1024) - if (*ptr != ')' && *ptr != '>') { - ecs_meta_error(ctx, ptr, - "expected ')' at end of collection definition"); - goto error; - } +/* Receive buffer size */ +#define ECS_HTTP_SEND_RECV_BUFFER_SIZE (16 * 1024) - return 0; -error: - return -1; -} +/* Max length of request (path + query + headers + body) */ +#define ECS_HTTP_REQUEST_LEN_MAX (10 * 1024 * 1024) -static -ecs_entity_t meta_lookup( - ecs_world_t *world, - meta_type_t *token, - const char *ptr, - int64_t count, - meta_parse_ctx_t *ctx); +/* HTTP server struct */ +struct ecs_http_server_t { + bool should_run; + bool running; -static -ecs_entity_t meta_lookup_array( - ecs_world_t *world, - ecs_entity_t e, - const char *params_decl, - meta_parse_ctx_t *ctx) -{ - meta_parse_ctx_t param_ctx = { - .name = ctx->name, - .desc = params_decl - }; + ecs_http_socket_t sock; + ecs_os_mutex_t lock; + ecs_os_thread_t thread; - meta_params_t params; - if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { - goto error; - } - if (!params.is_fixed_size) { - ecs_meta_error(ctx, params_decl, "missing size for array"); - goto error; - } + ecs_http_reply_action_t callback; + void *ctx; - if (!params.count) { - ecs_meta_error(ctx, params_decl, "invalid array size"); - goto error; - } + ecs_sparse_t *connections; /* sparse */ + ecs_sparse_t *requests; /* sparse */ - ecs_entity_t element_type = ecs_lookup_symbol(world, params.type.type, true); - if (!element_type) { - ecs_meta_error(ctx, params_decl, "unknown element type '%s'", - params.type.type); - } + bool initialized; - if (!e) { - e = ecs_new_id(world); - } + uint16_t port; + const char *ipaddr; - ecs_check(params.count <= INT32_MAX, ECS_INVALID_PARAMETER, NULL); + FLECS_FLOAT dequeue_timeout; /* used to not lock request queue too often */ + FLECS_FLOAT stats_timeout; /* used for periodic reporting of statistics */ - return ecs_set(world, e, EcsArray, { element_type, (int32_t)params.count }); -error: - return 0; -} + FLECS_FLOAT request_time; /* time spent on requests in last stats interval */ + FLECS_FLOAT request_time_total; /* total time spent on requests */ + int32_t requests_processed; /* requests processed in last stats interval */ + int32_t requests_processed_total; /* total requests processed */ + int32_t dequeue_count; /* number of dequeues in last stats interval */ +}; -static -ecs_entity_t meta_lookup_vector( - ecs_world_t *world, - ecs_entity_t e, - const char *params_decl, - meta_parse_ctx_t *ctx) -{ - meta_parse_ctx_t param_ctx = { - .name = ctx->name, - .desc = params_decl - }; +/** Fragment state, used by HTTP request parser */ +typedef enum { + HttpFragStateBegin, + HttpFragStateMethod, + HttpFragStatePath, + HttpFragStateVersion, + HttpFragStateHeaderStart, + HttpFragStateHeaderName, + HttpFragStateHeaderValueStart, + HttpFragStateHeaderValue, + HttpFragStateCR, + HttpFragStateCRLF, + HttpFragStateCRLFCR, + HttpFragStateBody, + HttpFragStateDone +} HttpFragState; - meta_params_t params; - if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { - goto error; - } +/** A fragment is a partially received HTTP request */ +typedef struct { + HttpFragState state; + ecs_strbuf_t buf; + ecs_http_method_t method; + int32_t body_offset; + int32_t query_offset; + int32_t header_offsets[ECS_HTTP_HEADER_COUNT_MAX]; + int32_t header_value_offsets[ECS_HTTP_HEADER_COUNT_MAX]; + int32_t header_count; + int32_t param_offsets[ECS_HTTP_QUERY_PARAM_COUNT_MAX]; + int32_t param_value_offsets[ECS_HTTP_QUERY_PARAM_COUNT_MAX]; + int32_t param_count; + char header_buf[32]; + char *header_buf_ptr; + int32_t content_length; + bool parse_content_length; + bool invalid; +} ecs_http_fragment_t; - if (params.is_key_value) { - ecs_meta_error(ctx, params_decl, - "unexpected key value parameters for vector"); - goto error; - } +/** Extend public connection type with fragment data */ +typedef struct { + ecs_http_connection_t pub; + ecs_http_fragment_t frag; + ecs_http_socket_t sock; - ecs_entity_t element_type = meta_lookup( - world, ¶ms.type, params_decl, 1, ¶m_ctx); + /* Connection is purged after both timeout expires and connection has + * exceeded retry count. This ensures that a connection does not immediately + * timeout when a frame takes longer than usual */ + FLECS_FLOAT dequeue_timeout; + int32_t dequeue_retries; +} ecs_http_connection_impl_t; - if (!e) { - e = ecs_new_id(world); - } +typedef struct { + ecs_http_request_t pub; + uint64_t conn_id; /* for sanity check */ + void *res; +} ecs_http_request_impl_t; - return ecs_set(world, e, EcsVector, { element_type }); -error: - return 0; +static +ecs_size_t http_send( + ecs_http_socket_t sock, + const void *buf, + ecs_size_t size, + int flags) +{ +#ifndef ECS_TARGET_MSVC + ssize_t send_bytes = send(sock, buf, flecs_itosize(size), flags); + return flecs_itoi32(send_bytes); +#else + int send_bytes = send(sock, buf, size, flags); + return flecs_itoi32(send_bytes); +#endif } static -ecs_entity_t meta_lookup_bitmask( - ecs_world_t *world, - ecs_entity_t e, - const char *params_decl, - meta_parse_ctx_t *ctx) +ecs_size_t http_recv( + ecs_http_socket_t sock, + void *buf, + ecs_size_t size, + int flags) { - (void)e; - - meta_parse_ctx_t param_ctx = { - .name = ctx->name, - .desc = params_decl - }; - - meta_params_t params; - if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { - goto error; + ecs_size_t ret; +#ifndef ECS_TARGET_MSVC + ssize_t recv_bytes = recv(sock, buf, flecs_itosize(size), flags); + ret = flecs_itoi32(recv_bytes); +#else + int recv_bytes = recv(sock, buf, size, flags); + ret = flecs_itoi32(recv_bytes); +#endif + if (ret == -1) { + ecs_dbg("recv failed: %s (sock = %d)", ecs_os_strerror(errno), sock); + } else if (ret == 0) { + ecs_dbg("recv: received 0 bytes (sock = %d)", sock); } - if (params.is_key_value) { - ecs_meta_error(ctx, params_decl, - "unexpected key value parameters for bitmask"); - goto error; - } + return ret; +} - if (params.is_fixed_size) { - ecs_meta_error(ctx, params_decl, - "unexpected size for bitmask"); - goto error; - } +static +int http_getnameinfo( + const struct sockaddr* addr, + ecs_size_t addr_len, + char *host, + ecs_size_t host_len, + char *port, + ecs_size_t port_len, + int flags) +{ + ecs_assert(addr_len > 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(host_len > 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(port_len > 0, ECS_INTERNAL_ERROR, NULL); + return getnameinfo(addr, (uint32_t)addr_len, host, (uint32_t)host_len, + port, (uint32_t)port_len, flags); +} - ecs_entity_t bitmask_type = meta_lookup( - world, ¶ms.type, params_decl, 1, ¶m_ctx); - ecs_check(bitmask_type != 0, ECS_INVALID_PARAMETER, NULL); +static +int http_bind( + ecs_http_socket_t sock, + const struct sockaddr* addr, + ecs_size_t addr_len) +{ + ecs_assert(addr_len > 0, ECS_INTERNAL_ERROR, NULL); + return bind(sock, addr, (uint32_t)addr_len); +} -#ifndef FLECS_NDEBUG - /* Make sure this is a bitmask type */ - const EcsMetaType *type_ptr = ecs_get(world, bitmask_type, EcsMetaType); - ecs_check(type_ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(type_ptr->kind == EcsBitmaskType, ECS_INVALID_PARAMETER, NULL); +static +void http_close( + ecs_http_socket_t sock) +{ +#if defined(ECS_TARGET_WINDOWS) + closesocket(sock); +#else + shutdown(sock, SHUT_RDWR); + close(sock); #endif - - return bitmask_type; -error: - return 0; } static -ecs_entity_t meta_lookup( - ecs_world_t *world, - meta_type_t *token, - const char *ptr, - int64_t count, - meta_parse_ctx_t *ctx) +ecs_http_socket_t http_accept( + ecs_http_socket_t sock, + struct sockaddr* addr, + ecs_size_t *addr_len) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(token != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ctx != NULL, ECS_INTERNAL_ERROR, NULL); - - const char *typename = token->type; - ecs_entity_t type = 0; - - /* Parse vector type */ - if (!token->is_ptr) { - if (!ecs_os_strcmp(typename, "ecs_array")) { - type = meta_lookup_array(world, 0, token->params, ctx); - - } else if (!ecs_os_strcmp(typename, "ecs_vector") || - !ecs_os_strcmp(typename, "flecs::vector")) - { - type = meta_lookup_vector(world, 0, token->params, ctx); - - } else if (!ecs_os_strcmp(typename, "flecs::bitmask")) { - type = meta_lookup_bitmask(world, 0, token->params, ctx); - - } else if (!ecs_os_strcmp(typename, "flecs::byte")) { - type = ecs_id(ecs_byte_t); + socklen_t len = (socklen_t)addr_len[0]; + ecs_http_socket_t result = accept(sock, addr, &len); + addr_len[0] = (ecs_size_t)len; + return result; +} - } else if (!ecs_os_strcmp(typename, "char")) { - type = ecs_id(ecs_char_t); +static +void reply_free(ecs_http_reply_t* response) { + ecs_assert(response != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_os_free(response->body.content); +} - } else if (!ecs_os_strcmp(typename, "bool") || - !ecs_os_strcmp(typename, "_Bool")) - { - type = ecs_id(ecs_bool_t); +static +void request_free(ecs_http_request_impl_t *req) { + ecs_assert(req != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(req->pub.conn != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(req->pub.conn->server != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(req->pub.conn->server->requests != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(req->pub.conn->id == req->conn_id, ECS_INTERNAL_ERROR, NULL); + ecs_os_free(req->res); + flecs_sparse_remove(req->pub.conn->server->requests, req->pub.id); +} - } else if (!ecs_os_strcmp(typename, "int8_t")) { - type = ecs_id(ecs_i8_t); - } else if (!ecs_os_strcmp(typename, "int16_t")) { - type = ecs_id(ecs_i16_t); - } else if (!ecs_os_strcmp(typename, "int32_t")) { - type = ecs_id(ecs_i32_t); - } else if (!ecs_os_strcmp(typename, "int64_t")) { - type = ecs_id(ecs_i64_t); +static +void connection_free(ecs_http_connection_impl_t *conn) { + ecs_assert(conn != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(conn->pub.id != 0, ECS_INTERNAL_ERROR, NULL); + uint64_t conn_id = conn->pub.id; - } else if (!ecs_os_strcmp(typename, "uint8_t")) { - type = ecs_id(ecs_u8_t); - } else if (!ecs_os_strcmp(typename, "uint16_t")) { - type = ecs_id(ecs_u16_t); - } else if (!ecs_os_strcmp(typename, "uint32_t")) { - type = ecs_id(ecs_u32_t); - } else if (!ecs_os_strcmp(typename, "uint64_t")) { - type = ecs_id(ecs_u64_t); + if (conn->sock) { + http_close(conn->sock); + } - } else if (!ecs_os_strcmp(typename, "float")) { - type = ecs_id(ecs_f32_t); - } else if (!ecs_os_strcmp(typename, "double")) { - type = ecs_id(ecs_f64_t); + flecs_sparse_remove(conn->pub.server->connections, conn_id); +} - } else if (!ecs_os_strcmp(typename, "ecs_entity_t")) { - type = ecs_id(ecs_entity_t); +// https://stackoverflow.com/questions/10156409/convert-hex-string-char-to-int +static +char hex_2_int(char a, char b){ + a = (a <= '9') ? (char)(a - '0') : (char)((a & 0x7) + 9); + b = (b <= '9') ? (char)(b - '0') : (char)((b & 0x7) + 9); + return (char)((a << 4) + b); +} - } else if (!ecs_os_strcmp(typename, "char*")) { - type = ecs_id(ecs_string_t); +static +void decode_url_str( + char *str) +{ + char ch, *ptr, *dst = str; + for (ptr = str; (ch = *ptr); ptr++) { + if (ch == '%') { + dst[0] = hex_2_int(ptr[1], ptr[2]); + dst ++; + ptr += 2; } else { - type = ecs_lookup_symbol(world, typename, true); - } - } else { - if (!ecs_os_strcmp(typename, "char")) { - typename = "flecs.meta.string"; - } else - if (token->is_ptr) { - typename = "flecs.meta.uptr"; - } else - if (!ecs_os_strcmp(typename, "char*") || - !ecs_os_strcmp(typename, "flecs::string")) - { - typename = "flecs.meta.string"; + dst[0] = ptr[0]; + dst ++; } + } + dst[0] = '\0'; +} - type = ecs_lookup_symbol(world, typename, true); +static +void parse_method( + ecs_http_fragment_t *frag) +{ + char *method = ecs_strbuf_get_small(&frag->buf); + if (!ecs_os_strcmp(method, "GET")) frag->method = EcsHttpGet; + else if (!ecs_os_strcmp(method, "POST")) frag->method = EcsHttpPost; + else if (!ecs_os_strcmp(method, "PUT")) frag->method = EcsHttpPut; + else if (!ecs_os_strcmp(method, "DELETE")) frag->method = EcsHttpDelete; + else if (!ecs_os_strcmp(method, "OPTIONS")) frag->method = EcsHttpOptions; + else { + frag->method = EcsHttpMethodUnsupported; + frag->invalid = true; } + ecs_strbuf_reset(&frag->buf); +} - if (count != 1) { - ecs_check(count <= INT32_MAX, ECS_INVALID_PARAMETER, NULL); +static +bool header_writable( + ecs_http_fragment_t *frag) +{ + return frag->header_count < ECS_HTTP_HEADER_COUNT_MAX; +} - type = ecs_set(world, 0, EcsArray, {type, (int32_t)count}); - } +static +void header_buf_reset( + ecs_http_fragment_t *frag) +{ + frag->header_buf[0] = '\0'; + frag->header_buf_ptr = frag->header_buf; +} - if (!type) { - ecs_meta_error(ctx, ptr, "unknown type '%s'", typename); - goto error; +static +void header_buf_append( + ecs_http_fragment_t *frag, + char ch) +{ + if ((frag->header_buf_ptr - frag->header_buf) < + ECS_SIZEOF(frag->header_buf)) + { + frag->header_buf_ptr[0] = ch; + frag->header_buf_ptr ++; + } else { + frag->header_buf_ptr[0] = '\0'; } - - return type; -error: - return 0; } static -int meta_parse_struct( - ecs_world_t *world, - ecs_entity_t t, - const char *desc) +void enqueue_request( + ecs_http_connection_impl_t *conn) { - const char *ptr = desc; - const char *name = ecs_get_name(world, t); - - meta_member_t token; - meta_parse_ctx_t ctx = { - .name = name, - .desc = ptr - }; + ecs_http_server_t *srv = conn->pub.server; + ecs_http_fragment_t *frag = &conn->frag; - ecs_entity_t old_scope = ecs_set_scope(world, t); + if (frag->invalid) { /* invalid request received, don't enqueue */ + ecs_strbuf_reset(&frag->buf); + } else { + char *res = ecs_strbuf_get(&frag->buf); + if (res) { + ecs_os_mutex_lock(srv->lock); + ecs_http_request_impl_t *req = flecs_sparse_add( + srv->requests, ecs_http_request_impl_t); + req->pub.id = flecs_sparse_last_id(srv->requests); + req->conn_id = conn->pub.id; + ecs_os_mutex_unlock(srv->lock); - while ((ptr = meta_parse_member(ptr, &token, &ctx)) && ptr[0]) { - ecs_entity_t m = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = token.name - }); + req->pub.conn = (ecs_http_connection_t*)conn; + req->pub.method = frag->method; + req->pub.path = res + 1; + if (frag->body_offset) { + req->pub.body = &res[frag->body_offset]; + } + int32_t i, count = frag->header_count; + for (i = 0; i < count; i ++) { + req->pub.headers[i].key = &res[frag->header_offsets[i]]; + req->pub.headers[i].value = &res[frag->header_value_offsets[i]]; + } + count = frag->param_count; + for (i = 0; i < count; i ++) { + req->pub.params[i].key = &res[frag->param_offsets[i]]; + req->pub.params[i].value = &res[frag->param_value_offsets[i]]; + decode_url_str((char*)req->pub.params[i].value); + } - ecs_entity_t type = meta_lookup( - world, &token.type, ptr, 1, &ctx); - if (!type) { - goto error; + req->pub.header_count = frag->header_count; + req->pub.param_count = frag->param_count; + req->res = res; } - - ecs_set(world, m, EcsMember, { - .type = type, - .count = (ecs_size_t)token.count - }); } - - ecs_set_scope(world, old_scope); - - return 0; -error: - return -1; } static -int meta_parse_constants( - ecs_world_t *world, - ecs_entity_t t, - const char *desc, - bool is_bitmask) +bool parse_request( + ecs_http_connection_impl_t *conn, + uint64_t conn_id, + const char* req_frag, + ecs_size_t req_frag_len) { - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(t != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(desc != NULL, ECS_INTERNAL_ERROR, NULL); - - const char *ptr = desc; - const char *name = ecs_get_name(world, t); - - meta_parse_ctx_t ctx = { - .name = name, - .desc = ptr - }; - - meta_constant_t token; - int64_t last_value = 0; + ecs_http_fragment_t *frag = &conn->frag; - ecs_entity_t old_scope = ecs_set_scope(world, t); + int32_t i; + for (i = 0; i < req_frag_len; i++) { + char c = req_frag[i]; + switch (frag->state) { + case HttpFragStateBegin: + ecs_os_memset_t(frag, 0, ecs_http_fragment_t); + frag->buf.max = ECS_HTTP_METHOD_LEN_MAX; + frag->state = HttpFragStateMethod; + frag->header_buf_ptr = frag->header_buf; + /* fallthrough */ + case HttpFragStateMethod: + if (c == ' ') { + parse_method(frag); + frag->state = HttpFragStatePath; + frag->buf.max = ECS_HTTP_REQUEST_LEN_MAX; + } else { + ecs_strbuf_appendch(&frag->buf, c); + } + break; + case HttpFragStatePath: + if (c == ' ') { + frag->state = HttpFragStateVersion; + ecs_strbuf_appendch(&frag->buf, '\0'); + } else { + if (c == '?' || c == '=' || c == '&') { + ecs_strbuf_appendch(&frag->buf, '\0'); + int32_t offset = ecs_strbuf_written(&frag->buf); + if (c == '?' || c == '&') { + frag->param_offsets[frag->param_count] = offset; + } else { + frag->param_value_offsets[frag->param_count] = offset; + frag->param_count ++; + } + } else { + ecs_strbuf_appendch(&frag->buf, c); + } + } + break; + case HttpFragStateVersion: + if (c == '\r') { + frag->state = HttpFragStateCR; + } /* version is not stored */ + break; + case HttpFragStateHeaderStart: + if (header_writable(frag)) { + frag->header_offsets[frag->header_count] = + ecs_strbuf_written(&frag->buf); + } + header_buf_reset(frag); + frag->state = HttpFragStateHeaderName; + /* fallthrough */ + case HttpFragStateHeaderName: + if (c == ':') { + frag->state = HttpFragStateHeaderValueStart; + header_buf_append(frag, '\0'); + frag->parse_content_length = !ecs_os_strcmp( + frag->header_buf, "Content-Length"); - while ((ptr = meta_parse_constant(ptr, &token, &ctx))) { - if (token.is_value_set) { - last_value = token.value; - } else if (is_bitmask) { - ecs_meta_error(&ctx, ptr, - "bitmask requires explicit value assignment"); - goto error; + if (header_writable(frag)) { + ecs_strbuf_appendch(&frag->buf, '\0'); + frag->header_value_offsets[frag->header_count] = + ecs_strbuf_written(&frag->buf); + } + } else if (c == '\r') { + frag->state = HttpFragStateCR; + } else { + header_buf_append(frag, c); + if (header_writable(frag)) { + ecs_strbuf_appendch(&frag->buf, c); + } + } + break; + case HttpFragStateHeaderValueStart: + header_buf_reset(frag); + frag->state = HttpFragStateHeaderValue; + if (c == ' ') { /* skip first space */ + break; + } + /* fallthrough */ + case HttpFragStateHeaderValue: + if (c == '\r') { + if (frag->parse_content_length) { + header_buf_append(frag, '\0'); + int32_t len = atoi(frag->header_buf); + if (len < 0) { + frag->invalid = true; + } else { + frag->content_length = len; + } + frag->parse_content_length = false; + } + if (header_writable(frag)) { + int32_t cur = ecs_strbuf_written(&frag->buf); + if (frag->header_offsets[frag->header_count] < cur && + frag->header_value_offsets[frag->header_count] < cur) + { + ecs_strbuf_appendch(&frag->buf, '\0'); + frag->header_count ++; + } + } + frag->state = HttpFragStateCR; + } else { + if (frag->parse_content_length) { + header_buf_append(frag, c); + } + if (header_writable(frag)) { + ecs_strbuf_appendch(&frag->buf, c); + } + } + break; + case HttpFragStateCR: + if (c == '\n') { + frag->state = HttpFragStateCRLF; + } else { + frag->state = HttpFragStateHeaderStart; + } + break; + case HttpFragStateCRLF: + if (c == '\r') { + frag->state = HttpFragStateCRLFCR; + } else { + frag->state = HttpFragStateHeaderStart; + i--; + } + break; + case HttpFragStateCRLFCR: + if (c == '\n') { + if (frag->content_length != 0) { + frag->body_offset = ecs_strbuf_written(&frag->buf); + frag->state = HttpFragStateBody; + } else { + frag->state = HttpFragStateDone; + } + } else { + frag->state = HttpFragStateHeaderStart; + } + break; + case HttpFragStateBody: { + ecs_strbuf_appendch(&frag->buf, c); + if ((ecs_strbuf_written(&frag->buf) - frag->body_offset) == + frag->content_length) + { + frag->state = HttpFragStateDone; + } + } + break; + case HttpFragStateDone: + break; } + } - ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = token.name - }); - - if (!is_bitmask) { - ecs_set_pair_object(world, c, EcsConstant, ecs_i32_t, - {(ecs_i32_t)last_value}); - } else { - ecs_set_pair_object(world, c, EcsConstant, ecs_u32_t, - {(ecs_u32_t)last_value}); + if (frag->state == HttpFragStateDone) { + frag->state = HttpFragStateBegin; + if (conn->pub.id == conn_id) { + enqueue_request(conn); } - - last_value ++; + return true; + } else { + return false; } - - ecs_set_scope(world, old_scope); - - return 0; -error: - return -1; -} - -static -int meta_parse_enum( - ecs_world_t *world, - ecs_entity_t t, - const char *desc) -{ - ecs_add(world, t, EcsEnum); - return meta_parse_constants(world, t, desc, false); } static -int meta_parse_bitmask( - ecs_world_t *world, - ecs_entity_t t, - const char *desc) -{ - ecs_add(world, t, EcsBitmask); - return meta_parse_constants(world, t, desc, true); -} - -int ecs_meta_from_desc( - ecs_world_t *world, - ecs_entity_t component, - ecs_type_kind_t kind, - const char *desc) +void append_send_headers( + ecs_strbuf_t *hdrs, + int code, + const char* status, + const char* content_type, + ecs_strbuf_t *extra_headers, + ecs_size_t content_len) { - switch(kind) { - case EcsStructType: - if (meta_parse_struct(world, component, desc)) { - goto error; - } - break; - case EcsEnumType: - if (meta_parse_enum(world, component, desc)) { - goto error; - } - break; - case EcsBitmaskType: - if (meta_parse_bitmask(world, component, desc)) { - goto error; - } - break; - default: - break; - } + ecs_strbuf_appendstr(hdrs, "HTTP/1.1 "); + ecs_strbuf_append(hdrs, "%d ", code); + ecs_strbuf_appendstr(hdrs, status); + ecs_strbuf_appendstr(hdrs, "\r\n"); - return 0; -error: - return -1; -} + ecs_strbuf_appendstr(hdrs, "Content-Type: "); + ecs_strbuf_appendstr(hdrs, content_type); + ecs_strbuf_appendstr(hdrs, "\r\n"); -#endif + ecs_strbuf_appendstr(hdrs, "Content-Length: "); + ecs_strbuf_append(hdrs, "%d", content_len); + ecs_strbuf_appendstr(hdrs, "\r\n"); + ecs_strbuf_appendstr(hdrs, "Server: flecs\r\n"); -#ifdef FLECS_LOG + ecs_strbuf_mergebuff(hdrs, extra_headers); -#include -#include + ecs_strbuf_appendstr(hdrs, "\r\n"); +} static -char *ecs_vasprintf( - const char *fmt, - va_list args) +void send_reply( + ecs_http_connection_impl_t* conn, + ecs_http_reply_t* reply) { - ecs_size_t size = 0; - char *result = NULL; - va_list tmpa; + char hdrs[ECS_HTTP_REPLY_HEADER_SIZE]; + ecs_strbuf_t hdr_buf = ECS_STRBUF_INIT; + hdr_buf.buf = hdrs; + hdr_buf.max = ECS_HTTP_REPLY_HEADER_SIZE; + hdr_buf.buf = hdrs; - va_copy(tmpa, args); + char *content = ecs_strbuf_get(&reply->body); + int32_t content_length = reply->body.length - 1; - size = vsnprintf(result, 0, fmt, tmpa); + /* First, send the response HTTP headers */ + append_send_headers(&hdr_buf, reply->code, reply->status, + reply->content_type, &reply->headers, content_length); - va_end(tmpa); + ecs_size_t hdrs_len = ecs_strbuf_written(&hdr_buf); + hdrs[hdrs_len] = '\0'; + ecs_size_t written = http_send(conn->sock, hdrs, hdrs_len, 0); - if ((int32_t)size < 0) { - return NULL; + if (written != hdrs_len) { + ecs_err("failed to write HTTP response headers to '%s:%s': %s", + conn->pub.host, conn->pub.port, ecs_os_strerror(errno)); + return; } - result = (char *) ecs_os_malloc(size + 1); - - if (!result) { - return NULL; + /* Second, send response body */ + if (content_length > 0) { + written = http_send(conn->sock, content, content_length, 0); + if (written != content_length) { + ecs_err("failed to write HTTP response body to '%s:%s': %s", + conn->pub.host, conn->pub.port, ecs_os_strerror(errno)); + } } +} - ecs_os_vsprintf(result, fmt, args); +static +void recv_request( + ecs_http_server_t *srv, + ecs_http_connection_impl_t *conn, + uint64_t conn_id, + ecs_http_socket_t sock) +{ + ecs_size_t bytes_read; + char recv_buf[ECS_HTTP_SEND_RECV_BUFFER_SIZE]; - return result; + while ((bytes_read = http_recv( + sock, recv_buf, ECS_SIZEOF(recv_buf), 0)) > 0) + { + ecs_os_mutex_lock(srv->lock); + bool is_alive = conn->pub.id == conn_id; + if (is_alive) { + conn->dequeue_timeout = 0; + conn->dequeue_retries = 0; + } + ecs_os_mutex_unlock(srv->lock); + + if (is_alive) { + if (parse_request(conn, conn_id, recv_buf, bytes_read)) { + return; + } + } else { + return; + } + } } static -void ecs_colorize_buf( - char *msg, - bool enable_colors, - ecs_strbuf_t *buf) +void init_connection( + ecs_http_server_t *srv, + ecs_http_socket_t sock_conn, + struct sockaddr_storage *remote_addr, + ecs_size_t remote_addr_len) { - char *ptr, ch, prev = '\0'; - bool isNum = false; - char isStr = '\0'; - bool isVar = false; - bool overrideColor = false; - bool autoColor = true; - bool dontAppend = false; + /* Create new connection */ + ecs_os_mutex_lock(srv->lock); + ecs_http_connection_impl_t *conn = flecs_sparse_add( + srv->connections, ecs_http_connection_impl_t); + uint64_t conn_id = conn->pub.id = flecs_sparse_last_id(srv->connections); + conn->pub.server = srv; + conn->sock = sock_conn; + ecs_os_mutex_unlock(srv->lock); - for (ptr = msg; (ch = *ptr); ptr++) { - dontAppend = false; + char *remote_host = conn->pub.host; + char *remote_port = conn->pub.port; - if (!overrideColor) { - if (isNum && !isdigit(ch) && !isalpha(ch) && (ch != '.') && (ch != '%')) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - isNum = false; - } - if (isStr && (isStr == ch) && prev != '\\') { - isStr = '\0'; - } else if (((ch == '\'') || (ch == '"')) && !isStr && - !isalpha(prev) && (prev != '\\')) - { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); - isStr = ch; - } + /* Fetch name & port info */ + if (http_getnameinfo((struct sockaddr*) remote_addr, remote_addr_len, + remote_host, ECS_SIZEOF(conn->pub.host), + remote_port, ECS_SIZEOF(conn->pub.port), + NI_NUMERICHOST | NI_NUMERICSERV)) + { + ecs_os_strcpy(remote_host, "unknown"); + ecs_os_strcpy(remote_port, "unknown"); + } - if ((isdigit(ch) || (ch == '%' && isdigit(prev)) || - (ch == '-' && isdigit(ptr[1]))) && !isNum && !isStr && !isVar && - !isalpha(prev) && !isdigit(prev) && (prev != '_') && - (prev != '.')) - { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREEN); - isNum = true; - } + ecs_dbg_2("http: connection established from '%s:%s'", + remote_host, remote_port); - if (isVar && !isalpha(ch) && !isdigit(ch) && ch != '_') { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - isVar = false; - } + recv_request(srv, conn, conn_id, sock_conn); - if (!isStr && !isVar && ch == '$' && isalpha(ptr[1])) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); - isVar = true; - } + ecs_dbg_2("http: request received from '%s:%s'", + remote_host, remote_port); +} + +static +void accept_connections( + ecs_http_server_t* srv, + const struct sockaddr* addr, + ecs_size_t addr_len) +{ +#ifdef ECS_TARGET_WINDOWS + /* If on Windows, test if winsock needs to be initialized */ + SOCKET testsocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); + if (SOCKET_ERROR == testsocket && WSANOTINITIALISED == WSAGetLastError()) { + WSADATA data = { 0 }; + int result = WSAStartup(MAKEWORD(2, 2), &data); + if (result) { + ecs_warn("WSAStartup failed with GetLastError = %d\n", + GetLastError()); + return; } + } else { + http_close(testsocket); + } +#endif - if (!isVar && !isStr && !isNum && ch == '#' && ptr[1] == '[') { - bool isColor = true; - overrideColor = true; + /* Resolve name + port (used for logging) */ + char addr_host[256]; + char addr_port[20]; - /* Custom colors */ - if (!ecs_os_strncmp(&ptr[2], "]", ecs_os_strlen("]"))) { - autoColor = false; - } else if (!ecs_os_strncmp(&ptr[2], "green]", ecs_os_strlen("green]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREEN); - } else if (!ecs_os_strncmp(&ptr[2], "red]", ecs_os_strlen("red]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_RED); - } else if (!ecs_os_strncmp(&ptr[2], "blue]", ecs_os_strlen("red]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_BLUE); - } else if (!ecs_os_strncmp(&ptr[2], "magenta]", ecs_os_strlen("magenta]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_MAGENTA); - } else if (!ecs_os_strncmp(&ptr[2], "cyan]", ecs_os_strlen("cyan]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_CYAN); - } else if (!ecs_os_strncmp(&ptr[2], "yellow]", ecs_os_strlen("yellow]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_YELLOW); - } else if (!ecs_os_strncmp(&ptr[2], "grey]", ecs_os_strlen("grey]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_GREY); - } else if (!ecs_os_strncmp(&ptr[2], "white]", ecs_os_strlen("white]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - } else if (!ecs_os_strncmp(&ptr[2], "bold]", ecs_os_strlen("bold]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_BOLD); - } else if (!ecs_os_strncmp(&ptr[2], "normal]", ecs_os_strlen("normal]"))) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - } else if (!ecs_os_strncmp(&ptr[2], "reset]", ecs_os_strlen("reset]"))) { - overrideColor = false; - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - } else { - isColor = false; - overrideColor = false; - } + if (http_getnameinfo( + addr, addr_len, addr_host, ECS_SIZEOF(addr_host), addr_port, + ECS_SIZEOF(addr_port), NI_NUMERICHOST | NI_NUMERICSERV)) + { + ecs_os_strcpy(addr_host, "unknown"); + ecs_os_strcpy(addr_port, "unknown"); + } - if (isColor) { - ptr += 2; - while ((ch = *ptr) != ']') ptr ++; - dontAppend = true; - } - if (!autoColor) { - overrideColor = true; - } + ecs_os_mutex_lock(srv->lock); + if (srv->should_run) { + ecs_dbg_2("http: initializing connection socket"); + + srv->sock = socket(addr->sa_family, SOCK_STREAM, IPPROTO_TCP); + if (srv->sock < 0) { + ecs_err("unable to create new connection socket: %s", + ecs_os_strerror(errno)); + ecs_os_mutex_unlock(srv->lock); + goto done; } - if (ch == '\n') { - if (isNum || isStr || isVar || overrideColor) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); - overrideColor = false; - isNum = false; - isStr = false; - isVar = false; + int reuse = 1; + int result = setsockopt(srv->sock, SOL_SOCKET, SO_REUSEADDR, + (char*)&reuse, ECS_SIZEOF(reuse)); + if (result) { + ecs_warn("failed to setsockopt: %s", ecs_os_strerror(errno)); + } + + if (addr->sa_family == AF_INET6) { + int ipv6only = 0; + if (setsockopt(srv->sock, IPPROTO_IPV6, IPV6_V6ONLY, + (char*)&ipv6only, ECS_SIZEOF(ipv6only))) + { + ecs_warn("failed to setsockopt: %s", ecs_os_strerror(errno)); } } + + result = http_bind(srv->sock, addr, addr_len); + if (result) { + ecs_err("http: failed to bind to '%s:%s': %s", + addr_host, addr_port, ecs_os_strerror(errno)); + ecs_os_mutex_unlock(srv->lock); + goto done; + } - if (!dontAppend) { - ecs_strbuf_appendstrn(buf, ptr, 1); + result = listen(srv->sock, SOMAXCONN); + if (result) { + ecs_warn("http: could not listen for SOMAXCONN (%d) connections: %s", + SOMAXCONN, ecs_os_strerror(errno)); } - if (!overrideColor) { - if (((ch == '\'') || (ch == '"')) && !isStr) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); + ecs_trace("http: listening for incoming connections on '%s:%s'", + addr_host, addr_port); + } + ecs_os_mutex_unlock(srv->lock); + + ecs_http_socket_t sock_conn; + struct sockaddr_storage remote_addr; + ecs_size_t remote_addr_len; + + while (srv->should_run) { + remote_addr_len = ECS_SIZEOF(remote_addr); + sock_conn = http_accept(srv->sock, (struct sockaddr*) &remote_addr, + &remote_addr_len); + + if (sock_conn == -1) { + if (srv->should_run) { + ecs_dbg("http: connection attempt failed: %s", + ecs_os_strerror(errno)); } + continue; } - prev = ch; + init_connection(srv, sock_conn, &remote_addr, remote_addr_len); } - if (isNum || isStr || isVar || overrideColor) { - if (enable_colors) ecs_strbuf_appendstr(buf, ECS_NORMAL); +done: + if (srv->sock && errno != EBADF) { + http_close(srv->sock); + srv->sock = 0; } -} -void _ecs_logv( - int level, - const char *file, - int32_t line, - const char *fmt, - va_list args) -{ - (void)level; - (void)line; + ecs_trace("http: no longer accepting connections on '%s:%s'", + addr_host, addr_port); +} - ecs_strbuf_t msg_buf = ECS_STRBUF_INIT; +static +void* http_server_thread(void* arg) { + ecs_http_server_t *srv = arg; + struct sockaddr_in addr; + ecs_os_zeromem(&addr); + addr.sin_family = AF_INET; + addr.sin_port = htons(srv->port); - if (level > ecs_os_api.log_level_) { - return; + if (!srv->ipaddr) { + addr.sin_addr.s_addr = htonl(INADDR_ANY); + } else { + inet_pton(AF_INET, srv->ipaddr, &(addr.sin_addr)); } - /* Apply color. Even if we don't want color, we still need to call the - * colorize function to get rid of the color tags (e.g. #[green]) */ - char *msg_nocolor = ecs_vasprintf(fmt, args); - ecs_colorize_buf(msg_nocolor, ecs_os_api.log_with_color_, &msg_buf); - ecs_os_free(msg_nocolor); - - char *msg = ecs_strbuf_get(&msg_buf); - ecs_os_api.log_(level, file, line, msg); - ecs_os_free(msg); + accept_connections(srv, (struct sockaddr*)&addr, ECS_SIZEOF(addr)); + return NULL; } -void _ecs_log( - int level, - const char *file, - int32_t line, - const char *fmt, - ...) +static +void handle_request( + ecs_http_server_t *srv, + ecs_http_request_impl_t *req) { - va_list args; - va_start(args, fmt); - _ecs_logv(level, file, line, fmt, args); - va_end(args); + ecs_http_reply_t reply = ECS_HTTP_REPLY_INIT; + ecs_http_connection_impl_t *conn = + (ecs_http_connection_impl_t*)req->pub.conn; + + if (srv->callback((ecs_http_request_t*)req, &reply, srv->ctx) == 0) { + reply.code = 404; + reply.status = "Resource not found"; + } + + send_reply(conn, &reply); + ecs_dbg_2("http: reply sent to '%s:%s'", conn->pub.host, conn->pub.port); + + reply_free(&reply); + request_free(req); + connection_free(conn); } -void _ecs_log_push( - int32_t level) +static +int32_t dequeue_requests( + ecs_http_server_t *srv, + float delta_time) { - if (level <= ecs_os_api.log_level_) { - ecs_os_api.log_indent_ ++; + ecs_os_mutex_lock(srv->lock); + + int32_t i, request_count = flecs_sparse_count(srv->requests); + for (i = request_count - 1; i >= 1; i --) { + ecs_http_request_impl_t *req = flecs_sparse_get_dense( + srv->requests, ecs_http_request_impl_t, i); + handle_request(srv, req); + } + + int32_t connections_count = flecs_sparse_count(srv->connections); + for (i = connections_count - 1; i >= 1; i --) { + ecs_http_connection_impl_t *conn = flecs_sparse_get_dense( + srv->connections, ecs_http_connection_impl_t, i); + + conn->dequeue_timeout += delta_time; + conn->dequeue_retries ++; + + if ((conn->dequeue_timeout > + (FLECS_FLOAT)ECS_HTTP_CONNECTION_PURGE_TIMEOUT) && + (conn->dequeue_retries > ECS_HTTP_CONNECTION_PURGE_RETRY_COUNT)) + { + ecs_dbg("http: purging connection '%s:%s' (sock = %d)", + conn->pub.host, conn->pub.port, conn->sock); + connection_free(conn); + } } + + ecs_os_mutex_unlock(srv->lock); + + return request_count; } -void _ecs_log_pop( - int32_t level) +const char* ecs_http_get_header( + const ecs_http_request_t* req, + const char* name) { - if (level <= ecs_os_api.log_level_) { - ecs_os_api.log_indent_ --; + for (ecs_size_t i = 0; i < req->header_count; i++) { + if (!ecs_os_strcmp(req->headers[i].key, name)) { + return req->headers[i].value; + } } + return NULL; } -void _ecs_parser_errorv( - const char *name, - const char *expr, - int64_t column_arg, - const char *fmt, - va_list args) +const char* ecs_http_get_param( + const ecs_http_request_t* req, + const char* name) { - int32_t column = flecs_itoi32(column_arg); - - if (ecs_os_api.log_level_ >= -2) { - ecs_strbuf_t msg_buf = ECS_STRBUF_INIT; + for (ecs_size_t i = 0; i < req->param_count; i++) { + if (!ecs_os_strcmp(req->params[i].key, name)) { + return req->params[i].value; + } + } + return NULL; +} - ecs_strbuf_vappend(&msg_buf, fmt, args); +ecs_http_server_t* ecs_http_server_init( + const ecs_http_server_desc_t *desc) +{ + ecs_check(ecs_os_has_threading(), ECS_UNSUPPORTED, + "missing OS API implementation"); - if (expr) { - ecs_strbuf_appendstr(&msg_buf, "\n"); + ecs_http_server_t* srv = ecs_os_calloc_t(ecs_http_server_t); + srv->lock = ecs_os_mutex_new(); - /* Find start of line by taking column and looking for the - * last occurring newline */ - if (column != -1) { - const char *ptr = &expr[column]; - while (ptr[0] != '\n' && ptr > expr) { - ptr --; - } + srv->should_run = false; + srv->initialized = true; - if (ptr == expr) { - /* ptr is already at start of line */ - } else { - column -= (int32_t)(ptr - expr + 1); - expr = ptr + 1; - } - } + srv->callback = desc->callback; + srv->ctx = desc->ctx; + srv->port = desc->port; + srv->ipaddr = desc->ipaddr; - /* Strip newlines from current statement, if any */ - char *newline_ptr = strchr(expr, '\n'); - if (newline_ptr) { - /* Strip newline from expr */ - ecs_strbuf_appendstrn(&msg_buf, expr, - (int32_t)(newline_ptr - expr)); - } else { - ecs_strbuf_appendstr(&msg_buf, expr); - } + srv->connections = flecs_sparse_new(ecs_http_connection_impl_t); + srv->requests = flecs_sparse_new(ecs_http_request_impl_t); - ecs_strbuf_appendstr(&msg_buf, "\n"); + /* Start at id 1 */ + flecs_sparse_new_id(srv->connections); + flecs_sparse_new_id(srv->requests); - if (column != -1) { - ecs_strbuf_append(&msg_buf, "%*s^", column, ""); - } - } +#ifndef ECS_TARGET_WINDOWS + /* Ignore pipe signal. SIGPIPE can occur when a message is sent to a client + * but te client already disconnected. */ + signal(SIGPIPE, SIG_IGN); +#endif - char *msg = ecs_strbuf_get(&msg_buf); - ecs_os_err(name, 0, msg); - ecs_os_free(msg); - } + return srv; +error: + return NULL; } -void _ecs_parser_error( - const char *name, - const char *expr, - int64_t column, - const char *fmt, - ...) +void ecs_http_server_fini( + ecs_http_server_t* srv) { - if (ecs_os_api.log_level_ >= -2) { - va_list args; - va_start(args, fmt); - _ecs_parser_errorv(name, expr, column, fmt, args); - va_end(args); + if (srv->should_run) { + ecs_http_server_stop(srv); } + ecs_os_mutex_free(srv->lock); + flecs_sparse_free(srv->connections); + flecs_sparse_free(srv->requests); + ecs_os_free(srv); } -void _ecs_abort( - int32_t err, - const char *file, - int32_t line, - const char *fmt, - ...) +int ecs_http_server_start( + ecs_http_server_t *srv) { - if (fmt) { - va_list args; - va_start(args, fmt); - char *msg = ecs_vasprintf(fmt, args); - va_end(args); - _ecs_fatal(file, line, "%s (%s)", msg, ecs_strerror(err)); - ecs_os_free(msg); - } else { - _ecs_fatal(file, line, "%s", ecs_strerror(err)); - } - ecs_os_api.log_last_error_ = err; -} + ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(srv->initialized, ECS_INVALID_PARAMETER, NULL); + ecs_check(!srv->should_run, ECS_INVALID_PARAMETER, NULL); + ecs_check(!srv->thread, ECS_INVALID_PARAMETER, NULL); -bool _ecs_assert( - bool condition, - int32_t err, - const char *cond_str, - const char *file, - int32_t line, - const char *fmt, - ...) -{ - if (!condition) { - if (fmt) { - va_list args; - va_start(args, fmt); - char *msg = ecs_vasprintf(fmt, args); - va_end(args); - _ecs_fatal(file, line, "assert: %s %s (%s)", - cond_str, msg, ecs_strerror(err)); - ecs_os_free(msg); - } else { - _ecs_fatal(file, line, "assert: %s %s", - cond_str, ecs_strerror(err)); - } - ecs_os_api.log_last_error_ = err; + srv->should_run = true; + + ecs_dbg("http: starting server thread"); + + srv->thread = ecs_os_thread_new(http_server_thread, srv); + if (!srv->thread) { + goto error; } - return condition; + return 0; +error: + return -1; } -void _ecs_deprecated( - const char *file, - int32_t line, - const char *msg) +void ecs_http_server_stop( + ecs_http_server_t* srv) { - _ecs_err(file, line, "%s", msg); -} + ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(srv->initialized, ECS_INVALID_OPERATION, NULL); + ecs_check(srv->should_run, ECS_INVALID_PARAMETER, NULL); -bool ecs_should_log(int32_t level) { -# if !defined(ECS_TRACE_3) - if (level == 3) { - return false; + /* Stop server thread */ + ecs_dbg("http: shutting down server thread"); + + ecs_os_mutex_lock(srv->lock); + srv->should_run = false; + if (srv->sock >= 0) { + http_close(srv->sock); } -# endif -# if !defined(ECS_TRACE_2) - if (level == 2) { - return false; + ecs_os_mutex_unlock(srv->lock); + + ecs_os_thread_join(srv->thread); + + ecs_trace("http: server thread shut down"); + + /* Cleanup all outstanding requests */ + int i, count = flecs_sparse_count(srv->requests); + for (i = count - 1; i >= 1; i --) { + request_free(flecs_sparse_get_dense( + srv->requests, ecs_http_request_impl_t, i)); } -# endif -# if !defined(ECS_TRACE_1) - if (level == 1) { - return false; + + /* Close all connections */ + count = flecs_sparse_count(srv->connections); + for (i = count - 1; i >= 1; i --) { + connection_free(flecs_sparse_get_dense( + srv->connections, ecs_http_connection_impl_t, i)); } -# endif - return level <= ecs_os_api.log_level_; -} + ecs_assert(flecs_sparse_count(srv->connections) == 1, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(flecs_sparse_count(srv->requests) == 1, + ECS_INTERNAL_ERROR, NULL); -#define ECS_ERR_STR(code) case code: return &(#code[4]) + srv->thread = 0; +error: + return; +} -const char* ecs_strerror( - int32_t error_code) +void ecs_http_server_dequeue( + ecs_http_server_t* srv, + float delta_time) { - switch (error_code) { - ECS_ERR_STR(ECS_INVALID_PARAMETER); - ECS_ERR_STR(ECS_NOT_A_COMPONENT); - ECS_ERR_STR(ECS_INTERNAL_ERROR); - ECS_ERR_STR(ECS_ALREADY_DEFINED); - ECS_ERR_STR(ECS_INVALID_COMPONENT_SIZE); - ECS_ERR_STR(ECS_INVALID_COMPONENT_ALIGNMENT); - ECS_ERR_STR(ECS_NAME_IN_USE); - ECS_ERR_STR(ECS_OUT_OF_MEMORY); - ECS_ERR_STR(ECS_OPERATION_FAILED); - ECS_ERR_STR(ECS_INVALID_CONVERSION); - ECS_ERR_STR(ECS_MODULE_UNDEFINED); - ECS_ERR_STR(ECS_MISSING_SYMBOL); - ECS_ERR_STR(ECS_ALREADY_IN_USE); - ECS_ERR_STR(ECS_COLUMN_INDEX_OUT_OF_RANGE); - ECS_ERR_STR(ECS_COLUMN_IS_NOT_SHARED); - ECS_ERR_STR(ECS_COLUMN_IS_SHARED); - ECS_ERR_STR(ECS_COLUMN_TYPE_MISMATCH); - ECS_ERR_STR(ECS_INVALID_WHILE_ITERATING); - ECS_ERR_STR(ECS_INVALID_FROM_WORKER); - ECS_ERR_STR(ECS_OUT_OF_RANGE); - ECS_ERR_STR(ECS_MISSING_OS_API); - ECS_ERR_STR(ECS_UNSUPPORTED); - ECS_ERR_STR(ECS_COLUMN_ACCESS_VIOLATION); - ECS_ERR_STR(ECS_COMPONENT_NOT_REGISTERED); - ECS_ERR_STR(ECS_INCONSISTENT_COMPONENT_ID); - ECS_ERR_STR(ECS_TYPE_INVALID_CASE); - ECS_ERR_STR(ECS_INCONSISTENT_NAME); - ECS_ERR_STR(ECS_INCONSISTENT_COMPONENT_ACTION); - ECS_ERR_STR(ECS_INVALID_OPERATION); - ECS_ERR_STR(ECS_CONSTRAINT_VIOLATED); - ECS_ERR_STR(ECS_LOCKED_STORAGE); - ECS_ERR_STR(ECS_ID_IN_USE); + ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(srv->initialized, ECS_INVALID_PARAMETER, NULL); + ecs_check(srv->should_run, ECS_INVALID_PARAMETER, NULL); + + srv->dequeue_timeout += delta_time; + srv->stats_timeout += delta_time; + + if ((1000 * srv->dequeue_timeout) > + (FLECS_FLOAT)ECS_HTTP_MIN_DEQUEUE_INTERVAL) + { + srv->dequeue_timeout = 0; + + ecs_time_t t = {0}; + ecs_time_measure(&t); + int32_t request_count = dequeue_requests(srv, srv->dequeue_timeout); + srv->requests_processed += request_count; + srv->requests_processed_total += request_count; + FLECS_FLOAT time_spent = (FLECS_FLOAT)ecs_time_measure(&t); + srv->request_time += time_spent; + srv->request_time_total += time_spent; + srv->dequeue_count ++; } - return "unknown error code"; + if ((1000 * srv->stats_timeout) > + (FLECS_FLOAT)ECS_HTTP_MIN_STATS_INTERVAL) + { + srv->stats_timeout = 0; + ecs_dbg("http: processed %d requests in %.3fs (avg %.3fs / dequeue)", + srv->requests_processed, (double)srv->request_time, + (double)(srv->request_time / (FLECS_FLOAT)srv->dequeue_count)); + srv->requests_processed = 0; + srv->request_time = 0; + srv->dequeue_count = 0; + } + +error: + return; } -#else +#endif -/* Empty bodies for when logging is disabled */ -void _ecs_log( - int32_t level, - const char *file, - int32_t line, - const char *fmt, - ...) + +#ifdef FLECS_DOC + +static ECS_COPY(EcsDocDescription, dst, src, { + ecs_os_strset((char**)&dst->value, src->value); + +}) + +static ECS_MOVE(EcsDocDescription, dst, src, { + ecs_os_free((char*)dst->value); + dst->value = src->value; + src->value = NULL; +}) + +static ECS_DTOR(EcsDocDescription, ptr, { + ecs_os_free((char*)ptr->value); +}) + +void ecs_doc_set_name( + ecs_world_t *world, + ecs_entity_t entity, + const char *name) { - (void)level; - (void)file; - (void)line; - (void)fmt; + ecs_set_pair(world, entity, EcsDocDescription, EcsName, { + .value = name + }); } -void _ecs_parser_error( - const char *name, - const char *expr, - int64_t column, - const char *fmt, - ...) +void ecs_doc_set_brief( + ecs_world_t *world, + ecs_entity_t entity, + const char *description) { - (void)name; - (void)expr; - (void)column; - (void)fmt; + ecs_set_pair(world, entity, EcsDocDescription, EcsDocBrief, { + .value = description + }); } -void _ecs_parser_errorv( - const char *name, - const char *expr, - int64_t column, - const char *fmt, - va_list args) +void ecs_doc_set_detail( + ecs_world_t *world, + ecs_entity_t entity, + const char *description) { - (void)name; - (void)expr; - (void)column; - (void)fmt; - (void)args; + ecs_set_pair(world, entity, EcsDocDescription, EcsDocDetail, { + .value = description + }); } -void _ecs_abort( - int32_t error_code, - const char *file, - int32_t line, - const char *fmt, - ...) +void ecs_doc_set_link( + ecs_world_t *world, + ecs_entity_t entity, + const char *link) { - (void)error_code; - (void)file; - (void)line; - (void)fmt; + ecs_set_pair(world, entity, EcsDocDescription, EcsDocLink, { + .value = link + }); } -bool _ecs_assert( - bool condition, - int32_t error_code, - const char *condition_str, - const char *file, - int32_t line, - const char *fmt, - ...) +const char* ecs_doc_get_name( + const ecs_world_t *world, + ecs_entity_t entity) { - (void)condition; - (void)error_code; - (void)condition_str; - (void)file; - (void)line; - (void)fmt; - return true; + EcsDocDescription *ptr = ecs_get_pair( + world, entity, EcsDocDescription, EcsName); + if (ptr) { + return ptr->value; + } else { + return ecs_get_name(world, entity); + } } -#endif - -int ecs_log_set_level( - int level) +const char* ecs_doc_get_brief( + const ecs_world_t *world, + ecs_entity_t entity) { - int prev = level; - ecs_os_api.log_level_ = level; - return prev; + EcsDocDescription *ptr = ecs_get_pair( + world, entity, EcsDocDescription, EcsDocBrief); + if (ptr) { + return ptr->value; + } else { + return NULL; + } } -bool ecs_log_enable_colors( - bool enabled) +const char* ecs_doc_get_detail( + const ecs_world_t *world, + ecs_entity_t entity) { - bool prev = ecs_os_api.log_with_color_; - ecs_os_api.log_with_color_ = enabled; - return prev; + EcsDocDescription *ptr = ecs_get_pair( + world, entity, EcsDocDescription, EcsDocDetail); + if (ptr) { + return ptr->value; + } else { + return NULL; + } } -int ecs_log_last_error(void) +const char* ecs_doc_get_link( + const ecs_world_t *world, + ecs_entity_t entity) { - int result = ecs_os_api.log_last_error_; - ecs_os_api.log_last_error_ = 0; - return result; + EcsDocDescription *ptr = ecs_get_pair( + world, entity, EcsDocDescription, EcsDocLink); + if (ptr) { + return ptr->value; + } else { + return NULL; + } } +void FlecsDocImport( + ecs_world_t *world) +{ + ECS_MODULE(world, FlecsDoc); + ecs_set_name_prefix(world, "EcsDoc"); -#ifdef FLECS_JSON + flecs_bootstrap_component(world, EcsDocDescription); + flecs_bootstrap_tag(world, EcsDocBrief); + flecs_bootstrap_tag(world, EcsDocDetail); + flecs_bootstrap_tag(world, EcsDocLink); -void json_next( - ecs_strbuf_t *buf); + ecs_set_component_actions(world, EcsDocDescription, { + .ctor = ecs_default_ctor, + .move = ecs_move(EcsDocDescription), + .copy = ecs_copy(EcsDocDescription), + .dtor = ecs_dtor(EcsDocDescription) + }); -void json_literal( - ecs_strbuf_t *buf, - const char *value); + ecs_add_id(world, ecs_id(EcsDocDescription), EcsDontInherit); +} -void json_number( - ecs_strbuf_t *buf, - double value); +#endif -void json_true( - ecs_strbuf_t *buf); -void json_false( - ecs_strbuf_t *buf); +#ifdef FLECS_PARSER -void json_bool( - ecs_strbuf_t *buf, - bool value); +#include -void json_array_push( - ecs_strbuf_t *buf); +#define ECS_ANNOTATION_LENGTH_MAX (16) -void json_array_pop( - ecs_strbuf_t *buf); +#define TOK_NEWLINE '\n' +#define TOK_COLON ':' +#define TOK_AND ',' +#define TOK_OR "||" +#define TOK_NOT '!' +#define TOK_OPTIONAL '?' +#define TOK_BITWISE_OR '|' +#define TOK_NAME_SEP '.' +#define TOK_BRACKET_OPEN '[' +#define TOK_BRACKET_CLOSE ']' +#define TOK_WILDCARD '*' +#define TOK_SINGLETON '$' +#define TOK_PAREN_OPEN '(' +#define TOK_PAREN_CLOSE ')' +#define TOK_AS_ENTITY '\\' -void json_object_push( - ecs_strbuf_t *buf); +#define TOK_SELF "self" +#define TOK_SUPERSET "super" +#define TOK_SUBSET "sub" +#define TOK_CASCADE "cascade" +#define TOK_PARENT "parent" +#define TOK_ALL "all" -void json_object_pop( - ecs_strbuf_t *buf); +#define TOK_OVERRIDE "OVERRIDE" -void json_string( - ecs_strbuf_t *buf, - const char *value); +#define TOK_ROLE_PAIR "PAIR" +#define TOK_ROLE_AND "AND" +#define TOK_ROLE_OR "OR" +#define TOK_ROLE_XOR "XOR" +#define TOK_ROLE_NOT "NOT" +#define TOK_ROLE_SWITCH "SWITCH" +#define TOK_ROLE_CASE "CASE" +#define TOK_ROLE_DISABLED "DISABLED" -void json_member( - ecs_strbuf_t *buf, - const char *name); +#define TOK_IN "in" +#define TOK_OUT "out" +#define TOK_INOUT "inout" +#define TOK_INOUT_FILTER "filter" -void json_path( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_entity_t e); +#define ECS_MAX_TOKEN_SIZE (256) -void json_label( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_entity_t e); +typedef char ecs_token_t[ECS_MAX_TOKEN_SIZE]; -void json_id( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_id_t id); +const char* ecs_parse_eol_and_whitespace( + const char *ptr) +{ + while (isspace(*ptr)) { + ptr ++; + } -ecs_primitive_kind_t json_op_to_primitive_kind( - ecs_meta_type_op_kind_t kind); + return ptr; +} -#endif +/** Skip spaces when parsing signature */ +const char* ecs_parse_whitespace( + const char *ptr) +{ + while ((*ptr != '\n') && isspace(*ptr)) { + ptr ++; + } -#include + return ptr; +} -#ifdef FLECS_JSON +const char* ecs_parse_digit( + const char *ptr, + char *token) +{ + char *tptr = token; + char ch = ptr[0]; -static -int json_ser_type( - const ecs_world_t *world, - ecs_vector_t *ser, - const void *base, - ecs_strbuf_t *str); + if (!isdigit(ch) && ch != '-') { + ecs_parser_error(NULL, NULL, 0, "invalid start of number '%s'", ptr); + return NULL; + } + + tptr[0] = ch; + tptr ++; + ptr ++; + + for (; (ch = *ptr); ptr ++) { + if (!isdigit(ch)) { + break; + } + + tptr[0] = ch; + tptr ++; + } + + tptr[0] = '\0'; + + return ptr; +} static -int json_ser_type_ops( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - ecs_strbuf_t *str); +bool is_newline_comment( + const char *ptr) +{ + if (ptr[0] == '/' && ptr[1] == '/') { + return true; + } + return false; +} + +const char* ecs_parse_fluff( + const char *ptr, + char **last_comment) +{ + const char *last_comment_start = NULL; + + do { + /* Skip whitespaces before checking for a comment */ + ptr = ecs_parse_whitespace(ptr); + + /* Newline comment, skip until newline character */ + if (is_newline_comment(ptr)) { + ptr += 2; + last_comment_start = ptr; + + while (ptr[0] && ptr[0] != TOK_NEWLINE) { + ptr ++; + } + } + + /* If a newline character is found, skip it */ + if (ptr[0] == TOK_NEWLINE) { + ptr ++; + } + + } while (isspace(ptr[0]) || is_newline_comment(ptr)); + + if (last_comment) { + *last_comment = (char*)last_comment_start; + } + + return ptr; +} + +/* -- Private functions -- */ static -int json_ser_type_op( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str); +bool valid_identifier_start_char( + char ch) +{ + if (ch && (isalpha(ch) || (ch == '.') || (ch == '_') || (ch == '*') || + (ch == '0') || (ch == TOK_AS_ENTITY) || isdigit(ch))) + { + return true; + } + + return false; +} -/* Serialize enumeration */ static -int json_ser_enum( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str) +bool valid_token_start_char( + char ch) { - const EcsEnum *enum_type = ecs_get(world, op->type, EcsEnum); - ecs_check(enum_type != NULL, ECS_INVALID_PARAMETER, NULL); + if ((ch == '"') || (ch == '{') || (ch == '}') || (ch == ',') || (ch == '-') + || (ch == '[') || (ch == ']') || valid_identifier_start_char(ch)) + { + return true; + } - int32_t value = *(int32_t*)base; - - /* Enumeration constants are stored in a map that is keyed on the - * enumeration value. */ - ecs_enum_constant_t *constant = ecs_map_get( - enum_type->constants, ecs_enum_constant_t, value); - if (!constant) { - goto error; + return false; +} + +static +bool valid_token_char( + char ch) +{ + if (ch && + (isalpha(ch) || isdigit(ch) || ch == '_' || ch == '.' || ch == '"')) + { + return true; } - ecs_strbuf_appendch(str, '"'); - ecs_strbuf_appendstr(str, ecs_get_name(world, constant->constant)); - ecs_strbuf_appendch(str, '"'); + return false; +} - return 0; -error: - return -1; +static +bool valid_operator_char( + char ch) +{ + if (ch == TOK_OPTIONAL || ch == TOK_NOT) { + return true; + } + + return false; } -/* Serialize bitmask */ static -int json_ser_bitmask( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) +const char* parse_digit( + const char *ptr, + char *token_out) { - const EcsBitmask *bitmask_type = ecs_get(world, op->type, EcsBitmask); - ecs_check(bitmask_type != NULL, ECS_INVALID_PARAMETER, NULL); + ptr = ecs_parse_whitespace(ptr); + ptr = ecs_parse_digit(ptr, token_out); + return ecs_parse_whitespace(ptr); +} - uint32_t value = *(uint32_t*)ptr; - ecs_map_key_t key; - ecs_bitmask_constant_t *constant; +const char* ecs_parse_token( + const char *name, + const char *expr, + const char *ptr, + char *token_out) +{ + int64_t column = ptr - expr; - if (!value) { - ecs_strbuf_appendch(str, '0'); - return 0; + ptr = ecs_parse_whitespace(ptr); + char *tptr = token_out, ch = ptr[0]; + + if (!valid_token_start_char(ch)) { + if (ch == '\0' || ch == '\n') { + ecs_parser_error(name, expr, column, + "unexpected end of expression"); + } else { + ecs_parser_error(name, expr, column, + "invalid start of token '%s'", ptr); + } + return NULL; + } + + tptr[0] = ch; + tptr ++; + ptr ++; + + if (ch == '{' || ch == '}' || ch == '[' || ch == ']' || ch == ',') { + tptr[0] = 0; + return ptr; } - ecs_strbuf_list_push(str, "\"", "|"); + int tmpl_nesting = 0; + bool in_str = ch == '"'; - /* Multiple flags can be set at a given time. Iterate through all the flags - * and append the ones that are set. */ - ecs_map_iter_t it = ecs_map_iter(bitmask_type->constants); - while ((constant = ecs_map_next(&it, ecs_bitmask_constant_t, &key))) { - if ((value & key) == key) { - ecs_strbuf_list_appendstr(str, - ecs_get_name(world, constant->constant)); - value -= (uint32_t)key; + for (; (ch = *ptr); ptr ++) { + if (ch == '<') { + tmpl_nesting ++; + } else if (ch == '>') { + if (!tmpl_nesting) { + break; + } + tmpl_nesting --; + } else if (ch == '"') { + in_str = !in_str; + } else + if (!valid_token_char(ch) && !in_str) { + break; } + + tptr[0] = ch; + tptr ++; } - if (value != 0) { - /* All bits must have been matched by a constant */ - goto error; + tptr[0] = '\0'; + + if (tmpl_nesting != 0) { + ecs_parser_error(name, expr, column, + "identifier '%s' has mismatching < > pairs", ptr); + return NULL; } - ecs_strbuf_list_pop(str, "\""); + const char *next_ptr = ecs_parse_whitespace(ptr); + if (next_ptr[0] == ':' && next_ptr != ptr) { + /* Whitespace between token and : is significant */ + ptr = next_ptr - 1; + } else { + ptr = next_ptr; + } - return 0; -error: - return -1; + return ptr; } -/* Serialize elements of a contiguous array */ static -int json_ser_elements( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - int32_t elem_count, - int32_t elem_size, - ecs_strbuf_t *str) +const char* ecs_parse_identifier( + const char *name, + const char *expr, + const char *ptr, + char *token_out) { - json_array_push(str); - - const void *ptr = base; - - int i; - for (i = 0; i < elem_count; i ++) { - ecs_strbuf_list_next(str); - if (json_ser_type_ops(world, ops, op_count, ptr, str)) { - return -1; - } - ptr = ECS_OFFSET(ptr, elem_size); + if (!valid_identifier_start_char(ptr[0])) { + ecs_parser_error(name, expr, (ptr - expr), + "expected start of identifier"); + return NULL; } - json_array_pop(str); + ptr = ecs_parse_token(name, expr, ptr, token_out); - return 0; + return ptr; } static -int json_ser_type_elements( - const ecs_world_t *world, - ecs_entity_t type, - const void *base, - int32_t elem_count, - ecs_strbuf_t *str) +int parse_identifier( + const char *token, + ecs_term_id_t *out) { - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - ecs_assert(ser != NULL, ECS_INTERNAL_ERROR, NULL); - - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); + char ch = token[0]; - ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); - int32_t op_count = ecs_vector_count(ser->ops); + const char *tptr = token; + if (ch == TOK_AS_ENTITY) { + tptr ++; + } - return json_ser_elements( - world, ops, op_count, base, elem_count, comp->size, str); -} + out->name = ecs_os_strdup(tptr); -/* Serialize array */ -static -int json_ser_array( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) -{ - const EcsArray *a = ecs_get(world, op->type, EcsArray); - ecs_assert(a != NULL, ECS_INTERNAL_ERROR, NULL); + if (ch == TOK_AS_ENTITY) { + out->var = EcsVarIsEntity; + } - return json_ser_type_elements( - world, a->type, ptr, a->count, str); + return 0; } -/* Serialize vector */ static -int json_ser_vector( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *base, - ecs_strbuf_t *str) +ecs_entity_t parse_role( + const char *name, + const char *sig, + int64_t column, + const char *token) { - ecs_vector_t *value = *(ecs_vector_t**)base; - if (!value) { - ecs_strbuf_appendstr(str, "null"); + if (!ecs_os_strcmp(token, TOK_ROLE_PAIR)) + { + return ECS_PAIR; + } else if (!ecs_os_strcmp(token, TOK_ROLE_AND)) { + return ECS_AND; + } else if (!ecs_os_strcmp(token, TOK_ROLE_OR)) { + return ECS_OR; + } else if (!ecs_os_strcmp(token, TOK_ROLE_XOR)) { + return ECS_XOR; + } else if (!ecs_os_strcmp(token, TOK_ROLE_NOT)) { + return ECS_NOT; + } else if (!ecs_os_strcmp(token, TOK_ROLE_SWITCH)) { + return ECS_SWITCH; + } else if (!ecs_os_strcmp(token, TOK_ROLE_CASE)) { + return ECS_CASE; + } else if (!ecs_os_strcmp(token, TOK_OVERRIDE)) { + return ECS_OVERRIDE; + } else if (!ecs_os_strcmp(token, TOK_ROLE_DISABLED)) { + return ECS_DISABLED; + } else { + ecs_parser_error(name, sig, column, "invalid role '%s'", token); return 0; } - - const EcsVector *v = ecs_get(world, op->type, EcsVector); - ecs_assert(v != NULL, ECS_INTERNAL_ERROR, NULL); - - const EcsComponent *comp = ecs_get(world, v->type, EcsComponent); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t count = ecs_vector_count(value); - void *array = ecs_vector_first_t(value, comp->size, comp->alignment); - - /* Serialize contiguous buffer of vector */ - return json_ser_type_elements(world, v->type, array, count, str); } -/* Forward serialization to the different type kinds */ static -int json_ser_type_op( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - const void *ptr, - ecs_strbuf_t *str) +ecs_oper_kind_t parse_operator( + char ch) { - switch(op->kind) { - case EcsOpPush: - case EcsOpPop: - /* Should not be parsed as single op */ - ecs_throw(ECS_INVALID_PARAMETER, NULL); - break; - case EcsOpF32: - ecs_strbuf_appendflt(str, - (ecs_f64_t)*(ecs_f32_t*)ECS_OFFSET(ptr, op->offset), '"'); - break; - case EcsOpF64: - ecs_strbuf_appendflt(str, - *(ecs_f64_t*)ECS_OFFSET(ptr, op->offset), '"'); - break; - case EcsOpEnum: - if (json_ser_enum(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpBitmask: - if (json_ser_bitmask(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpArray: - if (json_ser_array(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpVector: - if (json_ser_vector(world, op, ECS_OFFSET(ptr, op->offset), str)) { - goto error; - } - break; - case EcsOpEntity: { - ecs_entity_t e = *(ecs_entity_t*)ECS_OFFSET(ptr, op->offset); - if (!e) { - ecs_strbuf_appendch(str, '0'); - } else { - json_path(str, world, e); - } - break; - } - - default: - if (ecs_primitive_to_expr_buf(world, - json_op_to_primitive_kind(op->kind), - ECS_OFFSET(ptr, op->offset), str)) - { - /* Unknown operation */ - ecs_throw(ECS_INTERNAL_ERROR, NULL); - return -1; - } - break; + if (ch == TOK_OPTIONAL) { + return EcsOptional; + } else if (ch == TOK_NOT) { + return EcsNot; + } else { + ecs_abort(ECS_INTERNAL_ERROR, NULL); } - - return 0; -error: - return -1; } -/* Iterate over a slice of the type ops array */ static -int json_ser_type_ops( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - const void *base, - ecs_strbuf_t *str) +const char* parse_annotation( + const char *name, + const char *sig, + int64_t column, + const char *ptr, + ecs_inout_kind_t *inout_kind_out) { - for (int i = 0; i < op_count; i ++) { - ecs_meta_type_op_t *op = &ops[i]; + char token[ECS_MAX_TOKEN_SIZE]; - if (op != ops) { - if (op->name) { - json_member(str, op->name); - } + ptr = ecs_parse_identifier(name, sig, ptr, token); + if (!ptr) { + return NULL; + } - int32_t elem_count = op->count; - if (elem_count > 1 && op != ops) { - /* Serialize inline array */ - if (json_ser_elements(world, op, op->op_count, base, - elem_count, op->size, str)) - { - return -1; - } + if (!ecs_os_strcmp(token, TOK_IN)) { + *inout_kind_out = EcsIn; + } else + if (!ecs_os_strcmp(token, TOK_OUT)) { + *inout_kind_out = EcsOut; + } else + if (!ecs_os_strcmp(token, TOK_INOUT)) { + *inout_kind_out = EcsInOut; + } else if (!ecs_os_strcmp(token, TOK_INOUT_FILTER)) { + *inout_kind_out = EcsInOutFilter; + } - i += op->op_count - 1; - continue; - } - } - - switch(op->kind) { - case EcsOpPush: - json_object_push(str); - break; - case EcsOpPop: - json_object_pop(str); - break; - default: - if (json_ser_type_op(world, op, base, str)) { - goto error; - } - break; - } + ptr = ecs_parse_whitespace(ptr); + + if (ptr[0] != TOK_BRACKET_CLOSE) { + ecs_parser_error(name, sig, column, "expected ]"); + return NULL; } - return 0; -error: - return -1; + return ptr + 1; } -/* Iterate over the type ops of a type */ static -int json_ser_type( - const ecs_world_t *world, - ecs_vector_t *v_ops, - const void *base, - ecs_strbuf_t *str) +uint8_t parse_set_token( + const char *token) { - ecs_meta_type_op_t *ops = ecs_vector_first(v_ops, ecs_meta_type_op_t); - int32_t count = ecs_vector_count(v_ops); - return json_ser_type_ops(world, ops, count, base, str); + if (!ecs_os_strcmp(token, TOK_SELF)) { + return EcsSelf; + } else if (!ecs_os_strcmp(token, TOK_SUPERSET)) { + return EcsSuperSet; + } else if (!ecs_os_strcmp(token, TOK_SUBSET)) { + return EcsSubSet; + } else if (!ecs_os_strcmp(token, TOK_CASCADE)) { + return EcsCascade; + } else if (!ecs_os_strcmp(token, TOK_ALL)) { + return EcsAll; + } else if (!ecs_os_strcmp(token, TOK_PARENT)) { + return EcsParent; + } else { + return 0; + } } static -int array_to_json_buf_w_type_data( +const char* parse_set_expr( const ecs_world_t *world, - const void *ptr, - int32_t count, - ecs_strbuf_t *buf, - const EcsComponent *comp, - const EcsMetaTypeSerialized *ser) + const char *name, + const char *expr, + int64_t column, + const char *ptr, + char *token, + ecs_term_id_t *id, + char tok_end) { - if (count) { - ecs_size_t size = comp->size; - - json_array_push(buf); - - do { - ecs_strbuf_list_next(buf); - if (json_ser_type(world, ser->ops, ptr, buf)) { - return -1; - } + char token_buf[ECS_MAX_TOKEN_SIZE] = {0}; + if (!token) { + token = token_buf; + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + return NULL; + } + } - ptr = ECS_OFFSET(ptr, size); - } while (-- count); + do { + uint8_t tok = parse_set_token(token); + if (!tok) { + ecs_parser_error(name, expr, column, + "invalid set token '%s'", token); + return NULL; + } - json_array_pop(buf); - } else { - if (json_ser_type(world, ser->ops, ptr, buf)) { - return -1; + if (id->set.mask & tok) { + ecs_parser_error(name, expr, column, + "duplicate set token '%s'", token); + return NULL; } - } - return 0; -} + if ((tok == EcsSubSet && id->set.mask & EcsSuperSet) || + (tok == EcsSuperSet && id->set.mask & EcsSubSet)) + { + ecs_parser_error(name, expr, column, + "cannot mix super and sub", token); + return NULL; + } + + id->set.mask |= tok; -int ecs_array_to_json_buf( - const ecs_world_t *world, - ecs_entity_t type, - const void *ptr, - int32_t count, - ecs_strbuf_t *buf) -{ - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - if (!comp) { - char *path = ecs_get_fullpath(world, type); - ecs_err("cannot serialize to JSON, '%s' is not a component", path); - ecs_os_free(path); - return -1; - } + if (ptr[0] == TOK_PAREN_OPEN) { + ptr ++; - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - if (!ser) { - char *path = ecs_get_fullpath(world, type); - ecs_err("cannot serialize to JSON, '%s' has no reflection data", path); - ecs_os_free(path); - return -1; - } + /* Relationship (overrides IsA default) */ + if (!isdigit(ptr[0]) && valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + return NULL; + } - return array_to_json_buf_w_type_data(world, ptr, count, buf, comp, ser); -} + id->set.relation = ecs_lookup_fullpath(world, token); + if (!id->set.relation) { + ecs_parser_error(name, expr, column, + "unresolved identifier '%s'", token); + return NULL; + } -char* ecs_array_to_json( - const ecs_world_t *world, - ecs_entity_t type, - const void* ptr, - int32_t count) -{ - ecs_strbuf_t str = ECS_STRBUF_INIT; + if (ptr[0] == TOK_AND) { + ptr = ecs_parse_whitespace(ptr + 1); + } else if (ptr[0] != TOK_PAREN_CLOSE) { + ecs_parser_error(name, expr, column, + "expected ',' or ')'"); + return NULL; + } + } - if (ecs_array_to_json_buf(world, type, ptr, count, &str) != 0) { - ecs_strbuf_reset(&str); - return NULL; - } + /* Max depth of search */ + if (isdigit(ptr[0])) { + ptr = parse_digit(ptr, token); + if (!ptr) { + return NULL; + } - return ecs_strbuf_get(&str); -} + id->set.max_depth = atoi(token); + if (id->set.max_depth < 0) { + ecs_parser_error(name, expr, column, + "invalid negative depth"); + return NULL; + } -int ecs_ptr_to_json_buf( - const ecs_world_t *world, - ecs_entity_t type, - const void *ptr, - ecs_strbuf_t *buf) -{ - return ecs_array_to_json_buf(world, type, ptr, 0, buf); -} + if (ptr[0] == ',') { + ptr = ecs_parse_whitespace(ptr + 1); + } + } -char* ecs_ptr_to_json( - const ecs_world_t *world, - ecs_entity_t type, - const void* ptr) -{ - return ecs_array_to_json(world, type, ptr, 0); -} + /* If another digit is found, previous depth was min depth */ + if (isdigit(ptr[0])) { + ptr = parse_digit(ptr, token); + if (!ptr) { + return NULL; + } -static -bool skip_id( - const ecs_world_t *world, - ecs_id_t id, - const ecs_entity_to_json_desc_t *desc, - ecs_entity_t ent, - ecs_entity_t inst, - ecs_entity_t *pred_out, - ecs_entity_t *obj_out, - ecs_entity_t *role_out, - bool *hidden_out) -{ - bool is_base = ent != inst; - ecs_entity_t pred = 0, obj = 0, role = 0; - bool hidden = false; + id->set.min_depth = id->set.max_depth; + id->set.max_depth = atoi(token); + if (id->set.max_depth < 0) { + ecs_parser_error(name, expr, column, + "invalid negative depth"); + return NULL; + } + } - if (ECS_HAS_ROLE(id, PAIR)) { - pred = ecs_pair_first(world, id); - obj = ecs_pair_second(world, id); - } else { - pred = id & ECS_COMPONENT_MASK; - if (id & ECS_ROLE_MASK) { - role = id & ECS_ROLE_MASK; + if (ptr[0] != TOK_PAREN_CLOSE) { + ecs_parser_error(name, expr, column, "expected ')', got '%c'", + ptr[0]); + return NULL; + } else { + ptr = ecs_parse_whitespace(ptr + 1); + if (ptr[0] != tok_end && ptr[0] != TOK_AND && ptr[0] != 0) { + ecs_parser_error(name, expr, column, + "expected end of set expr"); + return NULL; + } + } } - } - if (!desc || !desc->serialize_meta_ids) { - if (pred == EcsIsA || pred == EcsChildOf || - pred == ecs_id(EcsIdentifier)) - { - return true; - } -#ifdef FLECS_DOC - if (pred == ecs_id(EcsDocDescription)) { - return true; - } -#endif - } + /* Next token in set expression */ + if (ptr[0] == TOK_BITWISE_OR) { + ptr ++; + if (valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + return NULL; + } + } - if (is_base) { - if (ecs_has_id(world, pred, EcsDontInherit)) { - return true; - } - } - if (!desc || !desc->serialize_private) { - if (ecs_has_id(world, pred, EcsPrivate)) { - return true; - } - } - if (is_base) { - if (ecs_get_object_for_id(world, inst, EcsIsA, id) != ent) { - hidden = true; + /* End of set expression */ + } else if (ptr[0] == tok_end || ptr[0] == TOK_AND || !ptr[0]) { + break; } - } - if (hidden && (!desc || !desc->serialize_hidden)) { - return true; + } while (true); + + if (id->set.mask & EcsCascade && !(id->set.mask & EcsSuperSet) && + !(id->set.mask & EcsSubSet)) + { + /* If cascade is used without specifying super or sub, assume + * super */ + id->set.mask |= EcsSuperSet; } - *pred_out = pred; - *obj_out = obj; - *role_out = role; - if (hidden_out) *hidden_out = hidden; + if (id->set.mask & EcsSelf && id->set.min_depth != 0) { + ecs_parser_error(name, expr, column, + "min_depth must be zero for set expression with 'self'"); + return NULL; + } - return false; + return ptr; } static -int append_type_labels( - const ecs_world_t *world, - ecs_strbuf_t *buf, - const ecs_id_t *ids, - int32_t count, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) +const char* parse_arguments( + const ecs_world_t *world, + const char *name, + const char *expr, + int64_t column, + const char *ptr, + char *token, + ecs_term_t *term) { - (void)world; (void)buf; (void)ids; (void)count; (void)ent; (void)inst; - (void)desc; - -#ifdef FLECS_DOC - if (!desc || !desc->serialize_id_labels) { - return 0; - } - - json_member(buf, "id_labels"); - json_array_push(buf); - - int32_t i; - for (i = 0; i < count; i ++) { - ecs_entity_t pred = 0, obj = 0, role = 0; - if (skip_id(world, ids[i], desc, ent, inst, &pred, &obj, &role, 0)) { - continue; - } + (void)column; - if (desc && desc->serialize_id_labels) { - json_next(buf); + int32_t arg = 0; - json_array_push(buf); - json_next(buf); - json_label(buf, world, pred); - if (obj) { - json_next(buf); - json_label(buf, world, obj); + do { + if (valid_token_start_char(ptr[0])) { + if (arg == 2) { + ecs_parser_error(name, expr, (ptr - expr), + "too many arguments in term"); + return NULL; } - json_array_pop(buf); - } - } - - json_array_pop(buf); -#endif - return 0; -} + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + return NULL; + } -static -int append_type_values( - const ecs_world_t *world, - ecs_strbuf_t *buf, - const ecs_id_t *ids, - int32_t count, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) -{ - if (!desc || !desc->serialize_values) { - return 0; - } + ecs_term_id_t *term_id = NULL; - json_member(buf, "values"); - json_array_push(buf); + if (arg == 0) { + term_id = &term->subj; + } else if (arg == 1) { + term_id = &term->obj; + } - int32_t i; - for (i = 0; i < count; i ++) { - bool hidden; - ecs_entity_t pred = 0, obj = 0, role = 0; - ecs_id_t id = ids[i]; - if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, - &hidden)) - { - continue; - } + /* If token is a colon, the token is an identifier followed by a + * set expression. */ + if (ptr[0] == TOK_COLON) { + if (parse_identifier(token, term_id)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + return NULL; + } - if (!hidden) { - bool serialized = false; - ecs_entity_t typeid = ecs_get_typeid(world, id); - if (typeid) { - const EcsMetaTypeSerialized *ser = ecs_get( - world, typeid, EcsMetaTypeSerialized); - if (ser) { - const void *ptr = ecs_get_id(world, ent, id); - ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + ptr = ecs_parse_whitespace(ptr + 1); + ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, + NULL, term_id, TOK_PAREN_CLOSE); + if (!ptr) { + return NULL; + } - json_next(buf); - if (json_ser_type(world, ser->ops, ptr, buf) != 0) { - /* Entity contains invalid value */ - return -1; - } - serialized = true; + /* If token is a self, super or sub token, this is a set + * expression */ + } else if (!ecs_os_strcmp(token, TOK_ALL) || + !ecs_os_strcmp(token, TOK_CASCADE) || + !ecs_os_strcmp(token, TOK_SELF) || + !ecs_os_strcmp(token, TOK_SUPERSET) || + !ecs_os_strcmp(token, TOK_SUBSET) || + !(ecs_os_strcmp(token, TOK_PARENT))) + { + ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, + token, term_id, TOK_PAREN_CLOSE); + if (!ptr) { + return NULL; } - } - if (!serialized) { - json_next(buf); - json_number(buf, 0); - } - } else { - if (!desc || desc->serialize_hidden) { - json_next(buf); - json_number(buf, 0); - } - } - } - json_array_pop(buf); - - return 0; -} + /* Regular identifier */ + } else if (parse_identifier(token, term_id)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + return NULL; + } -static -int append_type_info( - const ecs_world_t *world, - ecs_strbuf_t *buf, - const ecs_id_t *ids, - int32_t count, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) -{ - if (!desc || !desc->serialize_type_info) { - return 0; - } + if (ptr[0] == TOK_AND) { + ptr = ecs_parse_whitespace(ptr + 1); - json_member(buf, "type_info"); - json_array_push(buf); + term->role = ECS_PAIR; - int32_t i; - for (i = 0; i < count; i ++) { - bool hidden; - ecs_entity_t pred = 0, obj = 0, role = 0; - ecs_id_t id = ids[i]; - if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, - &hidden)) - { - continue; - } + } else if (ptr[0] == TOK_PAREN_CLOSE) { + ptr = ecs_parse_whitespace(ptr + 1); + break; - if (!hidden) { - ecs_entity_t typeid = ecs_get_typeid(world, id); - if (typeid) { - json_next(buf); - if (ecs_type_info_to_json_buf(world, typeid, buf) != 0) { - return -1; - } } else { - json_next(buf); - json_number(buf, 0); + ecs_parser_error(name, expr, (ptr - expr), + "expected ',' or ')'"); + return NULL; } + } else { - if (!desc || desc->serialize_hidden) { - json_next(buf); - json_number(buf, 0); - } + ecs_parser_error(name, expr, (ptr - expr), + "expected identifier or set expression"); + return NULL; } - } - json_array_pop(buf); - - return 0; + arg ++; + + } while (true); + + return ptr; } static -int append_type_hidden( - const ecs_world_t *world, - ecs_strbuf_t *buf, - const ecs_id_t *ids, - int32_t count, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) +void parser_unexpected_char( + const char *name, + const char *expr, + const char *ptr, + char ch) { - if (!desc || !desc->serialize_hidden) { - return 0; + if (ch && (ch != '\n')) { + ecs_parser_error(name, expr, (ptr - expr), + "unexpected character '%c'", ch); + } else { + ecs_parser_error(name, expr, (ptr - expr), + "unexpected end of term"); } +} - if (ent == inst) { - return 0; /* if this is not a base, components are never hidden */ - } +static +const char* parse_term( + const ecs_world_t *world, + const char *name, + const char *expr, + ecs_term_t *term_out) +{ + const char *ptr = expr; + char token[ECS_MAX_TOKEN_SIZE] = {0}; + ecs_term_t term = { .move = true /* parser never owns resources */ }; - json_member(buf, "hidden"); - json_array_push(buf); + ptr = ecs_parse_whitespace(ptr); - int32_t i; - for (i = 0; i < count; i ++) { - bool hidden; - ecs_entity_t pred = 0, obj = 0, role = 0; - ecs_id_t id = ids[i]; - if (skip_id(world, id, desc, ent, inst, &pred, &obj, &role, - &hidden)) - { - continue; + /* Inout specifiers always come first */ + if (ptr[0] == TOK_BRACKET_OPEN) { + ptr = parse_annotation(name, expr, (ptr - expr), ptr + 1, &term.inout); + if (!ptr) { + goto error; } - - json_next(buf); - json_bool(buf, hidden); + ptr = ecs_parse_whitespace(ptr); } - json_array_pop(buf); - - return 0; -} - + if (valid_operator_char(ptr[0])) { + term.oper = parse_operator(ptr[0]); + ptr = ecs_parse_whitespace(ptr + 1); + } -static -int append_type( - const ecs_world_t *world, - ecs_strbuf_t *buf, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) -{ - ecs_type_t type = ecs_get_type(world, ent); - const ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t i, count = ecs_vector_count(type); + /* If next token is the start of an identifier, it could be either a type + * role, source or component identifier */ + if (valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + goto error; + } - json_member(buf, "ids"); - json_array_push(buf); + /* Is token a type role? */ + if (ptr[0] == TOK_BITWISE_OR && ptr[1] != TOK_BITWISE_OR) { + ptr ++; + goto parse_role; + } - for (i = 0; i < count; i ++) { - ecs_entity_t pred = 0, obj = 0, role = 0; - if (skip_id(world, ids[i], desc, ent, inst, &pred, &obj, &role, 0)) { - continue; + /* Is token a predicate? */ + if (ptr[0] == TOK_PAREN_OPEN) { + goto parse_predicate; } + /* Next token must be a predicate */ + goto parse_predicate; - json_next(buf); - json_array_push(buf); - json_next(buf); - json_path(buf, world, pred); - if (obj || role) { - json_next(buf); - if (obj) { - json_path(buf, world, obj); - } else { - json_number(buf, 0); - } - if (role) { - json_next(buf); - json_string(buf, ecs_role_str(role)); + /* If next token is a singleton, assign identifier to pred and subject */ + } else if (ptr[0] == TOK_SINGLETON) { + ptr ++; + if (valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + goto error; } + + goto parse_singleton; + + } else { + ecs_parser_error(name, expr, (ptr - expr), + "expected identifier after singleton operator"); + goto error; } - json_array_pop(buf); - } - json_array_pop(buf); + /* Pair with implicit subject */ + } else if (ptr[0] == TOK_PAREN_OPEN) { + goto parse_pair; - if (append_type_labels(world, buf, ids, count, ent, inst, desc)) { - return -1; + /* Nothing else expected here */ + } else { + parser_unexpected_char(name, expr, ptr, ptr[0]); + goto error; } - - if (append_type_values(world, buf, ids, count, ent, inst, desc)) { - return -1; + +parse_role: + term.role = parse_role(name, expr, (ptr - expr), token); + if (!term.role) { + goto error; } - if (append_type_info(world, buf, ids, count, ent, inst, desc)) { - return -1; + ptr = ecs_parse_whitespace(ptr); + + /* If next token is the source token, this is an empty source */ + if (valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + goto error; + } + + /* If not, it's a predicate */ + goto parse_predicate; + + } else if (ptr[0] == TOK_PAREN_OPEN) { + goto parse_pair; + } else { + ecs_parser_error(name, expr, (ptr - expr), + "expected identifier after role"); + goto error; } - if (append_type_hidden(world, buf, ids, count, ent, inst, desc)) { - return -1; +parse_predicate: + if (parse_identifier(token, &term.pred)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + goto error; } - return 0; -} + /* Set expression */ + if (ptr[0] == TOK_COLON) { + ptr = ecs_parse_whitespace(ptr + 1); + ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, NULL, + &term.pred, TOK_COLON); + if (!ptr) { + goto error; + } -static -int append_base( - const ecs_world_t *world, - ecs_strbuf_t *buf, - ecs_entity_t ent, - ecs_entity_t inst, - const ecs_entity_to_json_desc_t *desc) -{ - ecs_type_t type = ecs_get_type(world, ent); - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t i, count = ecs_vector_count(type); + ptr = ecs_parse_whitespace(ptr); - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - if (ECS_HAS_RELATION(id, EcsIsA)) { - if (append_base(world, buf, ecs_pair_second(world, id), inst, desc)) - { - return -1; - } + if (ptr[0] == TOK_AND || !ptr[0]) { + goto parse_done; } - } - json_object_push(buf); - json_member(buf, "path"); - json_path(buf, world, ent); + if (ptr[0] != TOK_COLON) { + ecs_parser_error(name, expr, (ptr - expr), + "unexpected token '%c' after predicate set expression", ptr[0]); + goto error; + } - if (append_type(world, buf, ent, inst, desc)) { - return -1; + ptr = ecs_parse_whitespace(ptr + 1); + } else { + ptr = ecs_parse_whitespace(ptr); } + + if (ptr[0] == TOK_PAREN_OPEN) { + ptr ++; + if (ptr[0] == TOK_PAREN_CLOSE) { + term.subj.set.mask = EcsNothing; + ptr ++; + ptr = ecs_parse_whitespace(ptr); + } else { + ptr = parse_arguments( + world, name, expr, (ptr - expr), ptr, token, &term); + } - json_object_pop(buf); + goto parse_done; + } - return 0; -} + goto parse_done; -int ecs_entity_to_json_buf( - const ecs_world_t *world, - ecs_entity_t entity, - ecs_strbuf_t *buf, - const ecs_entity_to_json_desc_t *desc) -{ - if (!entity || !ecs_is_valid(world, entity)) { - return -1; +parse_pair: + ptr = ecs_parse_identifier(name, expr, ptr + 1, token); + if (!ptr) { + goto error; } - json_object_push(buf); + if (ptr[0] == TOK_AND) { + ptr ++; + term.subj.entity = EcsThis; + goto parse_pair_predicate; + } else if (ptr[0] == TOK_PAREN_CLOSE) { + term.subj.entity = EcsThis; + goto parse_pair_predicate; + } else { + parser_unexpected_char(name, expr, ptr, ptr[0]); + goto error; + } - if (!desc || desc->serialize_path) { - char *path = ecs_get_fullpath(world, entity); - json_member(buf, "path"); - json_string(buf, path); - ecs_os_free(path); +parse_pair_predicate: + if (parse_identifier(token, &term.pred)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + goto error; } -#ifdef FLECS_DOC - if (desc && desc->serialize_label) { - json_member(buf, "label"); - const char *doc_name = ecs_doc_get_name(world, entity); - if (doc_name) { - json_string(buf, doc_name); + ptr = ecs_parse_whitespace(ptr); + if (valid_token_start_char(ptr[0])) { + ptr = ecs_parse_identifier(name, expr, ptr, token); + if (!ptr) { + goto error; + } + + if (ptr[0] == TOK_PAREN_CLOSE) { + ptr ++; + goto parse_pair_object; } else { - char num_buf[20]; - ecs_os_sprintf(num_buf, "%u", (uint32_t)entity); - json_string(buf, num_buf); + parser_unexpected_char(name, expr, ptr, ptr[0]); + goto error; } + } else if (ptr[0] == TOK_PAREN_CLOSE) { + /* No object */ + ptr ++; + goto parse_done; + } else { + ecs_parser_error(name, expr, (ptr - expr), + "expected pair object or ')'"); + goto error; } - if (desc && desc->serialize_brief) { - const char *doc_brief = ecs_doc_get_brief(world, entity); - if (doc_brief) { - json_member(buf, "brief"); - json_string(buf, doc_brief); - } +parse_pair_object: + if (parse_identifier(token, &term.obj)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + goto error; } - if (desc && desc->serialize_link) { - const char *doc_link = ecs_doc_get_link(world, entity); - if (doc_link) { - json_member(buf, "link"); - json_string(buf, doc_link); + if (term.role != 0) { + if (term.role != ECS_PAIR && term.role != ECS_CASE) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid combination of role '%s' with pair", + ecs_role_str(term.role)); + goto error; } + } else { + term.role = ECS_PAIR; } -#endif - - ecs_type_t type = ecs_get_type(world, entity); - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t i, count = ecs_vector_count(type); - - if (!desc || desc->serialize_base) { - if (ecs_has_pair(world, entity, EcsIsA, EcsWildcard)) { - json_member(buf, "is_a"); - json_array_push(buf); - for (i = 0; i < count; i ++) { - ecs_id_t id = ids[i]; - if (ECS_HAS_RELATION(id, EcsIsA)) { - if (append_base( - world, buf, ecs_pair_second(world, id), entity, desc)) - { - return -1; - } - } - } + ptr = ecs_parse_whitespace(ptr); + goto parse_done; - json_array_pop(buf); - } +parse_singleton: + if (parse_identifier(token, &term.pred)) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid identifier '%s'", token); + goto error; } - if (append_type(world, buf, entity, entity, desc)) { - goto error; - } + parse_identifier(token, &term.subj); + goto parse_done; - json_object_pop(buf); +parse_done: + *term_out = term; + return ptr; - return 0; error: - return -1; -} - -char* ecs_entity_to_json( - const ecs_world_t *world, - ecs_entity_t entity, - const ecs_entity_to_json_desc_t *desc) -{ - ecs_strbuf_t buf = ECS_STRBUF_INIT; - - if (ecs_entity_to_json_buf(world, entity, &buf, desc) != 0) { - ecs_strbuf_reset(&buf); - return NULL; - } - - return ecs_strbuf_get(&buf); + ecs_term_fini(&term); + *term_out = (ecs_term_t){0}; + return NULL; } static -bool skip_variable( - const char *name) +bool is_valid_end_of_term( + const char *ptr) { - if (!name || name[0] == '_' || name[0] == '.') { + if ((ptr[0] == TOK_AND) || /* another term with And operator */ + (ptr[0] == TOK_OR[0]) || /* another term with Or operator */ + (ptr[0] == '\n') || /* newlines are valid */ + (ptr[0] == '\0') || /* end of string */ + (ptr[0] == '/') || /* comment (in plecs) */ + (ptr[0] == '{') || /* scope (in plecs) */ + (ptr[0] == '}') || + (ptr[0] == ':') || /* inheritance (in plecs) */ + (ptr[0] == '=')) /* assignment (in plecs) */ + { return true; - } else { - return false; } + return false; } -static -void serialize_id( +char* ecs_parse_term( const ecs_world_t *world, - ecs_id_t id, - ecs_strbuf_t *buf) + const char *name, + const char *expr, + const char *ptr, + ecs_term_t *term) { - json_id(buf, world, id); -} + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); -static -void serialize_iter_ids( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - int32_t term_count = it->term_count; - if (!term_count) { - return; - } + ecs_term_id_t *subj = &term->subj; - json_member(buf, "ids"); - json_array_push(buf); + bool prev_or = false; + if (ptr != expr) { + if (ptr[0]) { + if (ptr[0] == ',') { + ptr ++; + } else if (ptr[0] == '|') { + ptr += 2; + prev_or = true; + } else { + ecs_parser_error(name, expr, (ptr - expr), + "invalid preceding token"); + } + } + } + + ptr = ecs_parse_eol_and_whitespace(ptr); + if (!ptr[0]) { + *term = (ecs_term_t){0}; + return (char*)ptr; + } - for (int i = 0; i < term_count; i ++) { - json_next(buf); - serialize_id(world, it->terms[i].id, buf); + if (ptr == expr && !strcmp(expr, "0")) { + return (char*)&ptr[1]; } - json_array_pop(buf); -} + int32_t prev_set = subj->set.mask; -static -void serialize_type_info( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - int32_t term_count = it->term_count; - if (!term_count) { - return; + /* Parse next element */ + ptr = parse_term(world, name, ptr, term); + if (!ptr) { + goto error; } - json_member(buf, "type_info"); - json_object_push(buf); + /* Post-parse consistency checks */ - for (int i = 0; i < term_count; i ++) { - json_next(buf); - ecs_entity_t typeid = ecs_get_typeid(world, it->terms[i].id); - if (typeid) { - serialize_id(world, typeid, buf); - ecs_strbuf_appendstr(buf, ":"); - ecs_type_info_to_json_buf(world, typeid, buf); - } else { - serialize_id(world, it->terms[i].id, buf); - ecs_strbuf_appendstr(buf, ":"); - ecs_strbuf_appendstr(buf, "0"); + /* If next token is OR, term is part of an OR expression */ + if (!ecs_os_strncmp(ptr, TOK_OR, 2) || prev_or) { + /* An OR operator must always follow an AND or another OR */ + if (term->oper != EcsAnd) { + ecs_parser_error(name, expr, (ptr - expr), + "cannot combine || with other operators"); + goto error; } - } - json_object_pop(buf); -} + term->oper = EcsOr; + } -static -void serialize_iter_variables(ecs_iter_t *it, ecs_strbuf_t *buf) { - char **variable_names = it->variable_names; - int32_t var_count = it->variable_count; - int32_t actual_count = 0; + /* Term must either end in end of expression, AND or OR token */ + if (!is_valid_end_of_term(ptr)) { + ecs_parser_error(name, expr, (ptr - expr), + "expected end of expression or next term"); + goto error; + } - for (int i = 0; i < var_count; i ++) { - const char *var_name = variable_names[i]; - if (skip_variable(var_name)) continue; + /* If the term just contained a 0, the expression has nothing. Ensure + * that after the 0 nothing else follows */ + if (!ecs_os_strcmp(term->pred.name, "0")) { + if (ptr[0]) { + ecs_parser_error(name, expr, (ptr - expr), + "unexpected term after 0"); + goto error; + } - if (!actual_count) { - json_member(buf, "vars"); - json_array_push(buf); - actual_count ++; + if (subj->set.mask != EcsDefaultSet || + (subj->entity && subj->entity != EcsThis) || + (subj->name && ecs_os_strcmp(subj->name, "This"))) + { + ecs_parser_error(name, expr, (ptr - expr), + "invalid combination of 0 with non-default subject"); + goto error; } - ecs_strbuf_list_next(buf); - json_string(buf, var_name); + subj->set.mask = EcsNothing; + ecs_os_free(term->pred.name); + term->pred.name = NULL; } - if (actual_count) { - json_array_pop(buf); + /* Cannot combine EcsNothing with operators other than AND */ + if (term->oper != EcsAnd && subj->set.mask == EcsNothing) { + ecs_parser_error(name, expr, (ptr - expr), + "invalid operator for empty source"); + goto error; } -} -static -void serialize_iter_result_ids( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - json_member(buf, "ids"); - json_array_push(buf); + /* Verify consistency of OR expression */ + if (prev_or && term->oper == EcsOr) { + /* Set expressions must be the same for all OR terms */ + if (subj->set.mask != prev_set) { + ecs_parser_error(name, expr, (ptr - expr), + "cannot combine different sources in OR expression"); + goto error; + } - for (int i = 0; i < it->term_count; i ++) { - json_next(buf); - serialize_id(world, ecs_term_id(it, i + 1), buf); + term->oper = EcsOr; } - json_array_pop(buf); -} + /* Automatically assign This if entity is not assigned and the set is + * nothing */ + if (subj->set.mask != EcsNothing) { + if (!subj->name) { + if (!subj->entity) { + subj->entity = EcsThis; + } + } + } -static -void serialize_iter_result_subjects( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - json_member(buf, "subjects"); - json_array_push(buf); + if (subj->name && !ecs_os_strcmp(subj->name, "0")) { + subj->entity = 0; + subj->set.mask = EcsNothing; + } - for (int i = 0; i < it->term_count; i ++) { - json_next(buf); - ecs_entity_t subj = it->subjects[i]; - if (subj) { - json_path(buf, world, subj); - } else { - json_literal(buf, "0"); - } + /* Process role */ + if (term->role == ECS_AND) { + term->oper = EcsAndFrom; + term->role = 0; + } else if (term->role == ECS_OR) { + term->oper = EcsOrFrom; + term->role = 0; + } else if (term->role == ECS_NOT) { + term->oper = EcsNotFrom; + term->role = 0; } - json_array_pop(buf); + ptr = ecs_parse_whitespace(ptr); + + return (char*)ptr; +error: + if (term) { + ecs_term_fini(term); + } + return NULL; } -static -void serialize_iter_result_is_set( - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - json_member(buf, "is_set"); - json_array_push(buf); +#endif - for (int i = 0; i < it->term_count; i ++) { - ecs_strbuf_list_next(buf); - if (ecs_term_is_set(it, i + 1)) { - json_true(buf); - } else { - json_false(buf); - } - } - json_array_pop(buf); -} +#ifdef FLECS_META_C -static -void serialize_iter_result_variables( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - char **variable_names = it->variable_names; - ecs_entity_t *variables = it->variables; - int32_t var_count = it->variable_count; - int32_t actual_count = 0; +#include - for (int i = 0; i < var_count; i ++) { - const char *var_name = variable_names[i]; - if (skip_variable(var_name)) continue; +#define ECS_META_IDENTIFIER_LENGTH (256) - if (!actual_count) { - json_member(buf, "vars"); - json_array_push(buf); - actual_count ++; - } +#define ecs_meta_error(ctx, ptr, ...)\ + ecs_parser_error((ctx)->name, (ctx)->desc, ptr - (ctx)->desc, __VA_ARGS__); - ecs_strbuf_list_next(buf); - json_path(buf, world, variables[i]); - } +typedef char ecs_meta_token_t[ECS_META_IDENTIFIER_LENGTH]; - if (actual_count) { - json_array_pop(buf); - } -} +typedef struct meta_parse_ctx_t { + const char *name; + const char *desc; +} meta_parse_ctx_t; + +typedef struct meta_type_t { + ecs_meta_token_t type; + ecs_meta_token_t params; + bool is_const; + bool is_ptr; +} meta_type_t; + +typedef struct meta_member_t { + meta_type_t type; + ecs_meta_token_t name; + int64_t count; + bool is_partial; +} meta_member_t; + +typedef struct meta_constant_t { + ecs_meta_token_t name; + int64_t value; + bool is_value_set; +} meta_constant_t; + +typedef struct meta_params_t { + meta_type_t key_type; + meta_type_t type; + int64_t count; + bool is_key_value; + bool is_fixed_size; +} meta_params_t; static -void serialize_iter_result_variable_labels( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - char **variable_names = it->variable_names; - ecs_entity_t *variables = it->variables; - int32_t var_count = it->variable_count; - int32_t actual_count = 0; +const char* skip_scope(const char *ptr, meta_parse_ctx_t *ctx) { + /* Keep track of which characters were used to open the scope */ + char stack[256]; + int32_t sp = 0; + char ch; - for (int i = 0; i < var_count; i ++) { - const char *var_name = variable_names[i]; - if (skip_variable(var_name)) continue; + while ((ch = *ptr)) { + if (ch == '(' || ch == '<') { + stack[sp] = ch; - if (!actual_count) { - json_member(buf, "var_labels"); - json_array_push(buf); - actual_count ++; + sp ++; + if (sp >= 256) { + ecs_meta_error(ctx, ptr, "maximum level of nesting reached"); + goto error; + } + } else if (ch == ')' || ch == '>') { + sp --; + if ((sp < 0) || (ch == '>' && stack[sp] != '<') || + (ch == ')' && stack[sp] != '(')) + { + ecs_meta_error(ctx, ptr, "mismatching %c in identifier", ch); + goto error; + } } - ecs_strbuf_list_next(buf); - json_label(buf, world, variables[i]); - } + ptr ++; - if (actual_count) { - json_array_pop(buf); + if (!sp) { + break; + } } + + return ptr; +error: + return NULL; } static -void serialize_iter_result_entities( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) +const char* parse_c_digit( + const char *ptr, + int64_t *value_out) { - int32_t count = it->count; - if (!it->count) { - return; + char token[24]; + ptr = ecs_parse_eol_and_whitespace(ptr); + ptr = ecs_parse_digit(ptr, token); + if (!ptr) { + goto error; } - json_member(buf, "entities"); - json_array_push(buf); - - ecs_entity_t *entities = it->entities; - - for (int i = 0; i < count; i ++) { - json_next(buf); - json_path(buf, world, entities[i]); - } + *value_out = strtol(token, NULL, 0); - json_array_pop(buf); + return ecs_parse_eol_and_whitespace(ptr); +error: + return NULL; } static -void serialize_iter_result_entity_labels( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) +const char* parse_c_identifier( + const char *ptr, + char *buff, + char *params, + meta_parse_ctx_t *ctx) { - int32_t count = it->count; - if (!it->count) { - return; - } - - json_member(buf, "entity_labels"); - json_array_push(buf); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(buff != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ctx != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t *entities = it->entities; + char *bptr = buff, ch; - for (int i = 0; i < count; i ++) { - json_next(buf); - json_label(buf, world, entities[i]); + if (params) { + params[0] = '\0'; } - json_array_pop(buf); -} + /* Ignore whitespaces */ + ptr = ecs_parse_eol_and_whitespace(ptr); -static -void serialize_iter_result_values( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf) -{ - int32_t count = it->count; - if (!it->count) { - return; + if (!isalpha(*ptr)) { + ecs_meta_error(ctx, ptr, + "invalid identifier (starts with '%c')", *ptr); + goto error; } - json_member(buf, "values"); - json_array_push(buf); - - int32_t i, term_count = it->term_count; - for (i = 0; i < term_count; i ++) { - ecs_strbuf_list_next(buf); - - const void *ptr = NULL; - if (it->ptrs) { - ptr = it->ptrs[i]; - } - if (!ptr) { - /* No data in column. Append 0 if this is not an optional term */ - if (ecs_term_is_set(it, i + 1)) { - json_literal(buf, "0"); - continue; + while ((ch = *ptr) && !isspace(ch) && ch != ';' && ch != ',' && ch != ')' && ch != '>' && ch != '}') { + /* Type definitions can contain macro's or templates */ + if (ch == '(' || ch == '<') { + if (!params) { + ecs_meta_error(ctx, ptr, "unexpected %c", *ptr); + goto error; } - } - - if (ecs_term_is_writeonly(it, i + 1)) { - json_literal(buf, "0"); - continue; - } - - /* Get component id (can be different in case of pairs) */ - ecs_entity_t type = ecs_get_typeid(world, it->ids[i]); - if (!type) { - /* Odd, we have a ptr but no Component? Not the place of the - * serializer to complain about that. */ - json_literal(buf, "0"); - continue; - } - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - if (!comp) { - /* Also odd, typeid but not a component? */ - json_literal(buf, "0"); - continue; - } + const char *end = skip_scope(ptr, ctx); + ecs_os_strncpy(params, ptr, (ecs_size_t)(end - ptr)); + params[end - ptr] = '\0'; - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - if (!ser) { - /* Not odd, component just has no reflection data */ - json_literal(buf, "0"); - continue; + ptr = end; + } else { + *bptr = ch; + bptr ++; + ptr ++; } + } - /* If term is not set, append empty array. This indicates that the term - * could have had data but doesn't */ - if (!ecs_term_is_set(it, i + 1)) { - ecs_assert(ptr == NULL, ECS_INTERNAL_ERROR, NULL); - json_array_push(buf); - json_array_pop(buf); - continue; - } + *bptr = '\0'; - if (ecs_term_is_owned(it, i + 1)) { - array_to_json_buf_w_type_data(world, ptr, count, buf, comp, ser); - } else { - array_to_json_buf_w_type_data(world, ptr, 0, buf, comp, ser); - } + if (!ch) { + ecs_meta_error(ctx, ptr, "unexpected end of token"); + goto error; } - json_array_pop(buf); + return ptr; +error: + return NULL; } static -void serialize_iter_result( - const ecs_world_t *world, - const ecs_iter_t *it, - ecs_strbuf_t *buf, - const ecs_iter_to_json_desc_t *desc) +const char * meta_open_scope( + const char *ptr, + meta_parse_ctx_t *ctx) { - json_next(buf); - json_object_push(buf); + /* Skip initial whitespaces */ + ptr = ecs_parse_eol_and_whitespace(ptr); - /* Each result can be matched with different component ids. Add them to - * the result so clients know with which component an entity was matched */ - if (!desc || desc->serialize_ids) { - serialize_iter_result_ids(world, it, buf); - } + /* Is this the start of the type definition? */ + if (ctx->desc == ptr) { + if (*ptr != '{') { + ecs_meta_error(ctx, ptr, "missing '{' in struct definition"); + goto error; + } - /* Include information on which entity the term is matched with */ - if (!desc || desc->serialize_ids) { - serialize_iter_result_subjects(world, it, buf); + ptr ++; + ptr = ecs_parse_eol_and_whitespace(ptr); } - /* Write variable values for current result */ - if (!desc || desc->serialize_variables) { - serialize_iter_result_variables(world, it, buf); + /* Is this the end of the type definition? */ + if (!*ptr) { + ecs_meta_error(ctx, ptr, "missing '}' at end of struct definition"); + goto error; + } + + /* Is this the end of the type definition? */ + if (*ptr == '}') { + ptr = ecs_parse_eol_and_whitespace(ptr + 1); + if (*ptr) { + ecs_meta_error(ctx, ptr, + "stray characters after struct definition"); + goto error; + } + return NULL; } - /* Write labels for variables */ - if (desc && desc->serialize_variable_labels) { - serialize_iter_result_variable_labels(world, it, buf); + return ptr; +error: + return NULL; +} + +static +const char* meta_parse_constant( + const char *ptr, + meta_constant_t *token, + meta_parse_ctx_t *ctx) +{ + ptr = meta_open_scope(ptr, ctx); + if (!ptr) { + return NULL; } - /* Include information on which terms are set, to support optional terms */ - if (!desc || desc->serialize_is_set) { - serialize_iter_result_is_set(it, buf); + token->is_value_set = false; + + /* Parse token, constant identifier */ + ptr = parse_c_identifier(ptr, token->name, NULL, ctx); + if (!ptr) { + return NULL; } - /* Write entity ids for current result (for queries with This terms) */ - if (!desc || desc->serialize_entities) { - serialize_iter_result_entities(world, it, buf); + ptr = ecs_parse_eol_and_whitespace(ptr); + if (!ptr) { + return NULL; } - /* Write labels for entities */ - if (desc && desc->serialize_entity_labels) { - serialize_iter_result_entity_labels(world, it, buf); + /* Explicit value assignment */ + if (*ptr == '=') { + int64_t value = 0; + ptr = parse_c_digit(ptr + 1, &value); + token->value = value; + token->is_value_set = true; } - /* Serialize component values */ - if (!desc || desc->serialize_values) { - serialize_iter_result_values(world, it, buf); + /* Expect a ',' or '}' */ + if (*ptr != ',' && *ptr != '}') { + ecs_meta_error(ctx, ptr, "missing , after enum constant"); + goto error; } - json_object_pop(buf); + if (*ptr == ',') { + return ptr + 1; + } else { + return ptr; + } +error: + return NULL; } -int ecs_iter_to_json_buf( - const ecs_world_t *world, - ecs_iter_t *it, - ecs_strbuf_t *buf, - const ecs_iter_to_json_desc_t *desc) +static +const char* meta_parse_type( + const char *ptr, + meta_type_t *token, + meta_parse_ctx_t *ctx) { - ecs_time_t duration = {0}; - if (desc && desc->measure_eval_duration) { - ecs_time_measure(&duration); - } + token->is_ptr = false; + token->is_const = false; - json_object_push(buf); + ptr = ecs_parse_eol_and_whitespace(ptr); - /* Serialize component ids of the terms (usually provided by query) */ - if (!desc || desc->serialize_term_ids) { - serialize_iter_ids(world, it, buf); + /* Parse token, expect type identifier or ECS_PROPERTY */ + ptr = parse_c_identifier(ptr, token->type, token->params, ctx); + if (!ptr) { + goto error; } - /* Serialize type info if enabled */ - if (desc && desc->serialize_type_info) { - serialize_type_info(world, it, buf); + if (!strcmp(token->type, "ECS_PRIVATE")) { + /* Members from this point are not stored in metadata */ + ptr += ecs_os_strlen(ptr); + goto done; } - /* Serialize variable names, if iterator has any */ - serialize_iter_variables(it, buf); - - /* Serialize results */ - json_member(buf, "results"); - json_array_push(buf); - - /* Use instancing for improved performance */ - it->is_instanced = true; + /* If token is const, set const flag and continue parsing type */ + if (!strcmp(token->type, "const")) { + token->is_const = true; - ecs_iter_next_action_t next = it->next; - while (next(it)) { - serialize_iter_result(world, it, buf, desc); + /* Parse type after const */ + ptr = parse_c_identifier(ptr + 1, token->type, token->params, ctx); } - json_array_pop(buf); - - if (desc && desc->measure_eval_duration) { - double dt = ecs_time_measure(&duration); - json_member(buf, "eval_duration"); - json_number(buf, dt); + /* Check if type is a pointer */ + ptr = ecs_parse_eol_and_whitespace(ptr); + if (*ptr == '*') { + token->is_ptr = true; + ptr ++; } - json_object_pop(buf); - - return 0; +done: + return ptr; +error: + return NULL; } -char* ecs_iter_to_json( - const ecs_world_t *world, - ecs_iter_t *it, - const ecs_iter_to_json_desc_t *desc) +static +const char* meta_parse_member( + const char *ptr, + meta_member_t *token, + meta_parse_ctx_t *ctx) { - ecs_strbuf_t buf = ECS_STRBUF_INIT; - - if (ecs_iter_to_json_buf(world, it, &buf, desc)) { - ecs_strbuf_reset(&buf); + ptr = meta_open_scope(ptr, ctx); + if (!ptr) { return NULL; } - return ecs_strbuf_get(&buf); -} - -#endif - - - -#ifdef FLECS_JSON - -const char* ecs_parse_json( - const ecs_world_t *world, - const char *ptr, - ecs_entity_t type, - void *data_out, - const ecs_parse_json_desc_t *desc) -{ - char token[ECS_MAX_TOKEN_SIZE]; - int depth = 0; - - const char *name = NULL; - const char *expr = NULL; - - ptr = ecs_parse_fluff(ptr, NULL); + token->count = 1; + token->is_partial = false; - ecs_meta_cursor_t cur = ecs_meta_cursor(world, type, data_out); - if (cur.valid == false) { - return NULL; + /* Parse member type */ + ptr = meta_parse_type(ptr, &token->type, ctx); + if (!ptr) { + token->is_partial = true; + goto error; } - if (desc) { - name = desc->name; - expr = desc->expr; + /* Next token is the identifier */ + ptr = parse_c_identifier(ptr, token->name, NULL, ctx); + if (!ptr) { + goto error; } - while ((ptr = ecs_parse_expr_token(name, expr, ptr, token))) { - - ptr = ecs_parse_fluff(ptr, NULL); - - if (!ecs_os_strcmp(token, "{")) { - depth ++; - if (ecs_meta_push(&cur) != 0) { - goto error; - } + /* Skip whitespace between member and [ or ; */ + ptr = ecs_parse_eol_and_whitespace(ptr); - if (ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected '['"); - return NULL; - } + /* Check if this is an array */ + char *array_start = strchr(token->name, '['); + if (!array_start) { + /* If the [ was separated by a space, it will not be parsed as part of + * the name */ + if (*ptr == '[') { + array_start = (char*)ptr; /* safe, will not be modified */ } + } - else if (!ecs_os_strcmp(token, "}")) { - depth --; - - if (ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected ']'"); - return NULL; - } + if (array_start) { + /* Check if the [ matches with a ] */ + char *array_end = strchr(array_start, ']'); + if (!array_end) { + ecs_meta_error(ctx, ptr, "missing ']'"); + goto error; - if (ecs_meta_pop(&cur) != 0) { - goto error; - } + } else if (array_end - array_start == 0) { + ecs_meta_error(ctx, ptr, "dynamic size arrays are not supported"); + goto error; } - else if (!ecs_os_strcmp(token, "[")) { - depth ++; - if (ecs_meta_push(&cur) != 0) { - goto error; - } + token->count = atoi(array_start + 1); - if (!ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected '{'"); - return NULL; - } + if (array_start == ptr) { + /* If [ was found after name, continue parsing after ] */ + ptr = array_end + 1; + } else { + /* If [ was fonud in name, replace it with 0 terminator */ + array_start[0] = '\0'; } + } - else if (!ecs_os_strcmp(token, "]")) { - depth --; - - if (!ecs_meta_is_collection(&cur)) { - ecs_parser_error(name, expr, ptr - expr, "expected '}'"); - return NULL; - } + /* Expect a ; */ + if (*ptr != ';') { + ecs_meta_error(ctx, ptr, "missing ; after member declaration"); + goto error; + } - if (ecs_meta_pop(&cur) != 0) { - goto error; - } - } + return ptr + 1; +error: + return NULL; +} - else if (!ecs_os_strcmp(token, ",")) { - if (ecs_meta_next(&cur) != 0) { - goto error; - } - } +static +int meta_parse_desc( + const char *ptr, + meta_params_t *token, + meta_parse_ctx_t *ctx) +{ + token->is_key_value = false; + token->is_fixed_size = false; - else if (!ecs_os_strcmp(token, "null")) { - if (ecs_meta_set_null(&cur) != 0) { - goto error; - } - } + ptr = ecs_parse_eol_and_whitespace(ptr); + if (*ptr != '(' && *ptr != '<') { + ecs_meta_error(ctx, ptr, + "expected '(' at start of collection definition"); + goto error; + } - else if (token[0] == '\"') { - if (ptr[0] == ':') { - /* Member assignment */ - ptr ++; + ptr ++; - /* Strip trailing " */ - ecs_size_t len = ecs_os_strlen(token); - if (token[len - 1] != '"') { - ecs_parser_error(name, expr, ptr - expr, "expected \""); - return NULL; - } else { - token[len - 1] = '\0'; - } + /* Parse type identifier */ + ptr = meta_parse_type(ptr, &token->type, ctx); + if (!ptr) { + goto error; + } - if (ecs_meta_member(&cur, token + 1) != 0) { - goto error; - } - } else { - if (ecs_meta_set_string_literal(&cur, token) != 0) { - goto error; - } - } - } + ptr = ecs_parse_eol_and_whitespace(ptr); - else { - if (ecs_meta_set_string(&cur, token) != 0) { + /* If next token is a ',' the first type was a key type */ + if (*ptr == ',') { + ptr = ecs_parse_eol_and_whitespace(ptr + 1); + + if (isdigit(*ptr)) { + int64_t value; + ptr = parse_c_digit(ptr, &value); + if (!ptr) { goto error; } - } - if (!depth) { - break; + token->count = value; + token->is_fixed_size = true; + } else { + token->key_type = token->type; + + /* Parse element type */ + ptr = meta_parse_type(ptr, &token->type, ctx); + ptr = ecs_parse_eol_and_whitespace(ptr); + + token->is_key_value = true; } } - return ptr; + if (*ptr != ')' && *ptr != '>') { + ecs_meta_error(ctx, ptr, + "expected ')' at end of collection definition"); + goto error; + } + + return 0; error: - return NULL; + return -1; } -#endif +static +ecs_entity_t meta_lookup( + ecs_world_t *world, + meta_type_t *token, + const char *ptr, + int64_t count, + meta_parse_ctx_t *ctx); +static +ecs_entity_t meta_lookup_array( + ecs_world_t *world, + ecs_entity_t e, + const char *params_decl, + meta_parse_ctx_t *ctx) +{ + meta_parse_ctx_t param_ctx = { + .name = ctx->name, + .desc = params_decl + }; -#ifdef FLECS_JSON + meta_params_t params; + if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { + goto error; + } + if (!params.is_fixed_size) { + ecs_meta_error(ctx, params_decl, "missing size for array"); + goto error; + } -void json_next( - ecs_strbuf_t *buf) -{ - ecs_strbuf_list_next(buf); -} + if (!params.count) { + ecs_meta_error(ctx, params_decl, "invalid array size"); + goto error; + } -void json_literal( - ecs_strbuf_t *buf, - const char *value) -{ - ecs_strbuf_appendstr(buf, value); -} + ecs_entity_t element_type = ecs_lookup_symbol(world, params.type.type, true); + if (!element_type) { + ecs_meta_error(ctx, params_decl, "unknown element type '%s'", + params.type.type); + } -void json_number( - ecs_strbuf_t *buf, - double value) -{ - ecs_strbuf_appendflt(buf, value, '"'); -} + if (!e) { + e = ecs_new_id(world); + } -void json_true( - ecs_strbuf_t *buf) -{ - json_literal(buf, "true"); -} + ecs_check(params.count <= INT32_MAX, ECS_INVALID_PARAMETER, NULL); -void json_false( - ecs_strbuf_t *buf) -{ - json_literal(buf, "false"); + return ecs_set(world, e, EcsArray, { element_type, (int32_t)params.count }); +error: + return 0; } -void json_bool( - ecs_strbuf_t *buf, - bool value) +static +ecs_entity_t meta_lookup_vector( + ecs_world_t *world, + ecs_entity_t e, + const char *params_decl, + meta_parse_ctx_t *ctx) { - if (value) { - json_true(buf); - } else { - json_false(buf); + meta_parse_ctx_t param_ctx = { + .name = ctx->name, + .desc = params_decl + }; + + meta_params_t params; + if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { + goto error; } -} -void json_array_push( - ecs_strbuf_t *buf) -{ - ecs_strbuf_list_push(buf, "[", ", "); -} + if (params.is_key_value) { + ecs_meta_error(ctx, params_decl, + "unexpected key value parameters for vector"); + goto error; + } -void json_array_pop( - ecs_strbuf_t *buf) -{ - ecs_strbuf_list_pop(buf, "]"); -} + ecs_entity_t element_type = meta_lookup( + world, ¶ms.type, params_decl, 1, ¶m_ctx); -void json_object_push( - ecs_strbuf_t *buf) -{ - ecs_strbuf_list_push(buf, "{", ", "); -} + if (!e) { + e = ecs_new_id(world); + } -void json_object_pop( - ecs_strbuf_t *buf) -{ - ecs_strbuf_list_pop(buf, "}"); + return ecs_set(world, e, EcsVector, { element_type }); +error: + return 0; } -void json_string( - ecs_strbuf_t *buf, - const char *value) +static +ecs_entity_t meta_lookup_bitmask( + ecs_world_t *world, + ecs_entity_t e, + const char *params_decl, + meta_parse_ctx_t *ctx) { - ecs_strbuf_appendch(buf, '"'); - ecs_strbuf_appendstr(buf, value); - ecs_strbuf_appendch(buf, '"'); -} + (void)e; -void json_member( - ecs_strbuf_t *buf, - const char *name) -{ - ecs_strbuf_list_appendstr(buf, "\""); - ecs_strbuf_appendstr(buf, name); - ecs_strbuf_appendstr(buf, "\":"); -} + meta_parse_ctx_t param_ctx = { + .name = ctx->name, + .desc = params_decl + }; -void json_path( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_entity_t e) -{ - ecs_strbuf_appendch(buf, '"'); - ecs_get_path_w_sep_buf(world, 0, e, ".", "", buf); - ecs_strbuf_appendch(buf, '"'); -} + meta_params_t params; + if (meta_parse_desc(params_decl, ¶ms, ¶m_ctx)) { + goto error; + } -void json_label( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_entity_t e) -{ - const char *lbl = NULL; -#ifdef FLECS_DOC - lbl = ecs_doc_get_name(world, e); -#else - lbl = ecs_get_name(world, e); -#endif + if (params.is_key_value) { + ecs_meta_error(ctx, params_decl, + "unexpected key value parameters for bitmask"); + goto error; + } - if (lbl) { - ecs_strbuf_appendch(buf, '"'); - ecs_strbuf_appendstr(buf, lbl); - ecs_strbuf_appendch(buf, '"'); - } else { - ecs_strbuf_appendstr(buf, "0"); + if (params.is_fixed_size) { + ecs_meta_error(ctx, params_decl, + "unexpected size for bitmask"); + goto error; } -} -void json_id( - ecs_strbuf_t *buf, - const ecs_world_t *world, - ecs_id_t id) -{ - ecs_strbuf_appendch(buf, '"'); - ecs_id_str_buf(world, id, buf); - ecs_strbuf_appendch(buf, '"'); + ecs_entity_t bitmask_type = meta_lookup( + world, ¶ms.type, params_decl, 1, ¶m_ctx); + ecs_check(bitmask_type != 0, ECS_INVALID_PARAMETER, NULL); + +#ifndef FLECS_NDEBUG + /* Make sure this is a bitmask type */ + const EcsMetaType *type_ptr = ecs_get(world, bitmask_type, EcsMetaType); + ecs_check(type_ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(type_ptr->kind == EcsBitmaskType, ECS_INVALID_PARAMETER, NULL); +#endif + + return bitmask_type; +error: + return 0; } -ecs_primitive_kind_t json_op_to_primitive_kind( - ecs_meta_type_op_kind_t kind) +static +ecs_entity_t meta_lookup( + ecs_world_t *world, + meta_type_t *token, + const char *ptr, + int64_t count, + meta_parse_ctx_t *ctx) { - return kind - EcsOpPrimitive; -} + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(token != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ptr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ctx != NULL, ECS_INTERNAL_ERROR, NULL); -#endif + const char *typename = token->type; + ecs_entity_t type = 0; + /* Parse vector type */ + if (!token->is_ptr) { + if (!ecs_os_strcmp(typename, "ecs_array")) { + type = meta_lookup_array(world, 0, token->params, ctx); -#ifdef FLECS_JSON + } else if (!ecs_os_strcmp(typename, "ecs_vector") || + !ecs_os_strcmp(typename, "flecs::vector")) + { + type = meta_lookup_vector(world, 0, token->params, ctx); -static -int json_typeinfo_ser_type( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *buf); + } else if (!ecs_os_strcmp(typename, "flecs::bitmask")) { + type = meta_lookup_bitmask(world, 0, token->params, ctx); -static -int json_typeinfo_ser_primitive( - ecs_primitive_kind_t kind, - ecs_strbuf_t *str) -{ - switch(kind) { - case EcsBool: - json_string(str, "bool"); - break; - case EcsChar: - case EcsString: - json_string(str, "text"); - break; - case EcsByte: - json_string(str, "byte"); - break; - case EcsU8: - case EcsU16: - case EcsU32: - case EcsU64: - case EcsI8: - case EcsI16: - case EcsI32: - case EcsI64: - case EcsIPtr: - case EcsUPtr: - json_string(str, "int"); - break; - case EcsF32: - case EcsF64: - json_string(str, "float"); - break; - case EcsEntity: - json_string(str, "entity"); - break; - default: - return -1; - } + } else if (!ecs_os_strcmp(typename, "flecs::byte")) { + type = ecs_id(ecs_byte_t); - return 0; -} + } else if (!ecs_os_strcmp(typename, "char")) { + type = ecs_id(ecs_char_t); -static -void json_typeinfo_ser_constants( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *str) -{ - ecs_iter_t it = ecs_term_iter(world, &(ecs_term_t) { - .id = ecs_pair(EcsChildOf, type) - }); + } else if (!ecs_os_strcmp(typename, "bool") || + !ecs_os_strcmp(typename, "_Bool")) + { + type = ecs_id(ecs_bool_t); - while (ecs_term_next(&it)) { - int32_t i, count = it.count; - for (i = 0; i < count; i ++) { - json_next(str); - json_string(str, ecs_get_name(world, it.entities[i])); + } else if (!ecs_os_strcmp(typename, "int8_t")) { + type = ecs_id(ecs_i8_t); + } else if (!ecs_os_strcmp(typename, "int16_t")) { + type = ecs_id(ecs_i16_t); + } else if (!ecs_os_strcmp(typename, "int32_t")) { + type = ecs_id(ecs_i32_t); + } else if (!ecs_os_strcmp(typename, "int64_t")) { + type = ecs_id(ecs_i64_t); + + } else if (!ecs_os_strcmp(typename, "uint8_t")) { + type = ecs_id(ecs_u8_t); + } else if (!ecs_os_strcmp(typename, "uint16_t")) { + type = ecs_id(ecs_u16_t); + } else if (!ecs_os_strcmp(typename, "uint32_t")) { + type = ecs_id(ecs_u32_t); + } else if (!ecs_os_strcmp(typename, "uint64_t")) { + type = ecs_id(ecs_u64_t); + + } else if (!ecs_os_strcmp(typename, "float")) { + type = ecs_id(ecs_f32_t); + } else if (!ecs_os_strcmp(typename, "double")) { + type = ecs_id(ecs_f64_t); + + } else if (!ecs_os_strcmp(typename, "ecs_entity_t")) { + type = ecs_id(ecs_entity_t); + + } else if (!ecs_os_strcmp(typename, "char*")) { + type = ecs_id(ecs_string_t); + } else { + type = ecs_lookup_symbol(world, typename, true); + } + } else { + if (!ecs_os_strcmp(typename, "char")) { + typename = "flecs.meta.string"; + } else + if (token->is_ptr) { + typename = "flecs.meta.uptr"; + } else + if (!ecs_os_strcmp(typename, "char*") || + !ecs_os_strcmp(typename, "flecs::string")) + { + typename = "flecs.meta.string"; } - } -} -static -void json_typeinfo_ser_enum( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *str) -{ - ecs_strbuf_list_appendstr(str, "\"enum\""); - json_typeinfo_ser_constants(world, type, str); -} + type = ecs_lookup_symbol(world, typename, true); + } -static -void json_typeinfo_ser_bitmask( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *str) -{ - ecs_strbuf_list_appendstr(str, "\"bitmask\""); - json_typeinfo_ser_constants(world, type, str); -} + if (count != 1) { + ecs_check(count <= INT32_MAX, ECS_INVALID_PARAMETER, NULL); -static -int json_typeinfo_ser_array( - const ecs_world_t *world, - ecs_entity_t elem_type, - int32_t count, - ecs_strbuf_t *str) -{ - ecs_strbuf_list_appendstr(str, "\"array\""); + type = ecs_set(world, 0, EcsArray, {type, (int32_t)count}); + } - json_next(str); - if (json_typeinfo_ser_type(world, elem_type, str)) { + if (!type) { + ecs_meta_error(ctx, ptr, "unknown type '%s'", typename); goto error; } - ecs_strbuf_list_append(str, "%u", count); - return 0; + return type; error: - return -1; + return 0; } static -int json_typeinfo_ser_array_type( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *str) +int meta_parse_struct( + ecs_world_t *world, + ecs_entity_t t, + const char *desc) { - const EcsArray *arr = ecs_get(world, type, EcsArray); - ecs_assert(arr != NULL, ECS_INTERNAL_ERROR, NULL); - if (json_typeinfo_ser_array(world, arr->type, arr->count, str)) { - goto error; + const char *ptr = desc; + const char *name = ecs_get_name(world, t); + + meta_member_t token; + meta_parse_ctx_t ctx = { + .name = name, + .desc = ptr + }; + + ecs_entity_t old_scope = ecs_set_scope(world, t); + + while ((ptr = meta_parse_member(ptr, &token, &ctx)) && ptr[0]) { + ecs_entity_t m = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = token.name + }); + + ecs_entity_t type = meta_lookup( + world, &token.type, ptr, 1, &ctx); + if (!type) { + goto error; + } + + ecs_set(world, m, EcsMember, { + .type = type, + .count = (ecs_size_t)token.count + }); } + ecs_set_scope(world, old_scope); + return 0; error: return -1; } static -int json_typeinfo_ser_vector( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *str) +int meta_parse_constants( + ecs_world_t *world, + ecs_entity_t t, + const char *desc, + bool is_bitmask) { - const EcsVector *arr = ecs_get(world, type, EcsVector); - ecs_assert(arr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(t != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(desc != NULL, ECS_INTERNAL_ERROR, NULL); + + const char *ptr = desc; + const char *name = ecs_get_name(world, t); + + meta_parse_ctx_t ctx = { + .name = name, + .desc = ptr + }; + + meta_constant_t token; + int64_t last_value = 0; + + ecs_entity_t old_scope = ecs_set_scope(world, t); + + while ((ptr = meta_parse_constant(ptr, &token, &ctx))) { + if (token.is_value_set) { + last_value = token.value; + } else if (is_bitmask) { + ecs_meta_error(&ctx, ptr, + "bitmask requires explicit value assignment"); + goto error; + } - ecs_strbuf_list_appendstr(str, "\"vector\""); + ecs_entity_t c = ecs_entity_init(world, &(ecs_entity_desc_t) { + .name = token.name + }); - json_next(str); - if (json_typeinfo_ser_type(world, arr->type, str)) { - goto error; + if (!is_bitmask) { + ecs_set_pair_object(world, c, EcsConstant, ecs_i32_t, + {(ecs_i32_t)last_value}); + } else { + ecs_set_pair_object(world, c, EcsConstant, ecs_u32_t, + {(ecs_u32_t)last_value}); + } + + last_value ++; } + ecs_set_scope(world, old_scope); + return 0; error: return -1; } -/* Serialize unit information */ static -int json_typeinfo_ser_unit( - const ecs_world_t *world, - ecs_strbuf_t *str, - ecs_entity_t unit) +int meta_parse_enum( + ecs_world_t *world, + ecs_entity_t t, + const char *desc) { - json_member(str, "unit"); - json_path(str, world, unit); - - const EcsUnit *uptr = ecs_get(world, unit, EcsUnit); - if (uptr) { - if (uptr->symbol) { - json_member(str, "symbol"); - json_string(str, uptr->symbol); - } - ecs_entity_t quantity = ecs_get_object(world, unit, EcsQuantity, 0); - if (quantity) { - json_member(str, "quantity"); - json_path(str, world, quantity); - } - } - - return 0; + ecs_add(world, t, EcsEnum); + return meta_parse_constants(world, t, desc, false); } -/* Forward serialization to the different type kinds */ static -int json_typeinfo_ser_type_op( - const ecs_world_t *world, - ecs_meta_type_op_t *op, - ecs_strbuf_t *str) +int meta_parse_bitmask( + ecs_world_t *world, + ecs_entity_t t, + const char *desc) { - json_array_push(str); + ecs_add(world, t, EcsBitmask); + return meta_parse_constants(world, t, desc, true); +} - switch(op->kind) { - case EcsOpPush: - case EcsOpPop: - /* Should not be parsed as single op */ - ecs_throw(ECS_INVALID_PARAMETER, NULL); - break; - case EcsOpEnum: - json_typeinfo_ser_enum(world, op->type, str); - break; - case EcsOpBitmask: - json_typeinfo_ser_bitmask(world, op->type, str); +int ecs_meta_from_desc( + ecs_world_t *world, + ecs_entity_t component, + ecs_type_kind_t kind, + const char *desc) +{ + switch(kind) { + case EcsStructType: + if (meta_parse_struct(world, component, desc)) { + goto error; + } break; - case EcsOpArray: - json_typeinfo_ser_array_type(world, op->type, str); + case EcsEnumType: + if (meta_parse_enum(world, component, desc)) { + goto error; + } break; - case EcsOpVector: - json_typeinfo_ser_vector(world, op->type, str); + case EcsBitmaskType: + if (meta_parse_bitmask(world, component, desc)) { + goto error; + } break; default: - if (json_typeinfo_ser_primitive( - json_op_to_primitive_kind(op->kind), str)) - { - /* Unknown operation */ - ecs_throw(ECS_INTERNAL_ERROR, NULL); - return -1; - } break; } - ecs_entity_t unit = op->unit; - if (unit) { - json_next(str); - json_next(str); - - json_object_push(str); - json_typeinfo_ser_unit(world, str, unit); - json_object_pop(str); - } - - json_array_pop(str); - return 0; error: return -1; } -/* Iterate over a slice of the type ops array */ +#endif + + +#ifdef FLECS_APP + static -int json_typeinfo_ser_type_ops( - const ecs_world_t *world, - ecs_meta_type_op_t *ops, - int32_t op_count, - ecs_strbuf_t *str) +int default_run_action( + ecs_world_t *world, + ecs_app_desc_t *desc) { - for (int i = 0; i < op_count; i ++) { - ecs_meta_type_op_t *op = &ops[i]; + if (desc->init) { + desc->init(world); + } - if (op != ops) { - if (op->name) { - json_member(str, op->name); - } + int result; + while ((result = ecs_app_run_frame(world, desc)) == 0) { } - int32_t elem_count = op->count; - if (elem_count > 1 && op != ops) { - json_array_push(str); - json_typeinfo_ser_array(world, op->type, op->count, str); - json_array_pop(str); - i += op->op_count - 1; - continue; - } - } - - switch(op->kind) { - case EcsOpPush: - json_object_push(str); - break; - case EcsOpPop: - json_object_pop(str); - break; - default: - if (json_typeinfo_ser_type_op(world, op, str)) { - goto error; - } - break; - } + if (result == 1) { + return 0; /* Normal exit */ + } else { + return result; /* Error code */ } - - return 0; -error: - return -1; } static -int json_typeinfo_ser_type( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *buf) +int default_frame_action( + ecs_world_t *world, + const ecs_app_desc_t *desc) { - const EcsComponent *comp = ecs_get(world, type, EcsComponent); - if (!comp) { - ecs_strbuf_appendstr(buf, "0"); - return 0; - } + return !ecs_progress(world, desc->delta_time); +} - const EcsMetaTypeSerialized *ser = ecs_get( - world, type, EcsMetaTypeSerialized); - if (!ser) { - ecs_strbuf_appendstr(buf, "0"); - return 0; +static ecs_app_run_action_t run_action = default_run_action; +static ecs_app_frame_action_t frame_action = default_frame_action; +static ecs_app_desc_t ecs_app_desc; + +int ecs_app_run( + ecs_world_t *world, + ecs_app_desc_t *desc) +{ + ecs_app_desc = *desc; + + /* Don't set FPS & threads if custom run action is set, as the platform on + * which the app is running may not support it. */ + if (run_action == default_run_action) { + ecs_set_target_fps(world, ecs_app_desc.target_fps); + ecs_set_threads(world, ecs_app_desc.threads); } - ecs_meta_type_op_t *ops = ecs_vector_first(ser->ops, ecs_meta_type_op_t); - int32_t count = ecs_vector_count(ser->ops); + /* REST server enables connecting to app with explorer */ + if (desc->enable_rest) { +#ifdef FLECS_REST + ecs_set(world, EcsWorld, EcsRest, {.port = 0}); +#else + ecs_warn("cannot enable remote API, REST addon not available"); +#endif + } - return json_typeinfo_ser_type_ops(world, ops, count, buf); + return run_action(world, &ecs_app_desc); } -int ecs_type_info_to_json_buf( - const ecs_world_t *world, - ecs_entity_t type, - ecs_strbuf_t *buf) +int ecs_app_run_frame( + ecs_world_t *world, + const ecs_app_desc_t *desc) { - return json_typeinfo_ser_type(world, type, buf); + return frame_action(world, desc); } -char* ecs_type_info_to_json( - const ecs_world_t *world, - ecs_entity_t type) +int ecs_app_set_run_action( + ecs_app_run_action_t callback) { - ecs_strbuf_t str = ECS_STRBUF_INIT; + if (run_action != default_run_action) { + ecs_err("run action already set"); + return -1; + } - if (ecs_type_info_to_json_buf(world, type, &str) != 0) { - ecs_strbuf_reset(&str); - return NULL; + run_action = callback; + + return 0; +} + +int ecs_app_set_frame_action( + ecs_app_frame_action_t callback) +{ + if (frame_action != default_frame_action) { + ecs_err("frame action already set"); + return -1; } - return ecs_strbuf_get(&str); + frame_action = callback; + + return 0; } #endif +/* Roles */ +const ecs_id_t ECS_CASE = (ECS_ROLE | (0x7Cull << 56)); +const ecs_id_t ECS_SWITCH = (ECS_ROLE | (0x7Bull << 56)); +const ecs_id_t ECS_PAIR = (ECS_ROLE | (0x7Aull << 56)); +const ecs_id_t ECS_OVERRIDE = (ECS_ROLE | (0x75ull << 56)); +const ecs_id_t ECS_DISABLED = (ECS_ROLE | (0x74ull << 56)); + +/** Builtin component ids */ +const ecs_entity_t ecs_id(EcsComponent) = 1; +const ecs_entity_t ecs_id(EcsComponentLifecycle) = 2; +const ecs_entity_t ecs_id(EcsType) = 3; +const ecs_entity_t ecs_id(EcsIdentifier) = 4; +const ecs_entity_t ecs_id(EcsTrigger) = 5; +const ecs_entity_t ecs_id(EcsQuery) = 6; +const ecs_entity_t ecs_id(EcsObserver) = 7; +const ecs_entity_t ecs_id(EcsIterable) = 8; + +/* System module component ids */ +const ecs_entity_t ecs_id(EcsSystem) = 10; +const ecs_entity_t ecs_id(EcsTickSource) = 11; -#ifdef FLECS_SYSTEM -#endif +/** Pipeline module component ids */ +const ecs_entity_t ecs_id(EcsPipelineQuery) = 12; -#ifdef FLECS_PIPELINE -#ifndef FLECS_PIPELINE_PRIVATE_H -#define FLECS_PIPELINE_PRIVATE_H +/** Timer module component ids */ +const ecs_entity_t ecs_id(EcsTimer) = 13; +const ecs_entity_t ecs_id(EcsRateFilter) = 14; +/** Meta module component ids */ +const ecs_entity_t ecs_id(EcsMetaType) = 15; +const ecs_entity_t ecs_id(EcsMetaTypeSerialized) = 16; +const ecs_entity_t ecs_id(EcsPrimitive) = 17; +const ecs_entity_t ecs_id(EcsEnum) = 18; +const ecs_entity_t ecs_id(EcsBitmask) = 19; +const ecs_entity_t ecs_id(EcsMember) = 20; +const ecs_entity_t ecs_id(EcsStruct) = 21; +const ecs_entity_t ecs_id(EcsArray) = 22; +const ecs_entity_t ecs_id(EcsVector) = 23; +const ecs_entity_t ecs_id(EcsUnit) = 24; +const ecs_entity_t ecs_id(EcsUnitPrefix) = 25; -/** Instruction data for pipeline. - * This type is the element type in the "ops" vector of a pipeline and contains - * information about the set of systems that need to be ran before a merge. */ -typedef struct ecs_pipeline_op_t { - int32_t count; /* Number of systems to run before merge */ - bool multi_threaded; /* Whether systems can be ran multi threaded */ - bool no_staging; /* Whether systems are staged or not */ -} ecs_pipeline_op_t; +/* Core scopes & entities */ +const ecs_entity_t EcsWorld = ECS_HI_COMPONENT_ID + 0; +const ecs_entity_t EcsFlecs = ECS_HI_COMPONENT_ID + 1; +const ecs_entity_t EcsFlecsCore = ECS_HI_COMPONENT_ID + 2; +const ecs_entity_t EcsFlecsHidden = ECS_HI_COMPONENT_ID + 3; +const ecs_entity_t EcsModule = ECS_HI_COMPONENT_ID + 4; +const ecs_entity_t EcsPrivate = ECS_HI_COMPONENT_ID + 5; +const ecs_entity_t EcsPrefab = ECS_HI_COMPONENT_ID + 6; +const ecs_entity_t EcsDisabled = ECS_HI_COMPONENT_ID + 7; -typedef struct EcsPipelineQuery { - ecs_query_t *query; - ecs_query_t *build_query; - ecs_vector_t *ops; - int32_t match_count; - int32_t rebuild_count; - ecs_entity_t last_system; -} EcsPipelineQuery; +/* Relation properties */ +const ecs_entity_t EcsWildcard = ECS_HI_COMPONENT_ID + 10; +const ecs_entity_t EcsAny = ECS_HI_COMPONENT_ID + 11; +const ecs_entity_t EcsThis = ECS_HI_COMPONENT_ID + 12; +const ecs_entity_t EcsTransitive = ECS_HI_COMPONENT_ID + 13; +const ecs_entity_t EcsReflexive = ECS_HI_COMPONENT_ID + 14; +const ecs_entity_t EcsSymmetric = ECS_HI_COMPONENT_ID + 15; +const ecs_entity_t EcsFinal = ECS_HI_COMPONENT_ID + 16; +const ecs_entity_t EcsDontInherit = ECS_HI_COMPONENT_ID + 17; +const ecs_entity_t EcsTag = ECS_HI_COMPONENT_ID + 18; +const ecs_entity_t EcsExclusive = ECS_HI_COMPONENT_ID + 19; +const ecs_entity_t EcsAcyclic = ECS_HI_COMPONENT_ID + 20; +const ecs_entity_t EcsWith = ECS_HI_COMPONENT_ID + 21; -//////////////////////////////////////////////////////////////////////////////// -//// Pipeline API -//////////////////////////////////////////////////////////////////////////////// +/* Builtin relations */ +const ecs_entity_t EcsChildOf = ECS_HI_COMPONENT_ID + 25; +const ecs_entity_t EcsIsA = ECS_HI_COMPONENT_ID + 26; -/** Update a pipeline (internal function). - * Before running a pipeline, it must be updated. During this update phase - * all systems in the pipeline are collected, ordered and sync points are - * inserted where necessary. This operation may only be called when staging is - * disabled. - * - * Because multiple threads may run a pipeline, preparing the pipeline must - * happen synchronously, which is why this function is separate from - * ecs_run_pipeline. Not running the prepare step may cause systems to not get - * ran, or ran in the wrong order. - * - * If 0 is provided for the pipeline id, the default pipeline will be ran (this - * is either the builtin pipeline or the pipeline set with set_pipeline()). - * - * @param world The world. - * @param pipeline The pipeline to run. - * @return The number of elements in the pipeline. - */ -bool ecs_pipeline_update( - ecs_world_t *world, - ecs_entity_t pipeline, - bool start_of_frame); +/* Identifier tags */ +const ecs_entity_t EcsName = ECS_HI_COMPONENT_ID + 27; +const ecs_entity_t EcsSymbol = ECS_HI_COMPONENT_ID + 28; +const ecs_entity_t EcsAlias = ECS_HI_COMPONENT_ID + 29; -int32_t ecs_pipeline_reset_iter( - ecs_world_t *world, - const EcsPipelineQuery *pq, - ecs_iter_t *iter_out, - ecs_pipeline_op_t **op_out, - ecs_pipeline_op_t **last_op_out); +/* Events */ +const ecs_entity_t EcsOnAdd = ECS_HI_COMPONENT_ID + 30; +const ecs_entity_t EcsOnRemove = ECS_HI_COMPONENT_ID + 31; +const ecs_entity_t EcsOnSet = ECS_HI_COMPONENT_ID + 32; +const ecs_entity_t EcsUnSet = ECS_HI_COMPONENT_ID + 33; +const ecs_entity_t EcsOnDelete = ECS_HI_COMPONENT_ID + 34; +const ecs_entity_t EcsOnCreateTable = ECS_HI_COMPONENT_ID + 35; +const ecs_entity_t EcsOnDeleteTable = ECS_HI_COMPONENT_ID + 36; +const ecs_entity_t EcsOnTableEmpty = ECS_HI_COMPONENT_ID + 37; +const ecs_entity_t EcsOnTableFill = ECS_HI_COMPONENT_ID + 38; +const ecs_entity_t EcsOnCreateTrigger = ECS_HI_COMPONENT_ID + 39; +const ecs_entity_t EcsOnDeleteTrigger = ECS_HI_COMPONENT_ID + 40; +const ecs_entity_t EcsOnDeleteObservable = ECS_HI_COMPONENT_ID + 41; +const ecs_entity_t EcsOnComponentLifecycle = ECS_HI_COMPONENT_ID + 42; +const ecs_entity_t EcsOnDeleteObject = ECS_HI_COMPONENT_ID + 43; -//////////////////////////////////////////////////////////////////////////////// -//// Worker API -//////////////////////////////////////////////////////////////////////////////// +/* Actions */ +const ecs_entity_t EcsRemove = ECS_HI_COMPONENT_ID + 50; +const ecs_entity_t EcsDelete = ECS_HI_COMPONENT_ID + 51; +const ecs_entity_t EcsThrow = ECS_HI_COMPONENT_ID + 52; -void ecs_worker_begin( - ecs_world_t *world); +/* Misc */ +const ecs_entity_t EcsDefaultChildComponent = ECS_HI_COMPONENT_ID + 55; -int32_t ecs_worker_sync( - ecs_world_t *world, - const EcsPipelineQuery *pq, - ecs_iter_t *it, - int32_t i, - ecs_pipeline_op_t **op_out, - ecs_pipeline_op_t **last_op_out); +/* Systems */ +const ecs_entity_t EcsMonitor = ECS_HI_COMPONENT_ID + 61; +const ecs_entity_t EcsInactive = ECS_HI_COMPONENT_ID + 63; +const ecs_entity_t EcsPipeline = ECS_HI_COMPONENT_ID + 64; +const ecs_entity_t EcsPreFrame = ECS_HI_COMPONENT_ID + 65; +const ecs_entity_t EcsOnLoad = ECS_HI_COMPONENT_ID + 66; +const ecs_entity_t EcsPostLoad = ECS_HI_COMPONENT_ID + 67; +const ecs_entity_t EcsPreUpdate = ECS_HI_COMPONENT_ID + 68; +const ecs_entity_t EcsOnUpdate = ECS_HI_COMPONENT_ID + 69; +const ecs_entity_t EcsOnValidate = ECS_HI_COMPONENT_ID + 70; +const ecs_entity_t EcsPostUpdate = ECS_HI_COMPONENT_ID + 71; +const ecs_entity_t EcsPreStore = ECS_HI_COMPONENT_ID + 72; +const ecs_entity_t EcsOnStore = ECS_HI_COMPONENT_ID + 73; +const ecs_entity_t EcsPostFrame = ECS_HI_COMPONENT_ID + 74; -void ecs_worker_end( - ecs_world_t *world); +/* Meta primitive components (don't use low ids to save id space) */ +const ecs_entity_t ecs_id(ecs_bool_t) = ECS_HI_COMPONENT_ID + 80; +const ecs_entity_t ecs_id(ecs_char_t) = ECS_HI_COMPONENT_ID + 81; +const ecs_entity_t ecs_id(ecs_byte_t) = ECS_HI_COMPONENT_ID + 82; +const ecs_entity_t ecs_id(ecs_u8_t) = ECS_HI_COMPONENT_ID + 83; +const ecs_entity_t ecs_id(ecs_u16_t) = ECS_HI_COMPONENT_ID + 84; +const ecs_entity_t ecs_id(ecs_u32_t) = ECS_HI_COMPONENT_ID + 85; +const ecs_entity_t ecs_id(ecs_u64_t) = ECS_HI_COMPONENT_ID + 86; +const ecs_entity_t ecs_id(ecs_uptr_t) = ECS_HI_COMPONENT_ID + 87; +const ecs_entity_t ecs_id(ecs_i8_t) = ECS_HI_COMPONENT_ID + 88; +const ecs_entity_t ecs_id(ecs_i16_t) = ECS_HI_COMPONENT_ID + 89; +const ecs_entity_t ecs_id(ecs_i32_t) = ECS_HI_COMPONENT_ID + 90; +const ecs_entity_t ecs_id(ecs_i64_t) = ECS_HI_COMPONENT_ID + 91; +const ecs_entity_t ecs_id(ecs_iptr_t) = ECS_HI_COMPONENT_ID + 92; +const ecs_entity_t ecs_id(ecs_f32_t) = ECS_HI_COMPONENT_ID + 93; +const ecs_entity_t ecs_id(ecs_f64_t) = ECS_HI_COMPONENT_ID + 94; +const ecs_entity_t ecs_id(ecs_string_t) = ECS_HI_COMPONENT_ID + 95; +const ecs_entity_t ecs_id(ecs_entity_t) = ECS_HI_COMPONENT_ID + 96; +const ecs_entity_t EcsConstant = ECS_HI_COMPONENT_ID + 97; +const ecs_entity_t EcsQuantity = ECS_HI_COMPONENT_ID + 98; + +/* Doc module components */ +const ecs_entity_t ecs_id(EcsDocDescription) =ECS_HI_COMPONENT_ID + 100; +const ecs_entity_t EcsDocBrief = ECS_HI_COMPONENT_ID + 101; +const ecs_entity_t EcsDocDetail = ECS_HI_COMPONENT_ID + 102; +const ecs_entity_t EcsDocLink = ECS_HI_COMPONENT_ID + 103; + +/* REST module components */ +const ecs_entity_t ecs_id(EcsRest) = ECS_HI_COMPONENT_ID + 105; + +/* Default lookup path */ +static ecs_entity_t ecs_default_lookup_path[2] = { 0, 0 }; + +/* -- Private functions -- */ + +const ecs_stage_t* flecs_stage_from_readonly_world( + const ecs_world_t *world) +{ + ecs_assert(ecs_poly_is(world, ecs_world_t) || + ecs_poly_is(world, ecs_stage_t), + ECS_INTERNAL_ERROR, + NULL); + + if (ecs_poly_is(world, ecs_world_t)) { + return &world->stage; + + } else if (ecs_poly_is(world, ecs_stage_t)) { + return (ecs_stage_t*)world; + } + + return NULL; +} + +ecs_stage_t *flecs_stage_from_world( + ecs_world_t **world_ptr) +{ + ecs_world_t *world = *world_ptr; + + ecs_assert(ecs_poly_is(world, ecs_world_t) || + ecs_poly_is(world, ecs_stage_t), + ECS_INTERNAL_ERROR, + NULL); + + if (ecs_poly_is(world, ecs_world_t)) { + ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); + return &world->stage; + + } else if (ecs_poly_is(world, ecs_stage_t)) { + ecs_stage_t *stage = (ecs_stage_t*)world; + *world_ptr = stage->world; + return stage; + } + + return NULL; +} + +ecs_world_t* flecs_suspend_readonly( + const ecs_world_t *stage_world, + ecs_suspend_readonly_state_t *state) +{ + ecs_assert(stage_world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(state != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_world_t *world = (ecs_world_t*)ecs_get_world(stage_world); + ecs_poly_assert(world, ecs_world_t); + + bool is_readonly = world->is_readonly; + bool is_deferred = ecs_is_deferred(world); + + if (!world->is_readonly && !is_deferred) { + state->is_readonly = false; + state->is_deferred = false; + return world; + } -void ecs_workers_progress( - ecs_world_t *world, - ecs_entity_t pipeline, - FLECS_FLOAT delta_time); + ecs_dbg_3("suspending readonly mode"); -#endif + /* Cannot suspend when running with multiple threads */ + ecs_assert(ecs_get_stage_count(world) <= 1, + ECS_INVALID_WHILE_ITERATING, NULL); -#endif + state->is_readonly = is_readonly; + state->is_deferred = is_deferred; -#ifdef FLECS_STATS + /* Silence readonly checks */ + world->is_readonly = false; -#include + /* Hack around safety checks (this ought to look ugly) */ + ecs_world_t *temp_world = world; + ecs_stage_t *stage = flecs_stage_from_world(&temp_world); + state->defer_count = stage->defer; + state->defer_queue = stage->defer_queue; + state->scope = world->stage.scope; + state->with = world->stage.with; + stage->defer = 0; + stage->defer_queue = NULL; -static -int32_t t_next( - int32_t t) -{ - return (t + 1) % ECS_STAT_WINDOW; + if (&world->stage != (ecs_stage_t*)stage_world) { + world->stage.scope = stage->scope; + world->stage.with = stage->with; + } + + return world; } -static -int32_t t_prev( - int32_t t) +void flecs_resume_readonly( + ecs_world_t *world, + ecs_suspend_readonly_state_t *state) { - return (t - 1 + ECS_STAT_WINDOW) % ECS_STAT_WINDOW; -} + ecs_poly_assert(world, ecs_world_t); + ecs_assert(state != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_world_t *temp_world = world; + ecs_stage_t *stage = flecs_stage_from_world(&temp_world); -static -void _record_gauge( - ecs_gauge_t *m, - int32_t t, - float value) -{ - m->avg[t] = value; - m->min[t] = value; - m->max[t] = value; + if (state->is_readonly || state->is_deferred) { + ecs_dbg_3("resuming readonly mode"); + + ecs_force_aperiodic(world); + + /* Restore readonly state / defer count */ + world->is_readonly = state->is_readonly; + stage->defer = state->defer_count; + stage->defer_queue = state->defer_queue; + world->stage.scope = state->scope; + world->stage.with = state->with; + } } +/* Evaluate component monitor. If a monitored entity changed it will have set a + * flag in one of the world's component monitors. Queries can register + * themselves with component monitors to determine whether they need to rematch + * with tables. */ static -float _record_counter( - ecs_counter_t *m, - int32_t t, - float value) +void eval_component_monitor( + ecs_world_t *world) { - int32_t tp = t_prev(t); - float prev = m->value[tp]; - m->value[t] = value; - _record_gauge((ecs_gauge_t*)m, t, value - prev); - return value - prev; -} - -/* Macro's to silence conversion warnings without adding casts everywhere */ -#define record_gauge(m, t, value)\ - _record_gauge(m, t, (float)value) + ecs_poly_assert(world, ecs_world_t); -#define record_counter(m, t, value)\ - _record_counter(m, t, (float)value) + ecs_relation_monitor_t *rm = &world->monitors; -static -void print_value( - const char *name, - float value) -{ - ecs_size_t len = ecs_os_strlen(name); - printf("%s: %*s %.2f\n", name, 32 - len, "", (double)value); -} + if (!rm->is_dirty) { + return; + } -static -void print_gauge( - const char *name, - int32_t t, - const ecs_gauge_t *m) -{ - print_value(name, m->avg[t]); -} + ecs_map_iter_t it = ecs_map_iter(&rm->monitor_sets); + ecs_monitor_set_t *ms; -static -void print_counter( - const char *name, - int32_t t, - const ecs_counter_t *m) -{ - print_value(name, m->rate.avg[t]); -} + while ((ms = ecs_map_next(&it, ecs_monitor_set_t, NULL))) { + if (!ms->is_dirty) { + continue; + } -void ecs_gauge_reduce( - ecs_gauge_t *dst, - int32_t t_dst, - ecs_gauge_t *src, - int32_t t_src) -{ - ecs_check(dst != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(src != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_map_iter_t mit = ecs_map_iter(&ms->monitors); + ecs_monitor_t *m; + while ((m = ecs_map_next(&mit, ecs_monitor_t, NULL))) { + if (!m->is_dirty) { + continue; + } - bool min_set = false; - dst->min[t_dst] = 0; - dst->avg[t_dst] = 0; - dst->max[t_dst] = 0; + ecs_vector_each(m->queries, ecs_query_t*, q_ptr, { + flecs_query_notify(world, *q_ptr, &(ecs_query_event_t) { + .kind = EcsQueryTableRematch + }); + }); - int32_t i; - for (i = 0; i < ECS_STAT_WINDOW; i ++) { - int32_t t = (t_src + i) % ECS_STAT_WINDOW; - dst->avg[t_dst] += src->avg[t] / (float)ECS_STAT_WINDOW; - if (!min_set || (src->min[t] < dst->min[t_dst])) { - dst->min[t_dst] = src->min[t]; - min_set = true; + m->is_dirty = false; } - if ((src->max[t] > dst->max[t_dst])) { - dst->max[t_dst] = src->max[t]; + + ms->is_dirty = false; + } + + rm->is_dirty = false; +} + +void flecs_monitor_mark_dirty( + ecs_world_t *world, + ecs_entity_t relation, + ecs_entity_t id) +{ + /* Only flag if there are actually monitors registered, so that we + * don't waste cycles evaluating monitors if there's no interest */ + ecs_monitor_set_t *ms = ecs_map_get(&world->monitors.monitor_sets, + ecs_monitor_set_t, relation); + if (ms && ecs_map_is_initialized(&ms->monitors)) { + ecs_monitor_t *m = ecs_map_get(&ms->monitors, + ecs_monitor_t, id); + if (m) { + m->is_dirty = true; + ms->is_dirty = true; + world->monitors.is_dirty = true; } } -error: - return; } -void ecs_get_world_stats( - const ecs_world_t *world, - ecs_world_stats_t *s) +void flecs_monitor_register( + ecs_world_t *world, + ecs_entity_t relation, + ecs_entity_t id, + ecs_query_t *query) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); - world = ecs_get_world(world); + ecs_monitor_set_t *ms = ecs_map_ensure( + &world->monitors.monitor_sets, ecs_monitor_set_t, relation); + ecs_assert(ms != NULL, ECS_INTERNAL_ERROR, NULL); - int32_t t = s->t = t_next(s->t); + if (!ecs_map_is_initialized(&ms->monitors)) { + ecs_map_init(&ms->monitors, ecs_monitor_t, 1); + } - float delta_world_time = record_counter(&s->world_time_total_raw, t, world->stats.world_time_total_raw); - record_counter(&s->world_time_total, t, world->stats.world_time_total); - record_counter(&s->frame_time_total, t, world->stats.frame_time_total); - record_counter(&s->system_time_total, t, world->stats.system_time_total); - record_counter(&s->merge_time_total, t, world->stats.merge_time_total); + ecs_monitor_t *m = ecs_map_ensure(&ms->monitors, ecs_monitor_t, id); + ecs_assert(m != NULL, ECS_INTERNAL_ERROR, NULL); - float delta_frame_count = record_counter(&s->frame_count_total, t, world->stats.frame_count_total); - record_counter(&s->merge_count_total, t, world->stats.merge_count_total); - record_counter(&s->pipeline_build_count_total, t, world->stats.pipeline_build_count_total); - record_counter(&s->systems_ran_frame, t, world->stats.systems_ran_frame); + ecs_query_t **q = ecs_vector_add(&m->queries, ecs_query_t*); + *q = query; +} - if (delta_world_time != 0.0f && delta_frame_count != 0.0f) { - record_gauge( - &s->fps, t, 1.0f / (delta_world_time / (float)delta_frame_count)); - } else { - record_gauge(&s->fps, t, 0); - } +void flecs_monitor_unregister( + ecs_world_t *world, + ecs_entity_t relation, + ecs_entity_t id, + ecs_query_t *query) +{ + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); - record_gauge(&s->entity_count, t, flecs_sparse_count(ecs_eis(world))); - record_gauge(&s->component_count, t, ecs_count_id(world, ecs_id(EcsComponent))); - record_gauge(&s->query_count, t, flecs_sparse_count(world->queries)); - record_gauge(&s->system_count, t, ecs_count_id(world, ecs_id(EcsSystem))); + ecs_monitor_set_t *ms = ecs_map_get( + &world->monitors.monitor_sets, ecs_monitor_set_t, relation); + if (!ms) { + return; + } - record_counter(&s->new_count, t, world->new_count); - record_counter(&s->bulk_new_count, t, world->bulk_new_count); - record_counter(&s->delete_count, t, world->delete_count); - record_counter(&s->clear_count, t, world->clear_count); - record_counter(&s->add_count, t, world->add_count); - record_counter(&s->remove_count, t, world->remove_count); - record_counter(&s->set_count, t, world->set_count); - record_counter(&s->discard_count, t, world->discard_count); + if (!ecs_map_is_initialized(&ms->monitors)) { + return; + } - /* Compute table statistics */ - int32_t empty_table_count = 0; - int32_t singleton_table_count = 0; - int32_t matched_table_count = 0, matched_entity_count = 0; + ecs_monitor_t *m = ecs_map_get(&ms->monitors, ecs_monitor_t, id); + if (!m) { + return; + } - int32_t i, count = flecs_sparse_count(&world->store.tables); + int32_t i, count = ecs_vector_count(m->queries); + ecs_query_t **queries = ecs_vector_first(m->queries, ecs_query_t*); for (i = 0; i < count; i ++) { - ecs_table_t *table = flecs_sparse_get_dense(&world->store.tables, - ecs_table_t, i); - int32_t entity_count = ecs_table_count(table); - - if (!entity_count) { - empty_table_count ++; + if (queries[i] == query) { + ecs_vector_remove(m->queries, ecs_query_t*, i); + count --; + break; } + } - /* Singleton tables are tables that have just one entity that also has - * itself in the table type. */ - if (entity_count == 1) { - ecs_entity_t *entities = ecs_vector_first( - table->storage.entities, ecs_entity_t); - if (ecs_search_relation(world, table, 0, entities[0], EcsIsA, - 0, 0, 0, 0, 0) != -1) - { - singleton_table_count ++; - } - } + if (!count) { + ecs_vector_free(m->queries); + ecs_map_remove(&ms->monitors, id); } - record_gauge(&s->matched_table_count, t, matched_table_count); - record_gauge(&s->matched_entity_count, t, matched_entity_count); - - record_gauge(&s->table_count, t, count); - record_gauge(&s->empty_table_count, t, empty_table_count); - record_gauge(&s->singleton_table_count, t, singleton_table_count); + if (!ecs_map_count(&ms->monitors)) { + ecs_map_fini(&ms->monitors); + ecs_map_remove(&world->monitors.monitor_sets, relation); + } -error: - return; + if (!ecs_map_count(&world->monitors.monitor_sets)) { + ecs_map_fini(&world->monitors.monitor_sets); + } } -void ecs_get_query_stats( - const ecs_world_t *world, - const ecs_query_t *query, - ecs_query_stats_t *s) +static +void monitors_init( + ecs_relation_monitor_t *rm) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); - (void)world; - - int32_t t = s->t = t_next(s->t); - - ecs_iter_t it = ecs_query_iter(world, (ecs_query_t*)query); - record_gauge(&s->matched_entity_count, t, ecs_iter_count(&it)); - record_gauge(&s->matched_table_count, t, ecs_query_table_count(query)); - record_gauge(&s->matched_empty_table_count, t, - ecs_query_empty_table_count(query)); -error: - return; + ecs_map_init(&rm->monitor_sets, ecs_monitor_set_t, 0); + rm->is_dirty = false; } -#ifdef FLECS_SYSTEM -bool ecs_get_system_stats( - const ecs_world_t *world, - ecs_entity_t system, - ecs_system_stats_t *s) +static +void monitors_fini( + ecs_relation_monitor_t *rm) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); + ecs_map_iter_t it = ecs_map_iter(&rm->monitor_sets); + ecs_monitor_set_t *ms; - world = ecs_get_world(world); + while ((ms = ecs_map_next(&it, ecs_monitor_set_t, NULL))) { + ecs_map_iter_t mit = ecs_map_iter(&ms->monitors); + ecs_monitor_t *m; + while ((m = ecs_map_next(&mit, ecs_monitor_t, NULL))) { + ecs_vector_free(m->queries); + } - const EcsSystem *ptr = ecs_get(world, system, EcsSystem); - if (!ptr) { - return false; + ecs_map_fini(&ms->monitors); } - ecs_get_query_stats(world, ptr->query, &s->query_stats); - int32_t t = s->query_stats.t; - - record_counter(&s->time_spent, t, ptr->time_spent); - record_counter(&s->invoke_count, t, ptr->invoke_count); - record_gauge(&s->active, t, !ecs_has_id(world, system, EcsInactive)); - record_gauge(&s->enabled, t, !ecs_has_id(world, system, EcsDisabled)); - - return true; -error: - return false; + ecs_map_fini(&rm->monitor_sets); } -#endif - -#ifdef FLECS_PIPELINE - -static -ecs_system_stats_t* get_system_stats( - ecs_map_t *systems, - ecs_entity_t system) +static +void init_store( + ecs_world_t *world) { - ecs_check(systems != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(system != 0, ECS_INVALID_PARAMETER, NULL); + ecs_os_memset(&world->store, 0, ECS_SIZEOF(ecs_store_t)); + + /* Initialize entity index */ + flecs_sparse_init(&world->store.entity_index, ecs_record_t); + flecs_sparse_set_id_source(&world->store.entity_index, + &world->stats.last_id); - ecs_system_stats_t *s = ecs_map_get(systems, ecs_system_stats_t, system); - if (!s) { - s = ecs_map_ensure(systems, ecs_system_stats_t, system); - } + /* Initialize root table */ + flecs_sparse_init(&world->store.tables, ecs_table_t); - return s; -error: - return NULL; + /* Initialize table map */ + flecs_table_hashmap_init(&world->store.table_map); + + /* Initialize one root table per stage */ + flecs_init_root_table(world); } -bool ecs_get_pipeline_stats( - ecs_world_t *stage, - ecs_entity_t pipeline, - ecs_pipeline_stats_t *s) +static +void clean_tables( + ecs_world_t *world) { - ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(pipeline != 0, ECS_INVALID_PARAMETER, NULL); - - const ecs_world_t *world = ecs_get_world(stage); - - const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); - if (!pq) { - return false; - } + int32_t i, count = flecs_sparse_count(&world->store.tables); - int32_t sys_count = 0, active_sys_count = 0; + /* Ensure that first table in sparse set has id 0. This is a dummy table + * that only exists so that there is no table with id 0 */ + ecs_table_t *first = flecs_sparse_get_dense(&world->store.tables, + ecs_table_t, 0); + ecs_assert(first->id == 0, ECS_INTERNAL_ERROR, NULL); + (void)first; - /* Count number of active systems */ - ecs_iter_t it = ecs_query_iter(stage, pq->query); - while (ecs_query_next(&it)) { - active_sys_count += it.count; + for (i = 1; i < count; i ++) { + ecs_table_t *t = flecs_sparse_get_dense(&world->store.tables, + ecs_table_t, i); + flecs_table_release(world, t); } - /* Count total number of systems in pipeline */ - it = ecs_query_iter(stage, pq->build_query); - while (ecs_query_next(&it)) { - sys_count += it.count; - } - - /* Also count synchronization points */ - ecs_vector_t *ops = pq->ops; - ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); - ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); - int32_t pip_count = active_sys_count + ecs_vector_count(ops); - - if (!sys_count) { - return false; + /* Free table types separately so that if application destructors rely on + * a type it's still valid. */ + for (i = 1; i < count; i ++) { + ecs_table_t *t = flecs_sparse_get_dense(&world->store.tables, + ecs_table_t, i); + flecs_table_free_type(t); } - if (s->system_stats && !sys_count) { - ecs_map_free(s->system_stats); - } - if (!s->system_stats && sys_count) { - s->system_stats = ecs_map_new(ecs_system_stats_t, sys_count); - } - if (!sys_count) { - s->system_stats = NULL; + /* Clear the root table */ + if (count) { + flecs_table_reset(world, &world->store.root); } +} - /* Make sure vector is large enough to store all systems & sync points */ - ecs_entity_t *systems = NULL; - if (pip_count) { - ecs_vector_set_count(&s->systems, ecs_entity_t, pip_count); - systems = ecs_vector_first(s->systems, ecs_entity_t); - - /* Populate systems vector, keep track of sync points */ - it = ecs_query_iter(stage, pq->query); - - int32_t i, i_system = 0, ran_since_merge = 0; - while (ecs_query_next(&it)) { - for (i = 0; i < it.count; i ++) { - systems[i_system ++] = it.entities[i]; - ran_since_merge ++; - if (op != op_last && ran_since_merge == op->count) { - ran_since_merge = 0; - op++; - systems[i_system ++] = 0; /* 0 indicates a merge point */ - } - } - } - - systems[i_system ++] = 0; /* Last merge */ - ecs_assert(pip_count == i_system, ECS_INTERNAL_ERROR, NULL); - } else { - ecs_vector_free(s->systems); - s->systems = NULL; - } +static +void fini_store(ecs_world_t *world) { + clean_tables(world); + flecs_sparse_fini(&world->store.tables); + flecs_table_release(world, &world->store.root); + flecs_sparse_clear(&world->store.entity_index); + flecs_hashmap_fini(&world->store.table_map); - /* Separately populate system stats map from build query, which includes - * systems that aren't currently active */ - it = ecs_query_iter(stage, pq->build_query); - while (ecs_query_next(&it)) { - int i; - for (i = 0; i < it.count; i ++) { - ecs_system_stats_t *sys_stats = get_system_stats( - s->system_stats, it.entities[i]); - ecs_get_system_stats(world, it.entities[i], sys_stats); - } + ecs_graph_edge_hdr_t *cur, *next = world->store.first_free; + while ((cur = next)) { + next = cur->next; + ecs_os_free(cur); } - - return true; -error: - return false; } -void ecs_pipeline_stats_fini( - ecs_pipeline_stats_t *stats) +/* Implementation for iterable mixin */ +static +bool world_iter_next( + ecs_iter_t *it) { - ecs_map_free(stats->system_stats); - ecs_vector_free(stats->systems); -} + if (it->is_valid) { + return it->is_valid = false; + } -#endif + ecs_world_t *world = it->real_world; + ecs_sparse_t *entity_index = &world->store.entity_index; + it->entities = (ecs_entity_t*)flecs_sparse_ids(entity_index); + it->count = flecs_sparse_count(entity_index); + return it->is_valid = true; +} -void ecs_dump_world_stats( +static +void world_iter_init( const ecs_world_t *world, - const ecs_world_stats_t *s) + const ecs_poly_t *poly, + ecs_iter_t *iter, + ecs_term_t *filter) { - int32_t t = s->t; + ecs_poly_assert(poly, ecs_world_t); + (void)poly; - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(s != NULL, ECS_INVALID_PARAMETER, NULL); + if (filter) { + iter[0] = ecs_term_iter(world, filter); + } else { + iter[0] = (ecs_iter_t){ + .world = (ecs_world_t*)world, + .real_world = (ecs_world_t*)ecs_get_world(world), + .next = world_iter_next + }; + } +} - world = ecs_get_world(world); - - print_counter("Frame", t, &s->frame_count_total); - printf("-------------------------------------\n"); - print_counter("pipeline rebuilds", t, &s->pipeline_build_count_total); - print_counter("systems ran last frame", t, &s->systems_ran_frame); - printf("\n"); - print_value("target FPS", world->stats.target_fps); - print_value("time scale", world->stats.time_scale); - printf("\n"); - print_gauge("actual FPS", t, &s->fps); - print_counter("frame time", t, &s->frame_time_total); - print_counter("system time", t, &s->system_time_total); - print_counter("merge time", t, &s->merge_time_total); - print_counter("simulation time elapsed", t, &s->world_time_total); - printf("\n"); - print_gauge("entity count", t, &s->entity_count); - print_gauge("component count", t, &s->component_count); - print_gauge("query count", t, &s->query_count); - print_gauge("system count", t, &s->system_count); - print_gauge("table count", t, &s->table_count); - print_gauge("singleton table count", t, &s->singleton_table_count); - print_gauge("empty table count", t, &s->empty_table_count); - printf("\n"); - print_counter("deferred new operations", t, &s->new_count); - print_counter("deferred bulk_new operations", t, &s->bulk_new_count); - print_counter("deferred delete operations", t, &s->delete_count); - print_counter("deferred clear operations", t, &s->clear_count); - print_counter("deferred add operations", t, &s->add_count); - print_counter("deferred remove operations", t, &s->remove_count); - print_counter("deferred set operations", t, &s->set_count); - print_counter("discarded operations", t, &s->discard_count); - printf("\n"); - -error: - return; +static +void log_addons(void) { + ecs_trace("addons included in build:"); + ecs_log_push(); + #ifdef FLECS_CPP + ecs_trace("FLECS_CPP"); + #endif + #ifdef FLECS_MODULE + ecs_trace("FLECS_MODULE"); + #endif + #ifdef FLECS_PARSER + ecs_trace("FLECS_PARSER"); + #endif + #ifdef FLECS_PLECS + ecs_trace("FLECS_PLECS"); + #endif + #ifdef FLECS_RULES + ecs_trace("FLECS_RULES"); + #endif + #ifdef FLECS_SNAPSHOT + ecs_trace("FLECS_SNAPSHOT"); + #endif + #ifdef FLECS_STATS + ecs_trace("FLECS_STATS"); + #endif + #ifdef FLECS_SYSTEM + ecs_trace("FLECS_SYSTEM"); + #endif + #ifdef FLECS_PIPELINE + ecs_trace("FLECS_PIPELINE"); + #endif + #ifdef FLECS_TIMER + ecs_trace("FLECS_TIMER"); + #endif + #ifdef FLECS_META + ecs_trace("FLECS_META"); + #endif + #ifdef FLECS_META_C + ecs_trace("FLECS_META_C"); + #endif + #ifdef FLECS_UNITS + ecs_trace("FLECS_UNITS"); + #endif + #ifdef FLECS_EXPR + ecs_trace("FLECS_EXPR"); + #endif + #ifdef FLECS_JSON + ecs_trace("FLECS_JSON"); + #endif + #ifdef FLECS_DOC + ecs_trace("FLECS_DOC"); + #endif + #ifdef FLECS_COREDOC + ecs_trace("FLECS_COREDOC"); + #endif + #ifdef FLECS_LOG + ecs_trace("FLECS_LOG"); + #endif + #ifdef FLECS_APP + ecs_trace("FLECS_APP"); + #endif + #ifdef FLECS_OS_API_IMPL + ecs_trace("FLECS_OS_API_IMPL"); + #endif + #ifdef FLECS_HTTP + ecs_trace("FLECS_HTTP"); + #endif + #ifdef FLECS_REST + ecs_trace("FLECS_REST"); + #endif + ecs_log_pop(); } +/* -- Public functions -- */ + +ecs_world_t *ecs_mini(void) { +#ifdef FLECS_OS_API_IMPL + ecs_set_os_api_impl(); #endif + ecs_os_init(); + ecs_trace("#[bold]bootstrapping world"); + ecs_log_push(); -#ifdef FLECS_APP + ecs_trace("tracing enabled, call ecs_log_set_level(-1) to disable"); -static -int default_run_action( - ecs_world_t *world, - ecs_app_desc_t *desc) -{ - if (desc->init) { - desc->init(world); + if (!ecs_os_has_heap()) { + ecs_abort(ECS_MISSING_OS_API, NULL); } - int result; - while ((result = ecs_app_run_frame(world, desc)) == 0) { } - - if (result == 1) { - return 0; /* Normal exit */ - } else { - return result; /* Error code */ + if (!ecs_os_has_threading()) { + ecs_trace("threading unavailable, to use threads set OS API first (see examples)"); } -} - -static -int default_frame_action( - ecs_world_t *world, - const ecs_app_desc_t *desc) -{ - return !ecs_progress(world, desc->delta_time); -} - -static ecs_app_run_action_t run_action = default_run_action; -static ecs_app_frame_action_t frame_action = default_frame_action; -static ecs_app_desc_t ecs_app_desc; - -int ecs_app_run( - ecs_world_t *world, - ecs_app_desc_t *desc) -{ - ecs_app_desc = *desc; - /* Don't set FPS & threads if custom run action is set, as the platform on - * which the app is running may not support it. */ - if (run_action == default_run_action) { - ecs_set_target_fps(world, ecs_app_desc.target_fps); - ecs_set_threads(world, ecs_app_desc.threads); + if (!ecs_os_has_time()) { + ecs_trace("time management not available"); } - /* REST server enables connecting to app with explorer */ - if (desc->enable_rest) { -#ifdef FLECS_REST - ecs_set(world, EcsWorld, EcsRest, {.port = 0}); + log_addons(); + +#ifdef FLECS_SANITIZE + ecs_trace("sanitize build, rebuild witohut FLECS_SANITIZE for (much) " + "improved performance"); +#elif defined(FLECS_DEBUG) + ecs_trace("debug build, rebuild with NDEBUG or FLECS_NDEBUG for improved " + "performance"); #else - ecs_warn("cannot enable remote API, REST addon not available"); + ecs_trace("#[green]release#[reset] build"); #endif - } - return run_action(world, &ecs_app_desc); -} +#ifdef __clang__ + ecs_trace("compiled with clang %s", __clang_version__); +#elif defined(__GNUC__) + ecs_trace("compiled with gcc %d.%d", __GNUC__, __GNUC_MINOR__); +#elif defined (_MSC_VER) + ecs_trace("compiled with msvc %d", _MSC_VER); +#endif -int ecs_app_run_frame( - ecs_world_t *world, - const ecs_app_desc_t *desc) -{ - return frame_action(world, desc); -} + ecs_world_t *world = ecs_os_calloc_t(ecs_world_t); + ecs_assert(world != NULL, ECS_OUT_OF_MEMORY, NULL); + ecs_poly_init(world, ecs_world_t); -int ecs_app_set_run_action( - ecs_app_run_action_t callback) -{ - if (run_action != default_run_action) { - ecs_err("run action already set"); - return -1; - } + world->self = world; + world->type_info = flecs_sparse_new(ecs_type_info_t); + ecs_map_init(&world->id_index, ecs_id_record_t*, ECS_HI_COMPONENT_ID); + flecs_observable_init(&world->observable); + world->iterable.init = world_iter_init; - run_action = callback; + world->queries = flecs_sparse_new(ecs_query_t); + world->triggers = flecs_sparse_new(ecs_trigger_t); + world->observers = flecs_sparse_new(ecs_observer_t); + + world->pending_tables = flecs_sparse_new(ecs_table_t*); + world->pending_buffer = flecs_sparse_new(ecs_table_t*); - return 0; -} + world->fini_tasks = ecs_vector_new(ecs_entity_t, 0); + flecs_name_index_init(&world->aliases); + flecs_name_index_init(&world->symbols); + ecs_map_init(&world->type_handles, ecs_entity_t, 0); -int ecs_app_set_frame_action( - ecs_app_frame_action_t callback) -{ - if (frame_action != default_frame_action) { - ecs_err("frame action already set"); - return -1; + world->stats.time_scale = 1.0; + + monitors_init(&world->monitors); + + if (ecs_os_has_time()) { + ecs_os_get_time(&world->world_start_time); } - frame_action = callback; + flecs_stage_init(world, &world->stage); + ecs_set_stages(world, 1); - return 0; -} + ecs_default_lookup_path[0] = EcsFlecsCore; + ecs_set_lookup_path(world, ecs_default_lookup_path); -#endif + init_store(world); + ecs_trace("table store initialized"); + flecs_bootstrap(world); -#ifdef FLECS_RULES + ecs_trace("world ready!"); + ecs_log_pop(); -#include + return world; +} -/** Implementation of the rule query engine. - * - * A rule (terminology borrowed from prolog) is a list of constraints that - * specify which conditions must be met for an entity to match the rule. While - * this description matches any kind of ECS query, the rule engine has features - * that go beyond regular (flecs) ECS queries: - * - * - query for all components of an entity (vs. all entities for a component) - * - query for all relationship pairs of an entity - * - support for query variables that are resolved at evaluation time - * - automatic traversal of transitive relationships - * - * Query terms can have the following forms: - * - * - Component(Subject) - * - Relation(Subject, Object) - * - * Additionally the query parser supports the following shorthand notations: - * - * - Component // short for Component(This) - * - (Relation, Object) // short for Relation(This, Object) - * - * The subject, or first arugment of a term represents the entity on which the - * component or relation is matched. By default the subject is set to a builtin - * This variable, which causes the behavior to match a regular ECS query: - * - * - Position, Velocity - * - * Is equivalent to - * - * - Position(This), Velocity(This) - * - * The function of the variable is to ensure that all components are matched on - * the same entity. Conceptually the query first populates the This variable - * with all entities that have Position. When the query evaluates the Velocity - * term, the variable is populated and the entity it contains will be checked - * for whether it has Velocity. - * - * The actual implementation is more efficient and does not check per-entity. - * - * Custom variables can be used to join parts of different terms. For example, - * the following query can be used to find entities with a parent that has a - * Position component (note that variable names start with a _): - * - * - ChildOf(This, _Parent), Component(_Parent) - * - * The rule engine uses a backtracking algorithm to find the set of entities - * and variables that match all terms. As soon as the engine finds a term that - * does not match with the currently evaluated entity, the entity is discarded. - * When an entity is found for which all terms match, the entity is yielded to - * the iterator. - * - * While a rule is being evaluated, a variable can either contain a single - * entity or a table. The engine will attempt to work with tables as much as - * possible so entities can be eliminated/yielded in bulk. A rule may store - * both the table and entity version of a variable and only switch from table to - * entity when necessary. - * - * The rule engine has an algorithm for computing which variables should be - * resolved first. This algorithm works by finding a "root" variable, which is - * the subject variable that occurs in the term with the least dependencies. The - * remaining variables are then resolved based on their "distance" from the root - * with the closest variables being resolved first. - * - * This generally results in an ordering that resolves the variables with the - * least dependencies first and the most dependencies last, which is beneficial - * for two reasons: - * - * - it improves the average performance of all queries - * - it makes performance less dependent on how an application orders the terms - * - * A possible improvement would be for the query engine to also consider - * the number of tables that need to be evaluated for each term, as starting - * with the smallest term reduces the amount of work. Other than static variable - * analysis however, this can only be determined when the query is executed. - * - * Rules are "compiled" into a set of instructions that encode the operations - * the query needs to perform in order to find the right set of entities. - * Operations can either yield data, which progresses the program, or signal - * that there is no (more) matching data, which discards the current variables. - * - * An operation can yield multiple times, if there are multiple matches for its - * inputs. Operations are called with a redo flag, which can be either true or - * false. When redo is true the operation will yield the next result. When redo - * is false, the operation will reset its state and start from the first result. - * - * Operations can have an input, output and a filter. Most commonly an operation - * either matches the filter against an input and yields if it matches, or uses - * the filter to find all matching results and store the result in the output. - * - * Variables are resolved by matching a filter against the output of an - * operation. When a term contains variables, they are encoded as register ids - * in the filter. When the filter is evaluated, the most recent values of the - * register are used to match/lookup the output. - * - * For example, a filter could be (ChildOf, _Parent). When the program starts, - * the _Parent register is initialized with *, so that when this filter is first - * evaluated, the operation will find all tables with (ChildOf, *). The _Parent - * register is then populated by taking the actual value of the table. If the - * table has type [(ChildOf, Sun)], _Parent will be initialized with Sun. - * - * It is possible that a filter matches multiple times. Consider the filter - * (Likes, _Food), and a table [(Likes, Apples), (Likes, Pears)]. In this case - * an operation will yield the table twice, once with _Food=Apples, and once - * with _Food=Pears. - * - * If a rule contains a term with a transitive relation, it will automatically - * substitute the parts of the term to find a fact that matches. The following - * examples illustrate how transitivity is resolved: - * - * Query: - * LocatedIn(Bob, SanFrancisco) - * - * Expands to: - * LocatedIn(Bob, SanFrancisco:self|subset) - * - * Explanation: - * "Is Bob located in San Francisco" - This term is true if Bob is either - * located in San Francisco, or is located in anything that is itself located - * in (a subset of) San Francisco. - * - * - * Query: - * LocatedIn(Bob, X) - * - * Expands to: - * LocatedIn(Bob, X:self|superset) - * - * Explanation: - * "Where is Bob located?" - This term recursively returns all places that - * Bob is located in, which includes his location and the supersets of his - * location. When Bob is located in San Francisco, he is also located in - * the United States, North America etc. - * - * - * Query: - * LocatedIn(X, NorthAmerica) - * - * Expands to: - * LocatedIn(X, NorthAmerica:self|subset) - * - * Explanation: - * "What is located in North America?" - This term returns everything located - * in North America and its subsets, as something located in San Francisco is - * located in UnitedStates, which is located in NorthAmerica. - * - * - * Query: - * LocatedIn(X, Y) - * - * Expands to: - * LocatedIn(X, Y) - * - * Explanation: - * "Where is everything located" - This term returns everything that is - * located somewhere. No substitution is performed as this would explode the - * results while not yielding new information. - * - * - * In the above terms, the variable indicates the part of the term that is - * unknown at evaluation time. In an actual rule the picked strategy depends on - * whether the variable is known when the term is evaluated. For example, if - * variable X has been resolved by the time Located(X, Y) is evaluated, the - * strategy from the LocatedIn(Bob, X) example will be used. - */ +ecs_world_t *ecs_init(void) { + ecs_world_t *world = ecs_mini(); + +#ifdef FLECS_MODULE_H + ecs_trace("#[bold]import addons"); + ecs_log_push(); + ecs_trace("use ecs_mini to create world without importing addons"); +#ifdef FLECS_SYSTEM + ECS_IMPORT(world, FlecsSystem); +#endif +#ifdef FLECS_PIPELINE + ECS_IMPORT(world, FlecsPipeline); +#endif +#ifdef FLECS_TIMER + ECS_IMPORT(world, FlecsTimer); +#endif +#ifdef FLECS_META + ECS_IMPORT(world, FlecsMeta); +#endif +#ifdef FLECS_DOC + ECS_IMPORT(world, FlecsDoc); +#endif +#ifdef FLECS_COREDOC + ECS_IMPORT(world, FlecsCoreDoc); +#endif +#ifdef FLECS_REST + ECS_IMPORT(world, FlecsRest); +#endif +#ifdef FLECS_UNITS + ecs_trace("#[green]module#[reset] flecs.units is not automatically imported"); +#endif + ecs_trace("addons imported!"); + ecs_log_pop(); +#endif + return world; +} + +#define ARG(short, long, action)\ + if (i < argc) {\ + if (argv[i][0] == '-') {\ + if (argv[i][1] == '-') {\ + if (long && !strcmp(&argv[i][2], long ? long : "")) {\ + action;\ + parsed = true;\ + }\ + } else {\ + if (short && argv[i][1] == short) {\ + action;\ + parsed = true;\ + }\ + }\ + }\ + } -#define ECS_RULE_MAX_VAR_COUNT (32) +ecs_world_t* ecs_init_w_args( + int argc, + char *argv[]) +{ + ecs_world_t *world = ecs_init(); -#define RULE_PAIR_PREDICATE (1) -#define RULE_PAIR_OBJECT (2) + (void)argc; + (void) argv; -/* A rule pair contains a predicate and object that can be stored in a register. */ -typedef struct ecs_rule_pair_t { - union { - int32_t reg; - ecs_entity_t ent; - } pred; - union { - int32_t reg; - ecs_entity_t ent; - } obj; - int32_t reg_mask; /* bit 1 = predicate, bit 2 = object */ +#ifdef FLECS_DOC + if (argc) { + char *app = argv[0]; + char *last_elem = strrchr(app, '/'); + if (!last_elem) { + last_elem = strrchr(app, '\\'); + } + if (last_elem) { + app = last_elem + 1; + } + ecs_set_pair(world, EcsWorld, EcsDocDescription, EcsName, {app}); + } +#endif - bool transitive; /* Is predicate transitive */ - bool final; /* Is predicate final */ - bool reflexive; /* Is predicate reflexive */ - bool acyclic; /* Is predicate acyclic */ - bool obj_0; -} ecs_rule_pair_t; + return world; +} -/* Filter for evaluating & reifing types and variables. Filters are created ad- - * hoc from pairs, and take into account all variables that had been resolved - * up to that point. */ -typedef struct ecs_rule_filter_t { - ecs_id_t mask; /* Mask with wildcard in place of variables */ +void ecs_quit( + ecs_world_t *world) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + flecs_stage_from_world(&world); + world->should_quit = true; +error: + return; +} - bool wildcard; /* Does the filter contain wildcards */ - bool pred_wildcard; /* Is predicate a wildcard */ - bool obj_wildcard; /* Is object a wildcard */ - bool same_var; /* True if pred & obj are both the same variable */ +bool ecs_should_quit( + const ecs_world_t *world) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + world = ecs_get_world(world); + return world->should_quit; +error: + return true; +} - int32_t hi_var; /* If hi part should be stored in var, this is the var id */ - int32_t lo_var; /* If lo part should be stored in var, this is the var id */ -} ecs_rule_filter_t; +void flecs_notify_tables( + ecs_world_t *world, + ecs_id_t id, + ecs_table_event_t *event) +{ + ecs_poly_assert(world, ecs_world_t); -/* A rule register stores temporary values for rule variables */ -typedef enum ecs_rule_var_kind_t { - EcsRuleVarKindTable, /* Used for sorting, must be smallest */ - EcsRuleVarKindEntity, - EcsRuleVarKindUnknown -} ecs_rule_var_kind_t; + /* If no id is specified, broadcast to all tables */ + if (!id) { + ecs_sparse_t *tables = &world->store.tables; + int32_t i, count = flecs_sparse_count(tables); + for (i = 0; i < count; i ++) { + ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); + flecs_table_notify(world, table, event); + } -typedef struct ecs_table_slice_t { - ecs_table_t *table; - int32_t offset; - int32_t count; -} ecs_table_slice_t; + /* If id is specified, only broadcast to tables with id */ + } else { + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return; + } -typedef struct ecs_rule_reg_t { - /* Used for table variable */ - ecs_table_slice_t table; + ecs_table_cache_iter_t it; + const ecs_table_record_t *tr; - /* Used for entity variable. May also be set for table variable if it needs - * to store an empty entity. */ - ecs_entity_t entity; -} ecs_rule_reg_t; - -/* Operations describe how the rule should be evaluated */ -typedef enum ecs_rule_op_kind_t { - EcsRuleInput, /* Input placeholder, first instruction in every rule */ - EcsRuleSelect, /* Selects all ables for a given predicate */ - EcsRuleWith, /* Applies a filter to a table or entity */ - EcsRuleSubSet, /* Finds all subsets for transitive relationship */ - EcsRuleSuperSet, /* Finds all supersets for a transitive relationship */ - EcsRuleStore, /* Store entity in table or entity variable */ - EcsRuleEach, /* Forwards each entity in a table */ - EcsRuleSetJmp, /* Set label for jump operation to one of two values */ - EcsRuleJump, /* Jump to an operation label */ - EcsRuleNot, /* Invert result of an operation */ - EcsRuleInTable, /* Test if entity (subject) is in table (r_in) */ - EcsRuleEq, /* Test if entity in (subject) and (r_in) are equal */ - EcsRuleYield /* Yield result */ -} ecs_rule_op_kind_t; + flecs_table_cache_iter(&idr->cache, &it); + while ((tr = flecs_table_cache_next(&it, ecs_table_record_t))) { + flecs_table_notify(world, tr->hdr.table, event); + } -/* Single operation */ -typedef struct ecs_rule_op_t { - ecs_rule_op_kind_t kind; /* What kind of operation is it */ - ecs_rule_pair_t filter; /* Parameter that contains optional filter */ - ecs_entity_t subject; /* If set, operation has a constant subject */ + flecs_table_cache_empty_iter(&idr->cache, &it); + while ((tr = flecs_table_cache_next(&it, ecs_table_record_t))) { + flecs_table_notify(world, tr->hdr.table, event); + } + } +} - int32_t on_pass; /* Jump location when match succeeds */ - int32_t on_fail; /* Jump location when match fails */ - int32_t frame; /* Register frame */ +void ecs_default_ctor( + ecs_world_t *world, + const ecs_entity_t *entity_ptr, + void *ptr, + int32_t count, + const ecs_type_info_t *ti) +{ + (void)world; (void)entity_ptr; + ecs_os_memset(ptr, 0, ti->size * count); +} - int32_t term; /* Corresponding term index in signature */ - int32_t r_in; /* Optional In/Out registers */ - int32_t r_out; +static +void default_copy_ctor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, const void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->ctor(world, dst_entity, dst_ptr, count, ti); + cl->copy(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); +} - bool has_in, has_out; /* Keep track of whether operation uses input - * and/or output registers. This helps with - * debugging rule programs. */ -} ecs_rule_op_t; +static +void default_move_ctor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->ctor(world, dst_entity, dst_ptr, count, ti); + cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); +} -/* With context. Shared with select. */ -typedef struct ecs_rule_with_ctx_t { - ecs_id_record_t *idr; /* Currently evaluated table set */ - ecs_table_cache_iter_t it; - int32_t column; -} ecs_rule_with_ctx_t; +static +void default_ctor_w_move_w_dtor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->ctor(world, dst_entity, dst_ptr, count, ti); + cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); + cl->dtor(world, src_entity, src_ptr, count, ti); +} -/* Subset context */ -typedef struct ecs_rule_subset_frame_t { - ecs_rule_with_ctx_t with_ctx; - ecs_table_t *table; - int32_t row; - int32_t column; -} ecs_rule_subset_frame_t; +static +void default_move_ctor_w_dtor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->move_ctor(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); + cl->dtor(world, src_entity, src_ptr, count, ti); +} -typedef struct ecs_rule_subset_ctx_t { - ecs_rule_subset_frame_t storage[16]; /* Alloc-free array for small trees */ - ecs_rule_subset_frame_t *stack; - int32_t sp; -} ecs_rule_subset_ctx_t; +static +void default_move( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); +} -/* Superset context */ -typedef struct ecs_rule_superset_frame_t { - ecs_table_t *table; - int32_t column; -} ecs_rule_superset_frame_t; +static +void default_dtor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + (void)src_entity; -typedef struct ecs_rule_superset_ctx_t { - ecs_rule_superset_frame_t storage[16]; /* Alloc-free array for small trees */ - ecs_rule_superset_frame_t *stack; - ecs_id_record_t *idr; - int32_t sp; -} ecs_rule_superset_ctx_t; + /* When there is no move, destruct the destination component & memcpy the + * component to dst. The src component does not have to be destructed when + * a component has a trivial move. */ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->dtor(world, dst_entity, dst_ptr, count, ti); + ecs_os_memcpy(dst_ptr, src_ptr, flecs_uto(ecs_size_t, ti->size) * count); +} -/* Each context */ -typedef struct ecs_rule_each_ctx_t { - int32_t row; /* Currently evaluated row in evaluated table */ -} ecs_rule_each_ctx_t; +static +void default_move_w_dtor( + ecs_world_t *world, const ecs_entity_t *dst_entity, + const ecs_entity_t *src_entity, void *dst_ptr, void *src_ptr, + int32_t count, const ecs_type_info_t *ti) +{ + /* If a component has a move, the move will take care of memcpying the data + * and destroying any data in dst. Because this is not a trivial move, the + * src component must also be destructed. */ + const EcsComponentLifecycle *cl = &ti->lifecycle; + cl->move(world, dst_entity, src_entity, dst_ptr, src_ptr, count, ti); + cl->dtor(world, src_entity, src_ptr, count, ti); +} -/* Jump context */ -typedef struct ecs_rule_setjmp_ctx_t { - int32_t label; /* Operation label to jump to */ -} ecs_rule_setjmp_ctx_t; +void ecs_set_component_actions_w_id( + ecs_world_t *world, + ecs_entity_t component, + EcsComponentLifecycle *lifecycle) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + flecs_stage_from_world(&world); -/* Operation context. This is a per-operation, per-iterator structure that - * stores information for stateful operations. */ -typedef struct ecs_rule_op_ctx_t { - union { - ecs_rule_subset_ctx_t subset; - ecs_rule_superset_ctx_t superset; - ecs_rule_with_ctx_t with; - ecs_rule_each_ctx_t each; - ecs_rule_setjmp_ctx_t setjmp; - } is; -} ecs_rule_op_ctx_t; + ecs_type_info_t *ti = flecs_ensure_type_info(world, component); + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); -/* Rule variables allow for the rule to be parameterized */ -typedef struct ecs_rule_var_t { - ecs_rule_var_kind_t kind; - char *name; /* Variable name */ - int32_t id; /* Unique variable id */ - int32_t other; /* Id to table variable (-1 if none exists) */ - int32_t occurs; /* Number of occurrences (used for operation ordering) */ - int32_t depth; /* Depth in dependency tree (used for operation ordering) */ - bool marked; /* Used for cycle detection */ -} ecs_rule_var_t; + ecs_size_t size = ti->size; + ecs_size_t alignment = ti->alignment; -/* Variable ids per term */ -typedef struct ecs_rule_term_vars_t { - int32_t pred; - int32_t subj; - int32_t obj; -} ecs_rule_term_vars_t; + if (!size) { + const EcsComponent *component_ptr = ecs_get( + world, component, EcsComponent); -/* Top-level rule datastructure */ -struct ecs_rule_t { - ecs_header_t hdr; + /* Cannot register lifecycle actions for things that aren't a component */ + ecs_check(component_ptr != NULL, ECS_INVALID_PARAMETER, NULL); + /* Cannot register lifecycle actions for components with size 0 */ + ecs_check(component_ptr->size != 0, ECS_INVALID_PARAMETER, NULL); + + size = component_ptr->size; + alignment = component_ptr->alignment; + } + + if (ti->lifecycle_set) { + ecs_assert(ti->component == component, ECS_INTERNAL_ERROR, NULL); + ecs_check(!lifecycle->ctor || ti->lifecycle.ctor == lifecycle->ctor, + ECS_INCONSISTENT_COMPONENT_ACTION, NULL); + ecs_check(!lifecycle->dtor || ti->lifecycle.dtor == lifecycle->dtor, + ECS_INCONSISTENT_COMPONENT_ACTION, NULL); + ecs_check(!lifecycle->copy || ti->lifecycle.copy == lifecycle->copy, + ECS_INCONSISTENT_COMPONENT_ACTION, NULL); + ecs_check(!lifecycle->move || ti->lifecycle.move == lifecycle->move, + ECS_INCONSISTENT_COMPONENT_ACTION, NULL); + + if (!ti->lifecycle.on_set) { + ti->lifecycle.on_set = lifecycle->on_set; + } + if (!ti->lifecycle.on_remove) { + ti->lifecycle.on_remove = lifecycle->on_remove; + } + } else { + ti->component = component; + ti->lifecycle = *lifecycle; + ti->lifecycle_set = true; + ti->size = size; + ti->alignment = alignment; + + /* If no constructor is set, invoking any of the other lifecycle actions + * is not safe as they will potentially access uninitialized memory. For + * ease of use, if no constructor is specified, set a default one that + * initializes the component to 0. */ + if (!lifecycle->ctor && + (lifecycle->dtor || lifecycle->copy || lifecycle->move)) + { + ti->lifecycle.ctor = ecs_default_ctor; + } + + /* Set default copy ctor, move ctor and merge */ + if (lifecycle->copy && !lifecycle->copy_ctor) { + ti->lifecycle.copy_ctor = default_copy_ctor; + } + + if (lifecycle->move && !lifecycle->move_ctor) { + ti->lifecycle.move_ctor = default_move_ctor; + } + + if (!lifecycle->ctor_move_dtor) { + if (lifecycle->move) { + if (lifecycle->dtor) { + if (lifecycle->move_ctor) { + /* If an explicit move ctor has been set, use callback + * that uses the move ctor vs. using a ctor+move */ + ti->lifecycle.ctor_move_dtor = + default_move_ctor_w_dtor; + } else { + /* If no explicit move_ctor has been set, use + * combination of ctor + move + dtor */ + ti->lifecycle.ctor_move_dtor = + default_ctor_w_move_w_dtor; + } + } else { + /* If no dtor has been set, this is just a move ctor */ + ti->lifecycle.ctor_move_dtor = + ti->lifecycle.move_ctor; + } + } + } + + if (!lifecycle->move_dtor) { + if (lifecycle->move) { + if (lifecycle->dtor) { + ti->lifecycle.move_dtor = default_move_w_dtor; + } else { + ti->lifecycle.move_dtor = default_move; + } + } else { + if (lifecycle->dtor) { + ti->lifecycle.move_dtor = default_dtor; + } + } + } + + /* Ensure that no tables have yet been created for the component */ + ecs_assert( flecs_id_existst(world, component) == false, + ECS_ALREADY_IN_USE, ecs_get_name(world, component)); + ecs_assert( flecs_id_existst(world, + ecs_pair(component, EcsWildcard)) == false, + ECS_ALREADY_IN_USE, ecs_get_name(world, component)); + } +error: + return; +} + +bool ecs_component_has_actions( + const ecs_world_t *world, + ecs_entity_t component) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(component != 0, ECS_INVALID_PARAMETER, NULL); - ecs_world_t *world; /* Ref to world so rule can be used by itself */ - ecs_rule_op_t *operations; /* Operations array */ - ecs_filter_t filter; /* Filter of rule */ + world = ecs_get_world(world); + const ecs_type_info_t *ti = flecs_get_type_info(world, component); + return (ti != NULL) && ti->lifecycle_set; +error: + return false; +} - /* Passed to iterator */ - char *var_names[ECS_RULE_MAX_VAR_COUNT]; +void ecs_atfini( + ecs_world_t *world, + ecs_fini_action_t action, + void *ctx) +{ + ecs_poly_assert(world, ecs_world_t); + ecs_check(action != NULL, ECS_INVALID_PARAMETER, NULL); - /* Variable ids used in terms */ - ecs_rule_term_vars_t term_vars[ECS_RULE_MAX_VAR_COUNT]; + ecs_action_elem_t *elem = ecs_vector_add(&world->fini_actions, + ecs_action_elem_t); + ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); - /* Variable array */ - ecs_rule_var_t vars[ECS_RULE_MAX_VAR_COUNT]; + elem->action = action; + elem->ctx = ctx; +error: + return; +} - int32_t var_count; /* Number of variables in signature */ - int32_t subj_var_count; - int32_t frame_count; /* Number of register frames */ - int32_t operation_count; /* Number of operations in rule */ +void ecs_run_post_frame( + ecs_world_t *world, + ecs_fini_action_t action, + void *ctx) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(action != NULL, ECS_INVALID_PARAMETER, NULL); + + ecs_stage_t *stage = flecs_stage_from_world(&world); + ecs_action_elem_t *elem = ecs_vector_add(&stage->post_frame_actions, + ecs_action_elem_t); + ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_iterable_t iterable; /* Iterable mixin */ -}; + elem->action = action; + elem->ctx = ctx; +error: + return; +} -/* ecs_rule_t mixins */ -ecs_mixins_t ecs_rule_t_mixins = { - .type_name = "ecs_rule_t", - .elems = { - [EcsMixinWorld] = offsetof(ecs_rule_t, world), - [EcsMixinIterable] = offsetof(ecs_rule_t, iterable) +/* Unset data in tables */ +static +void fini_unset_tables( + ecs_world_t *world) +{ + ecs_sparse_t *tables = &world->store.tables; + int32_t i, count = flecs_sparse_count(tables); + + for (i = 0; i < count; i ++) { + ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); + flecs_table_remove_actions(world, table); } -}; +} + +/* Invoke fini actions */ +static +void fini_actions( + ecs_world_t *world) +{ + ecs_vector_each(world->fini_actions, ecs_action_elem_t, elem, { + elem->action(world, elem->ctx); + }); + + ecs_vector_free(world->fini_actions); +} +/* Cleanup component lifecycle callbacks & systems */ static -void rule_error( - const ecs_rule_t *rule, - const char *fmt, - ...) +void fini_component_lifecycle( + ecs_world_t *world) { - va_list valist; - va_start(valist, fmt); - ecs_parser_errorv(rule->filter.name, rule->filter.expr, -1, fmt, valist); - va_end(valist); + flecs_sparse_free(world->type_info); } +/* Cleanup queries */ static -bool subj_is_set( - ecs_term_t *term) +void fini_queries( + ecs_world_t *world) { - return ecs_term_id_is_set(&term->subj); + monitors_fini(&world->monitors); + + int32_t i, count = flecs_sparse_count(world->queries); + for (i = 0; i < count; i ++) { + ecs_query_t *query = flecs_sparse_get_dense(world->queries, ecs_query_t, 0); + ecs_query_fini(query); + } + flecs_sparse_free(world->queries); } static -bool obj_is_set( - ecs_term_t *term) +void fini_observers( + ecs_world_t *world) { - return ecs_term_id_is_set(&term->obj) || term->role == ECS_PAIR; + flecs_sparse_free(world->observers); } +/* Cleanup stages */ static -ecs_rule_op_t* create_operation( - ecs_rule_t *rule) +void fini_stages( + ecs_world_t *world) { - int32_t cur = rule->operation_count ++; - rule->operations = ecs_os_realloc( - rule->operations, (cur + 1) * ECS_SIZEOF(ecs_rule_op_t)); - - ecs_rule_op_t *result = &rule->operations[cur]; - ecs_os_memset_t(result, 0, ecs_rule_op_t); - - return result; + flecs_stage_deinit(world, &world->stage); + ecs_set_stages(world, 0); } static -const char* get_var_name(const char *name) { - if (name && !ecs_os_strcmp(name, "This")) { - /* Make sure that both This and . resolve to the same variable */ - name = "."; +ecs_id_record_t* new_id_record( + ecs_world_t *world, + ecs_id_t id) +{ + ecs_id_record_t *idr = ecs_os_calloc_t(ecs_id_record_t); + ecs_table_cache_init(&idr->cache); + + ecs_entity_t rel = 0, obj = 0; + if (ECS_HAS_ROLE(id, PAIR)) { + rel = ecs_pair_first(world, id); + ecs_assert(rel != 0, ECS_INTERNAL_ERROR, NULL); + + /* Relation object can be 0, as tables without a ChildOf relation are + * added to the (ChildOf, 0) id record */ + obj = ECS_PAIR_SECOND(id); + if (obj) { + obj = ecs_get_alive(world, obj); + ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); + } + + /* If id is a pair, inherit flags from relation id record */ + ecs_id_record_t *idr_r = flecs_get_id_record( + world, ECS_PAIR_FIRST(id)); + if (idr_r) { + idr->flags = idr_r->flags; + } + } else { + rel = id & ECS_COMPONENT_MASK; + rel = ecs_get_alive(world, rel); + ecs_assert(rel != 0, ECS_INTERNAL_ERROR, NULL); } - return name; + /* Mark entities that are used as component/pair ids. When a tracked + * entity is deleted, cleanup policies are applied so that the store + * won't contain any tables with deleted ids. */ + + /* Flag for OnDelete policies */ + flecs_add_flag(world, rel, ECS_FLAG_OBSERVED_ID); + if (obj) { + /* Flag for OnDeleteObject policies */ + flecs_add_flag(world, obj, ECS_FLAG_OBSERVED_OBJECT); + if (ecs_has_id(world, rel, EcsAcyclic)) { + /* Flag used to determine if object should be traversed when + * propagating events or with super/subset queries */ + flecs_add_flag(world, obj, ECS_FLAG_OBSERVED_ACYCLIC); + } + } + + if (ecs_should_log_1()) { + char *id_str = ecs_id_str(world, id); + ecs_dbg_1("#[green]id#[normal] %s #[green]created", id_str); + ecs_os_free(id_str); + } + + return idr; } + +/* Cleanup id index */ static -ecs_rule_var_t* create_variable( - ecs_rule_t *rule, - ecs_rule_var_kind_t kind, - const char *name) +bool free_id_record( + ecs_world_t *world, + ecs_id_t id, + ecs_id_record_t *idr) { - int32_t cur = ++ rule->var_count; - - name = get_var_name(name); - if (name && !ecs_os_strcmp(name, "*")) { - /* Wildcards are treated as anonymous variables */ - name = NULL; + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(id != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_poly_assert(world, ecs_world_t); + (void)id; + + /* Force the empty table administration to be consistent if the non-empty + * list of the id record has elements */ + if (ecs_table_cache_count(&idr->cache)) { + ecs_force_aperiodic(world); } - ecs_rule_var_t *var = &rule->vars[cur - 1]; - if (name) { - var->name = ecs_os_strdup(name); - } else { - /* Anonymous register */ - char name_buff[32]; - ecs_os_sprintf(name_buff, "_%u", cur - 1); - var->name = ecs_os_strdup(name_buff); + /* If there are still tables in the non-empty list they're really not empty. + * We can't free the record yet. */ + if (ecs_table_cache_count(&idr->cache)) { + return false; } - var->kind = kind; + /* If id record contains no more empty tables, free it */ + if (ecs_table_cache_empty_count(&idr->cache) == 0) { + if (ecs_should_log_1()) { + char *id_str = ecs_id_str(world, id); + ecs_dbg_1("#[green]id#[normal] %s #[red]deleted", id_str); + ecs_os_free(id_str); + } - /* The variable id is the location in the variable array and also points to - * the register element that corresponds with the variable. */ - var->id = cur - 1; + ecs_table_cache_fini(&idr->cache); + flecs_name_index_free(idr->name_index); + ecs_os_free(idr); + return true; + } - /* Depth is used to calculate how far the variable is from the root, where - * the root is the variable with 0 dependencies. */ - var->depth = UINT8_MAX; - var->marked = false; - var->occurs = 0; + /* Delete empty tables */ + ecs_table_cache_iter_t cache_it; + flecs_table_cache_empty_iter(&idr->cache, &cache_it); - return var; + const ecs_table_record_t *tr; + while ((tr = flecs_table_cache_next(&cache_it, ecs_table_record_t))) { + if (!flecs_table_release(world, tr->hdr.table)) { + /* Releasing the table did not free it, which means that something + * is keeping the table alive. Cleanup of the id record will happen + * when the last reference(s) to the table are released */ + return false; + } + } + + /* If all tables were deleted for this id record, the last deleted table + * should have removed the record from the world. */ + ecs_assert(flecs_get_id_record(world, id) == NULL, + ECS_INTERNAL_ERROR, NULL); + + return true; } static -ecs_rule_var_t* create_anonymous_variable( - ecs_rule_t *rule, - ecs_rule_var_kind_t kind) +void fini_id_index( + ecs_world_t *world) { - return create_variable(rule, kind, NULL); + ecs_map_iter_t it = ecs_map_iter(&world->id_index); + ecs_id_record_t *idr; + ecs_map_key_t key; + while ((idr = ecs_map_next_ptr(&it, ecs_id_record_t*, &key))) { + free_id_record(world, key, idr); + } + + ecs_map_fini(&world->id_index); + flecs_sparse_free(world->pending_tables); + flecs_sparse_free(world->pending_buffer); } -/* Find variable with specified name and type. If Unknown is provided as type, - * the function will return any variable with the provided name. The root - * variable can occur both as a table and entity variable, as some rules - * require that each entity in a table is iterated. In this case, there are two - * variables, one for the table and one for the entities in the table, that both - * have the same name. */ +/* Cleanup misc structures */ static -ecs_rule_var_t* find_variable( - const ecs_rule_t *rule, - ecs_rule_var_kind_t kind, - const char *name) +void fini_misc( + ecs_world_t *world) { - ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(name != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_map_fini(&world->type_handles); + ecs_vector_free(world->fini_tasks); +} - name = get_var_name(name); +/* The destroyer of worlds */ +int ecs_fini( + ecs_world_t *world) +{ + ecs_poly_assert(world, ecs_world_t); + ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); + ecs_assert(!world->is_fini, ECS_INVALID_OPERATION, NULL); - const ecs_rule_var_t *variables = rule->vars; - int32_t i, count = rule->var_count; + ecs_trace("#[bold]shutting down world"); + ecs_log_push(); + + world->is_fini = true; + + /* Operations invoked during UnSet/OnRemove/destructors are deferred and + * will be discarded after world cleanup */ + ecs_defer_begin(world); + + /* Run UnSet/OnRemove actions for components while the store is still + * unmodified by cleanup. */ + fini_unset_tables(world); - for (i = 0; i < count; i ++) { - const ecs_rule_var_t *variable = &variables[i]; - if (!ecs_os_strcmp(name, variable->name)) { - if (kind == EcsRuleVarKindUnknown || kind == variable->kind) { - return (ecs_rule_var_t*)variable; - } - } + /* Run fini actions (simple callbacks ran when world is deleted) before + * destroying the storage */ + fini_actions(world); + + /* This will destroy all entities and components. After this point no more + * user code is executed. */ + fini_store(world); + + /* Purge deferred operations from the queue. This discards operations but + * makes sure that any resources in the queue are freed */ + flecs_defer_purge(world, &world->stage); + + /* Entity index is kept alive until this point so that user code can do + * validity checks on entity ids, even though after store cleanup the index + * will be empty, so all entity ids are invalid. */ + flecs_sparse_fini(&world->store.entity_index); + + if (world->locking_enabled) { + ecs_os_mutex_free(world->mutex); } - return NULL; + ecs_trace("table store deinitialized"); + + fini_stages(world); + + fini_component_lifecycle(world); + + fini_queries(world); + + fini_observers(world); + + fini_id_index(world); + + flecs_observable_fini(&world->observable); + + flecs_sparse_free(world->triggers); + + flecs_name_index_fini(&world->aliases); + flecs_name_index_fini(&world->symbols); + + fini_misc(world); + + ecs_os_enable_high_timer_resolution(false); + + /* End of the world */ + ecs_poly_free(world, ecs_world_t); + + ecs_os_fini(); + + ecs_trace("world destroyed, bye!"); + ecs_log_pop(); + + return 0; } -/* Ensure variable with specified name and type exists. If an existing variable - * is found with an unknown type, its type will be overwritten with the - * specified type. During the variable ordering phase it is not yet clear which - * variable is the root. Which variable is the root determines its type, which - * is why during this phase variables are still untyped. */ -static -ecs_rule_var_t* ensure_variable( - ecs_rule_t *rule, - ecs_rule_var_kind_t kind, - const char *name) +bool ecs_is_fini( + const ecs_world_t *world) { - ecs_rule_var_t *var = find_variable(rule, kind, name); - if (!var) { - var = create_variable(rule, kind, name); - } else { - if (var->kind == EcsRuleVarKindUnknown) { - var->kind = kind; - } - } + ecs_assert(world != NULL, ECS_INVALID_PARAMETER, NULL); + world = ecs_get_world(world); + return world->is_fini; +} - return var; +void ecs_dim( + ecs_world_t *world, + int32_t entity_count) +{ + ecs_poly_assert(world, ecs_world_t); + ecs_eis_set_size(world, entity_count + ECS_HI_COMPONENT_ID); } -static -const char *term_id_var_name( - ecs_term_id_t *term_id) +void flecs_eval_component_monitors( + ecs_world_t *world) { - if (term_id->var == EcsVarIsVariable) { - if (term_id->name) { - return term_id->name; - } else if (term_id->entity == EcsThis) { - return "."; - } else if (term_id->entity == EcsWildcard) { - return "*"; - } else if (term_id->entity == EcsAny) { - return "_"; - } else { - ecs_check(term_id->name != NULL, ECS_INVALID_PARAMETER, NULL); - } - } - -error: - return NULL; + ecs_poly_assert(world, ecs_world_t); + flecs_process_pending_tables(world); + eval_component_monitor(world); } -static -ecs_rule_var_t* ensure_term_id_variable( - ecs_rule_t *rule, - ecs_term_id_t *term_id) +void ecs_measure_frame_time( + ecs_world_t *world, + bool enable) { - if (term_id->var == EcsVarIsVariable) { - if (term_id->entity == EcsAny) { - /* Any variables aren't translated to rule variables since their - * result isn't stored. */ - return NULL; - } + ecs_poly_assert(world, ecs_world_t); + ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); - const char *name = term_id_var_name(term_id); - ecs_rule_var_t *var = ensure_variable(rule, EcsRuleVarKindEntity, name); - ecs_os_strset(&term_id->name, var->name); - return var; + if (world->stats.target_fps == 0.0f || enable) { + world->measure_frame_time = enable; } - return NULL; +error: + return; } -static -bool term_id_is_variable( - ecs_term_id_t *term_id) +void ecs_measure_system_time( + ecs_world_t *world, + bool enable) { - return term_id->var == EcsVarIsVariable; + ecs_poly_assert(world, ecs_world_t); + ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); + world->measure_system_time = enable; +error: + return; } -/* Get variable from a term identifier */ -static -ecs_rule_var_t* term_id_to_var( - ecs_rule_t *rule, - ecs_term_id_t *id) +void ecs_set_target_fps( + ecs_world_t *world, + FLECS_FLOAT fps) { - if (id->var == EcsVarIsVariable) {; - return find_variable(rule, EcsRuleVarKindUnknown, term_id_var_name(id)); - } - return NULL; + ecs_poly_assert(world, ecs_world_t); + ecs_check(ecs_os_has_time(), ECS_MISSING_OS_API, NULL); + + ecs_measure_frame_time(world, true); + world->stats.target_fps = fps; + ecs_os_enable_high_timer_resolution(fps >= 60.0f); +error: + return; } -/* Get variable from a term predicate */ -static -ecs_rule_var_t* term_pred( - ecs_rule_t *rule, - ecs_term_t *term) +void* ecs_get_context( + const ecs_world_t *world) { - return term_id_to_var(rule, &term->pred); + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + world = ecs_get_world(world); + return world->context; +error: + return NULL; } -/* Get variable from a term subject */ -static -ecs_rule_var_t* term_subj( - ecs_rule_t *rule, - ecs_term_t *term) +void ecs_set_context( + ecs_world_t *world, + void *context) { - return term_id_to_var(rule, &term->subj); + ecs_poly_assert(world, ecs_world_t); + world->context = context; } -/* Get variable from a term object */ -static -ecs_rule_var_t* term_obj( - ecs_rule_t *rule, - ecs_term_t *term) +void ecs_set_entity_range( + ecs_world_t *world, + ecs_entity_t id_start, + ecs_entity_t id_end) { - if (obj_is_set(term)) { - return term_id_to_var(rule, &term->obj); - } else { - return NULL; + ecs_poly_assert(world, ecs_world_t); + ecs_check(!id_end || id_end > id_start, ECS_INVALID_PARAMETER, NULL); + ecs_check(!id_end || id_end > world->stats.last_id, + ECS_INVALID_PARAMETER, NULL); + + if (world->stats.last_id < id_start) { + world->stats.last_id = id_start - 1; } + + world->stats.min_id = id_start; + world->stats.max_id = id_end; +error: + return; } -/* Return predicate variable from pair */ -static -ecs_rule_var_t* pair_pred( - ecs_rule_t *rule, - const ecs_rule_pair_t *pair) +bool ecs_enable_range_check( + ecs_world_t *world, + bool enable) { - if (pair->reg_mask & RULE_PAIR_PREDICATE) { - return &rule->vars[pair->pred.reg]; - } else { - return NULL; - } + ecs_poly_assert(world, ecs_world_t); + bool old_value = world->range_check_enabled; + world->range_check_enabled = enable; + return old_value; } -/* Return object variable from pair */ -static -ecs_rule_var_t* pair_obj( - ecs_rule_t *rule, - const ecs_rule_pair_t *pair) +void ecs_set_entity_generation( + ecs_world_t *world, + ecs_entity_t entity_with_generation) { - if (pair->reg_mask & RULE_PAIR_OBJECT) { - return &rule->vars[pair->obj.reg]; - } else { - return NULL; - } + flecs_sparse_set_generation( + &world->store.entity_index, entity_with_generation); } -/* Create new frame for storing register values. Each operation that yields data - * gets its own register frame, which contains all variables reified up to that - * point. The preceding frame always contains the reified variables from the - * previous operation. Operations that do not yield data (such as control flow) - * do not have their own frames. */ -static -int32_t push_frame( - ecs_rule_t *rule) +int32_t ecs_get_threads( + ecs_world_t *world) { - return rule->frame_count ++; + return ecs_vector_count(world->worker_stages); } -/* Get register array for current stack frame. The stack frame is determined by - * the current operation that is evaluated. The register array contains the - * values for the reified variables. If a variable hasn't been reified yet, its - * register will store a wildcard. */ -static -ecs_rule_reg_t* get_register_frame( - const ecs_rule_iter_t *it, - int32_t frame) +bool ecs_enable_locking( + ecs_world_t *world, + bool enable) { - if (it->registers) { - return &it->registers[frame * it->rule->var_count]; + ecs_poly_assert(world, ecs_world_t); + + if (enable) { + if (!world->locking_enabled) { + world->mutex = ecs_os_mutex_new(); + world->thr_sync = ecs_os_mutex_new(); + world->thr_cond = ecs_os_cond_new(); + } } else { - return NULL; + if (world->locking_enabled) { + ecs_os_mutex_free(world->mutex); + ecs_os_mutex_free(world->thr_sync); + ecs_os_cond_free(world->thr_cond); + } } + + bool old = world->locking_enabled; + world->locking_enabled = enable; + return old; } -/* Get register array for current stack frame. The stack frame is determined by - * the current operation that is evaluated. The register array contains the - * values for the reified variables. If a variable hasn't been reified yet, its - * register will store a wildcard. */ -static -ecs_rule_reg_t* get_registers( - const ecs_rule_iter_t *it, - ecs_rule_op_t *op) +void ecs_lock( + ecs_world_t *world) { - return get_register_frame(it, op->frame); + ecs_poly_assert(world, ecs_world_t); + ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); + ecs_os_mutex_lock(world->mutex); } -/* Get columns array. Columns store, for each matched column in a table, the - * index at which it occurs. This reduces the amount of searching that - * operations need to do in a type, since select/with already provide it. */ -static -int32_t* rule_get_columns_frame( - ecs_rule_iter_t *it, - int32_t frame) +void ecs_unlock( + ecs_world_t *world) { - return &it->columns[frame * it->rule->filter.term_count]; + ecs_poly_assert(world, ecs_world_t); + ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); + ecs_os_mutex_unlock(world->mutex); } -static -int32_t* rule_get_columns( - ecs_rule_iter_t *it, - ecs_rule_op_t *op) +void ecs_begin_wait( + ecs_world_t *world) { - return rule_get_columns_frame(it, op->frame); + ecs_poly_assert(world, ecs_world_t); + ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); + ecs_os_mutex_lock(world->thr_sync); + ecs_os_cond_wait(world->thr_cond, world->thr_sync); } -static -void entity_reg_set( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r, - ecs_entity_t entity) +void ecs_end_wait( + ecs_world_t *world) { - (void)rule; - ecs_assert(rule->vars[r].kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - ecs_check(ecs_is_valid(rule->world, entity), ECS_INVALID_PARAMETER, NULL); - regs[r].entity = entity; -error: - return; + ecs_poly_assert(world, ecs_world_t); + ecs_assert(world->locking_enabled, ECS_INVALID_PARAMETER, NULL); + ecs_os_mutex_unlock(world->thr_sync); } -static -ecs_entity_t entity_reg_get( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r) +const ecs_type_info_t* flecs_get_type_info( + const ecs_world_t *world, + ecs_entity_t component) { - (void)rule; - ecs_entity_t e = regs[r].entity; - if (!e) { - return EcsWildcard; - } - - ecs_check(ecs_is_valid(rule->world, e), ECS_INVALID_PARAMETER, NULL); - return e; -error: - return 0; + ecs_poly_assert(world, ecs_world_t); + + ecs_assert(component != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!(component & ECS_ROLE_MASK), ECS_INTERNAL_ERROR, NULL); + + return flecs_sparse_get(world->type_info, ecs_type_info_t, component); } -static -void table_reg_set( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r, - ecs_table_t *table) +ecs_type_info_t* flecs_ensure_type_info( + ecs_world_t *world, + ecs_entity_t component) { - (void)rule; - ecs_assert(rule->vars[r].kind == EcsRuleVarKindTable, - ECS_INTERNAL_ERROR, NULL); + ecs_poly_assert(world, ecs_world_t); + ecs_assert(component != 0, ECS_INTERNAL_ERROR, NULL); - regs[r].table.table = table; - regs[r].table.offset = 0; - regs[r].table.count = 0; - regs[r].entity = 0; + const ecs_type_info_t *ti = flecs_get_type_info(world, component); + ecs_type_info_t *ti_mut = NULL; + if (!ti) { + ti_mut = flecs_sparse_ensure( + world->type_info, ecs_type_info_t, component); + ecs_assert(ti_mut != NULL, ECS_INTERNAL_ERROR, NULL); + } else { + ti_mut = (ecs_type_info_t*)ti; + } + + return ti_mut; } -static -ecs_table_slice_t table_reg_get( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r) +void flecs_init_type_info( + ecs_world_t *world, + ecs_entity_t component, + ecs_size_t size, + ecs_size_t alignment) { - (void)rule; - ecs_assert(rule->vars[r].kind == EcsRuleVarKindTable, - ECS_INTERNAL_ERROR, NULL); - - return regs[r].table; + ecs_type_info_t *ti = flecs_ensure_type_info(world, component); + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ti->size == 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ti->alignment == 0, ECS_INTERNAL_ERROR, NULL); + ti->size = size; + ti->alignment = alignment; } static -ecs_entity_t reg_get_entity( - const ecs_rule_t *rule, - ecs_rule_op_t *op, - ecs_rule_reg_t *regs, - int32_t r) +FLECS_FLOAT insert_sleep( + ecs_world_t *world, + ecs_time_t *stop) { - if (r == UINT8_MAX) { - ecs_assert(op->subject != 0, ECS_INTERNAL_ERROR, NULL); + ecs_poly_assert(world, ecs_world_t); - /* The subject is referenced from the query string by string identifier. - * If subject entity is not valid, it could have been deletd by the - * application after the rule was created */ - ecs_check(ecs_is_valid(rule->world, op->subject), - ECS_INVALID_PARAMETER, NULL); + ecs_time_t start = *stop; + FLECS_FLOAT delta_time = (FLECS_FLOAT)ecs_time_measure(stop); - return op->subject; + if (world->stats.target_fps == (FLECS_FLOAT)0.0) { + return delta_time; } - if (rule->vars[r].kind == EcsRuleVarKindTable) { - int32_t offset = regs[r].table.offset; - ecs_assert(regs[r].table.count == 1, ECS_INTERNAL_ERROR, NULL); - ecs_data_t *data = &table_reg_get(rule, regs, r).table->storage; - ecs_assert(data != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(offset < ecs_vector_count(data->entities), - ECS_INTERNAL_ERROR, NULL); - ecs_check(ecs_is_valid(rule->world, entities[offset]), - ECS_INVALID_PARAMETER, NULL); - - return entities[offset]; - } - if (rule->vars[r].kind == EcsRuleVarKindEntity) { - return entity_reg_get(rule, regs, r); - } + FLECS_FLOAT target_delta_time = + ((FLECS_FLOAT)1.0 / (FLECS_FLOAT)world->stats.target_fps); - /* Must return an entity */ - ecs_assert(false, ECS_INTERNAL_ERROR, NULL); + /* Calculate the time we need to sleep by taking the measured delta from the + * previous frame, and subtracting it from target_delta_time. */ + FLECS_FLOAT sleep = target_delta_time - delta_time; -error: - return 0; -} + /* Pick a sleep interval that is 4 times smaller than the time one frame + * should take. */ + FLECS_FLOAT sleep_time = sleep / (FLECS_FLOAT)4.0; -static -ecs_table_slice_t table_from_entity( - const ecs_world_t *world, - ecs_entity_t entity) -{ - ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); - - ecs_table_slice_t slice = {0}; - ecs_record_t *record = ecs_eis_get(world, entity); - if (record) { - slice.table = record->table; - slice.offset = ECS_RECORD_TO_ROW(record->row); - slice.count = 1; - } + do { + /* Only call sleep when sleep_time is not 0. On some platforms, even + * a sleep with a timeout of 0 can cause stutter. */ + if (sleep_time != 0) { + ecs_sleepf((double)sleep_time); + } - return slice; + ecs_time_t now = start; + delta_time = (FLECS_FLOAT)ecs_time_measure(&now); + } while ((target_delta_time - delta_time) > + (sleep_time / (FLECS_FLOAT)2.0)); + + return delta_time; } static -ecs_table_slice_t reg_get_table( - const ecs_rule_t *rule, - ecs_rule_op_t *op, - ecs_rule_reg_t *regs, - int32_t r) +FLECS_FLOAT start_measure_frame( + ecs_world_t *world, + FLECS_FLOAT user_delta_time) { - if (r == UINT8_MAX) { - ecs_check(ecs_is_valid(rule->world, op->subject), - ECS_INVALID_PARAMETER, NULL); - return table_from_entity(rule->world, op->subject); - } - if (rule->vars[r].kind == EcsRuleVarKindTable) { - return table_reg_get(rule, regs, r); + ecs_poly_assert(world, ecs_world_t); + + FLECS_FLOAT delta_time = 0; + + if (world->measure_frame_time || (user_delta_time == 0)) { + ecs_time_t t = world->frame_start_time; + do { + if (world->frame_start_time.nanosec || world->frame_start_time.sec){ + delta_time = insert_sleep(world, &t); + + ecs_time_measure(&t); + } else { + ecs_time_measure(&t); + if (world->stats.target_fps != 0) { + delta_time = (FLECS_FLOAT)1.0 / world->stats.target_fps; + } else { + /* Best guess */ + delta_time = (FLECS_FLOAT)1.0 / (FLECS_FLOAT)60.0; + } + } + + /* Keep trying while delta_time is zero */ + } while (delta_time == 0); + + world->frame_start_time = t; + + /* Keep track of total time passed in world */ + world->stats.world_time_total_raw += (FLECS_FLOAT)delta_time; } - if (rule->vars[r].kind == EcsRuleVarKindEntity) { - return table_from_entity(rule->world, entity_reg_get(rule, regs, r)); - } -error: - return (ecs_table_slice_t){0}; + + return (FLECS_FLOAT)delta_time; } static -void reg_set_entity( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r, - ecs_entity_t entity) +void stop_measure_frame( + ecs_world_t* world) { - if (rule->vars[r].kind == EcsRuleVarKindTable) { - ecs_world_t *world = rule->world; - ecs_check(ecs_is_valid(world, entity), ECS_INVALID_PARAMETER, NULL); - regs[r].table = table_from_entity(world, entity); - regs[r].entity = entity; - } else { - entity_reg_set(rule, regs, r, entity); + ecs_poly_assert(world, ecs_world_t); + + if (world->measure_frame_time) { + ecs_time_t t = world->frame_start_time; + world->stats.frame_time_total += (FLECS_FLOAT)ecs_time_measure(&t); } -error: - return; } -static -void reg_set_table( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t r, - ecs_table_slice_t table) +FLECS_FLOAT ecs_frame_begin( + ecs_world_t *world, + FLECS_FLOAT user_delta_time) { - if (rule->vars[r].kind == EcsRuleVarKindEntity) { - ecs_check(table.count == 1, ECS_INTERNAL_ERROR, NULL); - regs[r].table = table; - regs[r].entity = ecs_vector_get(table.table->storage.entities, - ecs_entity_t, table.offset)[0]; - } else { - regs[r].table = table; - regs[r].entity = 0; + ecs_poly_assert(world, ecs_world_t); + ecs_check(world->is_readonly == false, ECS_INVALID_OPERATION, NULL); + ecs_check(user_delta_time != 0 || ecs_os_has_time(), + ECS_MISSING_OS_API, "get_time"); + + if (world->locking_enabled) { + ecs_lock(world); } -error: - return; -} -/* This encodes a column expression into a pair. A pair stores information about - * the variable(s) associated with the column. Pairs are used by operations to - * apply filters, and when there is a match, to reify variables. */ -static -ecs_rule_pair_t term_to_pair( - ecs_rule_t *rule, - ecs_term_t *term) -{ - ecs_rule_pair_t result = {0}; + /* Start measuring total frame time */ + FLECS_FLOAT delta_time = start_measure_frame(world, user_delta_time); + if (user_delta_time == 0) { + user_delta_time = delta_time; + } - /* Terms must always have at least one argument (the subject) */ - ecs_assert(subj_is_set(term), ECS_INTERNAL_ERROR, NULL); + world->stats.delta_time_raw = user_delta_time; + world->stats.delta_time = user_delta_time * world->stats.time_scale; - /* If the predicate id is a variable, find the variable and encode its id - * in the pair so the operation can find it later. */ - if (term->pred.var == EcsVarIsVariable) { - if (term->pred.entity != EcsAny) { - /* Always lookup var as an entity, as pairs never refer to tables */ - const ecs_rule_var_t *var = find_variable( - rule, EcsRuleVarKindEntity, term_id_var_name(&term->pred)); + /* Keep track of total scaled time passed in world */ + world->stats.world_time_total += world->stats.delta_time; - /* Variables should have been declared */ - ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(var->kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - result.pred.reg = var->id; + ecs_force_aperiodic(world); - /* Set flag so the operation can see the predicate is a variable */ - result.reg_mask |= RULE_PAIR_PREDICATE; - result.final = true; - } else { - result.pred.ent = EcsWildcard; - result.final = true; - } - } else { - /* If the predicate is not a variable, simply store its id. */ - ecs_entity_t pred_id = term->pred.entity; - result.pred.ent = pred_id; + return world->stats.delta_time; +error: + return (FLECS_FLOAT)0; +} - /* Test if predicate is transitive. When evaluating the predicate, this - * will also take into account transitive relationships */ - if (ecs_has_id(rule->world, pred_id, EcsTransitive)) { - /* Transitive queries must have an object */ - if (obj_is_set(term)) { - result.transitive = true; - } - } +void ecs_frame_end( + ecs_world_t *world) +{ + ecs_poly_assert(world, ecs_world_t); + ecs_check(world->is_readonly == false, ECS_INVALID_OPERATION, NULL); - if (ecs_has_id(rule->world, pred_id, EcsFinal)) { - result.final = true; - } + world->stats.frame_count_total ++; - if (ecs_has_id(rule->world, pred_id, EcsReflexive)) { - result.reflexive = true; - } + ecs_vector_each(world->worker_stages, ecs_stage_t, stage, { + flecs_stage_merge_post_frame(world, stage); + }); - if (ecs_has_id(rule->world, pred_id, EcsAcyclic)) { - result.acyclic = true; - } - } + if (world->locking_enabled) { + ecs_unlock(world); - /* The pair doesn't do anything with the subject (subjects are the things that - * are matched against pairs) so if the column does not have a object, - * there is nothing left to do. */ - if (!obj_is_set(term)) { - return result; + ecs_os_mutex_lock(world->thr_sync); + ecs_os_cond_broadcast(world->thr_cond); + ecs_os_mutex_unlock(world->thr_sync); } - /* If arguments is higher than 2 this is not a pair but a nested rule */ - ecs_assert(obj_is_set(term), ECS_INTERNAL_ERROR, NULL); + stop_measure_frame(world); +error: + return; +} - /* Same as above, if the object is a variable, store it and flag it */ - if (term->obj.var == EcsVarIsVariable) { - if (term->obj.entity != EcsAny) { - const ecs_rule_var_t *var = find_variable( - rule, EcsRuleVarKindEntity, term_id_var_name(&term->obj)); +const ecs_world_info_t* ecs_get_world_info( + const ecs_world_t *world) +{ + world = ecs_get_world(world); + return &world->stats; +} - /* Variables should have been declared */ - ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(var->kind == EcsRuleVarKindEntity, ECS_INTERNAL_ERROR, - NULL); +void flecs_notify_queries( + ecs_world_t *world, + ecs_query_event_t *event) +{ + ecs_poly_assert(world, ecs_world_t); - result.obj.reg = var->id; - result.reg_mask |= RULE_PAIR_OBJECT; - } else { - result.obj.ent = EcsWildcard; - } - } else { - /* If the object is not a variable, simply store its id */ - result.obj.ent = term->obj.entity; - if (!result.obj.ent) { - result.obj_0 = true; + int32_t i, count = flecs_sparse_count(world->queries); + for (i = 0; i < count; i ++) { + ecs_query_t *query = flecs_sparse_get_dense( + world->queries, ecs_query_t, i); + if (query->flags & EcsQueryIsSubquery) { + continue; } - } + + flecs_query_notify(world, query, event); + } +} - return result; +void flecs_delete_table( + ecs_world_t *world, + ecs_table_t *table) +{ + ecs_poly_assert(world, ecs_world_t); + flecs_table_release(world, table); } -/* When an operation has a pair, it is used to filter its input. This function - * translates a pair back into an entity id, and in the process substitutes the - * variables that have already been filled out. It's one of the most important - * functions, as a lot of the filtering logic depends on having an entity that - * has all of the reified variables correctly filled out. */ -static -ecs_rule_filter_t pair_to_filter( - ecs_rule_iter_t *it, - ecs_rule_op_t *op, - ecs_rule_pair_t pair) +/** Walk over tables that had a state change which requires bookkeeping */ +void flecs_process_pending_tables( + const ecs_world_t *world_r) { - ecs_entity_t pred = pair.pred.ent; - ecs_entity_t obj = pair.obj.ent; - ecs_rule_filter_t result = { - .lo_var = -1, - .hi_var = -1 - }; + ecs_poly_assert(world_r, ecs_world_t); - /* Get registers in case we need to resolve ids from registers. Get them - * from the previous, not the current stack frame as the current operation - * hasn't reified its variables yet. */ - ecs_rule_reg_t *regs = get_register_frame(it, op->frame - 1); + /* We can't update the administration while in readonly mode, but we can + * ensure that when this function is called there are no pending events. */ + if (world_r->is_readonly) { + ecs_assert(flecs_sparse_count(world_r->pending_tables) == 0, + ECS_INTERNAL_ERROR, NULL); + return; + } - if (pair.reg_mask & RULE_PAIR_OBJECT) { - obj = entity_reg_get(it->rule, regs, pair.obj.reg); - obj = ecs_entity_t_lo(obj); /* Filters don't have generations */ + /* Safe to cast, world is not readonly */ + ecs_world_t *world = (ecs_world_t*)world_r; + + /* If pending buffer is NULL there already is a stackframe that's iterating + * the table list. This can happen when a trigger for a table event results + * in a mutation that causes another table to change state. A typical + * example of this is a system that becomes active/inactive as the result of + * a query (and as a result, its matched tables) becoming empty/non empty */ + if (!world->pending_buffer) { + return; + } - if (obj == EcsWildcard) { - result.wildcard = true; - result.obj_wildcard = true; - result.lo_var = pair.obj.reg; - } + /* Swap buffer. The logic could in theory have been implemented with a + * single sparse set, but that would've complicated (and slowed down) the + * iteration. Additionally, by using a double buffer approach we can still + * keep most of the original ordering of events intact, which is desirable + * as it means that the ordering of tables in the internal datastructures is + * more predictable. */ + int32_t i, count = flecs_sparse_count(world->pending_tables); + if (!count) { + return; } - if (pair.reg_mask & RULE_PAIR_PREDICATE) { - pred = entity_reg_get(it->rule, regs, pair.pred.reg); - pred = ecs_entity_t_lo(pred); /* Filters don't have generations */ + do { + ecs_sparse_t *pending_tables = world->pending_tables; + world->pending_tables = world->pending_buffer; + world->pending_buffer = NULL; - if (pred == EcsWildcard) { - if (result.wildcard) { - result.same_var = pair.pred.reg == pair.obj.reg; + for (i = 0; i < count; i ++) { + ecs_table_t *table = flecs_sparse_get_dense( + pending_tables, ecs_table_t*, i)[0]; + if (!table->id) { + /* Table is being deleted, ignore empty events */ + continue; } - result.wildcard = true; - result.pred_wildcard = true; + /* For each id in the table, add it to the empty/non empty list + * based on its current state */ + if (flecs_table_records_update_empty(table)) { + /* Only emit an event when there was a change in the + * administration. It is possible that a table ended up in the + * pending_tables list by going from empty->non-empty, but then + * became empty again. By the time we run this code, no changes + * in the administration would actually be made. */ + ecs_ids_t ids = { + .array = ecs_vector_first(table->type, ecs_id_t), + .count = ecs_vector_count(table->type) + }; - if (obj) { - result.hi_var = pair.pred.reg; - } else { - result.lo_var = pair.pred.reg; + ecs_emit(world, &(ecs_event_desc_t) { + .event = ecs_table_count(table) + ? EcsOnTableFill + : EcsOnTableEmpty + , + .table = table, + .ids = &ids, + .observable = world, + .table_event = true + }); } } - } - - if (!obj && !pair.obj_0) { - result.mask = pred; - } else { - result.mask = ecs_pair(pred, obj); - } + flecs_sparse_clear(pending_tables); - return result; + world->pending_buffer = pending_tables; + } while ((count = flecs_sparse_count(world->pending_tables))); } -/* This function is responsible for reifying the variables (filling them out - * with their actual values as soon as they are known). It uses the pair - * expression returned by pair_get_most_specific_var, and attempts to fill out each of the - * wildcards in the pair. If a variable isn't reified yet, the pair expression - * will still contain one or more wildcards, which is harmless as the respective - * registers will also point to a wildcard. */ -static -void reify_variables( - ecs_rule_iter_t *it, - ecs_rule_op_t *op, - ecs_rule_filter_t *filter, - ecs_type_t type, - int32_t column) +void flecs_table_set_empty( + ecs_world_t *world, + ecs_table_t *table) { - const ecs_rule_t *rule = it->rule; - const ecs_rule_var_t *vars = rule->vars; - (void)vars; - - ecs_rule_reg_t *regs = get_registers(it, op); - ecs_entity_t *elem = ecs_vector_get(type, ecs_entity_t, column); - ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); - - int32_t obj_var = filter->lo_var; - int32_t pred_var = filter->hi_var; + ecs_poly_assert(world, ecs_world_t); + ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); - if (obj_var != -1) { - ecs_assert(vars[obj_var].kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); + flecs_sparse_set_generation(world->pending_tables, (uint32_t)table->id); + flecs_sparse_ensure(world->pending_tables, ecs_table_t*, + (uint32_t)table->id)[0] = table; +} - entity_reg_set(rule, regs, obj_var, - ecs_get_alive(rule->world, ECS_PAIR_SECOND(*elem))); +ecs_id_record_t* flecs_ensure_id_record( + ecs_world_t *world, + ecs_id_t id) +{ + ecs_id_record_t **idr_ptr = ecs_map_ensure(&world->id_index, + ecs_id_record_t*, ecs_strip_generation(id)); + ecs_id_record_t *idr = idr_ptr[0]; + if (!idr) { + idr_ptr[0] = idr = new_id_record(world, id); } - if (pred_var != -1) { - ecs_assert(vars[pred_var].kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - - entity_reg_set(rule, regs, pred_var, - ecs_get_alive(rule->world, - ECS_PAIR_FIRST(*elem))); - } + return idr; } -/* Returns whether variable is a subject */ -static -bool is_subject( - ecs_rule_t *rule, - ecs_rule_var_t *var) +ecs_id_record_t* flecs_get_id_record( + const ecs_world_t *world, + ecs_id_t id) { - ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); + return ecs_map_get_ptr(&world->id_index, ecs_id_record_t*, + ecs_strip_generation(id)); +} - if (!var) { - return false; - } +ecs_hashmap_t* flecs_ensure_id_name_index( + ecs_world_t *world, + ecs_id_t id) +{ + ecs_id_record_t *idr = flecs_get_id_record(world, id); + ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); - if (var->id < rule->subj_var_count) { - return true; + ecs_hashmap_t *map = idr->name_index; + if (!map) { + map = idr->name_index = flecs_name_index_new(); } - return false; + return map; } -static -bool skip_term(ecs_term_t *term) { - if (term->subj.set.mask & EcsNothing) { - return true; - } - if (term->oper == EcsNot) { - return true; +ecs_hashmap_t* flecs_get_id_name_index( + const ecs_world_t *world, + ecs_id_t id) +{ + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return NULL; } - return false; + return idr->name_index; } -static -int32_t get_variable_depth( - ecs_rule_t *rule, - ecs_rule_var_t *var, - ecs_rule_var_t *root, - int recur); - -static -int32_t crawl_variable( - ecs_rule_t *rule, - ecs_rule_var_t *var, - ecs_rule_var_t *root, - int recur) +ecs_table_record_t* flecs_get_table_record( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_id_t id) { - ecs_term_t *terms = rule->filter.terms; - int32_t i, count = rule->filter.term_count; - - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - if (skip_term(term)) { - continue; - } - - ecs_rule_var_t - *pred = term_pred(rule, term), - *subj = term_subj(rule, term), - *obj = term_obj(rule, term); - - /* Variable must at least appear once in term */ - if (var != pred && var != subj && var != obj) { - continue; - } - - if (pred && pred != var && !pred->marked) { - get_variable_depth(rule, pred, root, recur + 1); - } - - if (subj && subj != var && !subj->marked) { - get_variable_depth(rule, subj, root, recur + 1); - } - - if (obj && obj != var && !obj->marked) { - get_variable_depth(rule, obj, root, recur + 1); - } + ecs_id_record_t* idr = flecs_get_id_record(world, id); + if (!idr) { + return NULL; } - return 0; + return (ecs_table_record_t*)ecs_table_cache_get(&idr->cache, table); } -static -int32_t get_depth_from_var( - ecs_rule_t *rule, - ecs_rule_var_t *var, - ecs_rule_var_t *root, - int recur) +void flecs_remove_id_record( + ecs_world_t *world, + ecs_id_t id, + ecs_id_record_t *idr) { - /* If variable is the root or if depth has been set, return depth + 1 */ - if (var == root || var->depth != UINT8_MAX) { - return var->depth + 1; - } - - /* Variable is already being evaluated, so this indicates a cycle. Stop */ - if (var->marked) { - return 0; - } - - /* Variable is not yet being evaluated and depth has not yet been set. - * Calculate depth. */ - int32_t depth = get_variable_depth(rule, var, root, recur + 1); - if (depth == UINT8_MAX) { - return depth; - } else { - return depth + 1; + /* Free id record resources */ + if (free_id_record(world, id, idr)) { + /* Remove record from world index */ + ecs_map_remove(&world->id_index, ecs_strip_generation(id)); } } -static -int32_t get_depth_from_term( - ecs_rule_t *rule, - ecs_rule_var_t *cur, - ecs_rule_var_t *pred, - ecs_rule_var_t *obj, - ecs_rule_var_t *root, - int recur) +void flecs_clear_id_record( + ecs_world_t *world, + ecs_id_t id, + ecs_id_record_t *idr) { - int32_t result = UINT8_MAX; - - /* If neither of the other parts of the terms are variables, this - * variable is guaranteed to have no dependencies. */ - if (!pred && !obj) { - result = 0; - } else { - /* If this is a variable that is not the same as the current, - * we can use it to determine dependency depth. */ - if (pred && cur != pred) { - int32_t depth = get_depth_from_var(rule, pred, root, recur); - if (depth == UINT8_MAX) { - return UINT8_MAX; - } + if (world->is_fini) { + return; + } - /* If the found depth is lower than the depth found, overwrite it */ - if (depth < result) { - result = depth; - } - } + ecs_table_cache_fini_delete_all(world, &idr->cache); - /* Same for obj */ - if (obj && cur != obj) { - int32_t depth = get_depth_from_var(rule, obj, root, recur); - if (depth == UINT8_MAX) { - return UINT8_MAX; - } + flecs_remove_id_record(world, id, idr); +} - if (depth < result) { - result = depth; - } - } +bool flecs_id_existst( + ecs_world_t *world, + ecs_id_t id) +{ + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return false; } - - return result; + return (ecs_table_cache_count(&idr->cache) != 0) || + (ecs_table_cache_empty_count(&idr->cache) != 0); } -/* Find the depth of the dependency tree from the variable to the root */ -static -int32_t get_variable_depth( - ecs_rule_t *rule, - ecs_rule_var_t *var, - ecs_rule_var_t *root, - int recur) +const ecs_table_record_t* flecs_id_record_table( + ecs_id_record_t *idr, + ecs_table_t *table) { - var->marked = true; + if (!idr) { + return NULL; + } + return (ecs_table_record_t*)ecs_table_cache_get(&idr->cache, table); +} - /* Iterate columns, find all instances where 'var' is not used as subject. - * If the subject of that column is either the root or a variable for which - * the depth is known, the depth for this variable can be determined. */ - ecs_term_t *terms = rule->filter.terms; +ecs_id_record_t* flecs_table_iter( + ecs_world_t *world, + ecs_id_t id, + ecs_table_cache_iter_t *out) +{ + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return NULL; + } - int32_t i, count = rule->filter.term_count; - int32_t result = UINT8_MAX; + flecs_process_pending_tables(world); + ecs_assert( flecs_sparse_count(world->pending_tables) == 0, + ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - if (skip_term(term)) { - continue; - } + flecs_table_cache_iter(&idr->cache, out); + return idr; +} - ecs_rule_var_t - *pred = term_pred(rule, term), - *subj = term_subj(rule, term), - *obj = term_obj(rule, term); +ecs_id_record_t* flecs_empty_table_iter( + ecs_world_t *world, + ecs_id_t id, + ecs_table_cache_iter_t *out) +{ + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return NULL; + } - if (subj != var) { - continue; - } + flecs_process_pending_tables(world); + ecs_assert( flecs_sparse_count(world->pending_tables) == 0, + ECS_INTERNAL_ERROR, NULL); - if (!is_subject(rule, pred)) { - pred = NULL; - } + flecs_table_cache_empty_iter(&idr->cache, out); + return idr; +} - if (!is_subject(rule, obj)) { - obj = NULL; - } +void ecs_force_aperiodic( + ecs_world_t *world) +{ + flecs_process_pending_tables(world); + flecs_eval_component_monitors(world); +} - int32_t depth = get_depth_from_term(rule, var, pred, obj, root, recur); - if (depth < result) { - result = depth; - } - } - if (result == UINT8_MAX) { - result = 0; - } +void flecs_observable_init( + ecs_observable_t *observable) +{ + observable->events = ecs_sparse_new(ecs_event_record_t); +} - var->depth = result; +void flecs_observable_fini( + ecs_observable_t *observable) +{ + ecs_sparse_t *triggers = observable->events; + int32_t i, count = flecs_sparse_count(triggers); - /* Dependencies are calculated from subject to (pred, obj). If there were - * subjects that are only related by object (like (X, Y), (Z, Y)) it is - * possible that those have not yet been found yet. To make sure those - * variables are found, loop again & follow predicate & object links */ for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - if (skip_term(term)) { - continue; - } - - ecs_rule_var_t - *subj = term_subj(rule, term), - *pred = term_pred(rule, term), - *obj = term_obj(rule, term); - - /* Only evaluate pred & obj for current subject. This ensures that we - * won't evaluate variables that are unreachable from the root. This - * must be detected as unconstrained variables are not allowed. */ - if (subj != var) { - continue; - } - - crawl_variable(rule, subj, root, recur); + ecs_event_record_t *et = + ecs_sparse_get_dense(triggers, ecs_event_record_t, i); + ecs_assert(et != NULL, ECS_INTERNAL_ERROR, NULL); - if (pred && pred != var) { - crawl_variable(rule, pred, root, recur); + ecs_map_iter_t it = ecs_map_iter(&et->event_ids); + ecs_event_id_record_t *idt; + while ((idt = ecs_map_next(&it, ecs_event_id_record_t, NULL))) { + ecs_map_fini(&idt->triggers); + ecs_map_fini(&idt->set_triggers); } - - if (obj && obj != var) { - crawl_variable(rule, obj, root, recur); - } + ecs_map_fini(&et->event_ids); } - return var->depth; + flecs_sparse_free(observable->events); } -/* Compare function used for qsort. It ensures that variables are first ordered - * by depth, followed by how often they occur. */ static -int compare_variable( - const void* ptr1, - const void *ptr2) +void notify_subset( + ecs_world_t *world, + ecs_iter_t *it, + ecs_observable_t *observable, + ecs_entity_t entity, + ecs_entity_t event, + ecs_ids_t *ids) { - const ecs_rule_var_t *v1 = ptr1; - const ecs_rule_var_t *v2 = ptr2; - - if (v1->kind < v2->kind) { - return -1; - } else if (v1->kind > v2->kind) { - return 1; + ecs_id_t pair = ecs_pair(EcsWildcard, entity); + ecs_table_cache_iter_t idt; + ecs_id_record_t *idr = flecs_table_iter(world, pair, &idt); + if (!idr) { + return; } - if (v1->depth < v2->depth) { - return -1; - } else if (v1->depth > v2->depth) { - return 1; - } + const ecs_table_record_t *tr; + while ((tr = flecs_table_cache_next(&idt, ecs_table_record_t))) { + ecs_table_t *table = tr->hdr.table; + ecs_id_t id = ecs_vector_get(table->type, ecs_id_t, tr->column)[0]; + ecs_entity_t rel = ECS_PAIR_FIRST(id); - if (v1->occurs < v2->occurs) { - return 1; - } else { - return -1; - } + if (ecs_is_valid(world, rel) && !ecs_has_id(world, rel, EcsAcyclic)) { + /* Only notify for acyclic relations */ + continue; + } - return (v1->id < v2->id) - (v1->id > v2->id); -} + int32_t e, entity_count = ecs_table_count(table); + it->table = table; + it->type = table->type; + it->other_table = NULL; + it->offset = 0; + it->count = entity_count; -/* After all subject variables have been found, inserted and sorted, the - * remaining variables (predicate & object) still need to be inserted. This - * function serves two purposes. The first purpose is to ensure that all - * variables are known before operations are emitted. This ensures that the - * variables array won't be reallocated while emitting, which simplifies code. - * The second purpose of the function is to ensure that if the root variable - * (which, if it exists has now been created with a table type) is also inserted - * with an entity type if required. This is used later to decide whether the - * rule needs to insert an each instruction. */ -static -void ensure_all_variables( - ecs_rule_t *rule) -{ - ecs_term_t *terms = rule->filter.terms; - int32_t i, count = rule->filter.term_count; + /* Treat as new event as this could trigger observers again for + * different tables. */ + world->event_id ++; - for (i = 0; i < count; i ++) { - ecs_term_t *term = &terms[i]; - if (skip_term(term)) { - continue; - } + flecs_set_triggers_notify(it, observable, ids, event, + ecs_pair(rel, EcsWildcard)); - /* If predicate is a variable, make sure it has been registered */ - if (term->pred.var == EcsVarIsVariable) { - ensure_term_id_variable(rule, &term->pred); - } + ecs_entity_t *entities = ecs_vector_first( + table->storage.entities, ecs_entity_t); + ecs_record_t **records = ecs_vector_first( + table->storage.record_ptrs, ecs_record_t*); - /* If subject is a variable and it is not This, make sure it is - * registered as an entity variable. This ensures that the program will - * correctly return all permutations */ - if (term->subj.var == EcsVarIsVariable) { - if (term->subj.entity != EcsThis) { - ensure_term_id_variable(rule, &term->subj); + for (e = 0; e < entity_count; e ++) { + uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(records[e]->row); + if (flags & ECS_FLAG_OBSERVED_ACYCLIC) { + /* Only notify for entities that are used in pairs with + * acyclic relations */ + notify_subset(world, it, observable, entities[e], event, ids); } } - - /* If object is a variable, make sure it has been registered */ - if (obj_is_set(term) && (term->obj.var == EcsVarIsVariable)) { - ensure_term_id_variable(rule, &term->obj); - } - } + } } -/* Scan for variables, put them in optimal dependency order. */ -static -int scan_variables( - ecs_rule_t *rule) +void ecs_emit( + ecs_world_t *world, + ecs_event_desc_t *desc) { - /* Objects found in rule. One will be elected root */ - int32_t subject_count = 0; + ecs_poly_assert(world, ecs_world_t); + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->event != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->event != EcsWildcard, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->ids != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->ids->count != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->table != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->observable != NULL, ECS_INVALID_PARAMETER, NULL); - /* If this (.) is found, it always takes precedence in root election */ - int32_t this_var = UINT8_MAX; + ecs_ids_t *ids = desc->ids; + ecs_entity_t event = desc->event; + ecs_table_t *table = desc->table; + int32_t row = desc->offset; + int32_t i, count = desc->count; + ecs_entity_t relation = desc->relation; - /* Keep track of the subject variable that occurs the most. In the absence of - * this (.) the variable with the most occurrences will be elected root. */ - int32_t max_occur = 0; - int32_t max_occur_var = UINT8_MAX; + if (!count) { + count = ecs_table_count(table) - row; + } - /* Step 1: find all possible roots */ - ecs_term_t *terms = rule->filter.terms; - int32_t i, term_count = rule->filter.term_count; + ecs_iter_t it = { + .world = world, + .real_world = world, + .table = table, + .type = table->type, + .term_count = 1, + .other_table = desc->other_table, + .offset = row, + .count = count, + .param = (void*)desc->param, + .table_only = desc->table_event + }; - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; + world->event_id ++; - /* Evaluate the subject. The predicate and object are not evaluated, - * since they never can be elected as root. */ - if (term_id_is_variable(&term->subj)) { - const char *subj_name = term_id_var_name(&term->subj); - - ecs_rule_var_t *subj = find_variable( - rule, EcsRuleVarKindTable, subj_name); - if (!subj) { - subj = create_variable(rule, EcsRuleVarKindTable, subj_name); - if (subject_count >= ECS_RULE_MAX_VAR_COUNT) { - rule_error(rule, "too many variables in rule"); - goto error; - } + ecs_observable_t *observable = ecs_get_observable(desc->observable); + ecs_check(observable != NULL, ECS_INVALID_PARAMETER, NULL); - /* Make sure that variable name in term array matches with the - * rule name. */ - ecs_os_strset(&term->subj.name, subj->name); + if (!desc->relation) { + flecs_triggers_notify(&it, observable, ids, event); + } else { + flecs_set_triggers_notify(&it, observable, ids, event, + ecs_pair(relation, EcsWildcard)); + } + + if (count && !desc->table_event) { + ecs_record_t **recs = ecs_vector_get( + table->storage.record_ptrs, ecs_record_t*, row); + + for (i = 0; i < count; i ++) { + ecs_record_t *r = recs[i]; + if (!r) { + /* If the event is emitted after a bulk operation, it's possible + * that it hasn't been populate with entities yet. */ + continue; } - if (++ subj->occurs > max_occur) { - max_occur = subj->occurs; - max_occur_var = subj->id; + uint32_t flags = ECS_RECORD_TO_ROW_FLAGS(recs[i]->row); + if (flags & ECS_FLAG_OBSERVED_ACYCLIC) { + notify_subset(world, &it, observable, ecs_vector_first( + table->storage.entities, ecs_entity_t)[row + i], + event, ids); } } } + +error: + return; +} - rule->subj_var_count = rule->var_count; - - ensure_all_variables(rule); - - /* Variables in a term with a literal subject have depth 0 */ - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; - if (term->subj.var == EcsVarIsEntity) { - ecs_rule_var_t - *pred = term_pred(rule, term), - *obj = term_obj(rule, term); +#include - if (pred) { - pred->depth = 0; - } - if (obj) { - obj->depth = 0; - } - } - } +static +void term_error( + const ecs_world_t *world, + const ecs_term_t *term, + const char *name, + const char *fmt, + ...) +{ + va_list args; + va_start(args, fmt); - /* Elect a root. This is either this (.) or the variable with the most - * occurrences. */ - int32_t root_var = this_var; - if (root_var == UINT8_MAX) { - root_var = max_occur_var; - if (root_var == UINT8_MAX) { - /* If no subject variables have been found, the rule expression only - * operates on a fixed set of entities, in which case no root - * election is required. */ - goto done; - } - } + char *expr = ecs_term_str(world, term); + ecs_parser_errorv(name, expr, 0, fmt, args); + ecs_os_free(expr); - ecs_rule_var_t *root = &rule->vars[root_var]; - root->depth = get_variable_depth(rule, root, root, 0); + va_end(args); +} - /* Verify that there are no unconstrained variables. Unconstrained variables - * are variables that are unreachable from the root. */ - for (i = 0; i < rule->subj_var_count; i ++) { - if (rule->vars[i].depth == UINT8_MAX) { - rule_error(rule, "unconstrained variable '%s'", - rule->vars[i].name); - goto error; - } +static +int finalize_term_set( + const ecs_world_t *world, + ecs_term_t *term, + ecs_term_id_t *identifier, + const char *name) +{ + if (identifier->set.mask & EcsParent) { + identifier->set.mask |= EcsSuperSet; + identifier->set.relation = EcsChildOf; } - /* For each Not term, verify that variables are known */ - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; - if (term->oper != EcsNot) { - continue; + /* Default relation for superset/subset is EcsIsA */ + if (identifier->set.mask & (EcsSuperSet|EcsSubSet)) { + if (!identifier->set.relation) { + identifier->set.relation = EcsIsA; } - ecs_rule_var_t - *pred = term_pred(rule, term), - *obj = term_obj(rule, term); - - if (!pred && term_id_is_variable(&term->pred)) { - rule_error(rule, "missing predicate variable '%s'", - term_id_var_name(&term->pred)); - goto error; + if (!(identifier->set.mask & EcsSelf)) { + if (!identifier->set.min_depth) { + identifier->set.min_depth = 1; + } } - if (!obj && term_id_is_variable(&term->obj)) { - rule_error(rule, "missing object variable '%s'", - term_id_var_name(&term->obj)); - goto error; + } else { + if (identifier->set.min_depth > 0) { + term_error(world, term, name, + "min depth cannnot be non-zero for Self term"); + return -1; + } + if (identifier->set.max_depth > 1) { + term_error(world, term, name, + "max depth cannnot be larger than 1 for Self term"); + return -1; } - } - /* Order variables by depth, followed by occurrence. The variable - * array will later be used to lead the iteration over the terms, and - * determine which operations get inserted first. */ - int32_t var_count = rule->var_count; - ecs_qsort_t(rule->vars, var_count, ecs_rule_var_t, compare_variable); + identifier->set.max_depth = 1; + } - /* Iterate variables to correct ids after sort */ - for (i = 0; i < rule->var_count; i ++) { - rule->vars[i].id = i; + if ((identifier->set.mask != EcsNothing) && + (identifier->set.mask & EcsNothing)) + { + term_error(world, term, name, "invalid Nothing in set mask"); + return -1; } - -done: + return 0; -error: - return -1; } -/* Get entity variable from table variable */ static -ecs_rule_var_t* to_entity( - ecs_rule_t *rule, - ecs_rule_var_t *var) +int finalize_term_var( + const ecs_world_t *world, + ecs_term_t *term, + ecs_term_id_t *identifier, + const char *name) { - if (!var) { - return NULL; + if (identifier->var == EcsVarDefault) { + const char *var = ecs_identifier_is_var(identifier->name); + if (var) { + char *var_dup = ecs_os_strdup(var); + ecs_os_free(identifier->name); + identifier->name = var_dup; + identifier->var = EcsVarIsVariable; + } } - ecs_rule_var_t *evar = NULL; - if (var->kind == EcsRuleVarKindTable) { - evar = find_variable(rule, EcsRuleVarKindEntity, var->name); - } else { - evar = var; + if (identifier->var == EcsVarDefault && identifier->set.mask != EcsNothing){ + identifier->var = EcsVarIsEntity; } - return evar; -} - -/* Ensure that if a table variable has been written, the corresponding entity - * variable is populated. The function will return the most specific, populated - * variable. */ -static -ecs_rule_var_t* most_specific_var( - ecs_rule_t *rule, - ecs_rule_var_t *var, - bool *written, - bool create) -{ - if (!var) { - return NULL; + if (!identifier->name) { + return 0; } - ecs_rule_var_t *tvar, *evar = to_entity(rule, var); - if (!evar) { - return var; + if (identifier->var != EcsVarIsVariable) { + if (ecs_identifier_is_0(identifier->name)) { + identifier->entity = 0; + } else { + ecs_entity_t e = ecs_lookup_symbol(world, identifier->name, true); + if (!e) { + term_error(world, term, name, + "unresolved identifier '%s'", identifier->name); + return -1; + } + + identifier->entity = e; + } } - if (var->kind == EcsRuleVarKindTable) { - tvar = var; - } else { - tvar = find_variable(rule, EcsRuleVarKindTable, var->name); + if ((identifier->set.mask == EcsNothing) && + (identifier->var != EcsVarDefault)) + { + term_error(world, term, name, "Invalid Nothing with entity"); + return -1; } - /* If variable is used as predicate or object, it should have been - * registered as an entity. */ - ecs_assert(evar != NULL, ECS_INTERNAL_ERROR, NULL); + if (identifier->var == EcsVarIsEntity) { + if (identifier->entity && !ecs_is_alive(world, identifier->entity)) { + term_error(world, term, name, + "cannot use not alive entity %u in query", + (uint32_t)identifier->entity); + return -1; + } + } - /* Usually table variables are resolved before they are used as a predicate - * or object, but in the case of cyclic dependencies this is not guaranteed. - * Only insert an each instruction of the table variable has been written */ - if (tvar && written[tvar->id]) { - /* If the variable has been written as a table but not yet - * as an entity, insert an each operation that yields each - * entity in the table. */ - if (evar) { - if (written[evar->id]) { - return evar; - } else if (create) { - ecs_rule_op_t *op = create_operation(rule); - op->kind = EcsRuleEach; - op->on_pass = rule->operation_count; - op->on_fail = rule->operation_count - 2; - op->frame = rule->frame_count; - op->has_in = true; - op->has_out = true; - op->r_in = tvar->id; - op->r_out = evar->id; + return 0; +} - /* Entity will either be written or has been written */ - written[evar->id] = true; +static +int finalize_term_identifier( + const ecs_world_t *world, + ecs_term_t *term, + ecs_term_id_t *identifier, + const char *name) +{ + if (finalize_term_set(world, term, identifier, name)) { + return -1; + } + if (finalize_term_var(world, term, identifier, name)) { + return -1; + } + return 0; +} - push_frame(rule); +static +bool term_can_inherit( + ecs_term_t *term) +{ + /* Hardcoded components that can't be inherited. TODO: replace with + * relationship property. */ + if (term->pred.entity == EcsChildOf || + (term->id == ecs_pair(ecs_id(EcsIdentifier), EcsName)) || + (term->id == EcsPrefab) || + (term->id == EcsDisabled)) + { + return false; + } + return true; +} - return evar; - } else { - return tvar; +static +ecs_entity_t term_id_entity( + const ecs_world_t *world, + ecs_term_id_t *term_id) +{ + if (term_id->entity && term_id->entity != EcsThis && + term_id->entity != EcsWildcard && term_id->entity != EcsAny) + { + if (!(term_id->entity & ECS_ROLE_MASK)) { + return term_id->entity; + } else { + return 0; + } + } else if (term_id->name) { + if (term_id->var == EcsVarIsEntity || + (term_id->var == EcsVarDefault && + !ecs_identifier_is_var(term_id->name))) + { + ecs_entity_t e = ecs_lookup_fullpath(world, term_id->name); + if (e != EcsWildcard && e != EcsThis && e != EcsAny) { + return e; } + return 0; + } else { + return 0; } - } else if (evar && written[evar->id]) { - return evar; + } else { + return 0; } - - return var; } -/* Get most specific known variable */ static -ecs_rule_var_t *get_most_specific_var( - ecs_rule_t *rule, - ecs_rule_var_t *var, - bool *written) +int finalize_term_vars( + const ecs_world_t *world, + ecs_term_t *term, + const char *name) { - return most_specific_var(rule, var, written, false); + if (finalize_term_var(world, term, &term->pred, name)) { + return -1; + } + if (finalize_term_var(world, term, &term->subj, name)) { + return -1; + } + if (finalize_term_var(world, term, &term->obj, name)) { + return -1; + } + return 0; } -/* Get or create most specific known variable. This will populate an entity - * variable if a table variable is known but the entity variable isn't. */ static -ecs_rule_var_t *ensure_most_specific_var( - ecs_rule_t *rule, - ecs_rule_var_t *var, - bool *written) +bool entity_is_var( + ecs_entity_t e) { - return most_specific_var(rule, var, written, true); + if (e == EcsThis || e == EcsWildcard || e == EcsAny) { + return true; + } + return false; } - -/* Ensure that an entity variable is written before using it */ static -ecs_rule_var_t* ensure_entity_written( - ecs_rule_t *rule, - ecs_rule_var_t *var, - bool *written) +int finalize_term_identifiers( + const ecs_world_t *world, + ecs_term_t *term, + const char *name) { - if (!var) { - return NULL; + /* By default select subsets for predicates. For example, when the term + * matches "Tree", also include "Oak", "Pine", "Elm". */ + if (term->pred.set.mask == EcsDefaultSet) { + ecs_entity_t e = term_id_entity(world, &term->pred); + + if (e && !ecs_has_id(world, e, EcsFinal)) { + term->pred.set.mask = EcsSelf|EcsSubSet; + } else { + /* If predicate is final, don't search subsets */ + term->pred.set.mask = EcsSelf; + } } - /* Ensure we're working with the most specific version of subj we can get */ - ecs_rule_var_t *evar = ensure_most_specific_var(rule, var, written); + /* By default select supersets for subjects. For example, when an entity has + * (IsA, SpaceShip), also search the components of SpaceShip. */ + if (term->subj.set.mask == EcsDefaultSet) { + ecs_entity_t e = term_id_entity(world, &term->pred); + + /* If the component has the DontInherit tag, use EcsSelf */ + if (!e || !ecs_has_id(world, e, EcsDontInherit)) { + term->subj.set.mask = EcsSelf|EcsSuperSet; + } else { + term->subj.set.mask = EcsSelf; + } + } + + /* By default select self for objects. */ + if (term->obj.set.mask == EcsDefaultSet) { + term->obj.set.mask = EcsSelf; + } + + if (finalize_term_set(world, term, &term->pred, name)) { + return -1; + } + if (finalize_term_set(world, term, &term->subj, name)) { + return -1; + } + if (finalize_term_set(world, term, &term->obj, name)) { + return -1; + } + + if (term->pred.set.mask & EcsNothing) { + term_error(world, term, name, + "invalid Nothing value for predicate set mask"); + return -1; + } - /* The post condition of this function is that there is an entity variable, - * and that it is written. Make sure that the result is an entity */ - ecs_assert(evar != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(evar->kind == EcsRuleVarKindEntity, ECS_INTERNAL_ERROR, NULL); + if (term->obj.set.mask & EcsNothing) { + term_error(world, term, name, + "invalid Nothing value for object set mask"); + return -1; + } - /* Make sure the variable has been written */ - ecs_assert(written[evar->id] == true, ECS_INTERNAL_ERROR, NULL); + if (!(term->subj.set.mask & EcsNothing) && + !term->subj.entity && + term->subj.var == EcsVarIsEntity) + { + term->subj.entity = EcsThis; + } - return evar; + if (entity_is_var(term->pred.entity)) { + term->pred.var = EcsVarIsVariable; + } + if (entity_is_var(term->subj.entity)) { + term->subj.var = EcsVarIsVariable; + } + if (entity_is_var(term->obj.entity)) { + term->obj.var = EcsVarIsVariable; + } + + return 0; } static -ecs_rule_op_t* insert_operation( - ecs_rule_t *rule, - int32_t term_index, - bool *written) +ecs_entity_t entity_from_identifier( + const ecs_term_id_t *identifier) { - ecs_rule_pair_t pair = {0}; - - /* Parse the term's type into a pair. A pair extracts the ids from - * the term, and replaces variables with wildcards which can then - * be matched against actual relationships. A pair retains the - * information about the variables, so that when a match happens, - * the pair can be used to reify the variable. */ - if (term_index != -1) { - ecs_term_t *term = &rule->filter.terms[term_index]; - - pair = term_to_pair(rule, term); - - /* If the pair contains entity variables that have not yet been written, - * insert each instructions in case their tables are known. Variables in - * a pair that are truly unknown will be populated by the operation, - * but an operation should never overwrite an entity variable if the - * corresponding table variable has already been resolved. */ - if (pair.reg_mask & RULE_PAIR_PREDICATE) { - ecs_rule_var_t *pred = &rule->vars[pair.pred.reg]; - pred = get_most_specific_var(rule, pred, written); - pair.pred.reg = pred->id; - } - - if (pair.reg_mask & RULE_PAIR_OBJECT) { - ecs_rule_var_t *obj = &rule->vars[pair.obj.reg]; - obj = get_most_specific_var(rule, obj, written); - pair.obj.reg = obj->id; - } + if (identifier->var == EcsVarDefault) { + return 0; + } else if (identifier->var == EcsVarIsEntity) { + return identifier->entity; + } else if (identifier->var == EcsVarIsVariable) { + return EcsWildcard; } else { - /* Not all operations have a filter (like Each) */ + /* This should've been caught earlier */ + ecs_abort(ECS_INTERNAL_ERROR, NULL); } - - ecs_rule_op_t *op = create_operation(rule); - op->on_pass = rule->operation_count; - op->on_fail = rule->operation_count - 2; - op->frame = rule->frame_count; - op->filter = pair; - - /* Store corresponding signature term so we can correlate and - * store the table columns with signature columns. */ - op->term = term_index; - - return op; } -/* Insert first operation, which is always Input. This creates an entry in - * the register stack for the initial state. */ static -void insert_input( - ecs_rule_t *rule) +int finalize_term_id( + const ecs_world_t *world, + ecs_term_t *term, + const char *name) { - ecs_rule_op_t *op = create_operation(rule); - op->kind = EcsRuleInput; - - /* The first time Input is evaluated it goes to the next/first operation */ - op->on_pass = 1; + ecs_entity_t pred = entity_from_identifier(&term->pred); + ecs_entity_t obj = entity_from_identifier(&term->obj); + ecs_id_t role = term->role; - /* When Input is evaluated with redo = true it will return false, which will - * finish the program as op becomes -1. */ - op->on_fail = -1; + if (ECS_HAS_ROLE(pred, PAIR)) { + if (obj) { + term_error(world, term, name, + "cannot set term.pred to a pair and term.obj at the same time"); + return -1; + } - push_frame(rule); -} + obj = ECS_PAIR_SECOND(pred); + pred = ECS_PAIR_FIRST(pred); -/* Insert last operation, which is always Yield. When the program hits Yield, - * data is returned to the application. */ -static -void insert_yield( - ecs_rule_t *rule) -{ - ecs_rule_op_t *op = create_operation(rule); - op->kind = EcsRuleYield; - op->has_in = true; - op->on_fail = rule->operation_count - 2; - /* Yield can only "fail" since it is the end of the program */ + term->pred.entity = pred; + term->obj.entity = obj; - /* Find variable associated with this. It is possible that the variable - * exists both as a table and as an entity. This can happen when a rule - * first selects a table for this, but then subsequently needs to evaluate - * each entity in that table. In that case the yield instruction should - * return the entity, so look for that first. */ - ecs_rule_var_t *var = find_variable(rule, EcsRuleVarKindEntity, "."); - if (!var) { - var = find_variable(rule, EcsRuleVarKindTable, "."); + if (finalize_term_identifier(world, term, &term->obj, name)) { + return -1; + } } - /* If there is no this, there is nothing to yield. In that case the rule - * simply returns true or false. */ - if (!var) { - op->r_in = UINT8_MAX; + if (!obj && role != ECS_PAIR) { + term->id = pred | role; } else { - op->r_in = var->id; + if (role) { + if (role && role != ECS_PAIR && role != ECS_CASE) { + term_error(world, term, name, "invalid role for pair"); + return -1; + } + + term->role = role; + } else { + term->role = ECS_PAIR; + } + + term->id = term->role | ecs_entity_t_comb(obj, pred); } - op->frame = push_frame(rule); + return 0; } -/* Return superset/subset including the root */ static -void insert_reflexive_set( - ecs_rule_t *rule, - ecs_rule_op_kind_t op_kind, - ecs_rule_var_t *out, - const ecs_rule_pair_t pair, - int32_t c, - bool *written, - bool reflexive) +int populate_from_term_id( + const ecs_world_t *world, + ecs_term_t *term, + const char *name) { - ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_rule_var_t *pred = pair_pred(rule, &pair); - ecs_rule_var_t *obj = pair_obj(rule, &pair); - - int32_t setjmp_lbl = rule->operation_count; - int32_t store_lbl = setjmp_lbl + 1; - int32_t set_lbl = setjmp_lbl + 2; - int32_t next_op = setjmp_lbl + 4; - int32_t prev_op = setjmp_lbl - 1; + ecs_entity_t pred = 0; + ecs_entity_t obj = 0; + ecs_id_t role = term->id & ECS_ROLE_MASK; - /* Insert 4 operations at once, so we don't have to worry about how - * the instruction array reallocs. If operation is not reflexive, we only - * need to insert the set operation. */ - if (reflexive) { - insert_operation(rule, -1, written); - insert_operation(rule, -1, written); - insert_operation(rule, -1, written); + if (!role && term->role) { + role = term->role; + term->id |= role; } - ecs_rule_op_t *op = insert_operation(rule, -1, written); - ecs_rule_op_t *setjmp = &rule->operations[setjmp_lbl]; - ecs_rule_op_t *store = &rule->operations[store_lbl]; - ecs_rule_op_t *set = &rule->operations[set_lbl]; - ecs_rule_op_t *jump = op; - - if (!reflexive) { - set_lbl = setjmp_lbl; - set = op; - setjmp = NULL; - store = NULL; - jump = NULL; - next_op = set_lbl + 1; - prev_op = set_lbl - 1; + if (term->role && term->role != role) { + term_error(world, term, name, "mismatch between term.id & term.role"); + return -1; } - /* The SetJmp operation stores a conditional jump label that either - * points to the Store or *Set operation */ - if (reflexive) { - setjmp->kind = EcsRuleSetJmp; - setjmp->on_pass = store_lbl; - setjmp->on_fail = set_lbl; - } + term->role = role; - /* The Store operation yields the root of the subtree. After yielding, - * this operation will fail and return to SetJmp, which will cause it - * to switch to the *Set operation. */ - if (reflexive) { - store->kind = EcsRuleStore; - store->on_pass = next_op; - store->on_fail = setjmp_lbl; - store->has_in = true; - store->has_out = true; - store->r_out = out->id; - store->term = c; + if (ECS_HAS_ROLE(term->id, PAIR) || ECS_HAS_ROLE(term->id, CASE)) { + pred = ECS_PAIR_FIRST(term->id); + obj = ECS_PAIR_SECOND(term->id); if (!pred) { - store->filter.pred = pair.pred; - } else { - store->filter.pred.reg = pred->id; - store->filter.reg_mask |= RULE_PAIR_PREDICATE; + term_error(world, term, name, "missing predicate in term.id pair"); + return -1; } - - /* If the object of the filter is not a variable, store literal */ if (!obj) { - store->r_in = UINT8_MAX; - store->subject = ecs_get_alive(rule->world, pair.obj.ent); - store->filter.obj = pair.obj; - } else { - store->r_in = obj->id; - store->filter.obj.reg = obj->id; - store->filter.reg_mask |= RULE_PAIR_OBJECT; + if (pred != EcsChildOf) { + term_error(world, term, name, "missing object in term.id pair"); + return -1; + } } - } - - /* This is either a SubSet or SuperSet operation */ - set->kind = op_kind; - set->on_pass = next_op; - set->on_fail = prev_op; - set->has_out = true; - set->r_out = out->id; - set->term = c; - - /* Predicate can be a variable if it's non-final */ - if (!pred) { - set->filter.pred = pair.pred; } else { - set->filter.pred.reg = pred->id; - set->filter.reg_mask |= RULE_PAIR_PREDICATE; + pred = term->id & ECS_COMPONENT_MASK; + if (!pred) { + term_error(world, term, name, "missing predicate in term.id"); + return -1; + } } - if (!obj) { - set->filter.obj = pair.obj; + ecs_entity_t term_pred = entity_from_identifier(&term->pred); + if (term_pred) { + if (term_pred != pred) { + term_error(world, term, name, + "mismatch between term.id and term.pred"); + return -1; + } } else { - set->filter.obj.reg = obj->id; - set->filter.reg_mask |= RULE_PAIR_OBJECT; + term->pred.entity = pred; + if (finalize_term_identifier(world, term, &term->pred, name)) { + return -1; + } } - if (reflexive) { - /* The jump operation jumps to either the store or subset operation, - * depending on whether the store operation already yielded. The - * operation is inserted last, so that the on_fail label of the next - * operation will point to it */ - jump->kind = EcsRuleJump; - - /* The pass/fail labels of the Jump operation are not used, since it - * jumps to a variable location. Instead, the pass label is (ab)used to - * store the label of the SetJmp operation, so that the jump can access - * the label it needs to jump to from the setjmp op_ctx. */ - jump->on_pass = setjmp_lbl; - jump->on_fail = -1; + ecs_entity_t term_obj = entity_from_identifier(&term->obj); + if (term_obj) { + if (ecs_entity_t_lo(term_obj) != obj) { + term_error(world, term, name, + "mismatch between term.id and term.obj"); + return -1; + } + } else { + term->obj.entity = obj; + if (finalize_term_identifier(world, term, &term->obj, name)) { + return -1; + } } - written[out->id] = true; + return 0; } static -ecs_rule_var_t* store_reflexive_set( - ecs_rule_t *rule, - ecs_rule_op_kind_t op_kind, - ecs_rule_pair_t *pair, - bool *written, - bool reflexive, - bool as_entity) +int verify_term_consistency( + const ecs_world_t *world, + const ecs_term_t *term, + const char *name) { - /* Ensure we're using the most specific version of obj */ - ecs_rule_var_t *obj = pair_obj(rule, pair); - if (obj) { - pair->obj.reg = obj->id; - } + ecs_entity_t pred = entity_from_identifier(&term->pred); + ecs_entity_t obj = entity_from_identifier(&term->obj); + ecs_id_t role = term->role; + ecs_id_t id = term->id; + bool wildcard = pred == EcsWildcard || obj == EcsWildcard; - /* The subset operation returns tables */ - ecs_rule_var_kind_t var_kind = EcsRuleVarKindTable; - if (op_kind == EcsSuperSet) { - var_kind = EcsRuleVarKindEntity; + if (obj && (!role || (role != ECS_PAIR && role != ECS_CASE))) { + term_error(world, term, name, + "invalid role for term with pair (expected ECS_PAIR)"); + return -1; } - /* Create anonymous variable for storing the set */ - ecs_rule_var_t *av = create_anonymous_variable(rule, var_kind); - int32_t ave_id = 0, av_id = av->id; - - /* If the variable kind is a table, also create an entity variable as the - * result of the set operation should be returned as an entity */ - if (var_kind == EcsRuleVarKindTable && as_entity) { - create_variable(rule, EcsRuleVarKindEntity, av->name); - av = &rule->vars[av_id]; - ave_id = av_id + 1; + if (role == ECS_CASE && !obj) { + term_error(world, term, name, + "missing object for term with ECS_CASE role"); + return -1; } - /* Generate the operations */ - insert_reflexive_set(rule, op_kind, av, *pair, -1, written, reflexive); - - /* Make sure to return entity variable, and that it is populated */ - if (as_entity) { - return ensure_entity_written(rule, &rule->vars[ave_id], written); - } else { - return &rule->vars[av_id]; + if (!pred) { + term_error(world, term, name, "missing predicate for term"); + return -1; } -} -static -bool is_known( - ecs_rule_var_t *var, - bool *written) -{ - if (!var) { - return true; - } else { - return written[var->id]; + if (role != (id & ECS_ROLE_MASK)) { + term_error(world, term, name, "mismatch between term.role & term.id"); + return -1; } -} -static -bool is_pair_known( - ecs_rule_t *rule, - ecs_rule_pair_t *pair, - bool *written) -{ - ecs_rule_var_t *pred_var = pair_pred(rule, pair); - if (!is_known(pred_var, written) || pair->pred.ent == EcsWildcard) { - return false; + if (obj && !ECS_HAS_ROLE(id, PAIR) && !ECS_HAS_ROLE(id, CASE)) { + term_error(world, term, name, "term has object but id is not a pair"); + return -1; } - ecs_rule_var_t *obj_var = pair_obj(rule, pair); - if (!is_known(obj_var, written) || pair->obj.ent == EcsWildcard) { - return false; + if (ECS_HAS_ROLE(id, PAIR) || ECS_HAS_ROLE(id, CASE)) { + if (!wildcard) { + role = ECS_ROLE_MASK & id; + if (id != (role | ecs_entity_t_comb( + term->obj.entity, term->pred.entity))) + { + char *id_str = ecs_id_str(world, ecs_pair(pred, obj)); + term_error(world, term, name, + "term id does not match pred/obj (%s)", id_str); + ecs_os_free(id_str); + return -1; + } + } + } else if (term->pred.entity != (id & ECS_COMPONENT_MASK)) { + if (!wildcard) { + char *pred_str = ecs_get_fullpath(world, term->pred.entity); + term_error(world, term, name, "term id does not match pred '%s'", + pred_str); + ecs_os_free(pred_str); + return -1; + } } - return true; -} - -static -void set_input_to_subj( - ecs_rule_t *rule, - ecs_rule_op_t *op, - ecs_term_t *term, - ecs_rule_var_t *var) -{ - (void)rule; - - op->has_in = true; - if (!var) { - op->r_in = UINT8_MAX; - op->subject = term->subj.entity; + if (term->pred.var == EcsVarIsEntity) { + const ecs_term_id_t *tsubj = &term->subj; + const ecs_term_id_t *tobj = &term->obj; - /* Invalid entities should have been caught during parsing */ - ecs_assert(ecs_is_valid(rule->world, op->subject), - ECS_INTERNAL_ERROR, NULL); - } else { - op->r_in = var->id; - } -} + if (ecs_term_id_is_set(tsubj) && ecs_term_id_is_set(tobj)) { + if (tsubj->var == tobj->var) { + bool is_same = false; -static -void set_output_to_subj( - ecs_rule_t *rule, - ecs_rule_op_t *op, - ecs_term_t *term, - ecs_rule_var_t *var) -{ - (void)rule; + if (tsubj->var == EcsVarIsEntity) { + is_same = tsubj->entity == tobj->entity; + } else if (tsubj->name && tobj->name) { + is_same = !ecs_os_strcmp(tsubj->name, tobj->name); + } - op->has_out = true; - if (!var) { - op->r_out = UINT8_MAX; - op->subject = term->subj.entity; + if (is_same && ecs_has_id(world, term->pred.entity, EcsAcyclic) + && !ecs_has_id(world, term->pred.entity, EcsReflexive)) + { + char *pred_str = ecs_get_fullpath(world, term->pred.entity); + term_error(world, term, name, "term with acyclic relation" + " '%s' cannot have same subject and object", + pred_str); + ecs_os_free(pred_str); + return -1; + } + } + } + } - /* Invalid entities should have been caught during parsing */ - ecs_assert(ecs_is_valid(rule->world, op->subject), - ECS_INTERNAL_ERROR, NULL); - } else { - op->r_out = var->id; + if (term->subj.set.relation && !term->subj.set.max_depth) { + if (!ecs_has_id(world, term->subj.set.relation, EcsAcyclic)) { + char *r_str = ecs_get_fullpath(world, term->subj.set.relation); + term_error(world, term, name, + "relation '%s' is used with SuperSet/SubSet but is not acyclic", + r_str); + ecs_os_free(r_str); + return -1; + } } -} -static -void insert_select_or_with( - ecs_rule_t *rule, - int32_t c, - ecs_term_t *term, - ecs_rule_var_t *subj, - ecs_rule_pair_t *pair, - bool *written) -{ - ecs_rule_op_t *op; - bool eval_subject_supersets = false; + return 0; +} - /* Find any entity and/or table variables for subject */ - ecs_rule_var_t *tvar = NULL, *evar = to_entity(rule, subj), *var = evar; - if (subj && subj->kind == EcsRuleVarKindTable) { - tvar = subj; - if (!evar) { - var = tvar; - } +bool ecs_identifier_is_0( + const char *id) +{ + return id[0] == '0' && !id[1]; +} + +const char* ecs_identifier_is_var( + const char *id) +{ + if (!id) { + return NULL; } - int32_t lbl_start = rule->operation_count; - ecs_rule_pair_t filter; - if (pair) { - filter = *pair; - } else { - filter = term_to_pair(rule, term); + /* Variable identifiers cannot start with a number */ + if (isdigit(id[0])) { + return NULL; } - /* Only insert implicit IsA if filter isn't already an IsA */ - if (!filter.transitive || filter.pred.ent != EcsIsA) { - if (!var) { - ecs_rule_pair_t isa_pair = { - .pred.ent = EcsIsA, - .obj.ent = term->subj.entity - }; + /* Identifiers that start with _ are variables */ + if (id[0] == '_' && id[1] != 0) { + return &id[1]; + } - evar = subj = store_reflexive_set(rule, EcsRuleSuperSet, &isa_pair, - written, true, true); - tvar = NULL; - eval_subject_supersets = true; + return NULL; +} - } else if (ecs_id_is_wildcard(term->id)) { - ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); +bool ecs_id_match( + ecs_id_t id, + ecs_id_t pattern) +{ + if (id == pattern) { + return true; + } - op = insert_operation(rule, -1, written); + if (ECS_HAS_ROLE(pattern, PAIR)) { + if (!ECS_HAS_ROLE(id, PAIR)) { + return false; + } - if (!is_known(subj, written)) { - op->kind = EcsRuleSelect; - set_output_to_subj(rule, op, term, subj); - written[subj->id] = true; - } else { - op->kind = EcsRuleWith; - set_input_to_subj(rule, op, term, subj); - } + ecs_entity_t id_rel = ECS_PAIR_FIRST(id); + ecs_entity_t id_obj = ECS_PAIR_SECOND(id); + ecs_entity_t pattern_rel = ECS_PAIR_FIRST(pattern); + ecs_entity_t pattern_obj = ECS_PAIR_SECOND(pattern); - ecs_rule_pair_t isa_pair = { - .pred.ent = EcsIsA, - .obj.reg = subj->id, - .reg_mask = RULE_PAIR_OBJECT - }; + ecs_check(id_rel != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(id_obj != 0, ECS_INVALID_PARAMETER, NULL); - op->filter = filter; - if (op->filter.reg_mask & RULE_PAIR_PREDICATE) { - op->filter.pred.ent = EcsWildcard; + ecs_check(pattern_rel != 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(pattern_obj != 0, ECS_INVALID_PARAMETER, NULL); + + if (pattern_rel == EcsWildcard) { + if (pattern_obj == EcsWildcard || pattern_obj == id_obj) { + return true; } - if (op->filter.reg_mask & RULE_PAIR_OBJECT) { - op->filter.obj.ent = EcsWildcard; + } else if (pattern_obj == EcsWildcard) { + if (pattern_rel == id_rel) { + return true; } - op->filter.reg_mask = 0; - - push_frame(rule); - - tvar = subj = store_reflexive_set(rule, EcsRuleSuperSet, &isa_pair, - written, true, false); - - evar = NULL; } - } - - /* If no pair is provided, create operation from specified term */ - if (!pair) { - op = insert_operation(rule, c, written); - - /* If an explicit pair is provided, override the default one from the - * term. This allows for using a predicate or object variable different - * from what is in the term. One application of this is to substitute a - * predicate with its subsets, if it is non final */ } else { - op = insert_operation(rule, -1, written); - op->filter = *pair; + if ((id & ECS_ROLE_MASK) != (pattern & ECS_ROLE_MASK)) { + return false; + } - /* Assign the term id, so that the operation will still be correctly - * associated with the correct expression term. */ - op->term = c; + if ((ECS_COMPONENT_MASK & pattern) == EcsWildcard) { + return true; + } } - /* If entity variable is known and resolved, create with for it */ - if (evar && is_known(evar, written)) { - op->kind = EcsRuleWith; - op->r_in = evar->id; - set_input_to_subj(rule, op, term, subj); +error: + return false; +} - /* If table variable is known and resolved, create with for it */ - } else if (tvar && is_known(tvar, written)) { - op->kind = EcsRuleWith; - op->r_in = tvar->id; - set_input_to_subj(rule, op, term, subj); +bool ecs_id_is_pair( + ecs_id_t id) +{ + return ECS_HAS_ROLE(id, PAIR); +} - /* If subject is neither table nor entitiy, with operates on literal */ - } else if (!tvar && !evar) { - op->kind = EcsRuleWith; - set_input_to_subj(rule, op, term, subj); +bool ecs_id_is_wildcard( + ecs_id_t id) +{ + return + (id == EcsWildcard) || (ECS_HAS_ROLE(id, PAIR) && ( + (ECS_PAIR_FIRST(id) == EcsWildcard) || + (ECS_PAIR_SECOND(id) == EcsWildcard) + )); +} - /* If subject is table or entity but not known, use select */ - } else { - ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); - op->kind = EcsRuleSelect; - set_output_to_subj(rule, op, term, subj); - written[subj->id] = true; - } +bool ecs_term_id_is_set( + const ecs_term_id_t *id) +{ + return id->entity != 0 || id->name != NULL; +} - /* If supersets of subject are being evaluated, and we're looking for a - * specific filter, stop as soon as the filter has been matched. */ - if (eval_subject_supersets && is_pair_known(rule, &op->filter, written)) { - op = insert_operation(rule, -1, written); +bool ecs_term_is_initialized( + const ecs_term_t *term) +{ + return term->id != 0 || ecs_term_id_is_set(&term->pred); +} - /* When the next operation returns, it will first hit SetJmp with a redo - * which will switch the jump label to the previous operation */ - op->kind = EcsRuleSetJmp; - op->on_pass = rule->operation_count; - op->on_fail = lbl_start - 1; +bool ecs_term_is_trivial( + const ecs_term_t *term) +{ + if (term->inout != EcsInOutDefault) { + return false; } - if (op->filter.reg_mask & RULE_PAIR_PREDICATE) { - written[op->filter.pred.reg] = true; + if (term->subj.entity != EcsThis) { + return false; } - if (op->filter.reg_mask & RULE_PAIR_OBJECT) { - written[op->filter.obj.reg] = true; + if (term->subj.set.mask && (term->subj.set.mask != EcsSelf)) { + return false; } -} - -static -void prepare_predicate( - ecs_rule_t *rule, - ecs_rule_pair_t *pair, - int32_t term, - bool *written) -{ - /* If pair is not final, resolve term for all IsA relationships of the - * predicate. Note that if the pair has final set to true, it is guaranteed - * that the predicate can be used in an IsA query */ - if (!pair->final) { - ecs_rule_pair_t isa_pair = { - .pred.ent = EcsIsA, - .obj.ent = pair->pred.ent - }; - ecs_rule_var_t *pred = store_reflexive_set(rule, EcsRuleSubSet, - &isa_pair, written, true, true); - - pair->pred.reg = pred->id; - pair->reg_mask |= RULE_PAIR_PREDICATE; + if (term->oper != EcsAnd && term->oper != EcsAndFrom) { + return false; + } - if (term != -1) { - rule->term_vars[term].pred = pred->id; - } + if (term->name != NULL) { + return false; } + + return true; } -static -void insert_term_2( - ecs_rule_t *rule, - ecs_term_t *term, - ecs_rule_pair_t *filter, - int32_t c, - bool *written) +int ecs_term_finalize( + const ecs_world_t *world, + const char *name, + ecs_term_t *term) { - int32_t subj_id = -1, obj_id = -1; - ecs_rule_var_t *subj = term_subj(rule, term); - if ((subj = get_most_specific_var(rule, subj, written))) { - subj_id = subj->id; + if (finalize_term_vars(world, term, name)) { + return -1; } - ecs_rule_var_t *obj = term_obj(rule, term); - if ((obj = get_most_specific_var(rule, obj, written))) { - obj_id = obj->id; + if (!term->id) { + if (finalize_term_id(world, term, name)) { + return -1; + } + } else { + if (populate_from_term_id(world, term, name)) { + return -1; + } } - bool subj_known = is_known(subj, written); - bool same_obj_subj = false; - if (subj && obj) { - same_obj_subj = !ecs_os_strcmp(subj->name, obj->name); + if (finalize_term_identifiers(world, term, name)) { + return -1; } - if (!filter->transitive) { - insert_select_or_with(rule, c, term, subj, filter, written); - if (subj) subj = &rule->vars[subj_id]; - if (obj) obj = &rule->vars[obj_id]; + if (!term_can_inherit(term)) { + if (term->subj.set.relation == EcsIsA) { + term->subj.set.relation = 0; + term->subj.set.mask = EcsSelf; + } + } - } else if (filter->transitive) { - if (subj_known) { - if (is_known(obj, written)) { - if (filter->obj.ent != EcsWildcard) { - ecs_rule_var_t *obj_subsets = store_reflexive_set( - rule, EcsRuleSubSet, filter, written, true, true); + if (term->role == ECS_AND || term->role == ECS_OR || term->role == ECS_NOT){ + /* AND/OR terms match >1 component, which is only valid as filter */ + if (term->inout != EcsInOutDefault && term->inout != EcsInOutFilter) { + term_error(world, term, name, "AND/OR terms must be filters"); + return -1; + } - if (subj) { - subj = &rule->vars[subj_id]; - } + term->inout = EcsInOutFilter; - rule->term_vars[c].obj = obj_subsets->id; + /* Translate role to operator */ + if (term->role == ECS_AND) { + term->oper = EcsAndFrom; + } else + if (term->role == ECS_OR) { + term->oper = EcsOrFrom; + } else + if (term->role == ECS_NOT) { + term->oper = EcsNotFrom; + } - ecs_rule_pair_t pair = *filter; - pair.obj.reg = obj_subsets->id; - pair.reg_mask |= RULE_PAIR_OBJECT; + /* Zero out role & strip from id */ + term->id &= ECS_COMPONENT_MASK; + term->role = 0; + } - insert_select_or_with(rule, c, term, subj, &pair, written); - } else { - insert_select_or_with(rule, c, term, subj, filter, written); - } - } else { - ecs_assert(obj != NULL, ECS_INTERNAL_ERROR, NULL); + if (verify_term_consistency(world, term, name)) { + return -1; + } - /* If subject is literal, find supersets for subject */ - if (subj == NULL || subj->kind == EcsRuleVarKindEntity) { - obj = to_entity(rule, obj); + return 0; +} - ecs_rule_pair_t set_pair = *filter; - set_pair.reg_mask &= RULE_PAIR_PREDICATE; +ecs_term_t ecs_term_copy( + const ecs_term_t *src) +{ + ecs_term_t dst = *src; + dst.name = ecs_os_strdup(src->name); + dst.pred.name = ecs_os_strdup(src->pred.name); + dst.subj.name = ecs_os_strdup(src->subj.name); + dst.obj.name = ecs_os_strdup(src->obj.name); + return dst; +} - if (subj) { - set_pair.obj.reg = subj->id; - set_pair.reg_mask |= RULE_PAIR_OBJECT; - } else { - set_pair.obj.ent = term->subj.entity; - } +ecs_term_t ecs_term_move( + ecs_term_t *src) +{ + if (src->move) { + ecs_term_t dst = *src; + src->name = NULL; + src->pred.name = NULL; + src->subj.name = NULL; + src->obj.name = NULL; + dst.move = false; + return dst; + } else { + ecs_term_t dst = ecs_term_copy(src); + dst.move = false; + return dst; + } +} - insert_reflexive_set(rule, EcsRuleSuperSet, obj, set_pair, - c, written, filter->reflexive); +void ecs_term_fini( + ecs_term_t *term) +{ + ecs_os_free(term->pred.name); + ecs_os_free(term->subj.name); + ecs_os_free(term->obj.name); + ecs_os_free(term->name); - /* If subject is variable, first find matching pair for the - * evaluated entity(s) and return supersets */ - } else { - ecs_rule_var_t *av = create_anonymous_variable( - rule, EcsRuleVarKindEntity); + term->pred.name = NULL; + term->subj.name = NULL; + term->obj.name = NULL; + term->name = NULL; +} - subj = &rule->vars[subj_id]; - obj = &rule->vars[obj_id]; - obj = to_entity(rule, obj); +int ecs_filter_finalize( + const ecs_world_t *world, + ecs_filter_t *f) +{ + int32_t i, term_count = f->term_count, actual_count = 0; + ecs_term_t *terms = f->terms; + bool is_or = false, prev_or = false; + int32_t filter_terms = 0; - ecs_rule_pair_t set_pair = *filter; - set_pair.obj.reg = av->id; - set_pair.reg_mask |= RULE_PAIR_OBJECT; + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; - /* Insert with to find initial object for relation */ - insert_select_or_with( - rule, c, term, subj, &set_pair, written); + if (ecs_term_finalize(world, f->name, term)) { + return -1; + } - push_frame(rule); + is_or = term->oper == EcsOr; + actual_count += !(is_or && prev_or); + term->index = actual_count - 1; + prev_or = is_or; - /* Find supersets for returned initial object. Make sure - * this is always reflexive since it needs to return the - * object from the pair that the entity has itself. */ - insert_reflexive_set(rule, EcsRuleSuperSet, obj, set_pair, - c, written, true); - } + if (term->subj.entity == EcsThis) { + f->match_this = true; + if (term->subj.set.mask != EcsSelf) { + f->match_only_this = false; } - - /* subj is not known */ } else { - ecs_assert(subj != NULL, ECS_INTERNAL_ERROR, NULL); + f->match_only_this = false; + } - if (is_known(obj, written)) { - ecs_rule_pair_t set_pair = *filter; - set_pair.reg_mask &= RULE_PAIR_PREDICATE; /* clear object mask */ + if (term->id == EcsPrefab) { + f->match_prefab = true; + } + if (term->id == EcsDisabled) { + f->match_disabled = true; + } - if (obj) { - set_pair.obj.reg = obj->id; - set_pair.reg_mask |= RULE_PAIR_OBJECT; - } else { - set_pair.obj.ent = term->obj.entity; - } + if (f->filter) { + term->inout = EcsInOutFilter; + } - if (obj) { - rule->term_vars[c].obj = obj->id; - } else { - ecs_rule_var_t *av = create_anonymous_variable(rule, - EcsRuleVarKindEntity); - rule->term_vars[c].obj = av->id; - written[av->id] = true; - } + if (term->inout == EcsInOutFilter) { + filter_terms ++; + } - insert_reflexive_set(rule, EcsRuleSubSet, subj, set_pair, c, - written, filter->reflexive); - } else if (subj == obj) { - insert_select_or_with(rule, c, term, subj, filter, written); - } else { - ecs_assert(obj != NULL, ECS_INTERNAL_ERROR, NULL); + if (term->oper != EcsNot || term->subj.entity != EcsThis) { + f->match_anything = false; + } + } - ecs_rule_var_t *av = NULL; - if (!filter->reflexive) { - av = create_anonymous_variable(rule, EcsRuleVarKindEntity); - } + f->term_count_actual = actual_count; - subj = &rule->vars[subj_id]; - obj = &rule->vars[obj_id]; - obj = to_entity(rule, obj); + if (filter_terms == term_count) { + f->filter = true; + } - /* Insert instruction to find all subjects and objects */ - ecs_rule_op_t *op = insert_operation(rule, -1, written); - op->kind = EcsRuleSelect; - set_output_to_subj(rule, op, term, subj); - op->filter.pred = filter->pred; + return 0; +} - if (filter->reflexive) { - op->filter.obj.ent = EcsWildcard; - op->filter.reg_mask = filter->reg_mask & RULE_PAIR_PREDICATE; - } else { - op->filter.obj.reg = av->id; - op->filter.reg_mask = filter->reg_mask | RULE_PAIR_OBJECT; - written[av->id] = true; - } +/* Implementation for iterable mixin */ +static +void filter_iter_init( + const ecs_world_t *world, + const ecs_poly_t *poly, + ecs_iter_t *iter, + ecs_term_t *filter) +{ + ecs_poly_assert(poly, ecs_filter_t); - written[subj->id] = true; + if (filter) { + iter[1] = ecs_filter_iter(world, (ecs_filter_t*)poly); + iter[0] = ecs_term_chain_iter(&iter[1], filter); + } else { + iter[0] = ecs_filter_iter(world, (ecs_filter_t*)poly); + } +} - /* Create new frame for operations that create reflexive set */ - push_frame(rule); +int ecs_filter_init( + const ecs_world_t *stage, + ecs_filter_t *filter_out, + const ecs_filter_desc_t *desc) +{ + ecs_filter_t f; + ecs_poly_init(&f, ecs_filter_t); - /* Insert superset instruction to find all supersets */ - if (filter->reflexive) { - subj = ensure_most_specific_var(rule, subj, written); - ecs_assert(subj->kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(written[subj->id] == true, - ECS_INTERNAL_ERROR, NULL); + ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(filter_out != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); + + const ecs_world_t *world = ecs_get_world(stage); + + int i, term_count = 0; + ecs_term_t *terms = desc->terms_buffer; + const char *name = desc->name; + const char *expr = desc->expr; - ecs_rule_pair_t super_filter = {0}; - super_filter.pred = filter->pred; - super_filter.obj.reg = subj->id; - super_filter.reg_mask = filter->reg_mask | RULE_PAIR_OBJECT; + /* Temporarily set the fields to the values provided in desc, until the + * filter has been validated. */ + f.name = (char*)name; + f.expr = (char*)expr; + f.filter = desc->filter; + f.instanced = desc->instanced; + f.match_empty_tables = desc->match_empty_tables; + f.match_anything = true; - insert_reflexive_set(rule, EcsRuleSuperSet, obj, - super_filter, c, written, true); - } else { - insert_reflexive_set(rule, EcsRuleSuperSet, obj, - op->filter, c, written, true); - } + if (terms) { + term_count = desc->terms_buffer_count; + } else { + terms = (ecs_term_t*)desc->terms; + for (i = 0; i < ECS_TERM_DESC_CACHE_SIZE; i ++) { + if (!ecs_term_is_initialized(&terms[i])) { + break; } + + term_count ++; } } - if (same_obj_subj) { - /* Can't have relation with same variables that is acyclic and not - * reflexive, this should've been caught earlier. */ - ecs_assert(!filter->acyclic || filter->reflexive, - ECS_INTERNAL_ERROR, NULL); + /* Temporarily set array from desc to filter, until the filter has been + * validated. */ + f.terms = terms; + f.term_count = term_count; - /* If relation is reflexive and entity has an instance of R, no checks - * are needed because R(X, X) is always true. */ - if (!filter->reflexive) { - push_frame(rule); + if (expr) { +#ifdef FLECS_PARSER + int32_t buffer_count = 0; - /* Insert check if the (R, X) pair that was found matches with one - * of the entities in the table with the pair. */ - ecs_rule_op_t *op = insert_operation(rule, -1, written); - obj = get_most_specific_var(rule, obj, written); - ecs_assert(obj->kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(written[subj->id] == true, ECS_INTERNAL_ERROR, NULL); - ecs_assert(written[obj->id] == true, ECS_INTERNAL_ERROR, NULL); + /* If terms have already been set, copy buffer to allocated one */ + if (terms && term_count) { + terms = ecs_os_memdup(terms, term_count * ECS_SIZEOF(ecs_term_t)); + buffer_count = term_count; + } else { + terms = NULL; + } + + /* Parse expression into array of terms */ + const char *ptr = desc->expr; + ecs_term_t term = {0}; + while (ptr[0] && (ptr = ecs_parse_term(world, name, expr, ptr, &term))){ + if (!ecs_term_is_initialized(&term)) { + break; + } - set_input_to_subj(rule, op, term, subj); - op->filter.obj.reg = obj->id; - op->filter.reg_mask = RULE_PAIR_OBJECT; + if (term_count == buffer_count) { + buffer_count = buffer_count ? buffer_count * 2 : 8; + terms = ecs_os_realloc(terms, + buffer_count * ECS_SIZEOF(ecs_term_t)); + } - if (subj->kind == EcsRuleVarKindTable) { - op->kind = EcsRuleInTable; - } else { - op->kind = EcsRuleEq; + /* Check for identifiers that have a name that starts with _. If the + * variable kind is left to Default, the kind should be set to + * variable and the _ prefix should be removed. */ + finalize_term_vars(world, &term, name); + + terms[term_count] = term; + term_count ++; + + if (ptr[0] == '\n') { + break; } } + + f.terms = terms; + f.term_count = term_count; + + if (!ptr) { + goto error; + } +#else + ecs_abort(ECS_UNSUPPORTED, "parser addon is not available"); +#endif } -} -static -void insert_term_1( - ecs_rule_t *rule, - ecs_term_t *term, - ecs_rule_pair_t *filter, - int32_t c, - bool *written) -{ - ecs_rule_var_t *subj = term_subj(rule, term); - subj = get_most_specific_var(rule, subj, written); - insert_select_or_with(rule, c, term, subj, filter, written); -} + /* Copy term resources. */ + if (term_count) { + ecs_term_t *dst_terms = terms; + if (!f.expr) { + if (term_count <= ECS_TERM_CACHE_SIZE) { + dst_terms = f.term_cache; + f.term_cache_used = true; + } else { + dst_terms = ecs_os_malloc_n(ecs_term_t, term_count); + } + } -static -void insert_term( - ecs_rule_t *rule, - ecs_term_t *term, - int32_t c, - bool *written) -{ - bool obj_set = obj_is_set(term); + for (i = 0; i < term_count; i ++) { + dst_terms[i] = ecs_term_move(&terms[i]); + } + f.terms = dst_terms; + } else { + f.terms = NULL; + } - ensure_most_specific_var(rule, term_pred(rule, term), written); - if (obj_set) { - ensure_most_specific_var(rule, term_obj(rule, term), written); + /* Ensure all fields are consistent and properly filled out */ + if (ecs_filter_finalize(world, &f)) { + goto error; } - /* If term has Not operator, prepend Not which turns a fail into a pass */ - int32_t prev = rule->operation_count; - ecs_rule_op_t *not_pre; - if (term->oper == EcsNot) { - not_pre = insert_operation(rule, -1, written); - not_pre->kind = EcsRuleNot; - not_pre->has_in = false; - not_pre->has_out = false; + *filter_out = f; + if (f.term_cache_used) { + filter_out->terms = filter_out->term_cache; } + filter_out->name = ecs_os_strdup(desc->name); + filter_out->expr = ecs_os_strdup(desc->expr); - ecs_rule_pair_t filter = term_to_pair(rule, term); - prepare_predicate(rule, &filter, c, written); + ecs_assert(!filter_out->term_cache_used || + filter_out->terms == filter_out->term_cache, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(filter_out->term_count == f.term_count, + ECS_INTERNAL_ERROR, NULL); - if (subj_is_set(term) && !obj_set) { - insert_term_1(rule, term, &filter, c, written); - } else if (obj_set) { - insert_term_2(rule, term, &filter, c, written); + filter_out->iterable.init = filter_iter_init; + + return 0; +error: + /* NULL members that point to non-owned resources */ + if (!f.expr) { + f.terms = NULL; } - /* If term has Not operator, append Not which turns a pass into a fail */ - if (term->oper == EcsNot) { - ecs_rule_op_t *not_post = insert_operation(rule, -1, written); - not_post->kind = EcsRuleNot; - not_post->has_in = false; - not_post->has_out = false; + f.name = NULL; + f.expr = NULL; - not_post->on_pass = prev - 1; - not_post->on_fail = prev - 1; - not_pre = &rule->operations[prev]; - not_pre->on_fail = rule->operation_count; - } + ecs_filter_fini(&f); - if (term->oper == EcsOptional) { - /* Insert Not instruction that ensures that the optional term is only - * executed once */ - ecs_rule_op_t *jump = insert_operation(rule, -1, written); - jump->kind = EcsRuleNot; - jump->has_in = false; - jump->has_out = false; - jump->on_pass = rule->operation_count; - jump->on_fail = prev - 1; + return -1; +} - /* Find exit instruction for optional term, and make the fail label - * point to the Not operation, so that even when the operation fails, - * it won't discard the result */ - int i, min_fail = -1, exit_op = -1; - for (i = prev; i < rule->operation_count; i ++) { - ecs_rule_op_t *op = &rule->operations[i]; - if (min_fail == -1 || (op->on_fail >= 0 && op->on_fail < min_fail)){ - min_fail = op->on_fail; - exit_op = i; - } +void ecs_filter_copy( + ecs_filter_t *dst, + const ecs_filter_t *src) +{ + if (src) { + *dst = *src; + + int32_t term_count = src->term_count; + + if (src->term_cache_used) { + dst->terms = dst->term_cache; + } else { + dst->terms = ecs_os_memdup_n(src->terms, ecs_term_t, term_count); } - ecs_assert(exit_op != -1, ECS_INTERNAL_ERROR, NULL); - ecs_rule_op_t *op = &rule->operations[exit_op]; - op->on_fail = rule->operation_count - 1; + int i; + for (i = 0; i < term_count; i ++) { + dst->terms[i] = ecs_term_copy(&src->terms[i]); + } + } else { + ecs_os_memset_t(dst, 0, ecs_filter_t); } - - push_frame(rule); } -/* Create program from operations that will execute the query */ -static -void compile_program( - ecs_rule_t *rule) +void ecs_filter_move( + ecs_filter_t *dst, + ecs_filter_t *src) { - /* Trace which variables have been written while inserting instructions. - * This determines which instruction needs to be inserted */ - bool written[ECS_RULE_MAX_VAR_COUNT] = { false }; - - ecs_term_t *terms = rule->filter.terms; - int32_t v, c, term_count = rule->filter.term_count; - ecs_rule_op_t *op; - - /* Insert input, which is always the first instruction */ - insert_input(rule); + if (src) { + *dst = *src; - /* First insert all instructions that do not have a variable subject. Such - * instructions iterate the type of an entity literal and are usually good - * candidates for quickly narrowing down the set of potential results. */ - for (c = 0; c < term_count; c ++) { - ecs_term_t *term = &terms[c]; - if (skip_term(term)) { - continue; + if (src->term_cache_used) { + dst->terms = dst->term_cache; } - if (term->oper == EcsOptional) { - continue; + if (dst != src) { + src->terms = NULL; + src->term_count = 0; } + } else { + ecs_os_memset_t(dst, 0, ecs_filter_t); + } +} - ecs_rule_var_t* subj = term_subj(rule, term); - if (subj) { - continue; +void ecs_filter_fini( + ecs_filter_t *filter) +{ + if (filter->terms) { + int i, count = filter->term_count; + for (i = 0; i < count; i ++) { + ecs_term_fini(&filter->terms[i]); } - insert_term(rule, term, c, written); + if (!filter->term_cache_used) { + ecs_os_free(filter->terms); + } } - /* Insert variables based on dependency order */ - for (v = 0; v < rule->subj_var_count; v ++) { - ecs_rule_var_t *var = &rule->vars[v]; + ecs_os_free(filter->name); + ecs_os_free(filter->expr); - ecs_assert(var->kind == EcsRuleVarKindTable, ECS_INTERNAL_ERROR, NULL); + filter->terms = NULL; + filter->name = NULL; + filter->expr = NULL; +} - for (c = 0; c < term_count; c ++) { - ecs_term_t *term = &terms[c]; - if (skip_term(term)) { - continue; - } +static +void filter_str_add_id( + const ecs_world_t *world, + ecs_strbuf_t *buf, + const ecs_term_id_t *id, + bool is_subject, + uint8_t default_set_mask) +{ + if (id->name) { + ecs_strbuf_appendstr(buf, id->name); + } else if (id->entity) { + bool id_added = false; + if (!is_subject || id->entity != EcsThis) { + char *path = ecs_get_fullpath(world, id->entity); + ecs_strbuf_appendstr(buf, path); + ecs_os_free(path); + id_added = true; + } - if (term->oper == EcsOptional) { - continue; + if (id->set.mask != default_set_mask) { + if (id_added) { + ecs_strbuf_list_push(buf, ":", "|"); + } else { + ecs_strbuf_list_push(buf, "", "|"); } - - /* Only process columns for which variable is subject */ - ecs_rule_var_t* subj = term_subj(rule, term); - if (subj != var) { - continue; + if (id->set.mask & EcsSelf) { + ecs_strbuf_list_appendstr(buf, "self"); + } + if (id->set.mask & EcsSuperSet) { + ecs_strbuf_list_appendstr(buf, "superset"); + } + if (id->set.mask & EcsSubSet) { + ecs_strbuf_list_appendstr(buf, "subset"); } - insert_term(rule, term, c, written); + if (id->set.relation != EcsIsA) { + ecs_strbuf_list_push(buf, "(", ""); - var = &rule->vars[v]; + char *rel_path = ecs_get_fullpath(world, id->set.relation); + ecs_strbuf_appendstr(buf, rel_path); + ecs_os_free(rel_path); + + ecs_strbuf_list_pop(buf, ")"); + } + + ecs_strbuf_list_pop(buf, ""); } + } else { + ecs_strbuf_appendstr(buf, "0"); } +} - /* Insert terms with Not operators */ - for (c = 0; c < term_count; c ++) { - ecs_term_t *term = &terms[c]; - if (term->oper != EcsNot) { - continue; - } +static +void term_str_w_strbuf( + const ecs_world_t *world, + const ecs_term_t *term, + ecs_strbuf_t *buf) +{ + const ecs_term_id_t *subj = &term->subj; + const ecs_term_id_t *obj = &term->obj; - insert_term(rule, term, c, written); + const uint8_t def_pred_mask = EcsSelf|EcsSubSet; + const uint8_t def_subj_mask = EcsSelf|EcsSuperSet; + const uint8_t def_obj_mask = EcsSelf; + + bool pred_set = ecs_term_id_is_set(&term->pred); + bool subj_set = ecs_term_id_is_set(subj); + bool obj_set = ecs_term_id_is_set(obj); + + if (term->role && term->role != ECS_PAIR) { + ecs_strbuf_appendstr(buf, ecs_role_str(term->role)); + ecs_strbuf_appendstr(buf, " "); } - /* Insert terms with Optional operators last, as optional terms cannot - * eliminate results, and would just add overhead to evaluation of - * non-matching entities. */ - for (c = 0; c < term_count; c ++) { - ecs_term_t *term = &terms[c]; - if (term->oper != EcsOptional) { - continue; - } - - insert_term(rule, term, c, written); + if (term->oper == EcsNot) { + ecs_strbuf_appendstr(buf, "!"); + } else if (term->oper == EcsOptional) { + ecs_strbuf_appendstr(buf, "?"); } - /* Verify all subject variables have been written. Subject variables are of - * the table type, and a select/subset should have been inserted for each */ - for (v = 0; v < rule->subj_var_count; v ++) { - if (!written[v]) { - /* If the table variable hasn't been written, this can only happen - * if an instruction wrote the variable before a select/subset could - * have been inserted for it. Make sure that this is the case by - * testing if an entity variable exists and whether it has been - * written. */ - ecs_rule_var_t *var = find_variable( - rule, EcsRuleVarKindEntity, rule->vars[v].name); - ecs_assert(var != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(written[var->id], ECS_INTERNAL_ERROR, var->name); - (void)var; + if (!subj_set) { + filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); + ecs_strbuf_appendstr(buf, "()"); + } else if (subj_set && subj->entity == EcsThis && subj->set.mask == def_subj_mask) + { + if (term->id) { + char *str = ecs_id_str(world, term->id); + ecs_strbuf_appendstr(buf, str); + ecs_os_free(str); + } else if (pred_set) { + filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); + } + } else { + filter_str_add_id(world, buf, &term->pred, false, def_pred_mask); + ecs_strbuf_appendstr(buf, "("); + filter_str_add_id(world, buf, &term->subj, true, def_subj_mask); + if (obj_set) { + ecs_strbuf_appendstr(buf, ","); + filter_str_add_id(world, buf, &term->obj, false, def_obj_mask); } + ecs_strbuf_appendstr(buf, ")"); } +} - /* Make sure that all entity variables are written. With the exception of - * the this variable, which can be returned as a table, other variables need - * to be available as entities. This ensures that all permutations for all - * variables are correctly returned by the iterator. When an entity variable - * hasn't been written yet at this point, it is because it only constrained - * through a common predicate or object. */ - for (; v < rule->var_count; v ++) { - if (!written[v]) { - ecs_rule_var_t *var = &rule->vars[v]; - ecs_assert(var->kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); +char* ecs_term_str( + const ecs_world_t *world, + const ecs_term_t *term) +{ + ecs_strbuf_t buf = ECS_STRBUF_INIT; + term_str_w_strbuf(world, term, &buf); + return ecs_strbuf_get(&buf); +} - ecs_rule_var_t *table_var = find_variable( - rule, EcsRuleVarKindTable, var->name); - - /* A table variable must exist if the variable hasn't been resolved - * yet. If there doesn't exist one, this could indicate an - * unconstrained variable which should have been caught earlier */ - ecs_assert(table_var != NULL, ECS_INTERNAL_ERROR, var->name); +char* ecs_filter_str( + const ecs_world_t *world, + const ecs_filter_t *filter) +{ + ecs_strbuf_t buf = ECS_STRBUF_INIT; - /* Insert each operation that takes the table variable as input, and - * yields each entity in the table */ - op = insert_operation(rule, -1, written); - op->kind = EcsRuleEach; - op->r_in = table_var->id; - op->r_out = var->id; - op->frame = rule->frame_count; - op->has_in = true; - op->has_out = true; - written[var->id] = true; - - push_frame(rule); - } - } + ecs_check(!filter->term_cache_used || filter->terms == filter->term_cache, + ECS_INVALID_PARAMETER, NULL); - /* Insert yield, which is always the last operation */ - insert_yield(rule); -} + ecs_term_t *terms = filter->terms; + int32_t i, count = filter->term_count; + int32_t or_count = 0; -static -void create_variable_name_array( - ecs_rule_t *rule) -{ - if (rule->var_count) { - int i; - for (i = 0; i < rule->var_count; i ++) { - ecs_rule_var_t *var = &rule->vars[i]; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; - if (var->kind != EcsRuleVarKindEntity) { - /* Table variables are hidden for applications. */ - rule->var_names[var->id] = NULL; + if (i) { + if (terms[i - 1].oper == EcsOr && term->oper == EcsOr) { + ecs_strbuf_appendstr(&buf, " || "); } else { - rule->var_names[var->id] = var->name; + ecs_strbuf_appendstr(&buf, ", "); + } + } + + if (term->oper != EcsOr) { + or_count = 0; + } + + if (or_count < 1) { + if (term->inout == EcsIn) { + ecs_strbuf_appendstr(&buf, "[in] "); + } else if (term->inout == EcsInOut) { + ecs_strbuf_appendstr(&buf, "[inout] "); + } else if (term->inout == EcsOut) { + ecs_strbuf_appendstr(&buf, "[out] "); + } else if (term->inout == EcsInOutFilter) { + ecs_strbuf_appendstr(&buf, "[filter] "); } } - } -} -static -void create_variable_cross_references( - ecs_rule_t *rule) -{ - if (rule->var_count) { - int i; - for (i = 0; i < rule->var_count; i ++) { - ecs_rule_var_t *var = &rule->vars[i]; - if (var->kind == EcsRuleVarKindEntity) { - ecs_rule_var_t *tvar = find_variable( - rule, EcsRuleVarKindTable, var->name); - if (tvar) { - var->other = tvar->id; - } else { - var->other = -1; - } - } else { - ecs_rule_var_t *evar = find_variable( - rule, EcsRuleVarKindEntity, var->name); - if (evar) { - var->other = evar->id; - } else { - var->other = -1; - } - } + if (term->oper == EcsOr) { + or_count ++; } + + term_str_w_strbuf(world, term, &buf); } + + return ecs_strbuf_get(&buf); +error: + return NULL; } -/* Implementation for iterable mixin */ static -void rule_iter_init( - const ecs_world_t *world, - const ecs_poly_t *poly, - ecs_iter_t *iter, - ecs_term_t *filter) +ecs_id_t actual_match_id( + ecs_id_t id) { - ecs_poly_assert(poly, ecs_rule_t); - - if (filter) { - iter[1] = ecs_rule_iter(world, (ecs_rule_t*)poly); - iter[0] = ecs_term_chain_iter(&iter[1], filter); - } else { - iter[0] = ecs_rule_iter(world, (ecs_rule_t*)poly); + /* Table types don't store CASE, so replace it with corresponding SWITCH */ + if (ECS_HAS_ROLE(id, CASE)) { + return ECS_SWITCH | ECS_PAIR_FIRST(id); } + + return id; } static -int32_t find_term_var_id( - ecs_rule_t *rule, - ecs_term_id_t *term_id) +bool flecs_n_term_match_table( + ecs_world_t *world, + const ecs_term_t *term, + const ecs_table_t *table, + ecs_type_t type, + ecs_id_t *id_out, + int32_t *column_out, + ecs_entity_t *subject_out, + int32_t *match_index_out, + bool first) { - if (term_id_is_variable(term_id)) { - const char *var_name = term_id_var_name(term_id); - ecs_rule_var_t *var = find_variable( - rule, EcsRuleVarKindEntity, var_name); - if (var) { - return var->id; - } else { - /* If this is Any look for table variable. Since Any is only - * required to return a single result, there is no need to - * insert an each instruction for a matching table. */ - if (term_id->entity == EcsAny) { - var = find_variable( - rule, EcsRuleVarKindTable, var_name); - if (var) { - return var->id; - } - } + (void)column_out; + + ecs_entity_t type_id = term->id; + ecs_oper_kind_t oper = term->oper; + + const EcsType *term_type = ecs_get(world, type_id, EcsType); + ecs_check(term_type != NULL, ECS_INVALID_PARAMETER, NULL); + + ecs_id_t *ids = ecs_vector_first(term_type->normalized->type, ecs_id_t); + int32_t i, count = ecs_vector_count(term_type->normalized->type); + ecs_term_t temp = *term; + temp.oper = EcsAnd; + + for (i = 0; i < count; i ++) { + temp.id = ids[i]; + bool result = flecs_term_match_table(world, &temp, table, type, id_out, + 0, subject_out, match_index_out, first); + if (!result && oper == EcsAndFrom) { + return false; + } else + if (result && oper == EcsOrFrom) { + return true; } } - - return -1; + + if (oper == EcsAndFrom) { + return true; + } else + if (oper == EcsOrFrom) { + return false; + } + +error: + return false; } -ecs_rule_t* ecs_rule_init( +bool flecs_term_match_table( ecs_world_t *world, - const ecs_filter_desc_t *desc) + const ecs_term_t *term, + const ecs_table_t *table, + ecs_type_t type, + ecs_id_t *id_out, + int32_t *column_out, + ecs_entity_t *subject_out, + int32_t *match_index_out, + bool first) { - ecs_rule_t *result = ecs_poly_new(ecs_rule_t); + const ecs_term_id_t *subj = &term->subj; + ecs_oper_kind_t oper = term->oper; + const ecs_table_t *match_table = table; + ecs_type_t match_type = type; + ecs_id_t id = term->id; - /* Parse the signature expression. This initializes the columns array which - * contains the information about which components/pairs are requested. */ - if (ecs_filter_init(world, &result->filter, desc)) { - goto error; + ecs_entity_t subj_entity = subj->entity; + if (!subj_entity) { + id_out[0] = id; /* no source corresponds with Nothing set mask */ + return true; } - result->world = world; - - /* Rule has no terms */ - if (!result->filter.term_count) { - rule_error(result, "rule has no terms"); - goto error; + if (oper == EcsAndFrom || oper == EcsOrFrom) { + return flecs_n_term_match_table(world, term, table, type, id_out, column_out, + subject_out, match_index_out, first); } - ecs_term_t *terms = result->filter.terms; - int32_t i, term_count = result->filter.term_count; - - /* Make sure rule doesn't just have Not terms */ - for (i = 0; i < term_count; i++) { - ecs_term_t *term = &terms[i]; - if (term->oper != EcsNot) { - break; + /* If source is not This, search in table of source */ + if (subj_entity != EcsThis) { + match_table = ecs_get_table(world, subj_entity); + if (match_table) { + match_type = match_table->type; + } else { + return false; } - } - if (i == term_count) { - rule_error(result, "rule cannot only have terms with Not operator"); - goto error; + } else { + /* If filter contains This terms, a table must be provided */ + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); } - /* Find all variables & resolve dependencies */ - if (scan_variables(result) != 0) { - goto error; + if (!match_type) { + return false; } - /* Create lookup array for subject variables */ - for (i = 0; i < term_count; i ++) { - ecs_term_t *term = &terms[i]; - ecs_rule_term_vars_t *vars = &result->term_vars[i]; - vars->pred = find_term_var_id(result, &term->pred); - vars->subj = find_term_var_id(result, &term->subj); - vars->obj = find_term_var_id(result, &term->obj); + ecs_entity_t source = 0; + + /* If first = false, we're searching from an offset. This supports returning + * multiple results when using wildcard filters. */ + int32_t column = 0; + if (!first && column_out && column_out[0] != 0) { + column = column_out[0]; + if (column < 0) { + /* In case column is not from This, flip sign */ + column = -column; + } + + /* Remove base 1 offset */ + column --; } - /* Generate the opcode array */ - compile_program(result); + /* Find location, source and id of match in table type */ + ecs_table_record_t *tr = 0; + column = ecs_search_relation(world, match_table, + column, actual_match_id(id), subj->set.relation, subj->set.min_depth, + subj->set.max_depth, &source, id_out, &tr); - /* Create array with variable names so this can be easily accessed by - * iterators without requiring access to the ecs_rule_t */ - create_variable_name_array(result); + if (tr && match_index_out) { + match_index_out[0] = tr->count; + } - /* Create cross-references between variables so it's easy to go from entity - * to table variable and vice versa */ - create_variable_cross_references(result); + bool result = column != -1; - result->iterable.init = rule_iter_init; + if (oper == EcsNot) { + if (match_index_out) { + match_index_out[0] = 1; + } + result = !result; + } - return result; -error: - ecs_rule_fini(result); - return NULL; -} + if (oper == EcsOptional) { + result = true; + } -void ecs_rule_fini( - ecs_rule_t *rule) -{ - int32_t i; - for (i = 0; i < rule->var_count; i ++) { - ecs_os_free(rule->vars[i].name); + if (!result) { + return false; } - ecs_filter_fini(&rule->filter); + if (subj_entity != EcsThis) { + if (!source) { + source = subj_entity; + } + } - ecs_os_free(rule->operations); - ecs_os_free(rule); -} + if (id_out && column < 0) { + id_out[0] = id; + } -const ecs_filter_t* ecs_rule_get_filter( - const ecs_rule_t *rule) -{ - return &rule->filter; -} + if (column_out) { + if (column >= 0) { + column ++; + if (source != 0) { + column *= -1; + } + column_out[0] = column; + } else { + column_out[0] = 0; + } + } -/* Quick convenience function to get a variable from an id */ -static -ecs_rule_var_t* get_variable( - const ecs_rule_t *rule, - int32_t var_id) -{ - if (var_id == UINT8_MAX) { - return NULL; + if (subject_out) { + subject_out[0] = source; } - return (ecs_rule_var_t*)&rule->vars[var_id]; + return result; } -/* Convert the program to a string. This can be useful to analyze how a rule is - * being evaluated. */ -char* ecs_rule_str( - ecs_rule_t *rule) +bool flecs_filter_match_table( + ecs_world_t *world, + const ecs_filter_t *filter, + const ecs_table_t *table, + ecs_id_t *ids, + int32_t *columns, + ecs_entity_t *subjects, + int32_t *match_indices, + int32_t *matches_left, + bool first, + int32_t skip_term) { - ecs_check(rule != NULL, ECS_INVALID_PARAMETER, NULL); - - ecs_world_t *world = rule->world; - ecs_strbuf_t buf = ECS_STRBUF_INIT; - char filter_expr[256]; - - int32_t i, count = rule->operation_count; - for (i = 1; i < count; i ++) { - ecs_rule_op_t *op = &rule->operations[i]; - ecs_rule_pair_t pair = op->filter; - ecs_entity_t pred = pair.pred.ent; - ecs_entity_t obj = pair.obj.ent; - const char *pred_name = NULL, *obj_name = NULL; - char *pred_name_alloc = NULL, *obj_name_alloc = NULL; - - if (pair.reg_mask & RULE_PAIR_PREDICATE) { - ecs_assert(rule->vars != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_rule_var_t *type_var = &rule->vars[pair.pred.reg]; - pred_name = type_var->name; - } else if (pred) { - pred_name_alloc = ecs_get_fullpath(world, ecs_get_alive(world, pred)); - pred_name = pred_name_alloc; - } + ecs_assert(!filter->term_cache_used || filter->terms == filter->term_cache, + ECS_INTERNAL_ERROR, NULL); - if (pair.reg_mask & RULE_PAIR_OBJECT) { - ecs_assert(rule->vars != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_rule_var_t *obj_var = &rule->vars[pair.obj.reg]; - obj_name = obj_var->name; - } else if (obj) { - obj_name_alloc = ecs_get_fullpath(world, ecs_get_alive(world, obj)); - obj_name = obj_name_alloc; - } else if (pair.obj_0) { - obj_name = "0"; - } + ecs_type_t type = NULL; + if (table) { + type = table->type; + } - ecs_strbuf_append(&buf, "%2d: [S:%2d, P:%2d, F:%2d, T:%2d] ", i, - op->frame, op->on_pass, op->on_fail, op->term); + ecs_term_t *terms = filter->terms; + int32_t i, count = filter->term_count; - bool has_filter = false; + bool is_or = false; + bool or_result = false; + int32_t match_count = 1; + if (matches_left) { + match_count = *matches_left; + } - switch(op->kind) { - case EcsRuleSelect: - ecs_strbuf_append(&buf, "select "); - has_filter = true; - break; - case EcsRuleWith: - ecs_strbuf_append(&buf, "with "); - has_filter = true; - break; - case EcsRuleStore: - ecs_strbuf_append(&buf, "store "); - break; - case EcsRuleSuperSet: - ecs_strbuf_append(&buf, "superset "); - has_filter = true; - break; - case EcsRuleSubSet: - ecs_strbuf_append(&buf, "subset "); - has_filter = true; - break; - case EcsRuleEach: - ecs_strbuf_append(&buf, "each "); - break; - case EcsRuleSetJmp: - ecs_strbuf_append(&buf, "setjmp "); - break; - case EcsRuleJump: - ecs_strbuf_append(&buf, "jump "); - break; - case EcsRuleNot: - ecs_strbuf_append(&buf, "not "); - break; - case EcsRuleInTable: - ecs_strbuf_append(&buf, "intable "); - has_filter = true; - break; - case EcsRuleEq: - ecs_strbuf_append(&buf, "eq "); - has_filter = true; - break; - case EcsRuleYield: - ecs_strbuf_append(&buf, "yield "); - break; - default: + for (i = 0; i < count; i ++) { + if (i == skip_term) { continue; } - if (op->has_out) { - ecs_rule_var_t *r_out = get_variable(rule, op->r_out); - if (r_out) { - ecs_strbuf_append(&buf, "O:%s%s ", - r_out->kind == EcsRuleVarKindTable ? "t" : "", - r_out->name); - } else if (op->subject) { - char *subj_path = ecs_get_fullpath(world, op->subject); - ecs_strbuf_append(&buf, "O:%s ", subj_path); - ecs_os_free(subj_path); + ecs_term_t *term = &terms[i]; + ecs_term_id_t *subj = &term->subj; + ecs_oper_kind_t oper = term->oper; + const ecs_table_t *match_table = table; + ecs_type_t match_type = type; + int32_t t_i = term->index; + + if (!is_or && oper == EcsOr) { + is_or = true; + or_result = false; + } else if (is_or && oper != EcsOr) { + if (!or_result) { + return false; } + + is_or = false; } - if (op->has_in) { - ecs_rule_var_t *r_in = get_variable(rule, op->r_in); - if (r_in) { - ecs_strbuf_append(&buf, "I:%s%s ", - r_in->kind == EcsRuleVarKindTable ? "t" : "", - r_in->name); - } - if (op->subject) { - char *subj_path = ecs_get_fullpath(world, op->subject); - ecs_strbuf_append(&buf, "I:%s ", subj_path); - ecs_os_free(subj_path); + ecs_entity_t subj_entity = subj->entity; + if (!subj_entity) { + if (ids) { + ids[t_i] = term->id; } + continue; } - if (has_filter) { - if (!pred_name) { - pred_name = "-"; - } - if (!obj_name && !pair.obj_0) { - ecs_os_sprintf(filter_expr, "(%s)", pred_name); + if (subj_entity != EcsThis) { + match_table = ecs_get_table(world, subj_entity); + if (match_table) { + match_type = match_table->type; } else { - ecs_os_sprintf(filter_expr, "(%s, %s)", pred_name, obj_name); + match_type = NULL; } - ecs_strbuf_append(&buf, "F:%s", filter_expr); - } - - ecs_strbuf_appendstr(&buf, "\n"); - - ecs_os_free(pred_name_alloc); - ecs_os_free(obj_name_alloc); - } - - return ecs_strbuf_get(&buf); -error: - return NULL; -} - -/* Public function that returns number of variables. This enables an application - * to iterate the variables and obtain their values. */ -int32_t ecs_rule_var_count( - const ecs_rule_t *rule) -{ - ecs_assert(rule != NULL, ECS_INTERNAL_ERROR, NULL); - return rule->var_count; -} - -/* Public function to find a variable by name */ -int32_t ecs_rule_find_var( - const ecs_rule_t *rule, - const char *name) -{ - ecs_rule_var_t *v = find_variable(rule, EcsRuleVarKindEntity, name); - if (v) { - return v->id; - } else { - return -1; - } -} - -/* Public function to get the name of a variable. */ -const char* ecs_rule_var_name( - const ecs_rule_t *rule, - int32_t var_id) -{ - return rule->vars[var_id].name; -} - -/* Public function to get the type of a variable. */ -bool ecs_rule_var_is_entity( - const ecs_rule_t *rule, - int32_t var_id) -{ - return rule->vars[var_id].kind == EcsRuleVarKindEntity; -} - -/* Public function to set the value of a variable before iterating. */ -void ecs_rule_set_var( - ecs_iter_t *it, - int32_t var_id, - ecs_entity_t value) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(var_id != -1, ECS_INVALID_PARAMETER, NULL); - ecs_check(value != 0, ECS_INVALID_PARAMETER, NULL); - /* Can't set variable while iterating */ - ecs_check(it->is_valid == false, ECS_INVALID_OPERATION, NULL); - ecs_check(it->next == ecs_rule_next, ECS_INVALID_OPERATION, NULL); + } else { + /* If filter contains This terms, table must be provided */ + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + } - ecs_rule_iter_t *iter = &it->priv.iter.rule; - ecs_check(iter->registers != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t match_index = 0; - const ecs_rule_t *r = iter->rule; - ecs_check(var_id < r->var_count, ECS_INVALID_PARAMETER, NULL); + bool result = flecs_term_match_table(world, term, match_table, + match_type, + ids ? &ids[t_i] : NULL, + columns ? &columns[t_i] : NULL, + subjects ? &subjects[t_i] : NULL, + &match_index, + first); - entity_reg_set(r, iter->registers, var_id, value); + if (is_or) { + or_result |= result; + } else if (!result) { + return false; + } - /* Also set table variable if it exists */ - const ecs_rule_var_t *var = &r->vars[var_id]; - if (var->other != -1) { - const ecs_rule_var_t *tvar = &r->vars[var->other]; - ecs_assert(tvar->kind == EcsRuleVarKindTable, - ECS_INTERNAL_ERROR, NULL); - (void)tvar; - reg_set_entity(r, iter->registers, var->other, value); + if (first && match_index) { + match_count *= match_index; + } + if (match_indices) { + match_indices[t_i] = match_index; + } } -error: - return; + + if (matches_left) { + *matches_left = match_count; + } + + return !is_or || or_result; } static -void ecs_rule_iter_free( - ecs_iter_t *iter) +void term_iter_init_no_data( + ecs_term_iter_t *iter) { - ecs_rule_iter_t *it = &iter->priv.iter.rule; - ecs_os_free(it->registers); - ecs_os_free(it->columns); - ecs_os_free(it->op_ctx); - ecs_os_free(it->variables); - iter->columns = NULL; - it->registers = NULL; - it->columns = NULL; - it->op_ctx = NULL; + iter->term = (ecs_term_t){ .index = -1 }; + iter->self_index = NULL; + iter->index = 0; } -/* Create rule iterator */ -ecs_iter_t ecs_rule_iter( +static +void term_iter_init_wildcard( const ecs_world_t *world, - const ecs_rule_t *rule) + ecs_term_iter_t *iter) { - ecs_assert(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_assert(rule != NULL, ECS_INVALID_PARAMETER, NULL); + iter->term = (ecs_term_t){ .index = -1 }; + iter->self_index = flecs_get_id_record(world, EcsAny); + iter->cur = iter->self_index; + flecs_table_cache_iter(&iter->self_index->cache, &iter->it); + iter->index = 0; +} - ecs_iter_t result = {0}; - int i; +static +void term_iter_init( + const ecs_world_t *world, + ecs_term_t *term, + ecs_term_iter_t *iter, + bool empty_tables) +{ + const ecs_term_id_t *subj = &term->subj; - result.world = (ecs_world_t*)world; - result.real_world = (ecs_world_t*)ecs_get_world(rule->world); + iter->term = *term; - flecs_process_pending_tables(result.real_world); + if (subj->set.mask == EcsDefaultSet || subj->set.mask & EcsSelf) { + iter->self_index = flecs_get_id_record(world, + actual_match_id(term->id)); + } - ecs_rule_iter_t *it = &result.priv.iter.rule; - it->rule = rule; + if (subj->set.mask & EcsSuperSet) { + iter->set_index = flecs_get_id_record(world, + ecs_pair(subj->set.relation, EcsWildcard)); + } - if (rule->operation_count) { - if (rule->var_count) { - it->registers = ecs_os_malloc_n(ecs_rule_reg_t, - rule->operation_count * rule->var_count); + iter->index = 0; - it->variables = ecs_os_malloc_n(ecs_entity_t, rule->var_count); - } - - it->op_ctx = ecs_os_calloc_n(ecs_rule_op_ctx_t, rule->operation_count); + ecs_id_record_t *idr; + if (iter->self_index) { + idr = iter->cur = iter->self_index; + } else { + idr = iter->cur = iter->set_index; + } - if (rule->filter.term_count) { - it->columns = ecs_os_malloc_n(int32_t, - rule->operation_count * rule->filter.term_count); + if (idr) { + if (empty_tables) { + if ((empty_tables = flecs_table_cache_empty_iter( + &idr->cache, &iter->it))) + { + iter->empty_tables = true; + } } - for (i = 0; i < rule->filter.term_count; i ++) { - it->columns[i] = -1; + if (!empty_tables) { + flecs_table_cache_iter(&idr->cache, &iter->it); } + } else { + term_iter_init_no_data(iter); } +} - it->op = 0; +ecs_iter_t ecs_term_iter( + const ecs_world_t *stage, + ecs_term_t *term) +{ + ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(term->id != 0, ECS_INVALID_PARAMETER, NULL); - for (i = 0; i < rule->var_count; i ++) { - if (rule->vars[i].kind == EcsRuleVarKindEntity) { - entity_reg_set(rule, it->registers, i, EcsWildcard); - } else { - table_reg_set(rule, it->registers, i, NULL); - } - } + const ecs_world_t *world = ecs_get_world(stage); - result.variable_names = (char**)rule->var_names; - result.variable_count = rule->var_count; - result.term_count = rule->filter.term_count; - result.terms = rule->filter.terms; - result.next = ecs_rule_next; - result.fini = ecs_rule_iter_free; - result.is_filter = rule->filter.filter; - result.columns = it->columns; /* prevent alloc */ + flecs_process_pending_tables(world); - return result; -} + if (ecs_term_finalize(world, NULL, term)) { + ecs_throw(ECS_INVALID_PARAMETER, NULL); + } -/* Edge case: if the filter has the same variable for both predicate and - * object, they are both resolved at the same time but at the time of - * evaluating the filter they're still wildcards which would match columns - * that have different predicates/objects. Do an additional scan to make - * sure the column we're returning actually matches. */ -static -int32_t find_next_same_var( - ecs_type_t type, - int32_t column, - ecs_id_t pattern) -{ - /* If same_var is true, this has to be a wildcard pair. We cannot have - * the same variable in a pair, and one part of a pair resolved with - * another part unresolved. */ - ecs_assert(pattern == ecs_pair(EcsWildcard, EcsWildcard), - ECS_INTERNAL_ERROR, NULL); - (void)pattern; - - /* Keep scanning for an id where rel and obj are the same */ - ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); - int32_t i, count = ecs_vector_count(type); - for (i = column + 1; i < count; i ++) { - ecs_id_t id = ids[i]; - if (!ECS_HAS_ROLE(id, PAIR)) { - /* If id is not a pair, this will definitely not match, and we - * will find no further matches. */ - return -1; - } + ecs_iter_t it = { + .real_world = (ecs_world_t*)world, + .world = (ecs_world_t*)stage, + .term_count = 1, + .next = ecs_term_next + }; - if (ECS_PAIR_FIRST(id) == ECS_PAIR_SECOND(id)) { - /* Found a match! */ - return i; - } - } + term_iter_init(world, term, &it.priv.iter.term, false); - /* No pairs found with same rel/obj */ - return -1; + return it; +error: + return (ecs_iter_t){ 0 }; } -static -int32_t find_next_column( - const ecs_world_t *world, - const ecs_table_t *table, - int32_t column, - ecs_rule_filter_t *filter) +ecs_iter_t ecs_term_chain_iter( + const ecs_iter_t *chain_it, + ecs_term_t *term) { - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_check(chain_it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_entity_t pattern = filter->mask; - ecs_type_t type = table->type; + ecs_world_t *world = chain_it->real_world; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - if (column == -1) { - ecs_table_record_t *tr = flecs_get_table_record(world, table, pattern); - if (!tr) { - return -1; - } - column = tr->column; - } else { - column = ecs_search_offset(world, table, column + 1, filter->mask, 0); - if (column == -1) { - return -1; - } + if (ecs_term_finalize(world, NULL, term)) { + ecs_throw(ECS_INVALID_PARAMETER, NULL); } - if (filter->same_var) { - column = find_next_same_var(type, column - 1, filter->mask); - } + ecs_iter_t it = { + .real_world = (ecs_world_t*)world, + .world = chain_it->world, + .terms = term, + .term_count = 1, + .chain_it = (ecs_iter_t*)chain_it, + .next = ecs_term_next + }; - return column; + term_iter_init(world, term, &it.priv.iter.term, false); + + return it; +error: + return (ecs_iter_t){ 0 }; } -/* This function finds the next table in a table set, and is used by the select - * operation. The function automatically skips empty tables, so that subsequent - * operations don't waste a lot of processing for nothing. */ static -ecs_table_record_t find_next_table( - ecs_rule_filter_t *filter, - ecs_rule_with_ctx_t *op_ctx) +const ecs_table_record_t *next_table( + ecs_term_iter_t *iter) { - ecs_table_cache_iter_t *it = &op_ctx->it; - ecs_table_t *table = NULL; - int32_t column = -1; + ecs_id_record_t *idr = iter->cur; + if (!idr) { + return NULL; + } const ecs_table_record_t *tr; - while ((column == -1) && (tr = flecs_table_cache_next(it, ecs_table_record_t))) { - table = tr->hdr.table; - - /* Should only iterate non-empty tables */ - ecs_assert(ecs_table_count(table) != 0, ECS_INTERNAL_ERROR, NULL); - - column = tr->column; - if (filter->same_var) { - column = find_next_same_var(table->type, column - 1, filter->mask); + if (!(tr = flecs_table_cache_next(&iter->it, ecs_table_record_t))) { + if (iter->empty_tables) { + iter->empty_tables = false; + flecs_table_cache_iter(&idr->cache, &iter->it); + tr = flecs_table_cache_next(&iter->it, ecs_table_record_t); } } - if (column == -1) { - table = NULL; - } - - return (ecs_table_record_t){.hdr.table = table, .column = column}; + return tr; } - static -ecs_id_record_t* find_tables( +bool term_iter_next( ecs_world_t *world, - ecs_id_t id) + ecs_term_iter_t *iter, + bool match_prefab, + bool match_disabled) { - ecs_id_record_t *idr = flecs_get_id_record(world, id); - if (!idr || !ecs_table_cache_count(&idr->cache)) { - /* Skip ids that don't have (non-empty) tables */ - return NULL; - } - return idr; -} + ecs_table_t *table = iter->table; + ecs_entity_t source = 0; + const ecs_table_record_t *tr; + ecs_term_t *term = &iter->term; -static -ecs_id_t rule_get_column( - ecs_type_t type, - int32_t column) -{ - ecs_id_t *comp = ecs_vector_get(type, ecs_id_t, column); - ecs_assert(comp != NULL, ECS_INTERNAL_ERROR, NULL); - return *comp; -} + do { + if (table) { + iter->cur_match ++; + if (iter->cur_match >= iter->match_count) { + table = NULL; + } else { + iter->last_column = ecs_search_offset( + world, table, iter->last_column + 1, term->id, 0); + iter->column = iter->last_column + 1; + if (iter->last_column >= 0) { + iter->id = ecs_vector_get( + table->type, ecs_id_t, iter->last_column)[0]; + } + } + } -static -void set_source( - ecs_iter_t *it, - ecs_rule_op_t *op, - ecs_rule_reg_t *regs, - int32_t r) -{ - if (op->term == -1) { - /* If operation is not associated with a term, don't set anything */ - return; - } + if (!table) { + if (!(tr = next_table(iter))) { + if (iter->cur != iter->set_index && iter->set_index != NULL) { + iter->cur = iter->set_index; + flecs_table_cache_iter(&iter->set_index->cache, &iter->it); + iter->index = 0; + tr = next_table(iter); + } - ecs_assert(op->term >= 0, ECS_INTERNAL_ERROR, NULL); + if (!tr) { + return false; + } + } - const ecs_rule_t *rule = it->priv.iter.rule.rule; - if ((r != UINT8_MAX) && rule->vars[r].kind == EcsRuleVarKindEntity) { - it->subjects[op->term] = reg_get_entity(rule, op, regs, r); - } else { - it->subjects[op->term] = 0; - } -} + table = tr->hdr.table; -static -void set_term_vars( - const ecs_rule_t *rule, - ecs_rule_reg_t *regs, - int32_t term, - ecs_id_t id) -{ - if (term != -1) { - const ecs_rule_term_vars_t *vars = &rule->term_vars[term]; - if (vars->pred != -1) { - regs[vars->pred].entity = ECS_PAIR_FIRST(id); + if (!match_prefab && (table->flags & EcsTableIsPrefab)) { + continue; + } + + if (!match_disabled && (table->flags & EcsTableIsDisabled)) { + continue; + } + + iter->table = table; + iter->match_count = tr->count; + iter->cur_match = 0; + iter->last_column = tr->column; + iter->column = tr->column + 1; + iter->id = ecs_vector_get(table->type, ecs_id_t, tr->column)[0]; } - if (vars->obj != -1) { - regs[vars->obj].entity = ECS_PAIR_SECOND(id); + + if (iter->cur == iter->set_index) { + const ecs_term_id_t *subj = &term->subj; + + if (iter->self_index) { + if (flecs_id_record_table(iter->self_index, table) != NULL) { + /* If the table has the id itself and this term matched Self + * we already matched it */ + continue; + } + } + + /* Test if following the relation finds the id */ + int32_t index = ecs_search_relation(world, table, 0, + term->id, subj->set.relation, subj->set.min_depth, + subj->set.max_depth, &source, &iter->id, NULL); + + if (index == -1) { + source = 0; + continue; + } + + ecs_assert(source != 0, ECS_INTERNAL_ERROR, NULL); + + iter->column = (index + 1) * -1; } - } + + break; + } while (true); + + iter->subject = source; + + return true; } -/* Input operation. The input operation acts as a placeholder for the start of - * the program, and creates an entry in the register array that can serve to - * store variables passed to an iterator. */ -static -bool eval_input( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +bool ecs_term_next( + ecs_iter_t *it) { - (void)it; - (void)op; - (void)op_index; + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_term_next, ECS_INVALID_PARAMETER, NULL); - if (!redo) { - /* First operation executed by the iterator. Always return true. */ - return true; + ecs_term_iter_t *iter = &it->priv.iter.term; + ecs_term_t *term = &iter->term; + ecs_world_t *world = it->real_world; + ecs_table_t *table; + + it->ids = &iter->id; + it->subjects = &iter->subject; + it->columns = &iter->column; + it->terms = &iter->term; + + if (term->inout != EcsInOutFilter) { + it->sizes = &iter->size; + it->ptrs = &iter->ptr; } else { - /* When Input is asked to redo, it means that all other operations have - * exhausted their results. Input itself does not yield anything, so - * return false. This will terminate rule execution. */ - return false; + it->sizes = NULL; + it->ptrs = NULL; } -} - -static -bool eval_superset( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_world_t *world = rule->world; - ecs_rule_superset_ctx_t *op_ctx = &iter->op_ctx[op_index].is.superset; - ecs_rule_superset_frame_t *frame = NULL; - ecs_rule_reg_t *regs = get_registers(iter, op); - /* Get register indices for output */ - int32_t sp; - int32_t r = op->r_out; + ecs_iter_t *chain_it = it->chain_it; + if (chain_it) { + ecs_iter_next_action_t next = chain_it->next; + bool match; - /* Register cannot be a literal, since we need to store things in it */ - ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); + do { + if (!next(chain_it)) { + goto done; + } - /* Get queried for id, fill out potential variables */ - ecs_rule_pair_t pair = op->filter; + table = chain_it->table; + match = flecs_term_match_table(world, term, table, table->type, + it->ids, it->columns, it->subjects, it->match_indices, true); + } while (!match); + goto yield; - ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); - ecs_entity_t rel = ECS_PAIR_FIRST(filter.mask); - ecs_rule_filter_t super_filter = { - .mask = ecs_pair(rel, EcsWildcard) - }; - ecs_table_t *table = NULL; + } else { + if (!term_iter_next(world, iter, false, false)) { + goto done; + } - /* If the input register is not NULL, this is a variable that's been set by - * the application. */ - ecs_entity_t result = iter->registers[r].entity; - bool output_is_input = result && result != EcsWildcard; + table = iter->table; - if (output_is_input && !redo) { - ecs_assert(regs[r].entity == iter->registers[r].entity, + /* Source must either be 0 (EcsThis) or nonzero in case of substitution */ + ecs_assert(iter->subject || iter->cur != iter->set_index, ECS_INTERNAL_ERROR, NULL); + ecs_assert(iter->table != NULL, ECS_INTERNAL_ERROR, NULL); } - if (!redo) { - op_ctx->stack = op_ctx->storage; - sp = op_ctx->sp = 0; - frame = &op_ctx->stack[sp]; +yield: + flecs_iter_populate_data(world, it, table, 0, 0, it->ptrs, it->sizes); + it->is_valid = true; + return true; +done: +error: + return false; +} - /* Get table of object for which to get supersets */ - ecs_entity_t obj = ECS_PAIR_SECOND(filter.mask); - if (obj == EcsWildcard) { - ecs_assert(pair.reg_mask & RULE_PAIR_OBJECT, - ECS_INTERNAL_ERROR, NULL); - table = regs[pair.obj.reg].table.table; - } else { - table = table_from_entity(world, obj).table; - } +static +const ecs_filter_t* init_filter_iter( + const ecs_world_t *world, + ecs_iter_t *it, + const ecs_filter_t *filter) +{ + ecs_filter_iter_t *iter = &it->priv.iter.filter; - int32_t column; + if (filter) { + iter->filter = *filter; - /* If output variable is already set, check if it matches */ - if (output_is_input) { - ecs_id_t id = ecs_pair(rel, result); - ecs_entity_t subj = 0; - column = ecs_search_relation(world, table, 0, id, rel, - 0, 0, &subj, 0, NULL); - if (column != -1) { - if (subj != 0) { - table = ecs_get_table(world, subj); - } - } - } else { - column = find_next_column(world, table, -1, &super_filter); + if (filter->term_cache_used) { + iter->filter.terms = iter->filter.term_cache; } - /* If no matching column was found, there are no supersets */ - if (column == -1) { - return false; - } + ecs_filter_finalize(world, &iter->filter); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!filter->term_cache_used || + filter->terms == filter->term_cache, ECS_INTERNAL_ERROR, NULL); + } else { + ecs_filter_init(world, &iter->filter, &(ecs_filter_desc_t) { + .terms = {{ .id = EcsAny }} + }); - ecs_entity_t col_entity = rule_get_column(table->type, column); - ecs_entity_t col_obj = ecs_entity_t_lo(col_entity); + filter = &iter->filter; + } - reg_set_entity(rule, regs, r, col_obj); + it->term_count = filter->term_count_actual; - frame->table = table; - frame->column = column; + return filter; +} - return true; - } else if (output_is_input) { - return false; - } +int32_t ecs_filter_pivot_term( + const ecs_world_t *world, + const ecs_filter_t *filter) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(filter != NULL, ECS_INVALID_PARAMETER, NULL); - sp = op_ctx->sp; - frame = &op_ctx->stack[sp]; - table = frame->table; - int32_t column = frame->column; + ecs_term_t *terms = filter->terms; + int32_t i, term_count = filter->term_count; + int32_t pivot_term = -1, min_count = -1; - ecs_entity_t col_entity = rule_get_column(table->type, column); - ecs_entity_t col_obj = ecs_entity_t_lo(col_entity); - ecs_table_t *next_table = table_from_entity(world, col_obj).table; + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_id_t id = term->id; - if (next_table) { - sp ++; - frame = &op_ctx->stack[sp]; - frame->table = next_table; - frame->column = -1; - } + if (term->oper != EcsAnd) { + continue; + } - do { - frame = &op_ctx->stack[sp]; - table = frame->table; - column = frame->column; + if (term->subj.entity != EcsThis) { + continue; + } - column = find_next_column(world, table, column, &super_filter); - if (column != -1) { - op_ctx->sp = sp; - frame->column = column; - col_entity = rule_get_column(table->type, column); - col_obj = ecs_entity_t_lo(col_entity); - reg_set_entity(rule, regs, r, col_obj); - return true; + ecs_id_record_t *idr = flecs_get_id_record(world, + actual_match_id(id)); + if (!idr) { + /* If one of the terms does not match with any data, iterator + * should not return anything */ + return -2; /* -2 indicates filter doesn't match anything */ } - sp --; - } while (sp >= 0); + int32_t table_count = ecs_table_cache_count(&idr->cache); + if (min_count == -1 || table_count < min_count) { + min_count = table_count; + pivot_term = i; + } + } - return false; + return pivot_term; +error: + return -2; } -static -bool eval_subset( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +ecs_iter_t ecs_filter_iter( + const ecs_world_t *stage, + const ecs_filter_t *filter) { - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_world_t *world = rule->world; - ecs_rule_subset_ctx_t *op_ctx = &iter->op_ctx[op_index].is.subset; - ecs_rule_subset_frame_t *frame = NULL; - ecs_table_record_t table_record; - ecs_rule_reg_t *regs = get_registers(iter, op); - - /* Get register indices for output */ - int32_t sp, row; - int32_t r = op->r_out; - ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); + ecs_check(stage != NULL, ECS_INVALID_PARAMETER, NULL); - /* Get queried for id, fill out potential variables */ - ecs_rule_pair_t pair = op->filter; - ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); - ecs_id_record_t *idr; - ecs_table_t *table = NULL; + const ecs_world_t *world = ecs_get_world(stage); + + flecs_process_pending_tables(world); - if (!redo) { - op_ctx->stack = op_ctx->storage; - sp = op_ctx->sp = 0; - frame = &op_ctx->stack[sp]; - idr = frame->with_ctx.idr = find_tables(world, filter.mask); - if (!idr) { - return false; - } + ecs_iter_t it = { + .real_world = (ecs_world_t*)world, + .world = (ecs_world_t*)stage, + .terms = filter ? filter->terms : NULL, + .next = ecs_filter_next, + .is_instanced = filter ? filter->instanced : false + }; - flecs_table_cache_iter(&idr->cache, &frame->with_ctx.it); - table_record = find_next_table(&filter, &frame->with_ctx); - - /* If first table set has no non-empty table, yield nothing */ - if (!table_record.hdr.table) { - return false; - } + ecs_filter_iter_t *iter = &it.priv.iter.filter; - frame->row = 0; - frame->column = table_record.column; - table_reg_set(rule, regs, r, (frame->table = table_record.hdr.table)); - goto yield; - } + filter = init_filter_iter(world, &it, filter); - do { - sp = op_ctx->sp; - frame = &op_ctx->stack[sp]; - table = frame->table; - row = frame->row; + /* Find term that represents smallest superset */ + if (filter->match_this) { + ecs_term_t *terms = filter->terms; + int32_t pivot_term = -1; + ecs_check(terms != NULL, ECS_INVALID_PARAMETER, NULL); - /* If row exceeds number of elements in table, find next table in frame that - * still has entities */ - while ((sp >= 0) && (row >= ecs_table_count(table))) { - table_record = find_next_table(&filter, &frame->with_ctx); + iter->kind = EcsIterEvalIndex; - if (table_record.hdr.table) { - table = frame->table = table_record.hdr.table; - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - frame->row = 0; - frame->column = table_record.column; - table_reg_set(rule, regs, r, table); - goto yield; - } else { - sp = -- op_ctx->sp; - if (sp < 0) { - /* If none of the frames yielded anything, no more data */ - return false; - } - frame = &op_ctx->stack[sp]; - table = frame->table; - idr = frame->with_ctx.idr; - row = ++ frame->row; + pivot_term = ecs_filter_pivot_term(world, filter); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(idr != NULL, ECS_INTERNAL_ERROR, NULL); - } + if (pivot_term == -2) { + /* One or more terms have no matching results */ + term_iter_init_no_data(&iter->term_iter); + return it; + } else if (pivot_term == -1) { + /* No terms meet the criteria to be a pivot term, evaluate filter + * against all tables */ + term_iter_init_wildcard(world, &iter->term_iter); + } else { + ecs_assert(pivot_term >= 0, ECS_INTERNAL_ERROR, NULL); + term_iter_init(world, &terms[pivot_term], &iter->term_iter, + filter->match_empty_tables); } - int32_t row_count = ecs_table_count(table); + iter->term_iter.empty_tables = filter->match_empty_tables; + } else { + if (!filter->match_anything) { + iter->kind = EcsIterEvalCondition; + term_iter_init_no_data(&iter->term_iter); + } else { + iter->kind = EcsIterEvalNone; + } + } - /* Table must have at least row elements */ - ecs_assert(row_count > row, ECS_INTERNAL_ERROR, NULL); + if (filter->terms == filter->term_cache) { + /* Because we're returning the iterator by value, the address of the + * term cache changes. The ecs_filter_next function will set the correct + * address when it detects that terms is set to NULL */ + iter->filter.terms = NULL; + } - ecs_entity_t *entities = ecs_vector_first( - table->storage.entities, ecs_entity_t); - ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); + it.is_filter = filter->filter; - /* The entity used to find the next table set */ - do { - ecs_entity_t e = entities[row]; + return it; +error: + return (ecs_iter_t){ 0 }; +} - /* Create look_for expression with the resolved entity as object */ - pair.reg_mask &= ~RULE_PAIR_OBJECT; /* turn of bit because it's not a reg */ - pair.obj.ent = e; - filter = pair_to_filter(iter, op, pair); +ecs_iter_t ecs_filter_chain_iter( + const ecs_iter_t *chain_it, + const ecs_filter_t *filter) +{ + ecs_iter_t it = { + .terms = filter->terms, + .term_count = filter->term_count, + .world = chain_it->world, + .real_world = chain_it->real_world, + .chain_it = (ecs_iter_t*)chain_it, + .next = ecs_filter_next + }; - /* Find table set for expression */ - table = NULL; - idr = find_tables(world, filter.mask); + ecs_filter_iter_t *iter = &it.priv.iter.filter; + init_filter_iter(it.world, &it, filter); - /* If table set is found, find first non-empty table */ - if (idr) { - ecs_rule_subset_frame_t *new_frame = &op_ctx->stack[sp + 1]; - new_frame->with_ctx.idr = idr; - flecs_table_cache_iter(&idr->cache, &new_frame->with_ctx.it); - table_record = find_next_table(&filter, &new_frame->with_ctx); + iter->kind = EcsIterEvalChain; - /* If set contains non-empty table, push it to stack */ - if (table_record.hdr.table) { - table = table_record.hdr.table; - op_ctx->sp ++; - new_frame->table = table; - new_frame->row = 0; - new_frame->column = table_record.column; - frame = new_frame; - } - } + if (filter->terms == filter->term_cache) { + /* See ecs_filter_iter */ + iter->filter.terms = NULL; + } - /* If no table was found for the current entity, advance row */ - if (!table) { - row = ++ frame->row; - } - } while (!table && row < row_count); - } while (!table); + return it; +} - table_reg_set(rule, regs, r, table); +bool ecs_filter_next( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_filter_next, ECS_INVALID_PARAMETER, NULL); -yield: - set_term_vars(rule, regs, op->term, ecs_vector_get(frame->table->type, - ecs_id_t, frame->column)[0]); + if (flecs_iter_next_row(it)) { + return true; + } - return true; + return flecs_iter_next_instanced(it, ecs_filter_next_instanced(it)); +error: + return false; } -/* Select operation. The select operation finds and iterates a table set that - * corresponds to its pair expression. */ -static -bool eval_select( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +bool ecs_filter_next_instanced( + ecs_iter_t *it) { - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_world_t *world = rule->world; - ecs_rule_with_ctx_t *op_ctx = &iter->op_ctx[op_index].is.with; - ecs_table_record_t table_record; - ecs_rule_reg_t *regs = get_registers(iter, op); - - /* Get register indices for output */ - int32_t r = op->r_out; - ecs_assert(r != UINT8_MAX, ECS_INTERNAL_ERROR, NULL); - - /* Get queried for id, fill out potential variables */ - ecs_rule_pair_t pair = op->filter; - ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); - ecs_entity_t pattern = filter.mask; - int32_t *columns = rule_get_columns(iter, op); + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_filter_next, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->chain_it != it, ECS_INVALID_PARAMETER, NULL); - int32_t column = -1; + ecs_filter_iter_t *iter = &it->priv.iter.filter; + ecs_filter_t *filter = &iter->filter; + ecs_world_t *world = it->real_world; ecs_table_t *table = NULL; - ecs_id_record_t *idr; + bool match; - if (!redo && op->term != -1) { - columns[op->term] = -1; + if (!filter->terms) { + filter->terms = filter->term_cache; } - /* If this is a redo, we already looked up the table set */ - if (redo) { - idr = op_ctx->idr; - - /* If this is not a redo lookup the table set. Even though this may not be - * the first time the operation is evaluated, variables may have changed - * since last time, which could change the table set to lookup. */ - } else { - /* A table set is a set of tables that all contain at least the - * requested look_for expression. What is returned is a table record, - * which in addition to the table also stores the first occurrance at - * which the requested expression occurs in the table. This reduces (and - * in most cases eliminates) any searching that needs to occur in a - * table type. Tables are also registered under wildcards, which is why - * this operation can simply use the look_for variable directly */ + flecs_iter_init(it); - idr = op_ctx->idr = find_tables(world, pattern); - } + ecs_iter_t *chain_it = it->chain_it; + ecs_iter_kind_t kind = iter->kind; - /* If no table set was found for queried for entity, there are no results */ - if (!idr) { - return false; - } + if (chain_it) { + ecs_assert(kind == EcsIterEvalChain, ECS_INVALID_PARAMETER, NULL); + + ecs_iter_next_action_t next = chain_it->next; + do { + if (!next(chain_it)) { + goto done; + } - /* If the input register is not NULL, this is a variable that's been set by - * the application. */ - table = iter->registers[r].table.table; - bool output_is_input = table != NULL; + table = chain_it->table; + match = flecs_filter_match_table(world, filter, table, + it->ids, it->columns, it->subjects, it->match_indices, NULL, + true, -1); + } while (!match); - if (output_is_input && !redo) { - ecs_assert(regs[r].table.table == iter->registers[r].table.table, - ECS_INTERNAL_ERROR, NULL); + goto yield; + } else if (kind == EcsIterEvalIndex || kind == EcsIterEvalCondition) { + ecs_term_iter_t *term_iter = &iter->term_iter; + ecs_term_t *term = &term_iter->term; + int32_t pivot_term = term->index; + bool first; - table = iter->registers[r].table.table; + do { + first = iter->matches_left == 0; - /* Check if table can be found in the id record. If not, the provided - * table does not match with the query. */ - ecs_table_record_t *tr = ecs_table_cache_get(&idr->cache, table); - if (!tr) { - return false; - } + if (first) { + if (kind != EcsIterEvalCondition) { + /* Find new match, starting with the leading term */ + if (!term_iter_next(world, term_iter, + filter->match_prefab, filter->match_disabled)) + { + goto done; + } - column = op_ctx->column = tr->column; - } + ecs_assert(term_iter->match_count != 0, + ECS_INTERNAL_ERROR, NULL); - /* If this is not a redo, start at the beginning */ - if (!redo) { - if (!table) { - flecs_table_cache_iter(&idr->cache, &op_ctx->it); + if (pivot_term == -1) { + /* Without a pivot term, we're iterating all tables with + * a wildcard, so the match count is meaningless. */ + term_iter->match_count = 1; + } - /* Return the first table_record in the table set. */ - table_record = find_next_table(&filter, op_ctx); - - /* If no table record was found, there are no results. */ - if (!table_record.hdr.table) { - return false; - } + iter->matches_left = term_iter->match_count; - table = table_record.hdr.table; + /* Filter iterator takes control over iterating all the + * permutations that match the wildcard. */ + term_iter->match_count = 1; - /* Set current column to first occurrence of queried for entity */ - column = op_ctx->column = table_record.column; + table = term_iter->table; + if (pivot_term != -1) { + it->ids[pivot_term] = term_iter->id; + it->subjects[pivot_term] = term_iter->subject; + it->columns[pivot_term] = term_iter->column; + } + } else { + /* Progress iterator to next match for table, if any */ + table = it->table; + if (term_iter->index == 0) { + iter->matches_left = 1; + term_iter->index = 1; /* prevents looping again */ + } else { + goto done; + } + } - /* Store table in register */ - table_reg_set(rule, regs, r, table); - } - - /* If this is a redo, progress to the next match */ - } else { - /* First test if there are any more matches for the current table, in - * case we're looking for a wildcard. */ - if (filter.wildcard) { - table = table_reg_get(rule, regs, r).table; - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + /* Match the remainder of the terms */ + match = flecs_filter_match_table(world, filter, table, + it->ids, it->columns, it->subjects, + it->match_indices, &iter->matches_left, first, + pivot_term); + if (!match) { + iter->matches_left = 0; + continue; + } + + ecs_assert(iter->matches_left != 0, ECS_INTERNAL_ERROR, NULL); + } + + /* If this is not the first result for the table, and the table + * is matched more than once, iterate remaining matches */ + if (!first && (iter->matches_left > 0)) { + table = it->table; + + /* Find first term that still has matches left */ + int32_t i, j, count = it->term_count; + for (i = count - 1; i >= 0; i --) { + int32_t mi = -- it->match_indices[i]; + if (mi) { + break; + } + } - column = op_ctx->column; - column = find_next_column(world, table, column, &filter); - op_ctx->column = column; - } + /* Progress first term to next match (must be at least one) */ + it->columns[i] ++; + flecs_term_match_table(world, &filter->terms[i], table, + table->type, &it->ids[i], &it->columns[i], &it->subjects[i], + &it->match_indices[i], false); - /* If no next match was found for this table, move to next table */ - if (column == -1) { - if (output_is_input) { - return false; + /* Reset remaining terms (if any) to first match */ + for (j = i + 1; j < count; j ++) { + flecs_term_match_table(world, &filter->terms[j], table, + table->type, &it->ids[j], &it->columns[j], + &it->subjects[j], &it->match_indices[j], true); + } } - table_record = find_next_table(&filter, op_ctx); - if (!table_record.hdr.table) { - return false; - } + match = iter->matches_left != 0; + iter->matches_left --; - /* Assign new table to table register */ - table_reg_set(rule, regs, r, (table = table_record.hdr.table)); + ecs_assert(iter->matches_left >= 0, ECS_INTERNAL_ERROR, NULL); + } while (!match); - /* Assign first matching column */ - column = op_ctx->column = table_record.column; - } + goto yield; } - /* If we got here, we found a match. Table and column must be set */ - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(column != -1, ECS_INTERNAL_ERROR, NULL); +done: +error: + ecs_iter_fini(it); + return false; - if (op->term != -1) { - columns[op->term] = column; - } +yield: + it->offset = 0; + flecs_iter_populate_data(world, it, table, 0, 0, it->ptrs, it->sizes); + it->is_valid = true; + return true; +} - /* If this is a wildcard query, fill out the variable registers */ - if (filter.wildcard) { - reify_variables(iter, op, &filter, table->type, column); + +static +int32_t type_search( + const ecs_table_t *table, + ecs_id_record_t *idr, + ecs_id_t *ids, + ecs_id_t *id_out, + ecs_table_record_t **tr_out) +{ + ecs_table_record_t *tr = ecs_table_cache_get(&idr->cache, table); + if (tr) { + int32_t r = tr->column; + if (tr_out) tr_out[0] = tr; + if (id_out) id_out[0] = ids[r]; + return r; } - return true; + return -1; } -/* With operation. The With operation always comes after either the Select or - * another With operation, and applies additional filters to the table. */ static -bool eval_with( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +int32_t type_offset_search( + int32_t offset, + ecs_id_t id, + ecs_id_t *ids, + int32_t count, + ecs_id_t *id_out) { - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_world_t *world = rule->world; - ecs_rule_with_ctx_t *op_ctx = &iter->op_ctx[op_index].is.with; - ecs_rule_reg_t *regs = get_registers(iter, op); + ecs_assert(ids != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(count > 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(offset > 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); + ecs_assert(!ECS_HAS_ROLE(id, CASE), ECS_INVALID_PARAMETER, NULL); - /* Get register indices for input */ - int32_t r = op->r_in; + while (offset < count) { + ecs_id_t type_id = ids[offset ++]; + if (ecs_id_match(type_id, id)) { + if (id_out) id_out[0] = type_id; + return offset - 1; + } + } - /* Get queried for id, fill out potential variables */ - ecs_rule_pair_t pair = op->filter; - ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); - int32_t *columns = rule_get_columns(iter, op); + return -1; +} - /* If looked for entity is not a wildcard (meaning there are no unknown/ - * unconstrained variables) and this is a redo, nothing more to yield. */ - if (redo && !filter.wildcard) { +static +bool type_can_inherit_id( + const ecs_world_t *world, + const ecs_table_t *table, + const ecs_id_record_t *idr, + ecs_id_t id) +{ + if (idr->flags & ECS_ID_DONT_INHERIT) { return false; } + if (idr->flags & ECS_ID_EXCLUSIVE) { + if (ECS_HAS_ROLE(id, PAIR)) { + ecs_entity_t er = ECS_PAIR_FIRST(id); + if (flecs_get_table_record( + world, table, ecs_pair(er, EcsWildcard))) + { + return false; + } + } + } + return true; +} - int32_t column = -1; - ecs_table_t *table = NULL; - ecs_id_record_t *idr; +static +int32_t type_search_relation( + const ecs_world_t *world, + const ecs_table_t *table, + int32_t offset, + ecs_id_t id, + ecs_id_record_t *idr, + ecs_id_t rel, + ecs_id_record_t *idr_r, + int32_t min_depth, + int32_t max_depth, + ecs_entity_t *subject_out, + ecs_id_t *id_out, + ecs_table_record_t **tr_out) +{ + ecs_type_t type = table->type; + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t count = ecs_vector_count(type); - if (op->term != -1) { - columns[op->term] = -1; + if (min_depth <= 0) { + if (offset) { + int32_t r = type_offset_search(offset, id, ids, count, id_out); + if (r != -1) { + return r; + } + } else { + int32_t r = type_search(table, idr, ids, id_out, tr_out); + if (r != -1) { + return r; + } + } } - /* If this is a redo, we already looked up the table set */ - if (redo) { - idr = op_ctx->idr; - - /* If this is not a redo lookup the table set. Even though this may not be - * the first time the operation is evaluated, variables may have changed - * since last time, which could change the table set to lookup. */ - } else { - /* Predicates can be reflexive, which means that if we have a - * transitive predicate which is provided with the same subject and - * object, it should return true. By default with will not return true - * as the subject likely does not have itself as a relationship, which - * is why this is a special case. - * - * TODO: might want to move this code to a separate with_reflexive - * instruction to limit branches for non-transitive queries (and to keep - * code more readable). - */ - if (pair.transitive && pair.reflexive) { - ecs_entity_t subj = 0, obj = 0; - - if (r == UINT8_MAX) { - subj = op->subject; - } else { - const ecs_rule_var_t *v_subj = &rule->vars[r]; + ecs_flags32_t flags = table->flags; + if ((flags & EcsTableHasPairs) && max_depth && rel) { + bool is_a = rel == ecs_pair(EcsIsA, EcsWildcard); + if (is_a) { + if (!(flags & EcsTableHasIsA)) { + return -1; + } + if (!type_can_inherit_id(world, table, idr, id)) { + return -1; + } + idr_r = world->idr_isa_wildcard; + } - if (v_subj->kind == EcsRuleVarKindEntity) { - subj = entity_reg_get(rule, regs, r); + if (!idr_r) { + idr_r = flecs_get_id_record(world, rel); + if (!idr_r) { + return -1; + } + } - /* This is the input for the op, so should always be set */ - ecs_assert(subj != 0, ECS_INTERNAL_ERROR, NULL); + ecs_id_t id_r; + ecs_table_record_t *tr_r; + int32_t r, r_column = type_search(table, idr_r, ids, &id_r, &tr_r); + while (r_column != -1) { + ecs_entity_t obj = ECS_PAIR_SECOND(id_r); + ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); + + ecs_record_t *rec = ecs_eis_get_any(world, obj); + ecs_assert(rec != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_table_t *obj_table = rec->table; + if (obj_table) { + r = type_search_relation(world, obj_table, offset, id, idr, + rel, idr_r, min_depth - 1, max_depth - 1, subject_out, + id_out, tr_out); + if (r != -1) { + if (subject_out && !subject_out[0]) { + subject_out[0] = ecs_get_alive(world, obj); + } + return r; } - } - /* If subj is set, it means that it is an entity. Try to also - * resolve the object. */ - if (subj) { - /* If the object is not a wildcard, it has been reified. Get the - * value from either the register or as a literal */ - if (!filter.obj_wildcard) { - obj = ecs_entity_t_lo(filter.mask); - if (subj == obj) { - return true; + if (!is_a) { + r = type_search_relation(world, obj_table, offset, id, idr, + ecs_pair(EcsIsA, EcsWildcard), world->idr_isa_wildcard, + 1, INT_MAX, subject_out, id_out, tr_out); + if (r != -1) { + if (subject_out && !subject_out[0]) { + subject_out[0] = ecs_get_alive(world, obj); + } + return r; } } } - } - /* The With operation finds the table set that belongs to its pair - * filter. The table set is a sparse set that provides an O(1) operation - * to check whether the current table has the required expression. */ - idr = op_ctx->idr = find_tables(world, filter.mask); + r_column = type_offset_search(r_column + 1, rel, ids, count, &id_r); + } } - /* If no table set was found for queried for entity, there are no results. - * If this result is a transitive query, the table we're evaluating may not - * be in the returned table set. Regardless, if the filter that contains a - * transitive predicate does not have any tables associated with it, there - * can be no transitive matches for the filter. */ - if (!idr) { - return false; - } + return -1; +} - table = reg_get_table(rule, op, regs, r).table; - if (!table) { - return false; - } +int32_t ecs_search_relation( + const ecs_world_t *world, + const ecs_table_t *table, + int32_t offset, + ecs_id_t id, + ecs_entity_t rel, + int32_t min_depth, + int32_t max_depth, + ecs_entity_t *subject_out, + ecs_id_t *id_out, + struct ecs_table_record_t **tr_out) +{ + if (!table) return -1; - /* If this is not a redo, start at the beginning */ - if (!redo) { - column = op_ctx->column = find_next_column(world, table, -1, &filter); - - /* If this is a redo, progress to the next match */ - } else { - if (!filter.wildcard) { - return false; - } - - /* Find the next match for the expression in the column. The columns - * array keeps track of the state for each With operation, so that - * even after redoing a With, the search doesn't have to start from - * the beginning. */ - column = find_next_column(world, table, op_ctx->column, &filter); - op_ctx->column = column; - } + ecs_poly_assert(world, ecs_world_t); + ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); - /* If no next match was found for this table, no more data */ - if (column == -1) { - return false; - } + bool is_case = ECS_HAS_ROLE(id, CASE); + id = is_case * (ECS_SWITCH | ECS_PAIR_FIRST(id)) + !is_case * id; - if (op->term != -1) { - columns[op->term] = column; + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return -1; } - /* If we got here, we found a match. Table and column must be set */ - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(column != -1, ECS_INTERNAL_ERROR, NULL); - - /* If this is a wildcard query, fill out the variable registers */ - if (filter.wildcard) { - reify_variables(iter, op, &filter, table->type, column); - } + max_depth = INT_MAX * !max_depth + max_depth * !!max_depth; - set_source(it, op, regs, r); + int32_t result = type_search_relation(world, table, offset, id, idr, + ecs_pair(rel, EcsWildcard), NULL, min_depth, max_depth, subject_out, + id_out, tr_out); - return true; + return result; } -/* Each operation. The each operation is a simple operation that takes a table - * as input, and outputs each of the entities in a table. This operation is - * useful for rules that match a table, and where the entities of the table are - * used as predicate or object. If a rule contains an each operation, an - * iterator is guaranteed to yield an entity instead of a table. The input for - * an each operation can only be the root variable. */ -static -bool eval_each( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +int32_t ecs_search( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_id_t id, + ecs_id_t *id_out) { - ecs_rule_iter_t *iter = &it->priv.iter.rule; - ecs_rule_each_ctx_t *op_ctx = &iter->op_ctx[op_index].is.each; - ecs_rule_reg_t *regs = get_registers(iter, op); - int32_t r_in = op->r_in; - int32_t r_out = op->r_out; - ecs_entity_t e; - - /* Make sure in/out registers are of the correct kind */ - ecs_assert(iter->rule->vars[r_in].kind == EcsRuleVarKindTable, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(iter->rule->vars[r_out].kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); - - /* Get table, make sure that it contains data. The select operation should - * ensure that empty tables are never forwarded. */ - ecs_table_slice_t slice = table_reg_get(iter->rule, regs, r_in); - ecs_table_t *table = slice.table; - if (table) { - int32_t row, count = slice.count; - int32_t offset = slice.offset; - - if (!count) { - count = ecs_table_count(table); - ecs_assert(count != 0, ECS_INTERNAL_ERROR, NULL); - } else { - count += offset; - } + if (!table) return -1; - ecs_entity_t *entities = ecs_vector_first( - table->storage.entities, ecs_entity_t); - ecs_assert(entities != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_poly_assert(world, ecs_world_t); + ecs_assert(id != 0, ECS_INVALID_PARAMETER, NULL); - /* If this is is not a redo, start from row 0, otherwise go to the - * next entity. */ - if (!redo) { - row = op_ctx->row = offset; - } else { - row = ++ op_ctx->row; - } + ecs_id_record_t *idr = flecs_get_id_record(world, id); + if (!idr) { + return -1; + } - /* If row exceeds number of entities in table, return false */ - if (row >= count) { - return false; - } + ecs_type_t type = table->type; + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + return type_search(table, idr, ids, id_out, NULL); +} - /* Skip builtin entities that could confuse operations */ - e = entities[row]; - while (e == EcsWildcard || e == EcsThis || e == EcsAny) { - row ++; - if (row == count) { - return false; - } - e = entities[row]; - } - } else { - if (!redo) { - e = entity_reg_get(iter->rule, regs, r_in); - } else { - return false; - } +int32_t ecs_search_offset( + const ecs_world_t *world, + const ecs_table_t *table, + int32_t offset, + ecs_id_t id, + ecs_id_t *id_out) +{ + if (!offset) { + return ecs_search(world, table, id, id_out); } - /* Assign entity */ - entity_reg_set(iter->rule, regs, r_out, e); + if (!table) return -1; - return true; + ecs_poly_assert(world, ecs_world_t); + + ecs_type_t type = table->type; + ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); + int32_t count = ecs_vector_count(type); + return type_offset_search(offset, id, ids, count, id_out); } -/* Store operation. Stores entity in register. This can either be an entity - * literal or an entity variable that will be stored in a table register. The - * latter facilitates scenarios where an iterator only need to return a single - * entity but where the Yield returns tables. */ + static -bool eval_store( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - (void)op_index; +bool observer_run(ecs_iter_t *it) { + ecs_observer_t *o = it->ctx; + ecs_world_t *world = it->world; - if (redo) { - /* Only ever return result once */ + ecs_assert(o->callback != NULL, ECS_INVALID_PARAMETER, NULL); + + if (o->last_event_id == world->event_id) { + /* Already handled this event */ return false; } - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_rule_reg_t *regs = get_registers(iter, op); - int32_t r_in = op->r_in; - int32_t r_out = op->r_out; - - const ecs_rule_var_t *var_out = &rule->vars[r_out]; - if (var_out->kind == EcsRuleVarKindEntity) { - ecs_entity_t out, in = reg_get_entity(rule, op, regs, r_in); + o->last_event_id = world->event_id; - out = iter->registers[r_out].entity; - bool output_is_input = out && out != EcsWildcard; + ecs_iter_t user_it = *it; + user_it.term_count = o->filter.term_count_actual; + user_it.terms = o->filter.terms; + user_it.is_filter = o->filter.filter; + user_it.ids = NULL; + user_it.columns = NULL; + user_it.subjects = NULL; + user_it.sizes = NULL; + user_it.ptrs = NULL; - if (output_is_input && !redo) { - ecs_assert(regs[r_out].entity == iter->registers[r_out].entity, - ECS_INTERNAL_ERROR, NULL); + flecs_iter_init(&user_it); - if (out != in) { - /* If output variable is set it must match the input */ - return false; - } - } + ecs_table_t *table = it->table; + ecs_table_t *prev_table = it->other_table; + int32_t pivot_term = it->term_index; + ecs_term_t *term = &o->filter.terms[pivot_term]; - reg_set_entity(rule, regs, r_out, in); - } else { - ecs_table_slice_t out, in = reg_get_table(rule, op, regs, r_in); + if (term->oper == EcsNot) { + table = it->other_table; + prev_table = it->table; + } - out = iter->registers[r_out].table; - bool output_is_input = out.table != NULL; + if (!table) { + table = &world->store.root; + } + if (!prev_table) { + prev_table = &world->store.root; + } - if (output_is_input && !redo) { - ecs_assert(regs[r_out].entity == iter->registers[r_out].entity, - ECS_INTERNAL_ERROR, NULL); + static int obs_count = 0; + obs_count ++; - if (ecs_os_memcmp_t(&out, &in, ecs_table_slice_t)) { - /* If output variable is set it must match the input */ - return false; - } - } + /* Populate the column for the term that triggered. This will allow the + * matching algorithm to pick the right column in case the term is a + * wildcard matching multiple columns. */ + user_it.columns[0] = 0; + user_it.columns[pivot_term] = it->columns[0]; - reg_set_table(rule, regs, r_out, in); + if (flecs_filter_match_table(world, &o->filter, table, + user_it.ids, user_it.columns, user_it.subjects, NULL, NULL, false, -1)) + { + /* Monitor observers only trigger when the filter matches for the first + * time with an entity */ + if (o->is_monitor) { + if (flecs_filter_match_table(world, &o->filter, prev_table, + NULL, NULL, NULL, NULL, NULL, true, -1)) + { + goto done; + } - /* Ensure that if the input was an empty entity, information is not - * lost */ - if (!regs[r_out].table.table) { - regs[r_out].entity = reg_get_entity(rule, op, regs, r_in); + if (term->oper == EcsNot) { + /* Flip event if this is a Not, so OnAdd and OnRemove can be + * reliably used to check if we're entering or leaving the + * monitor */ + if (it->event == EcsOnAdd) { + user_it.event = EcsOnRemove; + } else if (it->event == EcsOnRemove) { + user_it.event = EcsOnAdd; + } + } } - } - ecs_rule_filter_t filter = pair_to_filter(iter, op, op->filter); - set_term_vars(rule, regs, op->term, filter.mask); + flecs_iter_populate_data(world, &user_it, + it->table, it->offset, it->count, user_it.ptrs, user_it.sizes); - return true; -} + user_it.ids[it->term_index] = it->event_id; + user_it.system = o->entity; + user_it.term_index = it->term_index; + user_it.self = o->self; + user_it.ctx = o->ctx; + user_it.term_count = o->filter.term_count_actual; -/* A setjmp operation sets the jump label for a subsequent jump label. When the - * operation is first evaluated (redo=false) it sets the label to the on_pass - * label, and returns true. When the operation is evaluated again (redo=true) - * the label is set to on_fail and the operation returns false. */ -static -bool eval_setjmp( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - ecs_rule_iter_t *iter = &it->priv.iter.rule; - ecs_rule_setjmp_ctx_t *ctx = &iter->op_ctx[op_index].is.setjmp; + o->callback(&user_it); - if (!redo) { - ctx->label = op->on_pass; + ecs_iter_fini(&user_it); return true; - } else { - ctx->label = op->on_fail; - return false; } -} - -/* The jump operation jumps to an operation label. The operation always returns - * true. Since the operation modifies the control flow of the program directly, - * the dispatcher does not look at the on_pass or on_fail labels of the jump - * instruction. Instead, the on_pass label is used to store the label of the - * operation that contains the label to jump to. */ -static -bool eval_jump( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - (void)it; - (void)op; - (void)op_index; - /* Passthrough, result is not used for control flow */ - return !redo; +done: + ecs_iter_fini(&user_it); + return false; } -/* The not operation reverts the result of the operation it embeds */ -static -bool eval_not( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - (void)it; - (void)op; - (void)op_index; +bool ecs_observer_default_run_action(ecs_iter_t *it) { + return observer_run(it); +} - return !redo; +static +void default_observer_run_callback(ecs_iter_t *it) { + observer_run(it); } -/* Check if entity is stored in table */ -static -bool eval_intable( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - (void)op_index; - - if (redo) { +/* For convenience, so applications can (in theory) use a single run callback + * that uses ecs_iter_next to iterate results */ +static +bool default_observer_next_callback(ecs_iter_t *it) { + if (it->interrupted_by) { return false; + } else { + it->interrupted_by = it->system; + return true; } - - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - ecs_world_t *world = rule->world; - ecs_rule_reg_t *regs = get_registers(iter, op); - ecs_table_t *table = table_reg_get(rule, regs, op->r_in).table; - - ecs_rule_pair_t pair = op->filter; - ecs_rule_filter_t filter = pair_to_filter(iter, op, pair); - ecs_entity_t obj = ECS_PAIR_SECOND(filter.mask); - ecs_assert(obj != 0 && obj != EcsWildcard, ECS_INTERNAL_ERROR, NULL); - obj = ecs_get_alive(world, obj); - ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); - - ecs_table_t *obj_table = ecs_get_table(world, obj); - return obj_table == table; } -/* Yield operation. This is the simplest operation, as all it does is return - * false. This will move the solver back to the previous instruction which - * forces redo's on previous operations, for as long as there are matching - * results. */ static -bool eval_yield( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) -{ - (void)it; - (void)op; - (void)op_index; - (void)redo; +void observer_run_callback(ecs_iter_t *it) { + ecs_observer_t *o = it->ctx; + ecs_run_action_t run = o->run; - /* Yield always returns false, because there are never any operations after - * a yield. */ - return false; + if (run) { + it->next = default_observer_next_callback; + it->callback = default_observer_run_callback; + it->interrupted_by = 0; + run(it); + } else { + observer_run(it); + } } -/* Dispatcher for operations */ static -bool eval_op( - ecs_iter_t *it, - ecs_rule_op_t *op, - int32_t op_index, - bool redo) +void observer_yield_existing( + ecs_world_t *world, + ecs_observer_t *observer) { - switch(op->kind) { - case EcsRuleInput: - return eval_input(it, op, op_index, redo); - case EcsRuleSelect: - return eval_select(it, op, op_index, redo); - case EcsRuleWith: - return eval_with(it, op, op_index, redo); - case EcsRuleSubSet: - return eval_subset(it, op, op_index, redo); - case EcsRuleSuperSet: - return eval_superset(it, op, op_index, redo); - case EcsRuleEach: - return eval_each(it, op, op_index, redo); - case EcsRuleStore: - return eval_store(it, op, op_index, redo); - case EcsRuleSetJmp: - return eval_setjmp(it, op, op_index, redo); - case EcsRuleJump: - return eval_jump(it, op, op_index, redo); - case EcsRuleNot: - return eval_not(it, op, op_index, redo); - case EcsRuleInTable: - return eval_intable(it, op, op_index, redo); - case EcsRuleYield: - return eval_yield(it, op, op_index, redo); - default: - return false; + ecs_run_action_t run = observer->run; + if (!run) { + run = default_observer_run_callback; } -} -/* Utility to copy all registers to the next frame. Keeping track of register - * values for each operation is necessary, because if an operation is asked to - * redo matching, it must to be able to pick up from where it left of */ -static -void push_registers( - ecs_rule_iter_t *it, - int32_t cur, - int32_t next) -{ - if (!it->rule->var_count) { + int32_t pivot_term = ecs_filter_pivot_term(world, &observer->filter); + if (pivot_term < 0) { return; } - ecs_rule_reg_t *src_regs = get_register_frame(it, cur); - ecs_rule_reg_t *dst_regs = get_register_frame(it, next); + /* If yield existing is enabled, trigger for each thing that matches + * the event, if the event is iterable. */ + int i, count = observer->event_count; + for (i = 0; i < count; i ++) { + ecs_entity_t evt = observer->events[i]; + const EcsIterable *iterable = ecs_get(world, evt, EcsIterable); + if (!iterable) { + continue; + } - ecs_os_memcpy_n(dst_regs, src_regs, - ecs_rule_reg_t, it->rule->var_count); + ecs_iter_t it; + iterable->init(world, world, &it, &observer->filter.terms[pivot_term]); + it.terms = observer->filter.terms; + it.term_count = 1; + it.term_index = pivot_term; + it.system = observer->entity; + it.ctx = observer; + it.binding_ctx = observer->binding_ctx; + it.event = evt; + + ecs_iter_next_action_t next = it.next; + ecs_assert(next != NULL, ECS_INTERNAL_ERROR, NULL); + while (next(&it)) { + run(&it); + world->event_id ++; + } + } } -/* Utility to copy all columns to the next frame. Columns keep track of which - * columns are currently being evaluated for a table, and are populated by the - * Select and With operations. The columns array is important, as it is used - * to tell the application where to find component data. */ -static -void push_columns( - ecs_rule_iter_t *it, - int32_t cur, - int32_t next) +ecs_entity_t ecs_observer_init( + ecs_world_t *world, + const ecs_observer_desc_t *desc) { - if (!it->rule->filter.term_count) { - return; + ecs_entity_t entity = 0; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); + ecs_check(desc->callback != NULL || desc->run != NULL, + ECS_INVALID_OPERATION, NULL); + + /* If entity is provided, create it */ + ecs_entity_t existing = desc->entity.entity; + entity = ecs_entity_init(world, &desc->entity); + if (!existing && !desc->entity.name) { + ecs_add_pair(world, entity, EcsChildOf, EcsFlecsHidden); } - int32_t *src_cols = rule_get_columns_frame(it, cur); - int32_t *dst_cols = rule_get_columns_frame(it, next); + bool added = false; + EcsObserver *comp = ecs_get_mut(world, entity, EcsObserver, &added); + if (added) { + ecs_observer_t *observer = flecs_sparse_add( + world->observers, ecs_observer_t); + ecs_assert(observer != NULL, ECS_INTERNAL_ERROR, NULL); + observer->id = flecs_sparse_last_id(world->observers); + comp->observer = observer; - ecs_os_memcpy_n(dst_cols, src_cols, int32_t, it->rule->filter.term_count); -} + /* Make writeable copy of filter desc so that we can set name. This will + * make debugging easier, as any error messages related to creating the + * filter will have the name of the observer. */ + ecs_filter_desc_t filter_desc = desc->filter; + filter_desc.name = desc->entity.name; -/* Populate iterator with data before yielding to application */ -static -void populate_iterator( - const ecs_rule_t *rule, - ecs_iter_t *iter, - ecs_rule_iter_t *it, - ecs_rule_op_t *op) -{ - ecs_world_t *world = rule->world; - int32_t r = op->r_in; - ecs_rule_reg_t *regs = get_register_frame(it, op->frame); - ecs_table_t *table = NULL; - int32_t count = 0; - int32_t offset = 0; + /* Parse filter */ + ecs_filter_t *filter = &observer->filter; + if (ecs_filter_init(world, filter, &filter_desc)) { + flecs_observer_fini(world, observer); + return 0; + } - /* If the input register for the yield does not point to a variable, - * the rule doesn't contain a this (.) variable. In that case, the - * iterator doesn't contain any data, and this function will simply - * return true or false. An application will still be able to obtain - * the variables that were resolved. */ - if (r != UINT8_MAX) { - const ecs_rule_var_t *var = &rule->vars[r]; - ecs_rule_reg_t *reg = ®s[r]; + /* Creating an observer with no terms has no effect */ + ecs_assert(observer->filter.term_count != 0, + ECS_INVALID_PARAMETER, NULL); - if (var->kind == EcsRuleVarKindTable) { - ecs_table_slice_t slice = table_reg_get(rule, regs, r); - table = slice.table; - count = slice.count; - offset = slice.offset; - } else { - /* If a single entity is returned, simply return the - * iterator with count 1 and a pointer to the entity id */ - ecs_assert(var->kind == EcsRuleVarKindEntity, - ECS_INTERNAL_ERROR, NULL); + int i, e; + for (i = 0; i < ECS_TRIGGER_DESC_EVENT_COUNT_MAX; i ++) { + ecs_entity_t event = desc->events[i]; + if (!event) { + break; + } - ecs_entity_t e = reg->entity; - ecs_record_t *record = ecs_eis_get(world, e); - offset = ECS_RECORD_TO_ROW(record->row); + if (event == EcsMonitor) { + /* Monitor event must be first and last event */ + ecs_check(i == 0, ECS_INVALID_PARAMETER, NULL); - /* If an entity is not stored in a table, it could not have - * been matched by anything */ - ecs_assert(record != NULL, ECS_INTERNAL_ERROR, NULL); - table = record->table; - count = 1; + observer->events[0] = EcsOnAdd; + observer->events[1] = EcsOnRemove; + observer->event_count ++; + observer->is_monitor = true; + } else { + observer->events[i] = event; + } + + observer->event_count ++; } - } - int32_t i, var_count = rule->var_count; - int32_t term_count = rule->filter.term_count; - iter->variables = it->variables; + /* Observer must have at least one event */ + ecs_check(observer->event_count != 0, ECS_INVALID_PARAMETER, NULL); - for (i = 0; i < var_count; i ++) { - if (rule->vars[i].kind == EcsRuleVarKindEntity) { - it->variables[i] = regs[i].entity; - } else { - it->variables[i] = 0; - } - } + observer->callback = desc->callback; + observer->run = desc->run; + observer->self = desc->self; + observer->ctx = desc->ctx; + observer->binding_ctx = desc->binding_ctx; + observer->ctx_free = desc->ctx_free; + observer->binding_ctx_free = desc->binding_ctx_free; + observer->entity = entity; + comp->observer = observer; - for (i = 0; i < term_count; i ++) { - int32_t v = rule->term_vars[i].subj; - if (v != -1) { - const ecs_rule_var_t *var = &rule->vars[v]; - if (var->name[0] != '.') { - if (var->kind == EcsRuleVarKindEntity) { - iter->subjects[i] = regs[var->id].entity; - } else { - /* This can happen for Any variables, where the actual - * content of the variable is not of interest to the query. - * Just pick the first entity from the table, so that the - * column can be correctly resolved */ - ecs_table_t *t = regs[var->id].table.table; - if (t) { - iter->subjects[i] = ecs_vector_first( - t->storage.entities, ecs_entity_t)[0]; + /* Create a trigger for each term in the filter */ + ecs_trigger_desc_t tdesc = { + .callback = observer_run_callback, + .ctx = observer, + .binding_ctx = desc->binding_ctx, + .match_prefab = observer->filter.match_prefab, + .match_disabled = observer->filter.match_disabled, + .last_event_id = &observer->last_event_id + }; + + for (i = 0; i < filter->term_count; i ++) { + tdesc.term = filter->terms[i]; + ecs_oper_kind_t oper = tdesc.term.oper; + ecs_id_t id = tdesc.term.id; + + bool is_tag = ecs_id_is_tag(world, id); + + if (is_tag) { + /* If id is a tag, convert OnSet/UnSet to OnAdd/OnRemove. This + * allows for creating OnSet observers with both components and + * tags that only fire when the entity has all ids */ + for (e = 0; e < observer->event_count; e ++) { + if (observer->events[e] == EcsOnSet) { + tdesc.events[e] = EcsOnAdd; + } else + if (observer->events[e] == EcsUnSet) { + tdesc.events[e] = EcsOnRemove; } else { - /* Can happen if term is optional */ - iter->subjects[i] = 0; + tdesc.events[e] = observer->events[e]; } } + } else { + ecs_os_memcpy_n(tdesc.events, observer->events, ecs_entity_t, + observer->event_count); } - } - } - /* Iterator expects column indices to start at 1 */ - iter->columns = rule_get_columns_frame(it, op->frame); - for (i = 0; i < term_count; i ++) { - ecs_entity_t subj = iter->subjects[i]; - int32_t c = ++ iter->columns[i]; - if (!subj) { - subj = iter->terms[i].subj.entity; - if (subj != EcsThis && subj != EcsAny) { - iter->columns[i] = 0; - } - } else if (c) { - iter->columns[i] = -1; - } - } + /* AndFrom & OrFrom terms insert multiple triggers */ + if (oper == EcsAndFrom || oper == EcsOrFrom) { + const EcsType *type = ecs_get(world, id, EcsType); + int32_t ti, ti_count = ecs_vector_count(type->normalized->type); + ecs_id_t *ti_ids = ecs_vector_first( + type->normalized->type, ecs_id_t); - /* Set iterator ids */ - for (i = 0; i < term_count; i ++) { - const ecs_rule_term_vars_t *vars = &rule->term_vars[i]; - ecs_term_t *term = &rule->filter.terms[i]; - if (term->oper == EcsOptional || term->oper == EcsNot) { - if (iter->columns[i] == 0) { - iter->ids[i] = term->id; + /* Correct operator will be applied when a trigger occurs, and + * the observer is evaluated on the trigger source */ + tdesc.term.oper = EcsAnd; + for (ti = 0; ti < ti_count; ti ++) { + tdesc.term.pred.name = NULL; + tdesc.term.pred.entity = ti_ids[ti]; + tdesc.term.id = ti_ids[ti]; + ecs_entity_t t = ecs_vector_add(&observer->triggers, + ecs_entity_t)[0] = ecs_trigger_init(world, &tdesc); + if (!t) { + goto error; + } + } continue; } - } - - ecs_id_t id = term->id; - ecs_entity_t pred = 0; - ecs_entity_t obj = 0; - bool is_pair = ECS_HAS_ROLE(id, PAIR); - if (!is_pair) { - pred = id; - } else { - pred = ECS_PAIR_FIRST(id); - obj = ECS_PAIR_SECOND(id); + ecs_entity_t t = ecs_vector_add(&observer->triggers, ecs_entity_t) + [0] = ecs_trigger_init(world, &tdesc); + if (!t) { + goto error; + } } - if (vars->pred != -1) { - pred = regs[vars->pred].entity; - } - if (vars->obj != -1) { - ecs_assert(is_pair, ECS_INTERNAL_ERROR, NULL); - obj = regs[vars->obj].entity; + if (desc->entity.name) { + ecs_trace("#[green]observer#[reset] %s created", + ecs_get_name(world, entity)); } - if (!is_pair) { - id = pred; - } else { - id = ecs_pair(pred, obj); + if (desc->yield_existing) { + observer_yield_existing(world, observer); } + } else { + ecs_assert(comp->observer != NULL, ECS_INTERNAL_ERROR, NULL); - iter->ids[i] = id; + /* If existing entity handle was provided, override existing params */ + if (existing) { + if (desc->callback) { + ((ecs_observer_t*)comp->observer)->callback = desc->callback; + } + if (desc->ctx) { + ((ecs_observer_t*)comp->observer)->ctx = desc->ctx; + } + if (desc->binding_ctx) { + ((ecs_observer_t*)comp->observer)->binding_ctx = + desc->binding_ctx; + } + } } - flecs_iter_populate_data(world, iter, table, offset, count, - iter->ptrs, iter->sizes); + return entity; +error: + if (entity) { + ecs_delete(world, entity); + } + return 0; } -static -bool is_control_flow( - ecs_rule_op_t *op) +void flecs_observer_fini( + ecs_world_t *world, + ecs_observer_t *observer) { - switch(op->kind) { - case EcsRuleSetJmp: - case EcsRuleJump: - return true; - default: - return false; + /* Cleanup triggers */ + int i, count = ecs_vector_count(observer->triggers); + ecs_entity_t *triggers = ecs_vector_first(observer->triggers, ecs_entity_t); + for (i = 0; i < count; i ++) { + ecs_entity_t t = triggers[i]; + if (!t) continue; + ecs_delete(world, triggers[i]); } -} + ecs_vector_free(observer->triggers); -bool ecs_rule_next( - ecs_iter_t *it) -{ - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_rule_next, ECS_INVALID_PARAMETER, NULL); + /* Cleanup filters */ + ecs_filter_fini(&observer->filter); - if (flecs_iter_next_row(it)) { - return true; + /* Cleanup context */ + if (observer->ctx_free) { + observer->ctx_free(observer->ctx); } - return flecs_iter_next_instanced(it, ecs_rule_next_instanced(it)); -error: - return false; + if (observer->binding_ctx_free) { + observer->binding_ctx_free(observer->binding_ctx); + } + + /* Cleanup observer storage */ + flecs_sparse_remove(world->observers, observer->id); } -/* Iterator next function. This evaluates the program until it reaches a Yield - * operation, and returns the intermediate result(s) to the application. An - * iterator can, depending on the program, either return a table, entity, or - * just true/false, in case a rule doesn't contain the this variable. */ -bool ecs_rule_next_instanced( - ecs_iter_t *it) +void* ecs_get_observer_ctx( + const ecs_world_t *world, + ecs_entity_t observer) { - ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(it->next == ecs_rule_next, ECS_INVALID_PARAMETER, NULL); - - ecs_rule_iter_t *iter = &it->priv.iter.rule; - const ecs_rule_t *rule = iter->rule; - bool redo = iter->redo; - int32_t last_frame = -1; - bool init_subjects = it->subjects == NULL; + const EcsObserver *o = ecs_get(world, observer, EcsObserver); + if (o) { + return o->observer->ctx; + } else { + return NULL; + } +} - /* Can't iterate an iterator that's already depleted */ - ecs_check(iter->op != -1, ECS_INVALID_PARAMETER, NULL); +void* ecs_get_observer_binding_ctx( + const ecs_world_t *world, + ecs_entity_t observer) +{ + const EcsObserver *o = ecs_get(world, observer, EcsObserver); + if (o) { + return o->observer->binding_ctx; + } else { + return NULL; + } +} - flecs_iter_init(it); - /* Make sure that if there are any terms with literal subjects, they're - * initialized in the subjects array */ - if (init_subjects) { - int32_t i; - for (i = 0; i < rule->filter.term_count; i ++) { - ecs_term_t *t = &rule->filter.terms[i]; - ecs_term_id_t *subj = &t->subj; - ecs_assert(subj->var == EcsVarIsVariable || subj->entity != EcsThis, - ECS_INTERNAL_ERROR, NULL); +static +void table_cache_list_remove( + ecs_table_cache_t *cache, + ecs_table_cache_hdr_t *elem) +{ + ecs_table_cache_hdr_t *next = elem->next; + ecs_table_cache_hdr_t *prev = elem->prev; - if (subj->var == EcsVarIsEntity) { - it->subjects[i] = subj->entity; - } - } + if (next) { + next->prev = prev; + } + if (prev) { + prev->next = next; } - do { - /* Evaluate an operation. The result of an operation determines the - * flow of the program. If an operation returns true, the program - * continues to the operation pointed to by 'on_pass'. If the operation - * returns false, the program continues to the operation pointed to by - * 'on_fail'. - * - * In most scenarios, on_pass points to the next operation, and on_fail - * points to the previous operation. - * - * When an operation fails, the previous operation will be invoked with - * redo=true. This will cause the operation to continue its search from - * where it left off. When the operation succeeds, the next operation - * will be invoked with redo=false. This causes the operation to start - * from the beginning, which is necessary since it just received a new - * input. */ - int32_t op_index = iter->op; - ecs_rule_op_t *op = &rule->operations[op_index]; - int32_t cur = op->frame; - - /* If this is not the first operation and is also not a control flow - * operation, push a new frame on the stack for the next operation */ - if (!redo && !is_control_flow(op) && cur && cur != last_frame) { - int32_t prev = cur - 1; - push_registers(iter, prev, cur); - push_columns(iter, prev, cur); - } - - /* Dispatch the operation */ - bool result = eval_op(it, op, op_index, redo); - iter->op = result ? op->on_pass : op->on_fail; + cache->empty_tables.count -= !!elem->empty; + cache->tables.count -= !elem->empty; - /* If the current operation is yield, return results */ - if (op->kind == EcsRuleYield) { - populate_iterator(rule, it, iter, op); - iter->redo = true; - return true; - } + if (cache->empty_tables.first == elem) { + cache->empty_tables.first = next; + } else if (cache->tables.first == elem) { + cache->tables.first = next; + } + if (cache->empty_tables.last == elem) { + cache->empty_tables.last = prev; + } + if (cache->tables.last == elem) { + cache->tables.last = prev; + } +} - /* If the current operation is a jump, goto stored label */ - if (op->kind == EcsRuleJump) { - /* Label is stored in setjmp context */ - iter->op = iter->op_ctx[op->on_pass].is.setjmp.label; +static +void table_cache_list_insert( + ecs_table_cache_t *cache, + ecs_table_cache_hdr_t *elem) +{ + ecs_table_cache_hdr_t *last; + if (elem->empty) { + last = cache->empty_tables.last; + cache->empty_tables.last = elem; + if ((++ cache->empty_tables.count) == 1) { + cache->empty_tables.first = elem; } - - /* If jumping backwards, it's a redo */ - redo = iter->op <= op_index; - - if (!is_control_flow(op)) { - last_frame = op->frame; + } else { + last = cache->tables.last; + cache->tables.last = elem; + if ((++ cache->tables.count) == 1) { + cache->tables.first = elem; } - } while (iter->op != -1); + } - ecs_iter_fini(it); + elem->next = NULL; + elem->prev = last; -error: - return false; + if (last) { + last->next = elem; + } } -#endif - -/* This is a heavily modified version of the EmbeddableWebServer (see copyright - * below). This version has been stripped from everything not strictly necessary - * for receiving/replying to simple HTTP requests, and has been modified to use - * the Flecs OS API. */ - -/* EmbeddableWebServer Copyright (c) 2016, 2019, 2020 Forrest Heller, and - * CONTRIBUTORS (see below) - All rights reserved. - * - * CONTRIBUTORS: - * Martin Pulec - bug fixes, warning fixes, IPv6 support - * Daniel Barry - bug fix (ifa_addr != NULL) - * - * Released under the BSD 2-clause license: - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions are met: - * 1. Redistributions of source code must retain the above copyright notice, - * this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright notice, - * this list of conditions and the following disclaimer in the documentation - * and/or other materials provided with the distribution. THIS SOFTWARE IS - * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS - * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN - * NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY - * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND - * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - +void ecs_table_cache_init( + ecs_table_cache_t *cache) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_map_init(&cache->index, ecs_table_cache_hdr_t*, 0); +} -#ifdef FLECS_HTTP +void ecs_table_cache_fini( + ecs_table_cache_t *cache) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_map_fini(&cache->index); +} -#if defined(ECS_TARGET_WINDOWS) -#ifndef WIN32_LEAN_AND_MEAN -#define WIN32_LEAN_AND_MEAN -#endif -#pragma comment(lib, "Ws2_32.lib") -#include -#include -#include -typedef SOCKET ecs_http_socket_t; -#else -#include -#include -#include -#include -#include -#include -typedef int ecs_http_socket_t; -#endif +bool ecs_table_cache_is_empty( + const ecs_table_cache_t *cache) +{ + return ecs_map_count(&cache->index) == 0; +} -/* Max length of request method */ -#define ECS_HTTP_METHOD_LEN_MAX (8) +void ecs_table_cache_insert( + ecs_table_cache_t *cache, + const ecs_table_t *table, + ecs_table_cache_hdr_t *result) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!table || (ecs_table_cache_get(cache, table) == NULL), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); -/* Timeout (s) before connection purge */ -#define ECS_HTTP_CONNECTION_PURGE_TIMEOUT (1.0) + bool empty; + if (!table) { + empty = false; + } else { + empty = ecs_table_count(table) == 0; + } -/* Number of dequeues before purging */ -#define ECS_HTTP_CONNECTION_PURGE_RETRY_COUNT (5) + result->cache = cache; + result->table = (ecs_table_t*)table; + result->empty = empty; -/* Minimum interval between dequeueing requests (ms) */ -#define ECS_HTTP_MIN_DEQUEUE_INTERVAL (100) + table_cache_list_insert(cache, result); -/* Minimum interval between printing statistics (ms) */ -#define ECS_HTTP_MIN_STATS_INTERVAL (10 * 1000) + if (table) { + ecs_map_set_ptr(&cache->index, table->id, result); + } -/* Max length of headers in reply */ -#define ECS_HTTP_REPLY_HEADER_SIZE (1024) + ecs_assert(empty || cache->tables.first != NULL, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!empty || cache->empty_tables.first != NULL, + ECS_INTERNAL_ERROR, NULL); +} -/* Receive buffer size */ -#define ECS_HTTP_SEND_RECV_BUFFER_SIZE (16 * 1024) +void* ecs_table_cache_get( + const ecs_table_cache_t *cache, + const ecs_table_t *table) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + return ecs_map_get_ptr(&cache->index, ecs_table_cache_hdr_t*, table->id); +} -/* Max length of request (path + query + headers + body) */ -#define ECS_HTTP_REQUEST_LEN_MAX (10 * 1024 * 1024) +void* ecs_table_cache_remove( + ecs_table_cache_t *cache, + const ecs_table_t *table, + ecs_table_cache_hdr_t *elem) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); -/* HTTP server struct */ -struct ecs_http_server_t { - bool should_run; - bool running; + if (!ecs_map_is_initialized(&cache->index)) { + return NULL; + } - ecs_http_socket_t sock; - ecs_os_mutex_t lock; - ecs_os_thread_t thread; + if (!elem) { + elem = ecs_map_get_ptr( + &cache->index, ecs_table_cache_hdr_t*, table->id); + if (!elem) { + return false; + } + } - ecs_http_reply_action_t callback; - void *ctx; + ecs_assert(elem != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(elem->cache == cache, ECS_INTERNAL_ERROR, NULL); + ecs_assert(elem->table == table, ECS_INTERNAL_ERROR, NULL); - ecs_sparse_t *connections; /* sparse */ - ecs_sparse_t *requests; /* sparse */ + table_cache_list_remove(cache, elem); - bool initialized; + ecs_map_remove(&cache->index, table->id); - uint16_t port; - const char *ipaddr; + return elem; +} - FLECS_FLOAT dequeue_timeout; /* used to not lock request queue too often */ - FLECS_FLOAT stats_timeout; /* used for periodic reporting of statistics */ +bool ecs_table_cache_set_empty( + ecs_table_cache_t *cache, + const ecs_table_t *table, + bool empty) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - FLECS_FLOAT request_time; /* time spent on requests in last stats interval */ - FLECS_FLOAT request_time_total; /* total time spent on requests */ - int32_t requests_processed; /* requests processed in last stats interval */ - int32_t requests_processed_total; /* total requests processed */ - int32_t dequeue_count; /* number of dequeues in last stats interval */ -}; + ecs_table_cache_hdr_t *elem = ecs_map_get_ptr( + &cache->index, ecs_table_cache_hdr_t*, table->id); + if (!elem) { + return false; + } -/** Fragment state, used by HTTP request parser */ -typedef enum { - HttpFragStateBegin, - HttpFragStateMethod, - HttpFragStatePath, - HttpFragStateVersion, - HttpFragStateHeaderStart, - HttpFragStateHeaderName, - HttpFragStateHeaderValueStart, - HttpFragStateHeaderValue, - HttpFragStateCR, - HttpFragStateCRLF, - HttpFragStateCRLFCR, - HttpFragStateBody, - HttpFragStateDone -} HttpFragState; + if (elem->empty == empty) { + return false; + } -/** A fragment is a partially received HTTP request */ -typedef struct { - HttpFragState state; - ecs_strbuf_t buf; - ecs_http_method_t method; - int32_t body_offset; - int32_t query_offset; - int32_t header_offsets[ECS_HTTP_HEADER_COUNT_MAX]; - int32_t header_value_offsets[ECS_HTTP_HEADER_COUNT_MAX]; - int32_t header_count; - int32_t param_offsets[ECS_HTTP_QUERY_PARAM_COUNT_MAX]; - int32_t param_value_offsets[ECS_HTTP_QUERY_PARAM_COUNT_MAX]; - int32_t param_count; - char header_buf[32]; - char *header_buf_ptr; - int32_t content_length; - bool parse_content_length; - bool invalid; -} ecs_http_fragment_t; + table_cache_list_remove(cache, elem); + elem->empty = empty; + table_cache_list_insert(cache, elem); -/** Extend public connection type with fragment data */ -typedef struct { - ecs_http_connection_t pub; - ecs_http_fragment_t frag; - ecs_http_socket_t sock; + return true; +} - /* Connection is purged after both timeout expires and connection has - * exceeded retry count. This ensures that a connection does not immediately - * timeout when a frame takes longer than usual */ - FLECS_FLOAT dequeue_timeout; - int32_t dequeue_retries; -} ecs_http_connection_impl_t; +void ecs_table_cache_fini_delete_all( + ecs_world_t *world, + ecs_table_cache_t *cache) +{ + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + if (!ecs_map_is_initialized(&cache->index)) { + return; + } -typedef struct { - ecs_http_request_t pub; - uint64_t conn_id; /* for sanity check */ - void *res; -} ecs_http_request_impl_t; + /* Temporarily set index to NULL, so that when the table tries to remove + * itself from the cache it won't be able to. This keeps the arrays we're + * iterating over consistent */ + ecs_map_t index = cache->index; + ecs_os_zeromem(&cache->index); -static -ecs_size_t http_send( - ecs_http_socket_t sock, - const void *buf, - ecs_size_t size, - int flags) -{ -#ifndef ECS_TARGET_MSVC - ssize_t send_bytes = send(sock, buf, flecs_itosize(size), flags); - return flecs_itoi32(send_bytes); -#else - int send_bytes = send(sock, buf, size, flags); - return flecs_itoi32(send_bytes); -#endif -} + ecs_table_cache_hdr_t *cur, *next = cache->tables.first; + while ((cur = next)) { + flecs_delete_table(world, cur->table); + next = cur->next; + } -static -ecs_size_t http_recv( - ecs_http_socket_t sock, - void *buf, - ecs_size_t size, - int flags) -{ - ecs_size_t ret; -#ifndef ECS_TARGET_MSVC - ssize_t recv_bytes = recv(sock, buf, flecs_itosize(size), flags); - ret = flecs_itoi32(recv_bytes); -#else - int recv_bytes = recv(sock, buf, size, flags); - ret = flecs_itoi32(recv_bytes); -#endif - if (ret == -1) { - ecs_dbg("recv failed: %s (sock = %d)", ecs_os_strerror(errno), sock); - } else if (ret == 0) { - ecs_dbg("recv: received 0 bytes (sock = %d)", sock); + next = cache->empty_tables.first; + while ((cur = next)) { + flecs_delete_table(world, cur->table); + next = cur->next; } - return ret; -} + cache->index = index; -static -int http_getnameinfo( - const struct sockaddr* addr, - ecs_size_t addr_len, - char *host, - ecs_size_t host_len, - char *port, - ecs_size_t port_len, - int flags) -{ - ecs_assert(addr_len > 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(host_len > 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(port_len > 0, ECS_INTERNAL_ERROR, NULL); - return getnameinfo(addr, (uint32_t)addr_len, host, (uint32_t)host_len, - port, (uint32_t)port_len, flags); + ecs_table_cache_fini(cache); } -static -int http_bind( - ecs_http_socket_t sock, - const struct sockaddr* addr, - ecs_size_t addr_len) +bool flecs_table_cache_iter( + ecs_table_cache_t *cache, + ecs_table_cache_iter_t *out) { - ecs_assert(addr_len > 0, ECS_INTERNAL_ERROR, NULL); - return bind(sock, addr, (uint32_t)addr_len); + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); + out->next = cache->tables.first; + out->cur = NULL; + return out->next != NULL; } -static -void http_close( - ecs_http_socket_t sock) +bool flecs_table_cache_empty_iter( + ecs_table_cache_t *cache, + ecs_table_cache_iter_t *out) { -#if defined(ECS_TARGET_WINDOWS) - closesocket(sock); -#else - shutdown(sock, SHUT_RDWR); - close(sock); -#endif + ecs_assert(cache != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(out != NULL, ECS_INTERNAL_ERROR, NULL); + out->next = cache->empty_tables.first; + out->cur = NULL; + return out->next != NULL; } -static -ecs_http_socket_t http_accept( - ecs_http_socket_t sock, - struct sockaddr* addr, - ecs_size_t *addr_len) +ecs_table_cache_hdr_t* _flecs_table_cache_next( + ecs_table_cache_iter_t *it) { - socklen_t len = (socklen_t)addr_len[0]; - ecs_http_socket_t result = accept(sock, addr, &len); - addr_len[0] = (ecs_size_t)len; - return result; -} + ecs_table_cache_hdr_t *next = it->next; + if (!next) { + return false; + } -static -void reply_free(ecs_http_reply_t* response) { - ecs_assert(response != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_os_free(response->body.content); + it->cur = next; + it->next = next->next; + return next; } -static -void request_free(ecs_http_request_impl_t *req) { - ecs_assert(req != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(req->pub.conn != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(req->pub.conn->server != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(req->pub.conn->server->requests != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(req->pub.conn->id == req->conn_id, ECS_INTERNAL_ERROR, NULL); - ecs_os_free(req->res); - flecs_sparse_remove(req->pub.conn->server->requests, req->pub.id); -} +#include +#include -static -void connection_free(ecs_http_connection_impl_t *conn) { - ecs_assert(conn != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(conn->pub.id != 0, ECS_INTERNAL_ERROR, NULL); - uint64_t conn_id = conn->pub.id; +void ecs_os_api_impl(ecs_os_api_t *api); - if (conn->sock) { - http_close(conn->sock); - } +static bool ecs_os_api_initialized = false; +static bool ecs_os_api_initializing = false; +static int ecs_os_api_init_count = 0; - flecs_sparse_remove(conn->pub.server->connections, conn_id); -} +#ifndef __EMSCRIPTEN__ +ecs_os_api_t ecs_os_api = { + .log_with_color_ = true, + .log_level_ = -1 /* disable tracing by default, but enable >= warnings */ +}; +#else +/* Disable colors by default for emscripten */ +ecs_os_api_t ecs_os_api = { + .log_level_ = -1 +}; +#endif -// https://stackoverflow.com/questions/10156409/convert-hex-string-char-to-int -static -char hex_2_int(char a, char b){ - a = (a <= '9') ? (char)(a - '0') : (char)((a & 0x7) + 9); - b = (b <= '9') ? (char)(b - '0') : (char)((b & 0x7) + 9); - return (char)((a << 4) + b); +int64_t ecs_os_api_malloc_count = 0; +int64_t ecs_os_api_realloc_count = 0; +int64_t ecs_os_api_calloc_count = 0; +int64_t ecs_os_api_free_count = 0; + +void ecs_os_set_api( + ecs_os_api_t *os_api) +{ + if (!ecs_os_api_initialized) { + ecs_os_api = *os_api; + ecs_os_api_initialized = true; + } } -static -void decode_url_str( - char *str) +void ecs_os_init(void) { - char ch, *ptr, *dst = str; - for (ptr = str; (ch = *ptr); ptr++) { - if (ch == '%') { - dst[0] = hex_2_int(ptr[1], ptr[2]); - dst ++; - ptr += 2; - } else { - dst[0] = ptr[0]; - dst ++; + if (!ecs_os_api_initialized) { + ecs_os_set_api_defaults(); + } + + if (!(ecs_os_api_init_count ++)) { + if (ecs_os_api.init_) { + ecs_os_api.init_(); } } - dst[0] = '\0'; } -static -void parse_method( - ecs_http_fragment_t *frag) -{ - char *method = ecs_strbuf_get_small(&frag->buf); - if (!ecs_os_strcmp(method, "GET")) frag->method = EcsHttpGet; - else if (!ecs_os_strcmp(method, "POST")) frag->method = EcsHttpPost; - else if (!ecs_os_strcmp(method, "PUT")) frag->method = EcsHttpPut; - else if (!ecs_os_strcmp(method, "DELETE")) frag->method = EcsHttpDelete; - else if (!ecs_os_strcmp(method, "OPTIONS")) frag->method = EcsHttpOptions; - else { - frag->method = EcsHttpMethodUnsupported; - frag->invalid = true; +void ecs_os_fini(void) { + if (!--ecs_os_api_init_count) { + if (ecs_os_api.fini_) { + ecs_os_api.fini_(); + } } - ecs_strbuf_reset(&frag->buf); } +#if !defined(ECS_TARGET_WINDOWS) && !defined(ECS_TARGET_EM) && !defined(ECS_TARGET_ANDROID) +#include +#define ECS_BT_BUF_SIZE 100 static -bool header_writable( - ecs_http_fragment_t *frag) +void dump_backtrace( + FILE *stream) { - return frag->header_count < ECS_HTTP_HEADER_COUNT_MAX; -} + int nptrs; + void *buffer[ECS_BT_BUF_SIZE]; + char **strings; + + nptrs = backtrace(buffer, ECS_BT_BUF_SIZE); + + strings = backtrace_symbols(buffer, nptrs); + if (strings == NULL) { + return; + } + + for (int j = 3; j < nptrs; j++) { + fprintf(stream, "%s\n", strings[j]); + } + free(strings); +} +#else static -void header_buf_reset( - ecs_http_fragment_t *frag) -{ - frag->header_buf[0] = '\0'; - frag->header_buf_ptr = frag->header_buf; +void dump_backtrace( + FILE *stream) +{ + (void)stream; } +#endif static -void header_buf_append( - ecs_http_fragment_t *frag, - char ch) +void log_msg( + int32_t level, + const char *file, + int32_t line, + const char *msg) { - if ((frag->header_buf_ptr - frag->header_buf) < - ECS_SIZEOF(frag->header_buf)) - { - frag->header_buf_ptr[0] = ch; - frag->header_buf_ptr ++; + FILE *stream; + if (level >= 0) { + stream = stdout; } else { - frag->header_buf_ptr[0] = '\0'; + stream = stderr; } -} -static -void enqueue_request( - ecs_http_connection_impl_t *conn) -{ - ecs_http_server_t *srv = conn->pub.server; - ecs_http_fragment_t *frag = &conn->frag; + if (level >= 0) { + if (level == 0) { + if (ecs_os_api.log_with_color_) fputs(ECS_MAGENTA, stream); + } else { + if (ecs_os_api.log_with_color_) fputs(ECS_GREY, stream); + } + fputs("info", stream); + } else if (level == -2) { + if (ecs_os_api.log_with_color_) fputs(ECS_YELLOW, stream); + fputs("warning", stream); + } else if (level == -3) { + if (ecs_os_api.log_with_color_) fputs(ECS_RED, stream); + fputs("error", stream); + } else if (level == -4) { + if (ecs_os_api.log_with_color_) fputs(ECS_RED, stream); + fputs("fatal", stream); + } - if (frag->invalid) { /* invalid request received, don't enqueue */ - ecs_strbuf_reset(&frag->buf); - } else { - char *res = ecs_strbuf_get(&frag->buf); - if (res) { - ecs_os_mutex_lock(srv->lock); - ecs_http_request_impl_t *req = flecs_sparse_add( - srv->requests, ecs_http_request_impl_t); - req->pub.id = flecs_sparse_last_id(srv->requests); - req->conn_id = conn->pub.id; - ecs_os_mutex_unlock(srv->lock); + if (ecs_os_api.log_with_color_) fputs(ECS_NORMAL, stream); + fputs(": ", stream); - req->pub.conn = (ecs_http_connection_t*)conn; - req->pub.method = frag->method; - req->pub.path = res + 1; - if (frag->body_offset) { - req->pub.body = &res[frag->body_offset]; + if (level >= 0) { + if (ecs_os_api.log_indent_) { + char indent[32]; + int i, indent_count = ecs_os_api.log_indent_; + if (indent_count > 15) indent_count = 15; + + for (i = 0; i < indent_count; i ++) { + indent[i * 2] = '|'; + indent[i * 2 + 1] = ' '; } - int32_t i, count = frag->header_count; - for (i = 0; i < count; i ++) { - req->pub.headers[i].key = &res[frag->header_offsets[i]]; - req->pub.headers[i].value = &res[frag->header_value_offsets[i]]; + + if (ecs_os_api.log_indent_ != indent_count) { + indent[i * 2 - 2] = '+'; } - count = frag->param_count; - for (i = 0; i < count; i ++) { - req->pub.params[i].key = &res[frag->param_offsets[i]]; - req->pub.params[i].value = &res[frag->param_value_offsets[i]]; - decode_url_str((char*)req->pub.params[i].value); + + indent[i * 2] = '\0'; + + fputs(indent, stream); + } + } + + if (level < 0) { + if (file) { + const char *file_ptr = strrchr(file, '/'); + if (!file_ptr) { + file_ptr = strrchr(file, '\\'); } - req->pub.header_count = frag->header_count; - req->pub.param_count = frag->param_count; - req->res = res; + if (file_ptr) { + file = file_ptr + 1; + } + + fputs(file, stream); + fputs(": ", stream); + } + + if (line) { + fprintf(stream, "%d: ", line); } } + + fputs(msg, stream); + + fputs("\n", stream); + + if (level == -4) { + dump_backtrace(stream); + } } -static -bool parse_request( - ecs_http_connection_impl_t *conn, - uint64_t conn_id, - const char* req_frag, - ecs_size_t req_frag_len) +void ecs_os_dbg( + const char *file, + int32_t line, + const char *msg) { - ecs_http_fragment_t *frag = &conn->frag; + if (ecs_os_api.log_) { + ecs_os_api.log_(1, file, line, msg); + } +} - int32_t i; - for (i = 0; i < req_frag_len; i++) { - char c = req_frag[i]; - switch (frag->state) { - case HttpFragStateBegin: - ecs_os_memset_t(frag, 0, ecs_http_fragment_t); - frag->buf.max = ECS_HTTP_METHOD_LEN_MAX; - frag->state = HttpFragStateMethod; - frag->header_buf_ptr = frag->header_buf; - /* fallthrough */ - case HttpFragStateMethod: - if (c == ' ') { - parse_method(frag); - frag->state = HttpFragStatePath; - frag->buf.max = ECS_HTTP_REQUEST_LEN_MAX; - } else { - ecs_strbuf_appendch(&frag->buf, c); - } - break; - case HttpFragStatePath: - if (c == ' ') { - frag->state = HttpFragStateVersion; - ecs_strbuf_appendch(&frag->buf, '\0'); - } else { - if (c == '?' || c == '=' || c == '&') { - ecs_strbuf_appendch(&frag->buf, '\0'); - int32_t offset = ecs_strbuf_written(&frag->buf); - if (c == '?' || c == '&') { - frag->param_offsets[frag->param_count] = offset; - } else { - frag->param_value_offsets[frag->param_count] = offset; - frag->param_count ++; - } - } else { - ecs_strbuf_appendch(&frag->buf, c); - } - } - break; - case HttpFragStateVersion: - if (c == '\r') { - frag->state = HttpFragStateCR; - } /* version is not stored */ - break; - case HttpFragStateHeaderStart: - if (header_writable(frag)) { - frag->header_offsets[frag->header_count] = - ecs_strbuf_written(&frag->buf); - } - header_buf_reset(frag); - frag->state = HttpFragStateHeaderName; - /* fallthrough */ - case HttpFragStateHeaderName: - if (c == ':') { - frag->state = HttpFragStateHeaderValueStart; - header_buf_append(frag, '\0'); - frag->parse_content_length = !ecs_os_strcmp( - frag->header_buf, "Content-Length"); +void ecs_os_trace( + const char *file, + int32_t line, + const char *msg) +{ + if (ecs_os_api.log_) { + ecs_os_api.log_(0, file, line, msg); + } +} - if (header_writable(frag)) { - ecs_strbuf_appendch(&frag->buf, '\0'); - frag->header_value_offsets[frag->header_count] = - ecs_strbuf_written(&frag->buf); - } - } else if (c == '\r') { - frag->state = HttpFragStateCR; - } else { - header_buf_append(frag, c); - if (header_writable(frag)) { - ecs_strbuf_appendch(&frag->buf, c); - } - } - break; - case HttpFragStateHeaderValueStart: - header_buf_reset(frag); - frag->state = HttpFragStateHeaderValue; - if (c == ' ') { /* skip first space */ - break; - } - /* fallthrough */ - case HttpFragStateHeaderValue: - if (c == '\r') { - if (frag->parse_content_length) { - header_buf_append(frag, '\0'); - int32_t len = atoi(frag->header_buf); - if (len < 0) { - frag->invalid = true; - } else { - frag->content_length = len; - } - frag->parse_content_length = false; - } - if (header_writable(frag)) { - int32_t cur = ecs_strbuf_written(&frag->buf); - if (frag->header_offsets[frag->header_count] < cur && - frag->header_value_offsets[frag->header_count] < cur) - { - ecs_strbuf_appendch(&frag->buf, '\0'); - frag->header_count ++; - } - } - frag->state = HttpFragStateCR; - } else { - if (frag->parse_content_length) { - header_buf_append(frag, c); - } - if (header_writable(frag)) { - ecs_strbuf_appendch(&frag->buf, c); - } - } - break; - case HttpFragStateCR: - if (c == '\n') { - frag->state = HttpFragStateCRLF; - } else { - frag->state = HttpFragStateHeaderStart; - } - break; - case HttpFragStateCRLF: - if (c == '\r') { - frag->state = HttpFragStateCRLFCR; - } else { - frag->state = HttpFragStateHeaderStart; - i--; - } - break; - case HttpFragStateCRLFCR: - if (c == '\n') { - if (frag->content_length != 0) { - frag->body_offset = ecs_strbuf_written(&frag->buf); - frag->state = HttpFragStateBody; - } else { - frag->state = HttpFragStateDone; - } - } else { - frag->state = HttpFragStateHeaderStart; - } - break; - case HttpFragStateBody: { - ecs_strbuf_appendch(&frag->buf, c); - if ((ecs_strbuf_written(&frag->buf) - frag->body_offset) == - frag->content_length) - { - frag->state = HttpFragStateDone; - } - } - break; - case HttpFragStateDone: - break; - } +void ecs_os_warn( + const char *file, + int32_t line, + const char *msg) +{ + if (ecs_os_api.log_) { + ecs_os_api.log_(-2, file, line, msg); } +} - if (frag->state == HttpFragStateDone) { - frag->state = HttpFragStateBegin; - if (conn->pub.id == conn_id) { - enqueue_request(conn); - } - return true; - } else { - return false; +void ecs_os_err( + const char *file, + int32_t line, + const char *msg) +{ + if (ecs_os_api.log_) { + ecs_os_api.log_(-3, file, line, msg); } } -static -void append_send_headers( - ecs_strbuf_t *hdrs, - int code, - const char* status, - const char* content_type, - ecs_strbuf_t *extra_headers, - ecs_size_t content_len) +void ecs_os_fatal( + const char *file, + int32_t line, + const char *msg) { - ecs_strbuf_appendstr(hdrs, "HTTP/1.1 "); - ecs_strbuf_append(hdrs, "%d ", code); - ecs_strbuf_appendstr(hdrs, status); - ecs_strbuf_appendstr(hdrs, "\r\n"); - - ecs_strbuf_appendstr(hdrs, "Content-Type: "); - ecs_strbuf_appendstr(hdrs, content_type); - ecs_strbuf_appendstr(hdrs, "\r\n"); + if (ecs_os_api.log_) { + ecs_os_api.log_(-4, file, line, msg); + } +} - ecs_strbuf_appendstr(hdrs, "Content-Length: "); - ecs_strbuf_append(hdrs, "%d", content_len); - ecs_strbuf_appendstr(hdrs, "\r\n"); +static +void ecs_os_gettime(ecs_time_t *time) { + ecs_assert(ecs_os_has_time() == true, ECS_MISSING_OS_API, NULL); + + uint64_t now = ecs_os_now(); + uint64_t sec = now / 1000000000; - ecs_strbuf_appendstr(hdrs, "Server: flecs\r\n"); + assert(sec < UINT32_MAX); + assert((now - sec * 1000000000) < UINT32_MAX); - ecs_strbuf_mergebuff(hdrs, extra_headers); + time->sec = (uint32_t)sec; + time->nanosec = (uint32_t)(now - sec * 1000000000); +} - ecs_strbuf_appendstr(hdrs, "\r\n"); +static +void* ecs_os_api_malloc(ecs_size_t size) { + ecs_os_api_malloc_count ++; + ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); + return malloc((size_t)size); } static -void send_reply( - ecs_http_connection_impl_t* conn, - ecs_http_reply_t* reply) -{ - char hdrs[ECS_HTTP_REPLY_HEADER_SIZE]; - ecs_strbuf_t hdr_buf = ECS_STRBUF_INIT; - hdr_buf.buf = hdrs; - hdr_buf.max = ECS_HTTP_REPLY_HEADER_SIZE; - hdr_buf.buf = hdrs; +void* ecs_os_api_calloc(ecs_size_t size) { + ecs_os_api_calloc_count ++; + ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); + return calloc(1, (size_t)size); +} - char *content = ecs_strbuf_get(&reply->body); - int32_t content_length = reply->body.length - 1; +static +void* ecs_os_api_realloc(void *ptr, ecs_size_t size) { + ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); - /* First, send the response HTTP headers */ - append_send_headers(&hdr_buf, reply->code, reply->status, - reply->content_type, &reply->headers, content_length); + if (ptr) { + ecs_os_api_realloc_count ++; + } else { + /* If not actually reallocing, treat as malloc */ + ecs_os_api_malloc_count ++; + } + + return realloc(ptr, (size_t)size); +} - ecs_size_t hdrs_len = ecs_strbuf_written(&hdr_buf); - hdrs[hdrs_len] = '\0'; - ecs_size_t written = http_send(conn->sock, hdrs, hdrs_len, 0); +static +void ecs_os_api_free(void *ptr) { + if (ptr) { + ecs_os_api_free_count ++; + } + free(ptr); +} - if (written != hdrs_len) { - ecs_err("failed to write HTTP response headers to '%s:%s': %s", - conn->pub.host, conn->pub.port, ecs_os_strerror(errno)); - return; +static +char* ecs_os_api_strdup(const char *str) { + if (str) { + int len = ecs_os_strlen(str); + char *result = ecs_os_malloc(len + 1); + ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); + ecs_os_strcpy(result, str); + return result; + } else { + return NULL; } +} - /* Second, send response body */ - if (content_length > 0) { - written = http_send(conn->sock, content, content_length, 0); - if (written != content_length) { - ecs_err("failed to write HTTP response body to '%s:%s': %s", - conn->pub.host, conn->pub.port, ecs_os_strerror(errno)); +/* Replace dots with underscores */ +static +char *module_file_base(const char *module, char sep) { + char *base = ecs_os_strdup(module); + ecs_size_t i, len = ecs_os_strlen(base); + for (i = 0; i < len; i ++) { + if (base[i] == '.') { + base[i] = sep; } } + + return base; } static -void recv_request( - ecs_http_server_t *srv, - ecs_http_connection_impl_t *conn, - uint64_t conn_id, - ecs_http_socket_t sock) -{ - ecs_size_t bytes_read; - char recv_buf[ECS_HTTP_SEND_RECV_BUFFER_SIZE]; +char* ecs_os_api_module_to_dl(const char *module) { + ecs_strbuf_t lib = ECS_STRBUF_INIT; - while ((bytes_read = http_recv( - sock, recv_buf, ECS_SIZEOF(recv_buf), 0)) > 0) - { - ecs_os_mutex_lock(srv->lock); - bool is_alive = conn->pub.id == conn_id; - if (is_alive) { - conn->dequeue_timeout = 0; - conn->dequeue_retries = 0; - } - ecs_os_mutex_unlock(srv->lock); + /* Best guess, use module name with underscores + OS library extension */ + char *file_base = module_file_base(module, '_'); - if (is_alive) { - if (parse_request(conn, conn_id, recv_buf, bytes_read)) { - return; - } - } else { - return; - } - } +# if defined(ECS_TARGET_LINUX) || defined(ECS_TARGET_FREEBSD) + ecs_strbuf_appendstr(&lib, "lib"); + ecs_strbuf_appendstr(&lib, file_base); + ecs_strbuf_appendstr(&lib, ".so"); +# elif defined(ECS_TARGET_DARWIN) + ecs_strbuf_appendstr(&lib, "lib"); + ecs_strbuf_appendstr(&lib, file_base); + ecs_strbuf_appendstr(&lib, ".dylib"); +# elif defined(ECS_TARGET_WINDOWS) + ecs_strbuf_appendstr(&lib, file_base); + ecs_strbuf_appendstr(&lib, ".dll"); +# endif + + ecs_os_free(file_base); + + return ecs_strbuf_get(&lib); } static -void init_connection( - ecs_http_server_t *srv, - ecs_http_socket_t sock_conn, - struct sockaddr_storage *remote_addr, - ecs_size_t remote_addr_len) -{ - /* Create new connection */ - ecs_os_mutex_lock(srv->lock); - ecs_http_connection_impl_t *conn = flecs_sparse_add( - srv->connections, ecs_http_connection_impl_t); - uint64_t conn_id = conn->pub.id = flecs_sparse_last_id(srv->connections); - conn->pub.server = srv; - conn->sock = sock_conn; - ecs_os_mutex_unlock(srv->lock); - - char *remote_host = conn->pub.host; - char *remote_port = conn->pub.port; +char* ecs_os_api_module_to_etc(const char *module) { + ecs_strbuf_t lib = ECS_STRBUF_INIT; - /* Fetch name & port info */ - if (http_getnameinfo((struct sockaddr*) remote_addr, remote_addr_len, - remote_host, ECS_SIZEOF(conn->pub.host), - remote_port, ECS_SIZEOF(conn->pub.port), - NI_NUMERICHOST | NI_NUMERICSERV)) - { - ecs_os_strcpy(remote_host, "unknown"); - ecs_os_strcpy(remote_port, "unknown"); - } + /* Best guess, use module name with dashes + /etc */ + char *file_base = module_file_base(module, '-'); - ecs_dbg_2("http: connection established from '%s:%s'", - remote_host, remote_port); + ecs_strbuf_appendstr(&lib, file_base); + ecs_strbuf_appendstr(&lib, "/etc"); - recv_request(srv, conn, conn_id, sock_conn); + ecs_os_free(file_base); - ecs_dbg_2("http: request received from '%s:%s'", - remote_host, remote_port); + return ecs_strbuf_get(&lib); } -static -void accept_connections( - ecs_http_server_t* srv, - const struct sockaddr* addr, - ecs_size_t addr_len) +void ecs_os_set_api_defaults(void) { -#ifdef ECS_TARGET_WINDOWS - /* If on Windows, test if winsock needs to be initialized */ - SOCKET testsocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); - if (SOCKET_ERROR == testsocket && WSANOTINITIALISED == WSAGetLastError()) { - WSADATA data = { 0 }; - int result = WSAStartup(MAKEWORD(2, 2), &data); - if (result) { - ecs_warn("WSAStartup failed with GetLastError = %d\n", - GetLastError()); - return; - } - } else { - http_close(testsocket); + /* Don't overwrite if already initialized */ + if (ecs_os_api_initialized != 0) { + return; } -#endif - - /* Resolve name + port (used for logging) */ - char addr_host[256]; - char addr_port[20]; - if (http_getnameinfo( - addr, addr_len, addr_host, ECS_SIZEOF(addr_host), addr_port, - ECS_SIZEOF(addr_port), NI_NUMERICHOST | NI_NUMERICSERV)) - { - ecs_os_strcpy(addr_host, "unknown"); - ecs_os_strcpy(addr_port, "unknown"); + if (ecs_os_api_initializing != 0) { + return; } - ecs_os_mutex_lock(srv->lock); - if (srv->should_run) { - ecs_dbg_2("http: initializing connection socket"); - - srv->sock = socket(addr->sa_family, SOCK_STREAM, IPPROTO_TCP); - if (srv->sock < 0) { - ecs_err("unable to create new connection socket: %s", - ecs_os_strerror(errno)); - ecs_os_mutex_unlock(srv->lock); - goto done; - } + ecs_os_api_initializing = true; + + /* Memory management */ + ecs_os_api.malloc_ = ecs_os_api_malloc; + ecs_os_api.free_ = ecs_os_api_free; + ecs_os_api.realloc_ = ecs_os_api_realloc; + ecs_os_api.calloc_ = ecs_os_api_calloc; - int reuse = 1; - int result = setsockopt(srv->sock, SOL_SOCKET, SO_REUSEADDR, - (char*)&reuse, ECS_SIZEOF(reuse)); - if (result) { - ecs_warn("failed to setsockopt: %s", ecs_os_strerror(errno)); - } + /* Strings */ + ecs_os_api.strdup_ = ecs_os_api_strdup; - if (addr->sa_family == AF_INET6) { - int ipv6only = 0; - if (setsockopt(srv->sock, IPPROTO_IPV6, IPV6_V6ONLY, - (char*)&ipv6only, ECS_SIZEOF(ipv6only))) - { - ecs_warn("failed to setsockopt: %s", ecs_os_strerror(errno)); - } - } - - result = http_bind(srv->sock, addr, addr_len); - if (result) { - ecs_err("http: failed to bind to '%s:%s': %s", - addr_host, addr_port, ecs_os_strerror(errno)); - ecs_os_mutex_unlock(srv->lock); - goto done; - } + /* Time */ + ecs_os_api.get_time_ = ecs_os_gettime; - result = listen(srv->sock, SOMAXCONN); - if (result) { - ecs_warn("http: could not listen for SOMAXCONN (%d) connections: %s", - SOMAXCONN, ecs_os_strerror(errno)); - } + /* Logging */ + ecs_os_api.log_ = log_msg; - ecs_trace("http: listening for incoming connections on '%s:%s'", - addr_host, addr_port); + /* Modules */ + if (!ecs_os_api.module_to_dl_) { + ecs_os_api.module_to_dl_ = ecs_os_api_module_to_dl; } - ecs_os_mutex_unlock(srv->lock); - ecs_http_socket_t sock_conn; - struct sockaddr_storage remote_addr; - ecs_size_t remote_addr_len; + if (!ecs_os_api.module_to_etc_) { + ecs_os_api.module_to_etc_ = ecs_os_api_module_to_etc; + } - while (srv->should_run) { - remote_addr_len = ECS_SIZEOF(remote_addr); - sock_conn = http_accept(srv->sock, (struct sockaddr*) &remote_addr, - &remote_addr_len); + ecs_os_api.abort_ = abort; - if (sock_conn == -1) { - if (srv->should_run) { - ecs_dbg("http: connection attempt failed: %s", - ecs_os_strerror(errno)); - } - continue; - } +# ifdef FLECS_OS_API_IMPL + /* Initialize defaults to OS API IMPL addon, but still allow for overriding + * by the application */ + ecs_set_os_api_impl(); + ecs_os_api_initialized = false; +# endif - init_connection(srv, sock_conn, &remote_addr, remote_addr_len); - } + ecs_os_api_initializing = false; +} -done: - if (srv->sock && errno != EBADF) { - http_close(srv->sock); - srv->sock = 0; - } +bool ecs_os_has_heap(void) { + return + (ecs_os_api.malloc_ != NULL) && + (ecs_os_api.calloc_ != NULL) && + (ecs_os_api.realloc_ != NULL) && + (ecs_os_api.free_ != NULL); +} - ecs_trace("http: no longer accepting connections on '%s:%s'", - addr_host, addr_port); +bool ecs_os_has_threading(void) { + return + (ecs_os_api.mutex_new_ != NULL) && + (ecs_os_api.mutex_free_ != NULL) && + (ecs_os_api.mutex_lock_ != NULL) && + (ecs_os_api.mutex_unlock_ != NULL) && + (ecs_os_api.cond_new_ != NULL) && + (ecs_os_api.cond_free_ != NULL) && + (ecs_os_api.cond_wait_ != NULL) && + (ecs_os_api.cond_signal_ != NULL) && + (ecs_os_api.cond_broadcast_ != NULL) && + (ecs_os_api.thread_new_ != NULL) && + (ecs_os_api.thread_join_ != NULL); } -static -void* http_server_thread(void* arg) { - ecs_http_server_t *srv = arg; - struct sockaddr_in addr; - ecs_os_zeromem(&addr); - addr.sin_family = AF_INET; - addr.sin_port = htons(srv->port); +bool ecs_os_has_time(void) { + return + (ecs_os_api.get_time_ != NULL) && + (ecs_os_api.sleep_ != NULL) && + (ecs_os_api.now_ != NULL) && + (ecs_os_api.enable_high_timer_resolution_ != NULL); +} - if (!srv->ipaddr) { - addr.sin_addr.s_addr = htonl(INADDR_ANY); - } else { - inet_pton(AF_INET, srv->ipaddr, &(addr.sin_addr)); - } +bool ecs_os_has_logging(void) { + return (ecs_os_api.log_ != NULL); +} - accept_connections(srv, (struct sockaddr*)&addr, ECS_SIZEOF(addr)); - return NULL; +bool ecs_os_has_dl(void) { + return + (ecs_os_api.dlopen_ != NULL) && + (ecs_os_api.dlproc_ != NULL) && + (ecs_os_api.dlclose_ != NULL); } -static -void handle_request( - ecs_http_server_t *srv, - ecs_http_request_impl_t *req) -{ - ecs_http_reply_t reply = ECS_HTTP_REPLY_INIT; - ecs_http_connection_impl_t *conn = - (ecs_http_connection_impl_t*)req->pub.conn; +bool ecs_os_has_modules(void) { + return + (ecs_os_api.module_to_dl_ != NULL) && + (ecs_os_api.module_to_etc_ != NULL); +} - if (srv->callback((ecs_http_request_t*)req, &reply, srv->ctx) == 0) { - reply.code = 404; - reply.status = "Resource not found"; +void ecs_os_enable_high_timer_resolution(bool enable) { + if (ecs_os_api.enable_high_timer_resolution_) { + ecs_os_api.enable_high_timer_resolution_(enable); + } else { + ecs_assert(enable == false, ECS_MISSING_OS_API, + "enable_high_timer_resolution"); } +} - send_reply(conn, &reply); - ecs_dbg_2("http: reply sent to '%s:%s'", conn->pub.host, conn->pub.port); +#if defined(ECS_TARGET_WINDOWS) +static char error_str[255]; +#endif - reply_free(&reply); - request_free(req); - connection_free(conn); +const char* ecs_os_strerror(int err) { +# if defined(ECS_TARGET_WINDOWS) + strerror_s(error_str, 255, err); + return error_str; +# else + return strerror(err); +# endif } + +#ifdef FLECS_SYSTEM +#endif + static -int32_t dequeue_requests( - ecs_http_server_t *srv, - float delta_time) +void compute_group_id( + ecs_query_t *query, + ecs_query_table_match_t *match) { - ecs_os_mutex_lock(srv->lock); - - int32_t i, request_count = flecs_sparse_count(srv->requests); - for (i = request_count - 1; i >= 1; i --) { - ecs_http_request_impl_t *req = flecs_sparse_get_dense( - srv->requests, ecs_http_request_impl_t, i); - handle_request(srv, req); - } + ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - int32_t connections_count = flecs_sparse_count(srv->connections); - for (i = connections_count - 1; i >= 1; i --) { - ecs_http_connection_impl_t *conn = flecs_sparse_get_dense( - srv->connections, ecs_http_connection_impl_t, i); + if (query->group_by) { + ecs_table_t *table = match->table; + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - conn->dequeue_timeout += delta_time; - conn->dequeue_retries ++; - - if ((conn->dequeue_timeout > - (FLECS_FLOAT)ECS_HTTP_CONNECTION_PURGE_TIMEOUT) && - (conn->dequeue_retries > ECS_HTTP_CONNECTION_PURGE_RETRY_COUNT)) - { - ecs_dbg("http: purging connection '%s:%s' (sock = %d)", - conn->pub.host, conn->pub.port, conn->sock); - connection_free(conn); - } + match->group_id = query->group_by(query->world, table->type, + query->group_by_id, query->group_by_ctx); + } else { + match->group_id = 0; } +} - ecs_os_mutex_unlock(srv->lock); - - return request_count; +static +ecs_query_table_list_t* get_group( + ecs_query_t *query, + uint64_t group_id) +{ + return ecs_map_get(&query->groups, ecs_query_table_list_t, group_id); } -const char* ecs_http_get_header( - const ecs_http_request_t* req, - const char* name) +static +ecs_query_table_list_t* ensure_group( + ecs_query_t *query, + uint64_t group_id) { - for (ecs_size_t i = 0; i < req->header_count; i++) { - if (!ecs_os_strcmp(req->headers[i].key, name)) { - return req->headers[i].value; - } - } - return NULL; + return ecs_map_ensure(&query->groups, ecs_query_table_list_t, group_id); } -const char* ecs_http_get_param( - const ecs_http_request_t* req, - const char* name) +/* Find the last node of the group after which this group should be inserted */ +static +ecs_query_table_node_t* find_group_insertion_node( + ecs_query_t *query, + uint64_t group_id) { - for (ecs_size_t i = 0; i < req->param_count; i++) { - if (!ecs_os_strcmp(req->params[i].key, name)) { - return req->params[i].value; + /* Grouping must be enabled */ + ecs_assert(query->group_by != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_map_iter_t it = ecs_map_iter(&query->groups); + ecs_query_table_list_t *list, *closest_list = NULL; + uint64_t id, closest_id = 0; + + /* Find closest smaller group id */ + while ((list = ecs_map_next(&it, ecs_query_table_list_t, &id))) { + if (id >= group_id) { + continue; + } + + if (!list->last) { + ecs_assert(list->first == NULL, ECS_INTERNAL_ERROR, NULL); + continue; + } + + if (!closest_list || ((group_id - id) < (group_id - closest_id))) { + closest_id = id; + closest_list = list; } } - return NULL; + + if (closest_list) { + return closest_list->last; + } else { + return NULL; /* Group should be first in query */ + } } -ecs_http_server_t* ecs_http_server_init( - const ecs_http_server_desc_t *desc) +/* Initialize group with first node */ +static +void create_group( + ecs_query_t *query, + ecs_query_table_node_t *node) { - ecs_check(ecs_os_has_threading(), ECS_UNSUPPORTED, - "missing OS API implementation"); - - ecs_http_server_t* srv = ecs_os_calloc_t(ecs_http_server_t); - srv->lock = ecs_os_mutex_new(); - - srv->should_run = false; - srv->initialized = true; - - srv->callback = desc->callback; - srv->ctx = desc->ctx; - srv->port = desc->port; - srv->ipaddr = desc->ipaddr; + ecs_query_table_match_t *match = node->match; + uint64_t group_id = match->group_id; - srv->connections = flecs_sparse_new(ecs_http_connection_impl_t); - srv->requests = flecs_sparse_new(ecs_http_request_impl_t); + /* If query has grouping enabled & this is a new/empty group, find + * the insertion point for the group */ + ecs_query_table_node_t *insert_after = find_group_insertion_node( + query, group_id); - /* Start at id 1 */ - flecs_sparse_new_id(srv->connections); - flecs_sparse_new_id(srv->requests); + if (!insert_after) { + /* This group should appear first in the query list */ + ecs_query_table_node_t *query_first = query->list.first; + if (query_first) { + /* If this is not the first match for the query, insert before it */ + node->next = query_first; + query_first->prev = node; + query->list.first = node; + } else { + /* If this is the first match of the query, initialize its list */ + ecs_assert(query->list.last == NULL, ECS_INTERNAL_ERROR, NULL); + query->list.first = node; + query->list.last = node; + } + } else { + ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); -#ifndef ECS_TARGET_WINDOWS - /* Ignore pipe signal. SIGPIPE can occur when a message is sent to a client - * but te client already disconnected. */ - signal(SIGPIPE, SIG_IGN); -#endif + /* This group should appear after another group */ + ecs_query_table_node_t *insert_before = insert_after->next; + node->prev = insert_after; + insert_after->next = node; + node->next = insert_before; + if (insert_before) { + insert_before->prev = node; + } else { + ecs_assert(query->list.last == insert_after, + ECS_INTERNAL_ERROR, NULL); + + /* This group should appear last in the query list */ + query->list.last = node; + } + } +} - return srv; -error: - return NULL; +static +void remove_group( + ecs_query_t *query, + uint64_t group_id) +{ + ecs_map_remove(&query->groups, group_id); } -void ecs_http_server_fini( - ecs_http_server_t* srv) +/* Find the list the node should be part of */ +static +ecs_query_table_list_t* get_node_list( + ecs_query_t *query, + ecs_query_table_node_t *node) { - if (srv->should_run) { - ecs_http_server_stop(srv); + ecs_query_table_match_t *match = node->match; + if (query->group_by) { + return get_group(query, match->group_id); + } else { + return &query->list; } - ecs_os_mutex_free(srv->lock); - flecs_sparse_free(srv->connections); - flecs_sparse_free(srv->requests); - ecs_os_free(srv); } -int ecs_http_server_start( - ecs_http_server_t *srv) +/* Find or create the list the node should be part of */ +static +ecs_query_table_list_t* ensure_node_list( + ecs_query_t *query, + ecs_query_table_node_t *node) { - ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(srv->initialized, ECS_INVALID_PARAMETER, NULL); - ecs_check(!srv->should_run, ECS_INVALID_PARAMETER, NULL); - ecs_check(!srv->thread, ECS_INVALID_PARAMETER, NULL); - - srv->should_run = true; - - ecs_dbg("http: starting server thread"); - - srv->thread = ecs_os_thread_new(http_server_thread, srv); - if (!srv->thread) { - goto error; + ecs_query_table_match_t *match = node->match; + if (query->group_by) { + return ensure_group(query, match->group_id); + } else { + return &query->list; } - - return 0; -error: - return -1; } -void ecs_http_server_stop( - ecs_http_server_t* srv) +/* Remove node from list */ +static +void remove_table_node( + ecs_query_t *query, + ecs_query_table_node_t *node) { - ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(srv->initialized, ECS_INVALID_OPERATION, NULL); - ecs_check(srv->should_run, ECS_INVALID_PARAMETER, NULL); + ecs_query_table_node_t *prev = node->prev; + ecs_query_table_node_t *next = node->next; - /* Stop server thread */ - ecs_dbg("http: shutting down server thread"); + ecs_assert(prev != node, ECS_INTERNAL_ERROR, NULL); + ecs_assert(next != node, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!prev || prev != next, ECS_INTERNAL_ERROR, NULL); - ecs_os_mutex_lock(srv->lock); - srv->should_run = false; - if (srv->sock >= 0) { - http_close(srv->sock); - } - ecs_os_mutex_unlock(srv->lock); + ecs_query_table_list_t *list = get_node_list(query, node); - ecs_os_thread_join(srv->thread); + if (!list || !list->first) { + /* If list contains no nodes, the node must be empty */ + ecs_assert(!list || list->last == NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(prev == NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(next == NULL, ECS_INTERNAL_ERROR, NULL); + return; + } - ecs_trace("http: server thread shut down"); + ecs_assert(prev != NULL || query->list.first == node, + ECS_INTERNAL_ERROR, NULL); + ecs_assert(next != NULL || query->list.last == node, + ECS_INTERNAL_ERROR, NULL); - /* Cleanup all outstanding requests */ - int i, count = flecs_sparse_count(srv->requests); - for (i = count - 1; i >= 1; i --) { - request_free(flecs_sparse_get_dense( - srv->requests, ecs_http_request_impl_t, i)); + if (prev) { + prev->next = next; } - - /* Close all connections */ - count = flecs_sparse_count(srv->connections); - for (i = count - 1; i >= 1; i --) { - connection_free(flecs_sparse_get_dense( - srv->connections, ecs_http_connection_impl_t, i)); + if (next) { + next->prev = prev; } - ecs_assert(flecs_sparse_count(srv->connections) == 1, - ECS_INTERNAL_ERROR, NULL); - ecs_assert(flecs_sparse_count(srv->requests) == 1, - ECS_INTERNAL_ERROR, NULL); + ecs_assert(list->count > 0, ECS_INTERNAL_ERROR, NULL); + list->count --; - srv->thread = 0; -error: - return; -} + if (query->group_by) { + ecs_query_table_match_t *match = node->match; + uint64_t group_id = match->group_id; -void ecs_http_server_dequeue( - ecs_http_server_t* srv, - float delta_time) -{ - ecs_check(srv != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(srv->initialized, ECS_INVALID_PARAMETER, NULL); - ecs_check(srv->should_run, ECS_INVALID_PARAMETER, NULL); - - srv->dequeue_timeout += delta_time; - srv->stats_timeout += delta_time; + /* Make sure query.list is updated if this is the first or last group */ + if (query->list.first == node) { + ecs_assert(prev == NULL, ECS_INTERNAL_ERROR, NULL); + query->list.first = next; + prev = next; + } + if (query->list.last == node) { + ecs_assert(next == NULL, ECS_INTERNAL_ERROR, NULL); + query->list.last = prev; + next = prev; + } - if ((1000 * srv->dequeue_timeout) > - (FLECS_FLOAT)ECS_HTTP_MIN_DEQUEUE_INTERVAL) - { - srv->dequeue_timeout = 0; + ecs_assert(query->list.count > 0, ECS_INTERNAL_ERROR, NULL); + query->list.count --; - ecs_time_t t = {0}; - ecs_time_measure(&t); - int32_t request_count = dequeue_requests(srv, srv->dequeue_timeout); - srv->requests_processed += request_count; - srv->requests_processed_total += request_count; - FLECS_FLOAT time_spent = (FLECS_FLOAT)ecs_time_measure(&t); - srv->request_time += time_spent; - srv->request_time_total += time_spent; - srv->dequeue_count ++; + /* Make sure group list only contains nodes that belong to the group */ + if (prev && prev->match->group_id != group_id) { + /* The previous node belonged to another group */ + prev = next; + } + if (next && next->match->group_id != group_id) { + /* The next node belonged to another group */ + next = prev; + } + + /* Do check again, in case both prev & next belonged to another group */ + if (prev && prev->match->group_id != group_id) { + /* There are no more matches left in this group */ + remove_group(query, group_id); + list = NULL; + } } - if ((1000 * srv->stats_timeout) > - (FLECS_FLOAT)ECS_HTTP_MIN_STATS_INTERVAL) - { - srv->stats_timeout = 0; - ecs_dbg("http: processed %d requests in %.3fs (avg %.3fs / dequeue)", - srv->requests_processed, (double)srv->request_time, - (double)(srv->request_time / (FLECS_FLOAT)srv->dequeue_count)); - srv->requests_processed = 0; - srv->request_time = 0; - srv->dequeue_count = 0; + if (list) { + if (list->first == node) { + list->first = next; + } + if (list->last == node) { + list->last = prev; + } } -error: - return; -} + node->prev = NULL; + node->next = NULL; +#ifdef FLECS_SYSTEM + if (query->list.first == NULL && query->system && !query->world->is_fini) { + ecs_system_activate(query->world, query->system, false, NULL); + } #endif + query->match_count ++; +} +/* Add node to list */ +static +void insert_table_node( + ecs_query_t *query, + ecs_query_table_node_t *node) +{ + /* Node should not be part of an existing list */ + ecs_assert(node->prev == NULL && node->next == NULL, + ECS_INTERNAL_ERROR, NULL); -#ifdef FLECS_UNITS + /* If this is the first match, activate system */ +#ifdef FLECS_SYSTEM + if (!query->list.first && query->system) { + ecs_system_activate(query->world, query->system, true, NULL); + } +#endif -ECS_DECLARE(EcsUnitPrefixes); + compute_group_id(query, node->match); -ECS_DECLARE(EcsYocto); -ECS_DECLARE(EcsZepto); -ECS_DECLARE(EcsAtto); -ECS_DECLARE(EcsFemto); -ECS_DECLARE(EcsPico); -ECS_DECLARE(EcsNano); -ECS_DECLARE(EcsMicro); -ECS_DECLARE(EcsMilli); -ECS_DECLARE(EcsCenti); -ECS_DECLARE(EcsDeci); -ECS_DECLARE(EcsDeca); -ECS_DECLARE(EcsHecto); -ECS_DECLARE(EcsKilo); -ECS_DECLARE(EcsMega); -ECS_DECLARE(EcsGiga); -ECS_DECLARE(EcsTera); -ECS_DECLARE(EcsPeta); -ECS_DECLARE(EcsExa); -ECS_DECLARE(EcsZetta); -ECS_DECLARE(EcsYotta); + ecs_query_table_list_t *list = ensure_node_list(query, node); + if (list->last) { + ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(list->first != NULL, ECS_INTERNAL_ERROR, NULL); -ECS_DECLARE(EcsKibi); -ECS_DECLARE(EcsMebi); -ECS_DECLARE(EcsGibi); -ECS_DECLARE(EcsTebi); -ECS_DECLARE(EcsPebi); -ECS_DECLARE(EcsExbi); -ECS_DECLARE(EcsZebi); -ECS_DECLARE(EcsYobi); + ecs_query_table_node_t *last = list->last; + ecs_query_table_node_t *last_next = last->next; -ECS_DECLARE(EcsDuration); - ECS_DECLARE(EcsPicoSeconds); - ECS_DECLARE(EcsNanoSeconds); - ECS_DECLARE(EcsMicroSeconds); - ECS_DECLARE(EcsMilliSeconds); - ECS_DECLARE(EcsSeconds); - ECS_DECLARE(EcsMinutes); - ECS_DECLARE(EcsHours); - ECS_DECLARE(EcsDays); + node->prev = last; + node->next = last_next; + last->next = node; -ECS_DECLARE(EcsTime); - ECS_DECLARE(EcsDate); + if (last_next) { + last_next->prev = node; + } -ECS_DECLARE(EcsMass); - ECS_DECLARE(EcsGrams); - ECS_DECLARE(EcsKiloGrams); + list->last = node; -ECS_DECLARE(EcsElectricCurrent); - ECS_DECLARE(EcsAmpere); + if (query->group_by) { + /* Make sure to update query list if this is the last group */ + if (query->list.last == last) { + query->list.last = node; + } + } + } else { + ecs_assert(list->first == NULL, ECS_INTERNAL_ERROR, NULL); -ECS_DECLARE(EcsAmount); - ECS_DECLARE(EcsMole); + list->first = node; + list->last = node; -ECS_DECLARE(EcsLuminousIntensity); - ECS_DECLARE(EcsCandela); + if (query->group_by) { + /* Initialize group with its first node */ + create_group(query, node); + } + } -ECS_DECLARE(EcsForce); - ECS_DECLARE(EcsNewton); + if (query->group_by) { + query->list.count ++; + } -ECS_DECLARE(EcsLength); - ECS_DECLARE(EcsMeters); - ECS_DECLARE(EcsPicoMeters); - ECS_DECLARE(EcsNanoMeters); - ECS_DECLARE(EcsMicroMeters); - ECS_DECLARE(EcsMilliMeters); - ECS_DECLARE(EcsCentiMeters); - ECS_DECLARE(EcsKiloMeters); - ECS_DECLARE(EcsMiles); + list->count ++; + query->match_count ++; -ECS_DECLARE(EcsPressure); - ECS_DECLARE(EcsPascal); - ECS_DECLARE(EcsBar); + ecs_assert(node->prev != node, ECS_INTERNAL_ERROR, NULL); + ecs_assert(node->next != node, ECS_INTERNAL_ERROR, NULL); -ECS_DECLARE(EcsSpeed); - ECS_DECLARE(EcsMetersPerSecond); - ECS_DECLARE(EcsKiloMetersPerSecond); - ECS_DECLARE(EcsKiloMetersPerHour); - ECS_DECLARE(EcsMilesPerHour); + ecs_assert(list->first != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(list->last != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(list->last == node, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.first != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.last != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.first->prev == NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(query->list.last->next == NULL, ECS_INTERNAL_ERROR, NULL); +} -ECS_DECLARE(EcsAcceleration); +static +ecs_query_table_match_t* cache_add( + ecs_query_table_t *elem) +{ + ecs_query_table_match_t *result = ecs_os_calloc_t(ecs_query_table_match_t); + ecs_query_table_node_t *node = &result->node; -ECS_DECLARE(EcsTemperature); - ECS_DECLARE(EcsKelvin); - ECS_DECLARE(EcsCelsius); - ECS_DECLARE(EcsFahrenheit); + node->match = result; + if (!elem->first) { + elem->first = result; + elem->last = result; + } else { + ecs_assert(elem->last != NULL, ECS_INTERNAL_ERROR, NULL); + elem->last->next_match = result; + elem->last = result; + } -ECS_DECLARE(EcsData); - ECS_DECLARE(EcsBits); - ECS_DECLARE(EcsKiloBits); - ECS_DECLARE(EcsMegaBits); - ECS_DECLARE(EcsGigaBits); - ECS_DECLARE(EcsBytes); - ECS_DECLARE(EcsKiloBytes); - ECS_DECLARE(EcsMegaBytes); - ECS_DECLARE(EcsGigaBytes); - ECS_DECLARE(EcsKibiBytes); - ECS_DECLARE(EcsGibiBytes); - ECS_DECLARE(EcsMebiBytes); + return result; +} -ECS_DECLARE(EcsDataRate); - ECS_DECLARE(EcsBitsPerSecond); - ECS_DECLARE(EcsKiloBitsPerSecond); - ECS_DECLARE(EcsMegaBitsPerSecond); - ECS_DECLARE(EcsGigaBitsPerSecond); - ECS_DECLARE(EcsBytesPerSecond); - ECS_DECLARE(EcsKiloBytesPerSecond); - ECS_DECLARE(EcsMegaBytesPerSecond); - ECS_DECLARE(EcsGigaBytesPerSecond); +typedef struct { + ecs_table_t *table; + int32_t *dirty_state; + int32_t column; +} table_dirty_state_t; -ECS_DECLARE(EcsPercentage); +static +void get_dirty_state( + ecs_query_t *query, + ecs_query_table_match_t *match, + int32_t term, + table_dirty_state_t *out) +{ + ecs_world_t *world = query->world; + ecs_entity_t subject = match->subjects[term]; + int32_t column; -ECS_DECLARE(EcsAngle); - ECS_DECLARE(EcsRadians); - ECS_DECLARE(EcsDegrees); + if (!subject) { + out->table = match->table; + column = match->columns[term]; + if (column == -1) { + column = 0; + } + } else { + out->table = ecs_get_table(world, subject); + column = -match->columns[term]; + } -ECS_DECLARE(EcsBel); -ECS_DECLARE(EcsDeciBel); + out->dirty_state = flecs_table_get_dirty_state(out->table); -void FlecsUnitsImport( - ecs_world_t *world) + if (column) { + out->column = ecs_table_type_to_storage_index(out->table, column - 1); + } else { + out->column = -1; + } +} + +/* Get match monitor. Monitors are used to keep track of whether components + * matched by the query in a table have changed. */ +static +bool get_match_monitor( + ecs_query_t *query, + ecs_query_table_match_t *match) { - ECS_MODULE(world, FlecsUnits); + if (match->monitor) { + return false; + } - ecs_set_name_prefix(world, "Ecs"); + int32_t *monitor = ecs_os_calloc_n(int32_t, query->filter.term_count + 1); - EcsUnitPrefixes = ecs_entity_init(world, &(ecs_entity_desc_t) { - .name = "prefixes", - .add = { EcsModule } - }); + /* Mark terms that don't need to be monitored. This saves time when reading + * and/or updating the monitor. */ + const ecs_filter_t *f = &query->filter; + int32_t i, t = -1, term_count = f->term_count_actual; + table_dirty_state_t cur_dirty_state; - /* Initialize unit prefixes */ + for (i = 0; i < term_count; i ++) { + if (t == f->terms[i].index) { + if (monitor[t + 1] != -1) { + continue; + } + } - ecs_entity_t prev_scope = ecs_set_scope(world, EcsUnitPrefixes); + t = f->terms[i].index; + monitor[t + 1] = -1; - EcsYocto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Yocto", - .symbol = "y", - .translation = { .factor = 10, .power = -24 } - }); - EcsZepto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Zepto", - .symbol = "z", - .translation = { .factor = 10, .power = -21 } - }); - EcsAtto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Atto", - .symbol = "a", - .translation = { .factor = 10, .power = -18 } - }); - EcsFemto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Femto", - .symbol = "a", - .translation = { .factor = 10, .power = -15 } - }); - EcsPico = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Pico", - .symbol = "p", - .translation = { .factor = 10, .power = -12 } - }); - EcsNano = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Nano", - .symbol = "n", - .translation = { .factor = 10, .power = -9 } - }); - EcsMicro = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Micro", - .symbol = "μ", - .translation = { .factor = 10, .power = -6 } - }); - EcsMilli = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Milli", - .symbol = "m", - .translation = { .factor = 10, .power = -3 } - }); - EcsCenti = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Centi", - .symbol = "c", - .translation = { .factor = 10, .power = -2 } - }); - EcsDeci = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Deci", - .symbol = "d", - .translation = { .factor = 10, .power = -1 } - }); - EcsDeca = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Deca", - .symbol = "da", - .translation = { .factor = 10, .power = 1 } - }); - EcsHecto = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Hecto", - .symbol = "h", - .translation = { .factor = 10, .power = 2 } - }); - EcsKilo = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Kilo", - .symbol = "k", - .translation = { .factor = 10, .power = 3 } - }); - EcsMega = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Mega", - .symbol = "M", - .translation = { .factor = 10, .power = 6 } - }); - EcsGiga = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Giga", - .symbol = "G", - .translation = { .factor = 10, .power = 9 } - }); - EcsTera = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Tera", - .symbol = "T", - .translation = { .factor = 10, .power = 12 } - }); - EcsPeta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Peta", - .symbol = "P", - .translation = { .factor = 10, .power = 15 } - }); - EcsExa = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Exa", - .symbol = "E", - .translation = { .factor = 10, .power = 18 } - }); - EcsZetta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Zetta", - .symbol = "Z", - .translation = { .factor = 10, .power = 21 } - }); - EcsYotta = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Yotta", - .symbol = "Y", - .translation = { .factor = 10, .power = 24 } - }); + if (f->terms[i].inout != EcsIn && + f->terms[i].inout != EcsInOut && + f->terms[i].inout != EcsInOutDefault) { + continue; /* If term isn't read, don't monitor */ + } - EcsKibi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Kibi", - .symbol = "Ki", - .translation = { .factor = 1024, .power = 1 } - }); - EcsMebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Mebi", - .symbol = "Mi", - .translation = { .factor = 1024, .power = 2 } - }); - EcsGibi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Gibi", - .symbol = "Gi", - .translation = { .factor = 1024, .power = 3 } - }); - EcsTebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Tebi", - .symbol = "Ti", - .translation = { .factor = 1024, .power = 4 } - }); - EcsPebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Pebi", - .symbol = "Pi", - .translation = { .factor = 1024, .power = 5 } - }); - EcsExbi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Exbi", - .symbol = "Ei", - .translation = { .factor = 1024, .power = 6 } - }); - EcsZebi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Zebi", - .symbol = "Zi", - .translation = { .factor = 1024, .power = 7 } - }); - EcsYobi = ecs_unit_prefix_init(world, &(ecs_unit_prefix_desc_t) { - .entity.name = "Yobi", - .symbol = "Yi", - .translation = { .factor = 1024, .power = 8 } - }); + int32_t column = match->columns[t]; + if (column == 0) { + continue; /* Don't track terms that aren't matched */ + } - ecs_set_scope(world, prev_scope); + get_dirty_state(query, match, t, &cur_dirty_state); + if (cur_dirty_state.column == -1) { + continue; /* Don't track terms that aren't stored */ + } - /* Duration units */ + monitor[t + 1] = 0; + } - EcsDuration = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Duration" }); - prev_scope = ecs_set_scope(world, EcsDuration); + match->monitor = monitor; - EcsSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Seconds", - .quantity = EcsDuration, - .symbol = "s" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsSeconds, - .kind = EcsF32 - }); - EcsPicoSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "PicoSeconds", - .quantity = EcsDuration, - .base = EcsSeconds, - .prefix = EcsPico }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsPicoSeconds, - .kind = EcsF32 - }); + query->flags |= EcsQueryHasMonitor; + return true; +} - EcsNanoSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "NanoSeconds", - .quantity = EcsDuration, - .base = EcsSeconds, - .prefix = EcsNano }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsNanoSeconds, - .kind = EcsF32 - }); +/* Synchronize match monitor with table dirty state */ +static +void sync_match_monitor( + ecs_query_t *query, + ecs_query_table_match_t *match) +{ + ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); + if (!match->monitor) { + if (query->flags & EcsQueryHasMonitor) { + get_match_monitor(query, match); + } else { + return; + } + } - EcsMicroSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MicroSeconds", - .quantity = EcsDuration, - .base = EcsSeconds, - .prefix = EcsMicro }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMicroSeconds, - .kind = EcsF32 - }); + int32_t *monitor = match->monitor; + ecs_table_t *table = match->table; + int32_t *dirty_state = flecs_table_get_dirty_state(table); + ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); + table_dirty_state_t cur; - EcsMilliSeconds = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MilliSeconds", - .quantity = EcsDuration, - .base = EcsSeconds, - .prefix = EcsMilli }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMilliSeconds, - .kind = EcsF32 - }); + monitor[0] = dirty_state[0]; /* Did table gain/lose entities */ - EcsMinutes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Minutes", - .quantity = EcsDuration, - .base = EcsSeconds, - .symbol = "min", - .translation = { .factor = 60, .power = 1 } }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMinutes, - .kind = EcsU32 - }); + int32_t i, term_count = query->filter.term_count_actual; + for (i = 0; i < term_count; i ++) { + int32_t t = query->filter.terms[i].index; + if (monitor[t + 1] == -1) { + continue; + } + + get_dirty_state(query, match, t, &cur); + ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); + monitor[t + 1] = cur.dirty_state[cur.column + 1]; + } +} - EcsHours = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Hours", - .quantity = EcsDuration, - .base = EcsMinutes, - .symbol = "h", - .translation = { .factor = 60, .power = 1 } }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsHours, - .kind = EcsU32 - }); +/* Check if single match term has changed */ +static +bool check_match_monitor_term( + ecs_query_t *query, + ecs_query_table_match_t *match, + int32_t term) +{ + ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - EcsDays = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Days", - .quantity = EcsDuration, - .base = EcsHours, - .symbol = "d", - .translation = { .factor = 24, .power = 1 } }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsDays, - .kind = EcsU32 - }); - ecs_set_scope(world, prev_scope); + if (get_match_monitor(query, match)) { + return true; + } + + int32_t *monitor = match->monitor; + ecs_table_t *table = match->table; + int32_t *dirty_state = flecs_table_get_dirty_state(table); + ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); + table_dirty_state_t cur; - /* Time units */ + int32_t state = monitor[term]; + if (state == -1) { + return false; + } - EcsTime = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Time" }); - prev_scope = ecs_set_scope(world, EcsTime); + if (!term) { + return monitor[0] != dirty_state[0]; + } - EcsDate = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Date", - .quantity = EcsTime }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsDate, - .kind = EcsU32 - }); - ecs_set_scope(world, prev_scope); + get_dirty_state(query, match, term - 1, &cur); + ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); - /* Mass units */ + return monitor[term] != cur.dirty_state[cur.column + 1]; +} - EcsMass = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Mass" }); - prev_scope = ecs_set_scope(world, EcsMass); - EcsGrams = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Grams", - .quantity = EcsMass, - .symbol = "g" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGrams, - .kind = EcsF32 - }); - EcsKiloGrams = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloGrams", - .quantity = EcsMass, - .prefix = EcsKilo, - .base = EcsGrams }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloGrams, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); +/* Check if any term for match has changed */ +static +bool check_match_monitor( + ecs_query_t *query, + ecs_query_table_match_t *match) +{ + ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); - /* Electric current units */ + if (get_match_monitor(query, match)) { + return true; + } - EcsElectricCurrent = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "ElectricCurrent" }); - prev_scope = ecs_set_scope(world, EcsElectricCurrent); - EcsAmpere = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Ampere", - .quantity = EcsElectricCurrent, - .symbol = "A" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsAmpere, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + int32_t *monitor = match->monitor; + ecs_table_t *table = match->table; + int32_t *dirty_state = flecs_table_get_dirty_state(table); + ecs_assert(dirty_state != NULL, ECS_INTERNAL_ERROR, NULL); + table_dirty_state_t cur; - /* Amount of substance units */ + if (monitor[0] != dirty_state[0]) { + return true; + } - EcsAmount = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Amount" }); - prev_scope = ecs_set_scope(world, EcsAmount); - EcsMole = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Mole", - .quantity = EcsAmount, - .symbol = "mol" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMole, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + ecs_filter_t *f = &query->filter; + int32_t i, term_count = f->term_count_actual; + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &f->terms[i]; + int32_t t = term->index; + if (monitor[t + 1] == -1) { + continue; + } - /* Luminous intensity units */ + get_dirty_state(query, match, t, &cur); + ecs_assert(cur.column != -1, ECS_INTERNAL_ERROR, NULL); - EcsLuminousIntensity = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "LuminousIntensity" }); - prev_scope = ecs_set_scope(world, EcsLuminousIntensity); - EcsCandela = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Candela", - .quantity = EcsLuminousIntensity, - .symbol = "cd" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsCandela, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + if (monitor[t + 1] != cur.dirty_state[cur.column + 1]) { + return true; + } + } - /* Force units */ + return false; +} - EcsForce = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Force" }); - prev_scope = ecs_set_scope(world, EcsForce); - EcsNewton = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Newton", - .quantity = EcsForce, - .symbol = "N" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsNewton, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); +/* Check if any term for matched table has changed */ +static +bool check_table_monitor( + ecs_query_t *query, + ecs_query_table_t *table, + int32_t term) +{ + ecs_query_table_node_t *cur, *end = table->last->node.next; - /* Length units */ + for (cur = &table->first->node; cur != end; cur = cur->next) { + ecs_query_table_match_t *match = (ecs_query_table_match_t*)cur; + if (term == -1) { + if (check_match_monitor(query, match)) { + return true; + } + } else { + if (check_match_monitor_term(query, match, term)) { + return true; + } + } + } - EcsLength = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Length" }); - prev_scope = ecs_set_scope(world, EcsLength); - EcsMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Meters", - .quantity = EcsLength, - .symbol = "m" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMeters, - .kind = EcsF32 - }); + return false; +} - EcsPicoMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "PicoMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsPico }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsPicoMeters, - .kind = EcsF32 - }); +static +bool check_query_monitor( + ecs_query_t *query) +{ + ecs_table_cache_iter_t it; + if (flecs_table_cache_iter(&query->cache, &it)) { + ecs_query_table_t *qt; + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + if (check_table_monitor(query, qt, -1)) { + return true; + } + } + } - EcsNanoMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "NanoMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsNano }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsNanoMeters, - .kind = EcsF32 - }); + return false; +} - EcsMicroMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MicroMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsMicro }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMicroMeters, - .kind = EcsF32 - }); +static +void init_query_monitors( + ecs_query_t *query) +{ + ecs_query_table_node_t *cur = query->list.first; - EcsMilliMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MilliMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsMilli }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMilliMeters, - .kind = EcsF32 - }); + /* Ensure each match has a monitor */ + for (; cur != NULL; cur = cur->next) { + ecs_query_table_match_t *match = (ecs_query_table_match_t*)cur; + get_match_monitor(query, match); + } +} - EcsCentiMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "CentiMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsCenti }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsCentiMeters, - .kind = EcsF32 - }); +/* Builtin group_by callback for Cascade terms. + * This function traces the hierarchy depth of an entity type by following a + * relation upwards (to its 'parents') for as long as those parents have the + * specified component id. + * The result of the function is the number of parents with the provided + * component for a given relation. */ +static +uint64_t group_by_cascade( + ecs_world_t *world, + ecs_type_t type, + ecs_entity_t component, + void *ctx) +{ + uint64_t result = 0; + int32_t i, count = ecs_vector_count(type); + ecs_entity_t *array = ecs_vector_first(type, ecs_entity_t); + ecs_term_t *term = ctx; + ecs_entity_t relation = term->subj.set.relation; - EcsKiloMeters = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloMeters", - .quantity = EcsLength, - .base = EcsMeters, - .prefix = EcsKilo }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloMeters, - .kind = EcsF32 - }); - - EcsMiles = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Miles", - .quantity = EcsLength, - .symbol = "mi" - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMiles, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + /* Cascade needs a relation to calculate depth from */ + ecs_check(relation != 0, ECS_INVALID_PARAMETER, NULL); - /* Pressure units */ + /* Should only be used with cascade terms */ + ecs_check(term->subj.set.mask & EcsCascade, ECS_INVALID_PARAMETER, NULL); - EcsPressure = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Pressure" }); - prev_scope = ecs_set_scope(world, EcsPressure); - EcsPascal = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Pascal", - .quantity = EcsPressure, - .symbol = "Pa" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsPascal, - .kind = EcsF32 - }); - EcsBar = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Bar", - .quantity = EcsPressure, - .symbol = "bar" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBar, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + /* Iterate back to front as relations are more likely to occur near the + * end of a type. */ + for (i = count - 1; i >= 0; i --) { + /* Find relation & relation object in entity type */ + if (ECS_HAS_RELATION(array[i], relation)) { + ecs_type_t obj_type = ecs_get_type(world, + ecs_pair_second(world, array[i])); + int32_t j, c_count = ecs_vector_count(obj_type); + ecs_entity_t *c_array = ecs_vector_first(obj_type, ecs_entity_t); - /* Speed units */ + /* Iterate object type, check if it has the specified component */ + for (j = 0; j < c_count; j ++) { + /* If it has the component, it is part of the tree matched by + * the query, increase depth */ + if (c_array[j] == component) { + result ++; - EcsSpeed = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Speed" }); - prev_scope = ecs_set_scope(world, EcsSpeed); - EcsMetersPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MetersPerSecond", - .quantity = EcsSpeed, - .base = EcsMeters, - .over = EcsSeconds }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMetersPerSecond, - .kind = EcsF32 - }); - EcsKiloMetersPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloMetersPerSecond", - .quantity = EcsSpeed, - .base = EcsKiloMeters, - .over = EcsSeconds }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloMetersPerSecond, - .kind = EcsF32 - }); - EcsKiloMetersPerHour = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloMetersPerHour", - .quantity = EcsSpeed, - .base = EcsKiloMeters, - .over = EcsHours }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloMetersPerHour, - .kind = EcsF32 - }); - EcsMilesPerHour = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MilesPerHour", - .quantity = EcsSpeed, - .base = EcsMiles, - .over = EcsHours }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMilesPerHour, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); - - /* Acceleration */ + /* Recurse to test if the object has matching parents */ + result += group_by_cascade(world, obj_type, component, ctx); + break; + } + } - EcsAcceleration = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Acceleration", - .base = EcsMetersPerSecond, - .over = EcsSeconds }); - ecs_quantity_init(world, &(ecs_entity_desc_t) { - .entity = EcsAcceleration - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsAcceleration, - .kind = EcsF32 - }); + if (j != c_count) { + break; + } - /* Temperature units */ + /* If the id doesn't have a role set, we'll find no more relations */ + } else if (!(array[i] & ECS_ROLE_MASK)) { + break; + } + } - EcsTemperature = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Temperature" }); - prev_scope = ecs_set_scope(world, EcsTemperature); - EcsKelvin = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Kelvin", - .quantity = EcsTemperature, - .symbol = "K" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKelvin, - .kind = EcsF32 - }); - EcsCelsius = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Celsius", - .quantity = EcsTemperature, - .symbol = "°C" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsCelsius, - .kind = EcsF32 - }); - EcsFahrenheit = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Fahrenheit", - .quantity = EcsTemperature, - .symbol = "F" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsFahrenheit, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + return result; +error: + return 0; +} - /* Data units */ +static +int get_comp_and_src( + ecs_world_t *world, + ecs_query_t *query, + int32_t t, + ecs_table_t *table_arg, + ecs_entity_t *component_out, + ecs_entity_t *entity_out, + bool *match_out) +{ + ecs_entity_t component = 0, entity = 0; - EcsData = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Data" }); - prev_scope = ecs_set_scope(world, EcsData); + ecs_term_t *terms = query->filter.terms; + int32_t term_count = query->filter.term_count; + ecs_term_t *term = &terms[t]; + ecs_term_id_t *subj = &term->subj; + ecs_oper_kind_t op = term->oper; - EcsBits = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Bits", - .quantity = EcsData, - .symbol = "bit" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBits, - .kind = EcsU64 - }); + *match_out = true; - EcsKiloBits = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloBits", - .quantity = EcsData, - .base = EcsBits, - .prefix = EcsKilo }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloBits, - .kind = EcsU64 - }); + if (op == EcsNot) { + entity = subj->entity; + } - EcsMegaBits = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MegaBits", - .quantity = EcsData, - .base = EcsBits, - .prefix = EcsMega }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMegaBits, - .kind = EcsU64 - }); + if (!subj->entity) { + component = term->id; + } else { + ecs_table_t *table = table_arg; + if (subj->entity != EcsThis) { + table = ecs_get_table(world, subj->entity); + } - EcsGigaBits = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "GigaBits", - .quantity = EcsData, - .base = EcsBits, - .prefix = EcsGiga }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGigaBits, - .kind = EcsU64 - }); + if (op == EcsOr) { + for (; t < term_count; t ++) { + term = &terms[t]; - EcsBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Bytes", - .quantity = EcsData, - .symbol = "B", - .base = EcsBits, - .translation = { .factor = 8, .power = 1 } }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBytes, - .kind = EcsU64 - }); + /* Keep iterating until the next non-OR expression */ + if (term->oper != EcsOr) { + t --; + break; + } - EcsKiloBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsKilo }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloBytes, - .kind = EcsU64 - }); + if (!component) { + ecs_entity_t source = 0; + int32_t result = ecs_search_relation(world, table, + 0, term->id, subj->set.relation, subj->set.min_depth, + subj->set.max_depth, &source, NULL, NULL); - EcsMegaBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MegaBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsMega }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMegaBytes, - .kind = EcsU64 - }); + if (result != -1) { + component = term->id; + } - EcsGigaBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "GigaBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsGiga }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGigaBytes, - .kind = EcsU64 - }); + if (source) { + entity = source; + } + } + } + } else { + component = term->id; - EcsKibiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KibiBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsKibi }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKibiBytes, - .kind = EcsU64 - }); + ecs_entity_t source = 0; + bool result = ecs_search_relation(world, table, 0, component, + subj->set.relation, subj->set.min_depth, subj->set.max_depth, + &source, NULL, NULL) != -1; - EcsMebiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MebiBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsMebi }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMebiBytes, - .kind = EcsU64 - }); + *match_out = result; - EcsGibiBytes = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "GibiBytes", - .quantity = EcsData, - .base = EcsBytes, - .prefix = EcsGibi }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGibiBytes, - .kind = EcsU64 - }); + if (op == EcsNot) { + result = !result; + } - ecs_set_scope(world, prev_scope); + /* Optional terms may not have the component. *From terms contain + * the id of a type of which the contents must match, but the type + * itself does not need to match. */ + if (op == EcsOptional || op == EcsAndFrom || op == EcsOrFrom || + op == EcsNotFrom) + { + result = true; + } - /* DataRate units */ + /* Table has already been matched, so unless column is optional + * any components matched from the table must be available. */ + if (table == table_arg) { + ecs_assert(result == true, ECS_INTERNAL_ERROR, NULL); + } - EcsDataRate = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "DataRate" }); - prev_scope = ecs_set_scope(world, EcsDataRate); + if (source) { + entity = source; + } + } - EcsBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "BitsPerSecond", - .quantity = EcsDataRate, - .base = EcsBits, - .over = EcsSeconds }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBitsPerSecond, - .kind = EcsU64 - }); + if (subj->entity != EcsThis) { + entity = subj->entity; + } + } - EcsKiloBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloBitsPerSecond", - .quantity = EcsDataRate, - .base = EcsKiloBits, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloBitsPerSecond, - .kind = EcsU64 - }); + if (entity == EcsThis) { + entity = 0; + } - EcsMegaBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MegaBitsPerSecond", - .quantity = EcsDataRate, - .base = EcsMegaBits, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMegaBitsPerSecond, - .kind = EcsU64 - }); + *component_out = component; + *entity_out = entity; - EcsGigaBitsPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "GigaBitsPerSecond", - .quantity = EcsDataRate, - .base = EcsGigaBits, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGigaBitsPerSecond, - .kind = EcsU64 - }); + return t; +} - EcsBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "BytesPerSecond", - .quantity = EcsDataRate, - .base = EcsBytes, - .over = EcsSeconds }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBytesPerSecond, - .kind = EcsU64 - }); +typedef struct pair_offset_t { + int32_t index; + int32_t count; +} pair_offset_t; - EcsKiloBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "KiloBytesPerSecond", - .quantity = EcsDataRate, - .base = EcsKiloBytes, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsKiloBytesPerSecond, - .kind = EcsU64 - }); +/* Get index for specified pair. Take into account that a pair can be matched + * multiple times per table, by keeping an offset of the last found index */ +static +int32_t get_pair_index( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_id_t pair, + int32_t column_index, + pair_offset_t *pair_offsets, + int32_t count) +{ + int32_t result; - EcsMegaBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "MegaBytesPerSecond", - .quantity = EcsDataRate, - .base = EcsMegaBytes, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsMegaBytesPerSecond, - .kind = EcsU64 - }); + /* The count variable keeps track of the number of times a pair has been + * matched with the current table. Compare the count to check if the index + * was already resolved for this iteration */ + if (pair_offsets[column_index].count == count) { + /* If it was resolved, return the last stored index. Subtract one as the + * index is offset by one, to ensure we're not getting stuck on the same + * index. */ + result = pair_offsets[column_index].index - 1; + } else { + /* First time for this iteration that the pair index is resolved, look + * it up in the type. */ + result = ecs_search_offset(world, table, + pair_offsets[column_index].index, pair, 0); + pair_offsets[column_index].index = result + 1; + pair_offsets[column_index].count = count; + } - EcsGigaBytesPerSecond = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "GigaBytesPerSecond", - .quantity = EcsDataRate, - .base = EcsGigaBytes, - .over = EcsSeconds - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsGigaBytesPerSecond, - .kind = EcsU64 - }); + return result; +} + +static +int32_t get_component_index( + ecs_world_t *world, + ecs_table_t *table, + ecs_type_t table_type, + ecs_entity_t *component_out, + int32_t column_index, + ecs_oper_kind_t op, + pair_offset_t *pair_offsets, + int32_t count) +{ + int32_t result = 0; + ecs_entity_t component = *component_out; - ecs_set_scope(world, prev_scope); + ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); - /* Percentage */ + if (component) { + /* If requested component is a case, find the corresponding switch to + * lookup in the table */ + if (ECS_HAS_ROLE(component, CASE)) { + ecs_entity_t sw = ECS_PAIR_FIRST(component); + result = ecs_search(world, table, ECS_SWITCH | sw, 0); + ecs_assert(result != -1, ECS_INTERNAL_ERROR, NULL); + } else + if (ECS_HAS_ROLE(component, PAIR)) { + ecs_entity_t rel = ECS_PAIR_FIRST(component); + ecs_entity_t obj = ECS_PAIR_SECOND(component); - EcsPercentage = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Percentage" }); - ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.entity = EcsPercentage, - .symbol = "%" - }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsPercentage, - .kind = EcsF32 - }); + /* Both the relationship and the object of the pair must be set */ + ecs_assert(rel != 0, ECS_INVALID_PARAMETER, NULL); + ecs_assert(obj != 0, ECS_INVALID_PARAMETER, NULL); - /* Angles */ + if (rel == EcsWildcard || obj == EcsWildcard) { + ecs_assert(pair_offsets != NULL, ECS_INTERNAL_ERROR, NULL); - EcsAngle = ecs_quantity_init(world, &(ecs_entity_desc_t) { - .name = "Angle" }); - prev_scope = ecs_set_scope(world, EcsAngle); - EcsRadians = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Radians", - .quantity = EcsAngle, - .symbol = "rad" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsRadians, - .kind = EcsF32 - }); + /* Get index of pair. Start looking from the last pair index + * as this may not be the first instance of the pair. */ + result = get_pair_index(world, table, component, column_index, + pair_offsets, count); + + if (result != -1) { + /* If component of current column is a pair, get the actual + * pair type for the table, so the system can see which + * component the pair was applied to */ + ecs_entity_t *pair = ecs_vector_get( + table_type, ecs_entity_t, result); + *component_out = *pair; - EcsDegrees = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Degrees", - .quantity = EcsAngle, - .symbol = "°" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsDegrees, - .kind = EcsF32 - }); - ecs_set_scope(world, prev_scope); + /* Check if the pair is a tag or whether it has data */ + if (ecs_get(world, rel, EcsComponent) == NULL) { + /* If pair has no data associated with it, use the + * component to which the pair has been added */ + component = ECS_PAIR_SECOND(*pair); + } else { + component = rel; + } + } + } else { + /* If the low part is a regular entity (component), then + * this query exactly matches a single pair instance. In + * this case we can simply do a lookup of the pair + * identifier in the table type. */ + result = ecs_search(world, table, component, 0); + } + } else { + /* Get column index for component */ + result = ecs_search(world, table, component, 0); + } - /* DeciBel */ + /* If column is found, add one to the index, as column zero in + * a table is reserved for entity id's */ + if (result != -1) { + result ++; + } - EcsBel = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "Bel", - .symbol = "B" }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsBel, - .kind = EcsF32 - }); - EcsDeciBel = ecs_unit_init(world, &(ecs_unit_desc_t) { - .entity.name = "DeciBel", - .prefix = EcsDeci, - .base = EcsBel }); - ecs_primitive_init(world, &(ecs_primitive_desc_t) { - .entity.entity = EcsDeciBel, - .kind = EcsF32 - }); + /* ecs_table_column_offset may return -1 if the component comes + * from a prefab. If so, the component will be resolved as a + * reference (see below) */ + } - /* Documentation */ -#ifdef FLECS_DOC - ECS_IMPORT(world, FlecsDoc); + if (op == EcsAndFrom || op == EcsOrFrom || op == EcsNotFrom) { + result = 0; + } else if (op == EcsOptional) { + /* If table doesn't have the field, mark it as no data */ + if (-1 == ecs_search_relation(world, table, 0, component, EcsIsA, + 0, 0, 0, 0, 0)) + { + result = 0; + } + } - ecs_doc_set_brief(world, EcsDuration, - "Time amount (e.g. \"20 seconds\", \"2 hours\")"); - ecs_doc_set_brief(world, EcsSeconds, "Time amount in seconds"); - ecs_doc_set_brief(world, EcsMinutes, "60 seconds"); - ecs_doc_set_brief(world, EcsHours, "60 minutes"); - ecs_doc_set_brief(world, EcsDays, "24 hours"); + return result; +} - ecs_doc_set_brief(world, EcsTime, - "Time passed since an epoch (e.g. \"5pm\", \"March 3rd 2022\")"); - ecs_doc_set_brief(world, EcsDate, - "Seconds passed since January 1st 1970"); +static +ecs_vector_t* add_ref( + ecs_world_t *world, + ecs_query_t *query, + ecs_vector_t *references, + ecs_term_t *term, + ecs_entity_t component, + ecs_entity_t entity) +{ + ecs_ref_t *ref = ecs_vector_add(&references, ecs_ref_t); + ecs_term_id_t *subj = &term->subj; - ecs_doc_set_brief(world, EcsMass, "Units of mass (e.g. \"5 kilograms\")"); + if (!(subj->set.mask & EcsCascade)) { + ecs_assert(entity != 0, ECS_INTERNAL_ERROR, NULL); + } + + *ref = (ecs_ref_t){0}; + ref->entity = entity; + ref->component = component; - ecs_doc_set_brief(world, EcsElectricCurrent, - "Units of electrical current (e.g. \"2 ampere\")"); + const EcsComponent *c_info = flecs_component_from_id(world, component); + if (c_info) { + if (c_info->size && subj->entity != 0) { + if (entity) { + ecs_get_ref_id(world, ref, entity, component); + } - ecs_doc_set_brief(world, EcsAmount, - "Units of amount of substance (e.g. \"2 mole\")"); + query->flags |= EcsQueryHasRefs; + } + } - ecs_doc_set_brief(world, EcsLuminousIntensity, - "Units of luminous intensity (e.g. \"1 candela\")"); + return references; +} - ecs_doc_set_brief(world, EcsForce, "Units of force (e.g. \"10 newton\")"); +static +int32_t get_pair_count( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_entity_t pair) +{ + int32_t i = -1, result = 0; + while (-1 != (i = ecs_search_offset(world, table, i + 1, pair, 0))) { + result ++; + } - ecs_doc_set_brief(world, EcsLength, - "Units of length (e.g. \"5 meters\", \"20 miles\")"); + return result; +} - ecs_doc_set_brief(world, EcsPressure, - "Units of pressure (e.g. \"1 bar\", \"1000 pascal\")"); +/* For each pair that the query subscribes for, count the occurrences in the + * table. Cardinality of subscribed for pairs must be the same as in the table + * or else the table won't match. */ +static +int32_t count_pairs( + const ecs_world_t *world, + const ecs_query_t *query, + const ecs_table_t *table) +{ + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count; + int32_t first_count = 0, pair_count = 0; - ecs_doc_set_brief(world, EcsSpeed, - "Units of movement (e.g. \"5 meters/second\")"); + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; - ecs_doc_set_brief(world, EcsAcceleration, - "Unit of speed increase (e.g. \"5 meters/second/second\")"); + if (!ECS_HAS_ROLE(term->id, PAIR)) { + continue; + } - ecs_doc_set_brief(world, EcsTemperature, - "Units of temperature (e.g. \"5 degrees Celsius\")"); + if (term->subj.entity != EcsThis) { + continue; + } - ecs_doc_set_brief(world, EcsData, - "Units of information (e.g. \"8 bits\", \"100 megabytes\")"); + if (ecs_id_is_wildcard(term->id)) { + pair_count = get_pair_count(world, table, term->id); + if (!first_count) { + first_count = pair_count; + } else { + if (first_count != pair_count) { + /* The pairs that this query subscribed for occur in the + * table but don't have the same cardinality. Ignore the + * table. This could typically happen for empty tables along + * a path in the table graph. */ + return -1; + } + } + } + } - ecs_doc_set_brief(world, EcsDataRate, - "Units of data transmission (e.g. \"100 megabits/second\")"); + return first_count; +} - ecs_doc_set_brief(world, EcsAngle, - "Units of rotation (e.g. \"1.2 radians\", \"180 degrees\")"); +static +ecs_type_t get_term_type( + ecs_world_t *world, + ecs_term_t *term, + ecs_entity_t component) +{ + ecs_oper_kind_t oper = term->oper; + ecs_assert(oper == EcsAndFrom || oper == EcsOrFrom || oper == EcsNotFrom, + ECS_INTERNAL_ERROR, NULL); + (void)oper; -#endif + const EcsType *type = ecs_get(world, component, EcsType); + if (type) { + return type->normalized->type; + } else { + return ecs_get_type(world, component); + } } -#endif +/** Add table to system, compute offsets for system components in table it */ +static +void add_table( + ecs_world_t *world, + ecs_query_t *query, + ecs_table_t *table) +{ + ecs_type_t table_type = NULL; + ecs_term_t *terms = query->filter.terms; + int32_t t, c, term_count = query->filter.term_count; + if (table) { + table_type = table->type; + } -#ifdef FLECS_SNAPSHOT + int32_t pair_cur = 0, pair_count = count_pairs(world, query, table); + + /* If the query has pairs, we need to account for the fact that a table may + * have multiple components to which the pair is applied, which means the + * table has to be registered with the query multiple times, with different + * table columns. If so, allocate a small array for each pair in which the + * last added table index of the pair is stored, so that in the next + * iteration we can start the search from the correct offset type. */ + pair_offset_t *pair_offsets = NULL; + if (pair_count) { + pair_offsets = ecs_os_calloc( + ECS_SIZEOF(pair_offset_t) * term_count); + } + ecs_query_table_match_t *table_data; + ecs_vector_t *references = NULL; -/* World snapshot */ -struct ecs_snapshot_t { - ecs_world_t *world; - ecs_sparse_t *entity_index; - ecs_vector_t *tables; - ecs_entity_t last_id; - ecs_filter_t filter; -}; + ecs_query_table_t *qt = ecs_os_calloc_t(ecs_query_table_t); + ecs_table_cache_insert(&query->cache, table, &qt->hdr); -/** Small footprint data structure for storing data associated with a table. */ -typedef struct ecs_table_leaf_t { - ecs_table_t *table; - ecs_vector_t *type; - ecs_data_t *data; -} ecs_table_leaf_t; +add_pair: + table_data = cache_add(qt); + table_data->table = table; + if (table) { + table_type = table->type; + } -static -ecs_data_t* duplicate_data( - const ecs_world_t *world, - ecs_table_t *table, - ecs_data_t *main_data) -{ - if (!ecs_table_count(table)) { - return NULL; + if (term_count) { + /* Array that contains the system column to table column mapping */ + table_data->columns = ecs_os_calloc_n(int32_t, query->filter.term_count_actual); + ecs_assert(table_data->columns != NULL, ECS_OUT_OF_MEMORY, NULL); + + /* Store the components of the matched table. In the case of OR expressions, + * components may differ per matched table. */ + table_data->ids = ecs_os_calloc_n(ecs_entity_t, query->filter.term_count_actual); + ecs_assert(table_data->ids != NULL, ECS_OUT_OF_MEMORY, NULL); + + /* Cache subject (source) entity ids for components */ + table_data->subjects = ecs_os_calloc_n(ecs_entity_t, query->filter.term_count_actual); + ecs_assert(table_data->subjects != NULL, ECS_OUT_OF_MEMORY, NULL); + + /* Cache subject (source) entity ids for components */ + table_data->sizes = ecs_os_calloc_n(ecs_size_t, query->filter.term_count_actual); + ecs_assert(table_data->sizes != NULL, ECS_OUT_OF_MEMORY, NULL); } - ecs_data_t *result = ecs_os_calloc(ECS_SIZEOF(ecs_data_t)); + /* Walk columns parsed from the system signature */ + c = 0; + for (t = 0; t < term_count; t ++) { + ecs_term_t *term = &terms[t]; + ecs_term_id_t subj = term->subj; + ecs_entity_t entity = 0, component = 0; + ecs_oper_kind_t op = term->oper; - ecs_type_t storage_type = table->storage_type; - int32_t i, column_count = ecs_vector_count(storage_type); - ecs_entity_t *components = ecs_vector_first(storage_type, ecs_entity_t); + if (op == EcsNot) { + subj.entity = 0; + } - result->columns = ecs_os_memdup( - main_data->columns, ECS_SIZEOF(ecs_column_t) * column_count); + /* Get actual component and component source for current column */ + bool match; + t = get_comp_and_src(world, query, t, table, &component, &entity, &match); - /* Copy entities */ - result->entities = ecs_vector_copy(main_data->entities, ecs_entity_t); - ecs_entity_t *entities = ecs_vector_first(result->entities, ecs_entity_t); + /* This column does not retrieve data from a static entity */ + if (!entity && subj.entity) { + int32_t index = get_component_index(world, table, table_type, + &component, c, op, pair_offsets, pair_cur + 1); - /* Copy record ptrs */ - result->record_ptrs = ecs_vector_copy( - main_data->record_ptrs, ecs_record_t*); + if (index == -1) { + if (op == EcsOptional && subj.set.mask == EcsSelf) { + index = 0; + } + } else { + if (op == EcsOptional && !(subj.set.mask & EcsSelf)) { + index = 0; + } + } - ecs_size_t to_alloc = ecs_vector_size(result->entities); + table_data->columns[c] = index; - /* Copy each column */ - for (i = 0; i < column_count; i ++) { - ecs_entity_t component = components[i]; - ecs_column_t *column = &result->columns[i]; + /* If the column is a case, we should only iterate the entities in + * the column for this specific case. Add a sparse column with the + * case id so we can find the correct entities when iterating */ + if (ECS_HAS_ROLE(component, CASE)) { + flecs_sparse_column_t *sc = ecs_vector_add( + &table_data->sparse_columns, flecs_sparse_column_t); + sc->signature_column_index = t; + sc->sw_case = ECS_PAIR_SECOND(component); + sc->sw_column = NULL; + } - component = ecs_get_typeid(world, component); + /* If table has a disabled bitmask for components, check if there is + * a disabled column for the queried for component. If so, cache it + * in a vector as the iterator will need to skip the entity when the + * component is disabled. */ + if (index && (table && table->flags & EcsTableHasDisabled)) { + ecs_entity_t bs_id = + (component & ECS_COMPONENT_MASK) | ECS_DISABLED; + int32_t bs_index = ecs_search(world, table, bs_id, 0); + if (bs_index != -1) { + flecs_bitset_column_t *elem = ecs_vector_add( + &table_data->bitset_columns, flecs_bitset_column_t); + elem->column_index = bs_index; + elem->bs_column = NULL; + } + } + } - const ecs_type_info_t *ti = flecs_get_type_info(world, component); - int16_t size = column->size; - int16_t alignment = column->alignment; - ecs_copy_t copy; + ecs_entity_t type_id = ecs_get_typeid(world, component); + if (!type_id && !(ECS_ROLE_MASK & component)) { + type_id = component; + } - if (ti && (copy = ti->lifecycle.copy)) { - int32_t count = ecs_vector_count(column->data); - ecs_vector_t *dst_vec = ecs_vector_new_t(size, alignment, to_alloc); - ecs_vector_set_count_t(&dst_vec, size, alignment, count); - void *dst_ptr = ecs_vector_first_t(dst_vec, size, alignment); - - ecs_xtor_t ctor = ti->lifecycle.ctor; - if (ctor) { - ctor((ecs_world_t*)world, entities, dst_ptr, count, ti); + if (entity || table_data->columns[c] == -1 || subj.set.mask & EcsCascade) { + if (type_id) { + references = add_ref(world, query, references, term, + component, entity); + table_data->columns[c] = -ecs_vector_count(references); } - void *src_ptr = ecs_vector_first_t(column->data, size, alignment); - copy((ecs_world_t*)world, entities, entities, dst_ptr, - src_ptr, count, ti); + table_data->subjects[c] = entity; + flecs_add_flag(world, entity, ECS_FLAG_OBSERVED); - column->data = dst_vec; - } else { - column->data = ecs_vector_copy_t(column->data, size, alignment); + if (!match) { + ecs_ref_t *ref = ecs_vector_last(references, ecs_ref_t); + ref->entity = 0; + } } - } - return result; -} + if (type_id) { + const EcsComponent *cptr = ecs_get(world, type_id, EcsComponent); + if (!cptr || !cptr->size) { + int32_t column = table_data->columns[c]; + if (column < 0) { + ecs_ref_t *r = ecs_vector_get( + references, ecs_ref_t, -column - 1); + r->component = 0; + } + } -static -void snapshot_table( - const ecs_world_t *world, - ecs_snapshot_t *snapshot, - ecs_table_t *table) -{ - if (table->flags & EcsTableHasBuiltins) { - return; - } - - ecs_table_leaf_t *l = ecs_vector_get( - snapshot->tables, ecs_table_leaf_t, (int32_t)table->id); - ecs_assert(l != NULL, ECS_INTERNAL_ERROR, NULL); - - l->table = table; - l->type = ecs_vector_copy(table->type, ecs_id_t); - l->data = duplicate_data(world, table, &table->storage); -} + if (cptr) { + table_data->sizes[c] = cptr->size; + } else { + table_data->sizes[c] = 0; + } + } else { + table_data->sizes[c] = 0; + } -static -ecs_snapshot_t* snapshot_create( - const ecs_world_t *world, - const ecs_sparse_t *entity_index, - ecs_iter_t *iter, - ecs_iter_next_action_t next) -{ - ecs_snapshot_t *result = ecs_os_calloc_t(ecs_snapshot_t); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - ecs_force_aperiodic((ecs_world_t*)world); + if (ECS_HAS_ROLE(component, SWITCH)) { + table_data->sizes[c] = ECS_SIZEOF(ecs_entity_t); + } else if (ECS_HAS_ROLE(component, CASE)) { + table_data->sizes[c] = ECS_SIZEOF(ecs_entity_t); + } - result->world = (ecs_world_t*)world; + table_data->ids[c] = component; - /* If no iterator is provided, the snapshot will be taken of the entire - * world, and we can simply copy the entity index as it will be restored - * entirely upon snapshote restore. */ - if (!iter && entity_index) { - result->entity_index = flecs_sparse_copy(entity_index); + c ++; + } + + if (references) { + ecs_size_t ref_size = ECS_SIZEOF(ecs_ref_t) * ecs_vector_count(references); + table_data->references = ecs_os_malloc(ref_size); + ecs_os_memcpy(table_data->references, + ecs_vector_first(references, ecs_ref_t), ref_size); + ecs_vector_free(references); + references = NULL; } - /* Create vector with as many elements as tables, so we can store the - * snapshot tables at their element ids. When restoring a snapshot, the code - * will run a diff between the tables in the world and the snapshot, to see - * which of the world tables still exist, no longer exist, or need to be - * deleted. */ - uint64_t t, table_count = flecs_sparse_last_id(&world->store.tables) + 1; - result->tables = ecs_vector_new(ecs_table_leaf_t, (int32_t)table_count); - ecs_vector_set_count(&result->tables, ecs_table_leaf_t, (int32_t)table_count); - ecs_table_leaf_t *arr = ecs_vector_first(result->tables, ecs_table_leaf_t); - - /* Array may have holes, so initialize with 0 */ - ecs_os_memset_n(arr, 0, ecs_table_leaf_t, table_count); + /* Insert match to iteration list if table is not empty */ + if (!table || ecs_table_count(table) != 0) { + ecs_assert(table == qt->hdr.table, ECS_INTERNAL_ERROR, NULL); + insert_table_node(query, &table_data->node); + } - /* Iterate tables in iterator */ - if (iter) { - while (next(iter)) { - ecs_table_t *table = iter->table; - snapshot_table(world, result, table); - } - } else { - for (t = 0; t < table_count; t ++) { - ecs_table_t *table = flecs_sparse_get( - &world->store.tables, ecs_table_t, t); - snapshot_table(world, result, table); - } + /* Use tail recursion when adding table for multiple pairs */ + pair_cur ++; + if (pair_cur < pair_count) { + goto add_pair; } - return result; + if (pair_offsets) { + ecs_os_free(pair_offsets); + } } -/** Create a snapshot */ -ecs_snapshot_t* ecs_snapshot_take( - ecs_world_t *stage) +static +bool match_term( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_term_t *term) { - const ecs_world_t *world = ecs_get_world(stage); + ecs_term_id_t *subj = &term->subj; - ecs_snapshot_t *result = snapshot_create( - world, ecs_eis(world), NULL, NULL); + /* If term has no subject, there's nothing to match */ + if (!subj->entity) { + return true; + } - result->last_id = world->stats.last_id; + if (term->subj.entity != EcsThis) { + table = ecs_get_table(world, subj->entity); + } - return result; + return ecs_search_relation( + world, table, 0, term->id, subj->set.relation, + subj->set.min_depth, subj->set.max_depth, NULL, NULL, NULL) != -1; } -/** Create a filtered snapshot */ -ecs_snapshot_t* ecs_snapshot_take_w_iter( - ecs_iter_t *iter) +/* Match table with query */ +bool flecs_query_match( + const ecs_world_t *world, + const ecs_table_t *table, + const ecs_query_t *query) { - ecs_world_t *world = iter->world; - ecs_assert(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + if (!table->type) { + return false; + } - ecs_snapshot_t *result = snapshot_create( - world, ecs_eis(world), iter, iter ? iter->next : NULL); + if (!(query->flags & EcsQueryNeedsTables)) { + return false; + } - result->last_id = world->stats.last_id; + /* Don't match disabled entities */ + if (!(query->flags & EcsQueryMatchDisabled) && ecs_search( + world, table, EcsDisabled, 0) != -1) + { + return false; + } - return result; -} + /* Don't match prefab entities */ + if (!(query->flags & EcsQueryMatchPrefab) && ecs_search( + world, table, EcsPrefab, 0) != -1) + { + return false; + } -/* Restoring an unfiltered snapshot restores the world to the exact state it was - * when the snapshot was taken. */ -static -void restore_unfiltered( - ecs_world_t *world, - ecs_snapshot_t *snapshot) -{ - flecs_sparse_restore(ecs_eis(world), snapshot->entity_index); - flecs_sparse_free(snapshot->entity_index); - - world->stats.last_id = snapshot->last_id; + /* Check if pair cardinality matches pairs in query, if any */ + if (count_pairs(world, query, table) == -1) { + return false; + } - ecs_table_leaf_t *leafs = ecs_vector_first( - snapshot->tables, ecs_table_leaf_t); - int32_t i, count = (int32_t)flecs_sparse_last_id(&world->store.tables); - int32_t snapshot_count = ecs_vector_count(snapshot->tables); + ecs_term_t *terms = query->filter.terms; + int32_t i, term_count = query->filter.term_count; - for (i = 0; i <= count; i ++) { - ecs_table_t *world_table = flecs_sparse_get( - &world->store.tables, ecs_table_t, (uint32_t)i); + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_oper_kind_t oper = term->oper; - if (world_table && (world_table->flags & EcsTableHasBuiltins)) { + if (term->subj.var != EcsVarIsVariable || term->subj.entity != EcsThis){ + /* If term is matched on entity instead of This variable, it does + * not affect whether the table is matched */ continue; } - ecs_table_leaf_t *snapshot_table = NULL; - if (i < snapshot_count) { - snapshot_table = &leafs[i]; - if (!snapshot_table->table) { - snapshot_table = NULL; + if (oper == EcsAnd) { + if (!match_term(world, table, term)) { + return false; } - } - /* If the world table no longer exists but the snapshot table does, - * reinsert it */ - if (!world_table && snapshot_table) { - ecs_ids_t type = { - .array = ecs_vector_first(snapshot_table->type, ecs_id_t), - .count = ecs_vector_count(snapshot_table->type) - }; + } else if (oper == EcsNot) { + if (match_term(world, table, term)) { + return false; + } - ecs_table_t *table = flecs_table_find_or_create(world, &type); - ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + } else if (oper == EcsOr) { + bool match = false; - if (snapshot_table->data) { - flecs_table_replace_data(world, table, snapshot_table->data); + for (; i < term_count; i ++) { + term = &terms[i]; + if (term->oper != EcsOr) { + i --; + break; + } + + if (!match && match_term( world, table, term)) { + match = true; + } } - - /* If the world table still exists, replace its data */ - } else if (world_table && snapshot_table) { - ecs_assert(snapshot_table->table == world_table, - ECS_INTERNAL_ERROR, NULL); - if (snapshot_table->data) { - flecs_table_replace_data( - world, world_table, snapshot_table->data); - } else { - flecs_table_clear_data( - world, world_table, &world_table->storage); - flecs_table_init_data(world, world_table); + if (!match) { + return false; } - - /* If the snapshot table doesn't exist, this table was created after the - * snapshot was taken and needs to be deleted */ - } else if (world_table && !snapshot_table) { - /* Deleting a table invokes OnRemove triggers & updates the entity - * index. That is not what we want, since entities may no longer be - * valid (if they don't exist in the snapshot) or may have been - * restored in a different table. Therefore first clear the data - * from the table (which doesn't invoke triggers), and then delete - * the table. */ - flecs_table_clear_data(world, world_table, &world_table->storage); - flecs_delete_table(world, world_table); - - /* If there is no world & snapshot table, nothing needs to be done */ - } else { } + + } else if (oper == EcsAndFrom || oper == EcsOrFrom || oper == EcsNotFrom) { + ecs_type_t type = get_term_type((ecs_world_t*)world, term, term->id); + int32_t match_count = 0, j, count = ecs_vector_count(type); + ecs_entity_t *ids = ecs_vector_first(type, ecs_entity_t); - if (snapshot_table) { - ecs_os_free(snapshot_table->data); - ecs_os_free(snapshot_table->type); + for (j = 0; j < count; j ++) { + ecs_term_t tmp_term = *term; + tmp_term.oper = EcsAnd; + tmp_term.id = ids[j]; + tmp_term.pred.entity = ids[j]; + + if (match_term(world, table, &tmp_term)) { + match_count ++; + } + } + + if (oper == EcsAndFrom && match_count != count) { + return false; + } + if (oper == EcsOrFrom && match_count == 0) { + return false; + } + if (oper == EcsNotFrom && match_count != 0) { + return false; + } } } - /* Now that all tables have been restored and world is in a consistent - * state, run OnSet systems */ - int32_t world_count = flecs_sparse_count(&world->store.tables); - for (i = 0; i < world_count; i ++) { + return true; +} + +/** Match existing tables against system (table is created before system) */ +static +void match_tables( + ecs_world_t *world, + ecs_query_t *query) +{ + int32_t i, count = flecs_sparse_count(&world->store.tables); + + for (i = 0; i < count; i ++) { ecs_table_t *table = flecs_sparse_get_dense( &world->store.tables, ecs_table_t, i); - if (table->flags & EcsTableHasBuiltins) { - continue; - } - int32_t tcount = ecs_table_count(table); - if (tcount) { - flecs_notify_on_set(world, table, 0, tcount, NULL, true); + if (flecs_query_match(world, table, query)) { + add_table(world, query, table); } } } -/* Restoring a filtered snapshots only restores the entities in the snapshot - * to their previous state. */ static -void restore_filtered( +int32_t qsort_partition( ecs_world_t *world, - ecs_snapshot_t *snapshot) + ecs_table_t *table, + ecs_data_t *data, + ecs_entity_t *entities, + void *ptr, + int32_t elem_size, + int32_t lo, + int32_t hi, + ecs_order_by_action_t compare) { - ecs_table_leaf_t *leafs = ecs_vector_first( - snapshot->tables, ecs_table_leaf_t); - int32_t l = 0, snapshot_count = ecs_vector_count(snapshot->tables); + int32_t p = (hi + lo) / 2; + void *pivot = ECS_ELEM(ptr, elem_size, p); + ecs_entity_t pivot_e = entities[p]; + int32_t i = lo - 1, j = hi + 1; + void *el; - for (l = 0; l < snapshot_count; l ++) { - ecs_table_leaf_t *snapshot_table = &leafs[l]; - ecs_table_t *table = snapshot_table->table; +repeat: + { + do { + i ++; + el = ECS_ELEM(ptr, elem_size, i); + } while ( compare(entities[i], el, pivot_e, pivot) < 0); - if (!table) { - continue; - } + do { + j --; + el = ECS_ELEM(ptr, elem_size, j); + } while ( compare(entities[j], el, pivot_e, pivot) > 0); - ecs_data_t *data = snapshot_table->data; - if (!data) { - ecs_vector_free(snapshot_table->type); - continue; + if (i >= j) { + return j; } - /* Delete entity from storage first, so that when we restore it to the - * current table we can be sure that there won't be any duplicates */ - int32_t i, entity_count = ecs_vector_count(data->entities); - ecs_entity_t *entities = ecs_vector_first( - snapshot_table->data->entities, ecs_entity_t); - for (i = 0; i < entity_count; i ++) { - ecs_entity_t e = entities[i]; - ecs_record_t *r = ecs_eis_get(world, e); - if (r && r->table) { - flecs_table_delete(world, r->table, &r->table->storage, - ECS_RECORD_TO_ROW(r->row), true); - } else { - /* Make sure that the entity has the same generation count */ - ecs_eis_set_generation(world, e); - } + flecs_table_swap(world, table, data, i, j); + + if (p == i) { + pivot = ECS_ELEM(ptr, elem_size, j); + pivot_e = entities[j]; + } else if (p == j) { + pivot = ECS_ELEM(ptr, elem_size, i); + pivot_e = entities[i]; } - /* Merge data from snapshot table with world table */ - int32_t old_count = ecs_table_count(snapshot_table->table); - int32_t new_count = flecs_table_data_count(snapshot_table->data); + goto repeat; + } +} - flecs_table_merge(world, table, table, &table->storage, snapshot_table->data); +static +void qsort_array( + ecs_world_t *world, + ecs_table_t *table, + ecs_data_t *data, + ecs_entity_t *entities, + void *ptr, + int32_t size, + int32_t lo, + int32_t hi, + ecs_order_by_action_t compare) +{ + if ((hi - lo) < 1) { + return; + } - /* Run OnSet systems for merged entities */ - if (new_count) { - flecs_notify_on_set( - world, table, old_count, new_count, NULL, true); - } + int32_t p = qsort_partition( + world, table, data, entities, ptr, size, lo, hi, compare); - ecs_os_free(snapshot_table->data->columns); - ecs_os_free(snapshot_table->data); - ecs_vector_free(snapshot_table->type); - } + qsort_array(world, table, data, entities, ptr, size, lo, p, compare); + + qsort_array(world, table, data, entities, ptr, size, p + 1, hi, compare); } -/** Restore a snapshot */ -void ecs_snapshot_restore( +static +void sort_table( ecs_world_t *world, - ecs_snapshot_t *snapshot) + ecs_table_t *table, + int32_t column_index, + ecs_order_by_action_t compare) { - ecs_force_aperiodic(world); - - if (snapshot->entity_index) { - /* Unfiltered snapshots have a copy of the entity index which is - * copied back entirely when the snapshot is restored */ - restore_unfiltered(world, snapshot); - } else { - restore_filtered(world, snapshot); + ecs_data_t *data = &table->storage; + if (!data->entities) { + /* Nothing to sort */ + return; } - ecs_vector_free(snapshot->tables); + int32_t count = flecs_table_data_count(data); + if (count < 2) { + return; + } - ecs_os_free(snapshot); + ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); + + void *ptr = NULL; + int32_t size = 0; + if (column_index != -1) { + ecs_column_t *column = &data->columns[column_index]; + size = column->size; + ptr = ecs_vector_first_t(column->data, size, column->alignment); + } + + qsort_array(world, table, data, entities, ptr, size, 0, count - 1, compare); } -ecs_iter_t ecs_snapshot_iter( - ecs_snapshot_t *snapshot) +/* Helper struct for building sorted table ranges */ +typedef struct sort_helper_t { + ecs_query_table_match_t *match; + ecs_entity_t *entities; + const void *ptr; + int32_t row; + int32_t elem_size; + int32_t count; + bool shared; +} sort_helper_t; + +static +const void* ptr_from_helper( + sort_helper_t *helper) { - ecs_snapshot_iter_t iter = { - .tables = snapshot->tables, - .index = 0 - }; + ecs_assert(helper->row < helper->count, ECS_INTERNAL_ERROR, NULL); + ecs_assert(helper->elem_size >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(helper->row >= 0, ECS_INTERNAL_ERROR, NULL); + if (helper->shared) { + return helper->ptr; + } else { + return ECS_ELEM(helper->ptr, helper->elem_size, helper->row); + } +} - return (ecs_iter_t){ - .world = snapshot->world, - .table_count = ecs_vector_count(snapshot->tables), - .priv.iter.snapshot = iter, - .next = ecs_snapshot_next - }; +static +ecs_entity_t e_from_helper( + sort_helper_t *helper) +{ + if (helper->row < helper->count) { + return helper->entities[helper->row]; + } else { + return 0; + } } -bool ecs_snapshot_next( - ecs_iter_t *it) +static +void build_sorted_table_range( + ecs_query_t *query, + ecs_query_table_list_t *list) { - ecs_snapshot_iter_t *iter = &it->priv.iter.snapshot; - ecs_table_leaf_t *tables = ecs_vector_first(iter->tables, ecs_table_leaf_t); - int32_t count = ecs_vector_count(iter->tables); - int32_t i; + ecs_world_t *world = query->world; + ecs_entity_t id = query->order_by_component; + ecs_order_by_action_t compare = query->order_by; + + if (!list->count) { + return; + } - for (i = iter->index; i < count; i ++) { - ecs_table_t *table = tables[i].table; - if (!table) { + int to_sort = 0; + + sort_helper_t *helper = ecs_os_malloc_n(sort_helper_t, list->count); + ecs_query_table_node_t *cur, *end = list->last->next; + for (cur = list->first; cur != end; cur = cur->next) { + ecs_query_table_match_t *match = cur->match; + ecs_table_t *table = match->table; + ecs_data_t *data = &table->storage; + ecs_vector_t *entities; + + if (!(entities = data->entities) || !ecs_table_count(table)) { continue; } - ecs_data_t *data = tables[i].data; + int32_t index = -1; + if (id) { + index = ecs_search(world, table->storage_table, id, 0); + } - it->table = table; - it->count = ecs_table_count(table); - if (data) { - it->entities = ecs_vector_first(data->entities, ecs_entity_t); + if (index != -1) { + ecs_column_t *column = &data->columns[index]; + int16_t size = column->size; + int16_t align = column->alignment; + helper[to_sort].ptr = ecs_vector_first_t(column->data, size, align); + helper[to_sort].elem_size = size; + helper[to_sort].shared = false; + } else if (id) { + /* Find component in prefab */ + ecs_entity_t base = 0; + ecs_search_relation(world, table, 0, id, + EcsIsA, 1, 0, &base, NULL, NULL); + + /* If a base was not found, the query should not have allowed using + * the component for sorting */ + ecs_assert(base != 0, ECS_INTERNAL_ERROR, NULL); + + const EcsComponent *cptr = ecs_get(world, id, EcsComponent); + ecs_assert(cptr != NULL, ECS_INTERNAL_ERROR, NULL); + + helper[to_sort].ptr = ecs_get_id(world, base, id); + helper[to_sort].elem_size = cptr->size; + helper[to_sort].shared = true; } else { - it->entities = NULL; + helper[to_sort].ptr = NULL; + helper[to_sort].elem_size = 0; + helper[to_sort].shared = false; } - it->is_valid = true; - iter->index = i + 1; - - goto yield; + helper[to_sort].match = match; + helper[to_sort].entities = ecs_vector_first(entities, ecs_entity_t); + helper[to_sort].row = 0; + helper[to_sort].count = ecs_table_count(table); + to_sort ++; } - it->is_valid = false; - return false; - -yield: - it->is_valid = true; - return true; -} - -/** Cleanup snapshot */ -void ecs_snapshot_free( - ecs_snapshot_t *snapshot) -{ - flecs_sparse_free(snapshot->entity_index); + ecs_assert(to_sort != 0, ECS_INTERNAL_ERROR, NULL); - ecs_table_leaf_t *tables = ecs_vector_first(snapshot->tables, ecs_table_leaf_t); - int32_t i, count = ecs_vector_count(snapshot->tables); - for (i = 0; i < count; i ++) { - ecs_table_leaf_t *snapshot_table = &tables[i]; - ecs_table_t *table = snapshot_table->table; - if (table) { - ecs_data_t *data = snapshot_table->data; - if (data) { - flecs_table_clear_data(snapshot->world, table, data); - ecs_os_free(data); + bool proceed; + do { + int32_t j, min = 0; + proceed = true; + + ecs_entity_t e1; + while (!(e1 = e_from_helper(&helper[min]))) { + min ++; + if (min == to_sort) { + proceed = false; + break; } - ecs_vector_free(snapshot_table->type); } - } - - ecs_vector_free(snapshot->tables); - ecs_os_free(snapshot); -} - -#endif + if (!proceed) { + break; + } + for (j = min + 1; j < to_sort; j++) { + ecs_entity_t e2 = e_from_helper(&helper[j]); + if (!e2) { + continue; + } -#ifdef FLECS_DOC + const void *ptr1 = ptr_from_helper(&helper[min]); + const void *ptr2 = ptr_from_helper(&helper[j]); -static ECS_COPY(EcsDocDescription, dst, src, { - ecs_os_strset((char**)&dst->value, src->value); + if (compare(e1, ptr1, e2, ptr2) > 0) { + min = j; + e1 = e_from_helper(&helper[min]); + } + } -}) + sort_helper_t *cur_helper = &helper[min]; + if (!cur || cur->match != cur_helper->match) { + cur = ecs_vector_add(&query->table_slices, ecs_query_table_node_t); + ecs_assert(cur != NULL, ECS_INTERNAL_ERROR, NULL); + cur->match = cur_helper->match; + cur->offset = cur_helper->row; + cur->count = 1; + } else { + cur->count ++; + } -static ECS_MOVE(EcsDocDescription, dst, src, { - ecs_os_free((char*)dst->value); - dst->value = src->value; - src->value = NULL; -}) + cur_helper->row ++; + } while (proceed); -static ECS_DTOR(EcsDocDescription, ptr, { - ecs_os_free((char*)ptr->value); -}) + /* Iterate through the vector of slices to set the prev/next ptrs. This + * can't be done while building the vector, as reallocs may occur */ + int32_t i, count = ecs_vector_count(query->table_slices); + ecs_query_table_node_t *nodes = ecs_vector_first( + query->table_slices, ecs_query_table_node_t); + for (i = 0; i < count; i ++) { + nodes[i].prev = &nodes[i - 1]; + nodes[i].next = &nodes[i + 1]; + } -void ecs_doc_set_name( - ecs_world_t *world, - ecs_entity_t entity, - const char *name) -{ - ecs_set_pair(world, entity, EcsDocDescription, EcsName, { - .value = name - }); -} + nodes[0].prev = NULL; + nodes[i - 1].next = NULL; -void ecs_doc_set_brief( - ecs_world_t *world, - ecs_entity_t entity, - const char *description) -{ - ecs_set_pair(world, entity, EcsDocDescription, EcsDocBrief, { - .value = description - }); + ecs_os_free(helper); } -void ecs_doc_set_detail( - ecs_world_t *world, - ecs_entity_t entity, - const char *description) +static +void build_sorted_tables( + ecs_query_t *query) { - ecs_set_pair(world, entity, EcsDocDescription, EcsDocDetail, { - .value = description - }); -} + ecs_vector_clear(query->table_slices); -void ecs_doc_set_link( - ecs_world_t *world, - ecs_entity_t entity, - const char *link) -{ - ecs_set_pair(world, entity, EcsDocDescription, EcsDocLink, { - .value = link - }); -} + if (query->group_by) { + /* Populate sorted node list in grouping order */ + ecs_query_table_node_t *cur = query->list.first; + if (cur) { + do { + /* Find list for current group */ + ecs_query_table_match_t *match = cur->match; + ecs_assert(match != NULL, ECS_INTERNAL_ERROR, NULL); + uint64_t group_id = match->group_id; + ecs_query_table_list_t *list = ecs_map_get(&query->groups, + ecs_query_table_list_t, group_id); + ecs_assert(list != NULL, ECS_INTERNAL_ERROR, NULL); -const char* ecs_doc_get_name( - const ecs_world_t *world, - ecs_entity_t entity) -{ - EcsDocDescription *ptr = ecs_get_pair( - world, entity, EcsDocDescription, EcsName); - if (ptr) { - return ptr->value; + /* Sort tables in current group */ + build_sorted_table_range(query, list); + + /* Find next group to sort */ + cur = list->last->next; + } while (cur); + } } else { - return ecs_get_name(world, entity); + build_sorted_table_range(query, &query->list); } } -const char* ecs_doc_get_brief( - const ecs_world_t *world, - ecs_entity_t entity) +static +void sort_tables( + ecs_world_t *world, + ecs_query_t *query) { - EcsDocDescription *ptr = ecs_get_pair( - world, entity, EcsDocDescription, EcsDocBrief); - if (ptr) { - return ptr->value; - } else { - return NULL; + ecs_order_by_action_t compare = query->order_by; + if (!compare) { + return; } -} + + ecs_entity_t order_by_component = query->order_by_component; + int32_t i, order_by_term = -1; -const char* ecs_doc_get_detail( - const ecs_world_t *world, - ecs_entity_t entity) -{ - EcsDocDescription *ptr = ecs_get_pair( - world, entity, EcsDocDescription, EcsDocDetail); - if (ptr) { - return ptr->value; - } else { - return NULL; - } -} + /* Find term that iterates over component (must be at least one) */ + if (order_by_component) { + const ecs_filter_t *f = &query->filter; + int32_t term_count = f->term_count_actual; + for (i = 0; i < term_count; i ++) { + ecs_term_t *term = &f->terms[i]; + if (term->subj.entity != EcsThis) { + continue; + } -const char* ecs_doc_get_link( - const ecs_world_t *world, - ecs_entity_t entity) -{ - EcsDocDescription *ptr = ecs_get_pair( - world, entity, EcsDocDescription, EcsDocLink); - if (ptr) { - return ptr->value; - } else { - return NULL; + if (term->id == order_by_component) { + order_by_term = i; + break; + } + } + + ecs_assert(order_by_term != -1, ECS_INTERNAL_ERROR, NULL); } -} -void FlecsDocImport( - ecs_world_t *world) -{ - ECS_MODULE(world, FlecsDoc); + /* Iterate over non-empty tables. Don't bother with empty tables as they + * have nothing to sort */ - ecs_set_name_prefix(world, "EcsDoc"); + bool tables_sorted = false; - flecs_bootstrap_component(world, EcsDocDescription); - flecs_bootstrap_tag(world, EcsDocBrief); - flecs_bootstrap_tag(world, EcsDocDetail); - flecs_bootstrap_tag(world, EcsDocLink); + ecs_table_cache_iter_t it; + ecs_query_table_t *qt; + flecs_table_cache_iter(&query->cache, &it); - ecs_set_component_actions(world, EcsDocDescription, { - .ctor = ecs_default_ctor, - .move = ecs_move(EcsDocDescription), - .copy = ecs_copy(EcsDocDescription), - .dtor = ecs_dtor(EcsDocDescription) - }); + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + ecs_table_t *table = qt->hdr.table; + bool dirty = false; - ecs_add_id(world, ecs_id(EcsDocDescription), EcsDontInherit); -} + if (check_table_monitor(query, qt, 0)) { + dirty = true; + } -#endif + int32_t column = -1; + if (order_by_component) { + if (check_table_monitor(query, qt, order_by_term + 1)) { + dirty = true; + } + if (dirty) { + column = -1; -#ifdef FLECS_PLECS + ecs_table_t *storage_table = table->storage_table; + if (storage_table) { + column = ecs_search(world, storage_table, + order_by_component, NULL); + } -#include -#include + if (column == -1) { + /* Component is shared, no sorting is needed */ + dirty = false; + } + } + } -#define TOK_NEWLINE '\n' -#define TOK_WITH "with" -#define TOK_USING "using" + if (!dirty) { + continue; + } -#define STACK_MAX_SIZE (64) + /* Something has changed, sort the table */ + sort_table(world, table, column, compare); + tables_sorted = true; + } -typedef struct { - const char *name; - const char *code; + if (tables_sorted || query->match_count != query->prev_match_count) { + build_sorted_tables(query); + query->match_count ++; /* Increase version if tables changed */ + } +} - ecs_entity_t last_predicate; - ecs_entity_t last_subject; - ecs_entity_t last_object; +static +bool has_refs( + ecs_query_t *query) +{ + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count; - ecs_id_t last_assign_id; - ecs_entity_t assign_to; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_term_id_t *subj = &term->subj; - ecs_entity_t scope[STACK_MAX_SIZE]; - ecs_entity_t default_scope_type[STACK_MAX_SIZE]; - ecs_entity_t with[STACK_MAX_SIZE]; - ecs_entity_t using[STACK_MAX_SIZE]; - int32_t with_frames[STACK_MAX_SIZE]; - int32_t using_frames[STACK_MAX_SIZE]; - int32_t sp; - int32_t with_frame; - int32_t using_frame; + if (term->oper == EcsNot && !subj->entity) { + /* Special case: if oper kind is Not and the query contained a + * shared expression, the expression is translated to FromEmpty to + * prevent resolving the ref */ + return true; + } else if (subj->entity && (subj->entity != EcsThis || subj->set.mask != EcsSelf)) { + /* If entity is not this, or if it can be substituted by other + * entities, the query can have references. */ + return true; + } + } - char *comment; + return false; +} - bool with_stmt; - bool scope_assign_stmt; - bool using_stmt; - bool assign_stmt; - bool isa_stmt; +static +bool has_pairs( + ecs_query_t *query) +{ + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count; - int32_t errors; -} plecs_state_t; + for (i = 0; i < count; i ++) { + if (ecs_id_is_wildcard(terms[i].id)) { + return true; + } + } + + return false; +} static -ecs_entity_t plecs_lookup( - const ecs_world_t *world, - const char *path, - plecs_state_t *state, - bool is_subject) +void for_each_component_monitor( + ecs_world_t *world, + ecs_query_t *query, + void(*callback)( + ecs_world_t* world, + ecs_entity_t relation, + ecs_id_t id, + ecs_query_t *query)) { - ecs_entity_t e = 0; + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count; - if (!is_subject) { - int using_scope = state->using_frame - 1; - for (; using_scope >= 0; using_scope--) { - e = ecs_lookup_path_w_sep( - world, state->using[using_scope], path, NULL, NULL, false); - if (e) { - break; + for (i = 0; i < count; i++) { + ecs_term_t *term = &terms[i]; + ecs_term_id_t *subj = &term->subj; + + /* If component is requested with EcsCascade register component as a + * parent monitor. Parent monitors keep track of whether an entity moved + * in the hierarchy, which potentially requires the query to reorder its + * tables. + * Also register a regular component monitor for EcsCascade columns. + * This ensures that when the component used in the EcsCascade column + * is added or removed tables are updated accordingly*/ + if (subj->set.mask & EcsSuperSet && subj->set.mask & EcsCascade && + subj->set.relation != EcsIsA) + { + if (term->oper != EcsOr) { + if (term->subj.set.relation != EcsIsA) { + callback( + world, term->subj.set.relation, term->id, query); + } + callback(world, 0, term->id, query); } - } - } - if (!e) { - e = ecs_lookup_path_w_sep(world, 0, path, NULL, NULL, !is_subject); + /* FromAny also requires registering a monitor, as FromAny columns can + * be matched with prefabs. The only term kinds that do not require + * registering a monitor are FromOwned and FromEmpty. */ + } else if ((subj->set.mask & EcsSuperSet) || (subj->entity != EcsThis)){ + if (term->oper != EcsOr) { + callback(world, 0, term->id, query); + } + } } - - return e; } -/* Lookup action used for deserializing entity refs in component values */ -#ifdef FLECS_EXPR static -ecs_entity_t plecs_lookup_action( - const ecs_world_t *world, - const char *path, - void *ctx) +void register_monitors( + ecs_world_t *world, + ecs_query_t *query) { - return plecs_lookup(world, path, ctx, false); + for_each_component_monitor(world, query, flecs_monitor_register); } -#endif static -void clear_comment( - const char *expr, - const char *ptr, - plecs_state_t *state) +void unregister_monitors( + ecs_world_t *world, + ecs_query_t *query) { - if (state->comment) { - ecs_parser_error(state->name, expr, ptr - expr, "unused doc comment"); - ecs_os_free(state->comment); - state->comment = NULL; + for_each_component_monitor(world, query, flecs_monitor_unregister); +} - state->errors ++; /* Non-fatal error */ +static +bool is_term_id_supported( + ecs_term_id_t *term_id) +{ + if (term_id->var != EcsVarIsVariable) { + return true; + } + if (term_id->entity == EcsWildcard) { + return true; } + return false; } static -const char* parse_fluff( - const char *expr, - const char *ptr, - plecs_state_t *state) +void process_signature( + ecs_world_t *world, + ecs_query_t *query) { - char *comment; - const char *next = ecs_parse_fluff(ptr, &comment); + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count; - if (comment && comment[0] == '/') { - comment = (char*)ecs_parse_fluff(comment + 1, NULL); - int32_t len = (ecs_size_t)(next - comment); - int32_t newline_count = 0; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_term_id_t *pred = &term->pred; + ecs_term_id_t *subj = &term->subj; + ecs_term_id_t *obj = &term->obj; + ecs_oper_kind_t op = term->oper; + ecs_inout_kind_t inout = term->inout; - /* Trim trailing whitespaces */ - while (len >= 0 && (isspace(comment[len - 1]))) { - if (comment[len - 1] == '\n') { - newline_count ++; - if (newline_count > 1) { - /* If newline separates comment from statement, discard */ - len = -1; - break; + bool is_pred_supported = is_term_id_supported(pred); + bool is_subj_supported = is_term_id_supported(subj); + bool is_obj_supported = is_term_id_supported(obj); + + (void)pred; + (void)obj; + (void)is_pred_supported; + (void)is_subj_supported; + (void)is_obj_supported; + + /* Queries do not support named variables */ + ecs_check(is_pred_supported, ECS_UNSUPPORTED, NULL); + ecs_check(is_obj_supported, ECS_UNSUPPORTED, NULL); + ecs_check(is_subj_supported || subj->entity == EcsThis, + ECS_UNSUPPORTED, NULL); + + /* If self is not included in set, always start from depth 1 */ + if (!subj->set.min_depth && !(subj->set.mask & EcsSelf)) { + subj->set.min_depth = 1; + } + + if (inout != EcsIn) { + query->flags |= EcsQueryHasOutColumns; + } + + if (op == EcsOptional) { + query->flags |= EcsQueryHasOptional; + } + + if (!(query->flags & EcsQueryMatchDisabled)) { + if (op == EcsAnd || op == EcsOr || op == EcsOptional) { + if (term->id == EcsDisabled) { + query->flags |= EcsQueryMatchDisabled; } } - len --; } - if (len > 0) { - clear_comment(expr, ptr, state); - state->comment = ecs_os_calloc_n(char, len + 1); - ecs_os_strncpy(state->comment, comment, len); - } else { - ecs_parser_error(state->name, expr, ptr - expr, - "unused doc comment"); - state->errors ++; - } - } else { - if (ptr != next && state->comment) { - clear_comment(expr, ptr, state); + if (!(query->flags & EcsQueryMatchPrefab)) { + if (op == EcsAnd || op == EcsOr || op == EcsOptional) { + if (term->id == EcsPrefab) { + query->flags |= EcsQueryMatchPrefab; + } + } + } + + if (subj->entity == EcsThis) { + query->flags |= EcsQueryNeedsTables; + } + + if (subj->set.mask & EcsCascade && term->oper == EcsOptional) { + /* Query can only have one cascade column */ + ecs_assert(query->cascade_by == 0, ECS_INVALID_PARAMETER, NULL); + query->cascade_by = i + 1; + } + + if (subj->entity && subj->entity != EcsThis && + subj->set.mask == EcsSelf) + { + flecs_add_flag(world, term->subj.entity, ECS_FLAG_OBSERVED); } } - return next; + query->flags |= (ecs_flags32_t)(has_refs(query) * EcsQueryHasRefs); + query->flags |= (ecs_flags32_t)(has_pairs(query) * EcsQueryHasTraits); + + if (!(query->flags & EcsQueryIsSubquery)) { + register_monitors(world, query); + } +error: + return; } static -ecs_entity_t ensure_entity( +bool match_table( ecs_world_t *world, - plecs_state_t *state, - const char *path, - bool is_subject) + ecs_query_t *query, + ecs_table_t *table) { - if (!path) { - return 0; + if (flecs_query_match(world, table, query)) { + add_table(world, query, table); + return true; } + return false; +} - ecs_entity_t e = plecs_lookup(world, path, state, is_subject); - if (!e) { - if (!is_subject) { - /* If this is not a subject create an existing empty id, which - * ensures that scope & with are not applied */ - e = ecs_new_id(world); - } +/** When a table becomes empty remove it from the query list, or vice versa. */ +static +void update_table( + ecs_query_t *query, + ecs_table_t *table, + bool empty) +{ + int32_t prev_count = ecs_query_table_count(query); + ecs_table_cache_set_empty(&query->cache, table, empty); + int32_t cur_count = ecs_query_table_count(query); - e = ecs_add_path(world, e, 0, path); - ecs_assert(e != 0, ECS_INTERNAL_ERROR, NULL); - } else { - /* If entity exists, make sure it gets the right scope and with */ - if (is_subject) { - ecs_entity_t scope = ecs_get_scope(world); - if (scope) { - ecs_add_pair(world, e, EcsChildOf, scope); - } + if (prev_count != cur_count) { + ecs_query_table_t *qt = ecs_table_cache_get(&query->cache, table); + ecs_assert(qt != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_query_table_match_t *cur, *next; - ecs_entity_t with = ecs_get_with(world); - if (with) { - ecs_add_id(world, e, with); + for (cur = qt->first; cur != NULL; cur = next) { + next = cur->next_match; + + if (empty) { + ecs_assert(ecs_table_count(table) == 0, + ECS_INTERNAL_ERROR, NULL); + + remove_table_node(query, &cur->node); + } else { + ecs_assert(ecs_table_count(table) != 0, + ECS_INTERNAL_ERROR, NULL); + insert_table_node(query, &cur->node); } } } - return e; + ecs_assert(cur_count || query->list.first == NULL, + ECS_INTERNAL_ERROR, NULL); } static -bool pred_is_subj( - ecs_term_t *term, - plecs_state_t *state) +void add_subquery( + ecs_world_t *world, + ecs_query_t *parent, + ecs_query_t *subquery) { - if (term->subj.name != NULL) { - return false; - } - if (term->obj.name != NULL) { - return false; - } - if (term->subj.set.mask == EcsNothing) { - return false; - } - if (state->with_stmt) { - return false; - } - if (state->assign_stmt) { - return false; - } - if (state->isa_stmt) { - return false; + ecs_query_t **elem = ecs_vector_add(&parent->subqueries, ecs_query_t*); + *elem = subquery; + + ecs_table_cache_t *cache = &parent->cache; + ecs_table_cache_iter_t it; + ecs_query_table_t *qt; + flecs_table_cache_iter(cache, &it); + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + match_table(world, subquery, qt->hdr.table); } - if (state->using_stmt) { - return false; + + flecs_table_cache_empty_iter(cache, &it); + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + match_table(world, subquery, qt->hdr.table); } - - return true; } -/* Set masks aren't useful in plecs, so translate them back to entity names */ static -const char* set_mask_to_name( - ecs_flags32_t flags) +void notify_subqueries( + ecs_world_t *world, + ecs_query_t *query, + ecs_query_event_t *event) { - if (flags == EcsSelf) { - return "self"; - } else if (flags == EcsAll) { - return "all"; - } else if (flags == EcsSuperSet) { - return "super"; - } else if (flags == EcsSubSet) { - return "sub"; - } else if (flags == EcsCascade || flags == (EcsSuperSet|EcsCascade)) { - return "cascade"; - } else if (flags == EcsParent) { - return "parent"; + if (query->subqueries) { + ecs_query_t **queries = ecs_vector_first(query->subqueries, ecs_query_t*); + int32_t i, count = ecs_vector_count(query->subqueries); + + ecs_query_event_t sub_event = *event; + sub_event.parent_query = query; + + for (i = 0; i < count; i ++) { + ecs_query_t *sub = queries[i]; + flecs_query_notify(world, sub, &sub_event); + } } - return NULL; } static -int create_term( - ecs_world_t *world, - ecs_term_t *term, - const char *name, - const char *expr, - int64_t column, - plecs_state_t *state) +void resolve_cascade_subject_for_table( + ecs_world_t *world, + ecs_query_t *query, + const ecs_table_t *table, + ecs_query_table_match_t *table_data) { - state->last_subject = 0; - state->last_predicate = 0; - state->last_object = 0; - state->last_assign_id = 0; - - const char *pred_name = term->pred.name; - const char *subj_name = term->subj.name; - const char *obj_name = term->obj.name; - - if (!subj_name) { - subj_name = set_mask_to_name(term->subj.set.mask); - } - if (!obj_name) { - obj_name = set_mask_to_name(term->obj.set.mask); - } - - if (!ecs_term_id_is_set(&term->pred)) { - ecs_parser_error(name, expr, column, "missing predicate in expression"); - return -1; - } - - if (state->assign_stmt && term->subj.entity != EcsThis) { - ecs_parser_error(name, expr, column, - "invalid statement in assign statement"); - return -1; - } + int32_t term_index = query->cascade_by - 1; + ecs_term_t *term = &query->filter.terms[term_index]; - bool pred_as_subj = pred_is_subj(term, state); + ecs_assert(table_data->references != 0, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t pred = ensure_entity(world, state, pred_name, pred_as_subj); - ecs_entity_t subj = ensure_entity(world, state, subj_name, true); - ecs_entity_t obj = 0; + /* Obtain reference index */ + int32_t *column_indices = table_data->columns; + int32_t ref_index = -column_indices[term_index] - 1; - if (ecs_term_id_is_set(&term->obj)) { - obj = ensure_entity(world, state, obj_name, - state->assign_stmt == false); - } + /* Obtain pointer to the reference data */ + ecs_ref_t *references = table_data->references; - if (state->assign_stmt || state->isa_stmt) { - subj = state->assign_to; - } + /* Find source for component */ + ecs_entity_t subject = 0; + ecs_search_relation(world, table, 0, term->id, + term->subj.set.relation, 1, 0, &subject, NULL, NULL); - if (state->isa_stmt && obj) { - ecs_parser_error(name, expr, column, - "invalid object in inheritance statement"); - return -1; - } + /* If container was found, update the reference */ + if (subject) { + ecs_ref_t *ref = &references[ref_index]; + ecs_assert(ref->component == term->id, ECS_INTERNAL_ERROR, NULL); - if (state->using_stmt && (obj || subj)) { - ecs_parser_error(name, expr, column, - "invalid predicate/object in using statement"); - return -1; + references[ref_index].entity = ecs_get_alive(world, subject); + table_data->subjects[term_index] = subject; + ecs_get_ref_id(world, ref, subject, term->id); + } else { + references[ref_index].entity = 0; + table_data->subjects[term_index] = 0; } - if (state->isa_stmt) { - pred = ecs_pair(EcsIsA, pred); + if (ecs_table_count(table)) { + /* The subject (or depth of the subject) may have changed, so reinsert + * the node to make sure it's in the right group */ + remove_table_node(query, &table_data->node); + insert_table_node(query, &table_data->node); } +} - if (subj) { - if (!obj) { - ecs_add_id(world, subj, pred); - state->last_assign_id = pred; - } else { - ecs_add_pair(world, subj, pred, obj); - state->last_object = obj; - state->last_assign_id = ecs_pair(pred, obj); - } - state->last_predicate = pred; - state->last_subject = subj; - - pred_as_subj = false; - } else { - if (!obj) { - /* If no subject or object were provided, use predicate as subj - * unless the expression explictly excluded the subject */ - if (pred_as_subj) { - state->last_subject = pred; - subj = pred; - } else { - state->last_predicate = pred; - pred_as_subj = false; - } - } else { - state->last_predicate = pred; - state->last_object = obj; - pred_as_subj = false; - } +static +void resolve_cascade_subject( + ecs_world_t *world, + ecs_query_t *query, + ecs_query_table_t *elem, + const ecs_table_t *table) +{ + ecs_query_table_match_t *cur; + for (cur = elem->first; cur != NULL; cur = cur->next_match) { + resolve_cascade_subject_for_table(world, query, table, cur); } +} - /* If this is a with clause (the list of entities between 'with' and scope - * open), add subject to the array of with frames */ - if (state->with_stmt) { - ecs_assert(pred != 0, ECS_INTERNAL_ERROR, NULL); - ecs_id_t id; - - if (obj) { - id = ecs_pair(pred, obj); - } else { - id = pred; - } - - state->with[state->with_frame ++] = id; - - } else if (state->using_stmt) { - ecs_assert(pred != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(obj == 0, ECS_INTERNAL_ERROR, NULL); +/* Remove table */ +static +void query_table_free( + ecs_query_t *query, + ecs_query_table_t *elem) +{ + ecs_query_table_match_t *cur, *next; - state->using[state->using_frame ++] = pred; - state->using_frames[state->sp] = state->using_frame; + for (cur = elem->first; cur != NULL; cur = next) { + ecs_os_free(cur->columns); + ecs_os_free(cur->ids); + ecs_os_free(cur->subjects); + ecs_os_free(cur->sizes); + ecs_os_free(cur->references); + ecs_os_free(cur->sparse_columns); + ecs_os_free(cur->bitset_columns); + ecs_os_free(cur->monitor); - /* If this is not a with/using clause, add with frames to subject */ - } else { - if (subj) { - int32_t i, frame_count = state->with_frames[state->sp]; - for (i = 0; i < frame_count; i ++) { - ecs_add_id(world, subj, state->with[i]); - } + if (!elem->hdr.empty) { + remove_table_node(query, &cur->node); } - } - /* If an id was provided by itself, add default scope type to it */ - ecs_entity_t default_scope_type = state->default_scope_type[state->sp]; - if (pred_as_subj && default_scope_type) { - ecs_add_id(world, subj, default_scope_type); - } + next = cur->next_match; - /* If a comment preceded the statement, add it as a brief description */ -#ifdef FLECS_DOC - if (subj && state->comment) { - ecs_doc_set_brief(world, subj, state->comment); - ecs_os_free(state->comment); - state->comment = NULL; + ecs_os_free(cur); } -#endif - return 0; + ecs_os_free(elem); } static -const char* parse_inherit_stmt( - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) +void unmatch_table( + ecs_query_t *query, + ecs_table_t *table) { - if (state->isa_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "cannot nest inheritance"); - return NULL; - } - - if (!state->last_subject) { - ecs_parser_error(name, expr, ptr - expr, - "missing entity to assign inheritance to"); - return NULL; + ecs_query_table_t *qt = ecs_table_cache_remove( + &query->cache, table, NULL); + if (qt) { + query_table_free(query, qt); } - - state->isa_stmt = true; - state->assign_to = state->last_subject; - - return ptr; } static -const char* parse_assign_expr( +void rematch_table( ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) + ecs_query_t *query, + ecs_table_t *table) { - (void)world; - - if (!state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "unexpected value outside of assignment statement"); - return NULL; - } + ecs_query_table_t *match = ecs_table_cache_get(&query->cache, table); - ecs_id_t assign_id = state->last_assign_id; - if (!assign_id) { - ecs_parser_error(name, expr, ptr - expr, - "missing type for assignment statement"); - return NULL; - } + if (flecs_query_match(world, table, query)) { + /* If the table matches, and it is not currently matched, add */ + if (match == NULL) { + add_table(world, query, table); -#ifndef FLECS_EXPR - ecs_parser_error(name, expr, ptr - expr, - "cannot parse value, missing FLECS_EXPR addon"); - return NULL; -#else - ecs_entity_t assign_to = state->assign_to; - if (!assign_to) { - assign_to = state->last_subject; - } + /* If table still matches and has cascade column, reevaluate the + * sources of references. This may have changed in case + * components were added/removed to container entities */ + } else if (query->cascade_by) { + resolve_cascade_subject(world, query, match, table); - if (!assign_to) { - ecs_parser_error(name, expr, ptr - expr, - "missing entity to assign to"); - return NULL; - } + /* If query has optional columns, it is possible that a column that + * previously had data no longer has data, or vice versa. Do a + * rematch to make sure data is consistent. */ + } else if (query->flags & EcsQueryHasOptional) { + /* Check if optional terms that weren't matched before are matched + * now & vice versa */ + ecs_query_table_match_t *qt = match->first; - ecs_entity_t type = ecs_get_typeid(world, assign_id); - if (!type) { - char *id_str = ecs_id_str(world, assign_id); - ecs_parser_error(name, expr, ptr - expr, - "invalid assignment, '%s' is not a type", id_str); - ecs_os_free(id_str); - return NULL; - } + bool rematch = false; + int32_t i, count = query->filter.term_count_actual; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &query->filter.terms[i]; - void *value_ptr = ecs_get_mut_id( - world, assign_to, assign_id, NULL); + if (term->oper == EcsOptional) { + int32_t t = term->index; + int32_t column = 0; + flecs_term_match_table(world, term, table, + table->type, 0, &column, 0, 0, true); + if (column && (qt->columns[t] == 0)) { + rematch = true; + } else if (!column && (qt->columns[t] != 0)) { + rematch = true; + } + } + } - ptr = ecs_parse_expr(world, ptr, type, value_ptr, - &(ecs_parse_expr_desc_t) { - .name = name, - .expr = expr, - .lookup_action = plecs_lookup_action, - .lookup_ctx = state - }); - if (!ptr) { - return NULL; + if (rematch) { + unmatch_table(query, table); + add_table(world, query, table); + } + } + } else { + /* Table no longer matches, remove */ + if (match != NULL) { + unmatch_table(query, table); + notify_subqueries(world, query, &(ecs_query_event_t){ + .kind = EcsQueryTableUnmatch, + .table = table + }); + } } - - ecs_modified_id(world, assign_to, assign_id); -#endif - - return ptr; } static -const char* parse_assign_stmt( +bool satisfy_constraints( ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) -{ - (void)world; - - state->isa_stmt = false; - - /* Component scope (add components to entity) */ - if (!state->last_subject) { - ecs_parser_error(name, expr, ptr - expr, - "missing entity to assign to"); - return NULL; - } - - if (state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid assign statement in assign statement"); - return NULL; - } - - if (!state->scope_assign_stmt) { - state->assign_to = state->last_subject; - } + const ecs_filter_t *filter) +{ + ecs_term_t *terms = filter->terms; + int32_t i, count = filter->term_count; - state->assign_stmt = true; - - /* Assignment without a preceding component */ - if (ptr[0] == '{') { - ecs_entity_t type = 0; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + ecs_term_id_t *subj = &term->subj; + ecs_oper_kind_t oper = term->oper; - if (state->scope_assign_stmt) { - ecs_assert(state->assign_to == ecs_get_scope(world), - ECS_INTERNAL_ERROR, NULL); + if (oper == EcsOptional) { + continue; } - /* If we're in a scope & last_subject is a type, assign to scope */ - if (ecs_get_scope(world) != 0) { - type = ecs_get_typeid(world, state->last_subject); - if (type != 0) { - type = state->last_subject; + if (subj->entity != EcsThis && subj->entity) { + ecs_table_t *table = ecs_get_table(world, subj->entity); + if (!table) { + goto no_match; } - } - /* If type hasn't been set yet, check if scope has default type */ - if (!type && !state->scope_assign_stmt) { - type = state->default_scope_type[state->sp]; + if (!flecs_term_match_table(world, term, table, table->type, NULL, + NULL, NULL, NULL, true)) + { + goto no_match; + } } + } - /* If no type has been found still, check if last with id is a type */ - if (!type && !state->scope_assign_stmt) { - int32_t with_frame_count = state->with_frames[state->sp]; - if (with_frame_count) { - type = state->with[with_frame_count - 1]; + return true; +no_match: + return false; +} + +/* Rematch system with tables after a change happened to a watched entity */ +static +void rematch_tables( + ecs_world_t *world, + ecs_query_t *query, + ecs_query_t *parent_query) +{ + if (parent_query) { + ecs_table_cache_iter_t it; + if (flecs_table_cache_iter(&parent_query->cache, &it)) { + ecs_query_table_t *qt; + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + rematch_table(world, query, qt->hdr.table); } } - if (!type) { - ecs_parser_error(name, expr, ptr - expr, - "missing type for assignment"); - return NULL; - } + if (flecs_table_cache_empty_iter(&parent_query->cache, &it)) { + ecs_query_table_t *qt; + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + rematch_table(world, query, qt->hdr.table); + } + } + } else { + ecs_sparse_t *tables = &world->store.tables; + int32_t i, count = flecs_sparse_count(tables); - state->last_assign_id = type; + for (i = 0; i < count; i ++) { + /* Is the system currently matched with the table? */ + ecs_table_t *table = flecs_sparse_get_dense(tables, ecs_table_t, i); + rematch_table(world, query, table); + } } - return ptr; + /* Enable/disable system if constraints are (not) met. If the system is + * already dis/enabled this operation has no side effects. */ + query->constraints_satisfied = satisfy_constraints(world, &query->filter); } static -const char* parse_using_stmt( - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) +void remove_subquery( + ecs_query_t *parent, + ecs_query_t *sub) { - if (state->isa_stmt || state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid usage of using keyword"); - return NULL; - } + ecs_assert(parent != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(sub != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(parent->subqueries != NULL, ECS_INTERNAL_ERROR, NULL); - /* Add following expressions to using list */ - state->using_stmt = true; + int32_t i, count = ecs_vector_count(parent->subqueries); + ecs_query_t **sq = ecs_vector_first(parent->subqueries, ecs_query_t*); - return ptr + 5; + for (i = 0; i < count; i ++) { + if (sq[i] == sub) { + break; + } + } + + ecs_vector_remove(parent->subqueries, ecs_query_t*, i); } -static -const char* parse_with_stmt( - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) +/* -- Private API -- */ + +void flecs_query_notify( + ecs_world_t *world, + ecs_query_t *query, + ecs_query_event_t *event) { - if (state->isa_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid with after inheritance"); - return NULL; - } + bool notify = true; - if (state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid with in assign_stmt"); - return NULL; + switch(event->kind) { + case EcsQueryTableMatch: + /* Creation of new table */ + if (match_table(world, query, event->table)) { + if (query->subqueries) { + notify_subqueries(world, query, event); + } + } + notify = false; + break; + case EcsQueryTableUnmatch: + /* Deletion of table */ + unmatch_table(query, event->table); + break; + case EcsQueryTableRematch: + /* Rematch tables of query */ + rematch_tables(world, query, event->parent_query); + break; + case EcsQueryOrphan: + ecs_assert(query->flags & EcsQueryIsSubquery, ECS_INTERNAL_ERROR, NULL); + query->flags |= EcsQueryIsOrphaned; + query->parent = NULL; + break; } - /* Add following expressions to with list */ - state->with_stmt = true; - return ptr + 5; + if (notify) { + notify_subqueries(world, query, event); + } } static -const char* parse_scope_open( +void query_order_by( ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) + ecs_query_t *query, + ecs_entity_t order_by_component, + ecs_order_by_action_t order_by) { - state->isa_stmt = false; - - if (state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid scope in assign_stmt"); - return NULL; - } - - state->sp ++; - - ecs_entity_t scope = 0; - ecs_entity_t default_scope_type = 0; + ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(!(query->flags & EcsQueryIsOrphaned), ECS_INVALID_PARAMETER, NULL); + ecs_check(query->flags & EcsQueryNeedsTables, ECS_INVALID_PARAMETER, NULL); - if (!state->with_stmt) { - if (state->last_subject) { - scope = state->last_subject; - ecs_set_scope(world, state->last_subject); + query->order_by_component = order_by_component; + query->order_by = order_by; - /* Check if scope has a default child component */ - ecs_entity_t def_type_src = ecs_get_object_for_id(world, scope, - 0, ecs_pair(EcsDefaultChildComponent, EcsWildcard)); + ecs_vector_free(query->table_slices); + query->table_slices = NULL; - if (def_type_src) { - default_scope_type = ecs_get_object( - world, def_type_src, EcsDefaultChildComponent, 0); - } - } else { - if (state->last_object) { - scope = ecs_pair( - state->last_predicate, state->last_object); - ecs_set_with(world, scope); - } else { - if (state->last_predicate) { - scope = ecs_pair(EcsChildOf, state->last_predicate); - } - ecs_set_scope(world, state->last_predicate); - } - } + sort_tables(world, query); - state->scope[state->sp] = scope; - state->default_scope_type[state->sp] = default_scope_type; - } else { - state->scope[state->sp] = state->scope[state->sp - 1]; - state->default_scope_type[state->sp] = - state->default_scope_type[state->sp - 1]; + if (!query->table_slices) { + build_sorted_tables(query); } +error: + return; +} - state->using_frames[state->sp] = state->using_frame; - state->with_frames[state->sp] = state->with_frame; - state->with_stmt = false; +static +void query_group_by( + ecs_query_t *query, + ecs_entity_t sort_component, + ecs_group_by_action_t group_by) +{ + /* Cannot change grouping once a query has been created */ + ecs_check(query->group_by_id == 0, ECS_INVALID_OPERATION, NULL); + ecs_check(query->group_by == 0, ECS_INVALID_OPERATION, NULL); - return ptr; + query->group_by_id = sort_component; + query->group_by = group_by; + ecs_map_init(&query->groups, ecs_query_table_list_t, 16); +error: + return; } +/* Implementation for iterable mixin */ static -const char* parse_scope_close( - ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) +void query_iter_init( + const ecs_world_t *world, + const ecs_poly_t *poly, + ecs_iter_t *iter, + ecs_term_t *filter) { - if (state->isa_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "invalid '}' after inheritance statement"); - return NULL; - } + ecs_poly_assert(poly, ecs_query_t); - if (state->assign_stmt) { - ecs_parser_error(name, expr, ptr - expr, - "unfinished assignment before }"); - return NULL; + if (filter) { + iter[1] = ecs_query_iter(world, (ecs_query_t*)poly); + iter[0] = ecs_term_chain_iter(&iter[1], filter); + } else { + iter[0] = ecs_query_iter(world, (ecs_query_t*)poly); } +} - state->scope[state->sp] = 0; - state->default_scope_type[state->sp] = 0; - state->sp --; - - if (state->sp < 0) { - ecs_parser_error(name, expr, ptr - expr, "invalid } without a {"); - return NULL; +static +void query_on_event( + ecs_iter_t *it) +{ + /* Because this is the observer::run callback, checking if this is event is + * already handled is not done for us. */ + ecs_world_t *world = it->world; + ecs_observer_t *o = it->ctx; + if (o->last_event_id == world->event_id) { + return; } + o->last_event_id = world->event_id; - ecs_id_t id = state->scope[state->sp]; + ecs_query_t *query = o->ctx; + ecs_table_t *table = it->table; - if (!id || ECS_HAS_ROLE(id, PAIR)) { - ecs_set_with(world, id); + ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); + + /* The observer isn't doing the matching because the query can do it more + * efficiently by checking the table with the query cache. */ + if (ecs_table_cache_get(&query->cache, table) == NULL) { + return; } - if (!id || !ECS_HAS_ROLE(id, PAIR)) { - ecs_set_scope(world, id); + ecs_entity_t event = it->event; + if (event == EcsOnTableEmpty) { + update_table(query, table, true); + } else + if (event == EcsOnTableFill) { + update_table(query, table, false); } +} - state->with_frame = state->with_frames[state->sp]; - state->using_frame = state->using_frames[state->sp]; - state->last_subject = 0; - state->assign_stmt = false; - return ptr; -} +/* -- Public API -- */ -static -const char *parse_plecs_term( +ecs_query_t* ecs_query_init( ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) + const ecs_query_desc_t *desc) { - ecs_term_t term = {0}; - ecs_entity_t scope = ecs_get_scope(world); + ecs_query_t *result = NULL; + ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); - /* If first character is a (, this should be interpreted as an id assigned - * to the current scope if: - * - this is not already an assignment: "Foo = (Hello, World)" - * - this is in a scope - */ - bool scope_assignment = (ptr[0] == '(') && !state->assign_stmt && scope != 0; + /* Ensure that while initially populating the query with tables, they are + * in the right empty/non-empty list. This ensures the query won't miss + * empty/non-empty events for tables that are currently out of sync, but + * change back to being in sync before processing pending events. */ + ecs_force_aperiodic(world); - ptr = ecs_parse_term(world, name, expr, ptr, &term); - if (!ptr) { - return NULL; + result = flecs_sparse_add(world->queries, ecs_query_t); + ecs_poly_init(result, ecs_query_t); + result->id = flecs_sparse_last_id(world->queries); + + ecs_observer_desc_t observer_desc = { .filter = desc->filter }; + observer_desc.filter.match_empty_tables = true; + + if (ecs_filter_init(world, &result->filter, &observer_desc.filter)) { + goto error; } - if (!ecs_term_is_initialized(&term)) { - ecs_parser_error(name, expr, ptr - expr, "expected identifier"); - return NULL; /* No term found */ + if (result->filter.term_count) { + observer_desc.run = query_on_event; + observer_desc.ctx = result; + observer_desc.events[0] = EcsOnTableEmpty; + observer_desc.events[1] = EcsOnTableFill; + observer_desc.filter.filter = true; + + /* ecs_filter_init could have moved away resources from the terms array + * in the descriptor, so use the terms array from the filter. */ + observer_desc.filter.terms_buffer = result->filter.terms; + observer_desc.filter.terms_buffer_count = result->filter.term_count; + observer_desc.filter.expr = NULL; /* Already parsed */ + + result->observer = ecs_observer_init(world, &observer_desc); + if (!result->observer) { + goto error; + } } - /* Lookahead to check if this is an implicit scope assignment (no parens) */ - if (ptr[0] == '=') { - const char *tptr = ecs_parse_fluff(ptr + 1, NULL); - if (tptr[0] == '{') { - ecs_entity_t pred = plecs_lookup( - world, term.pred.name, state, false); - ecs_entity_t obj = plecs_lookup( - world, term.obj.name, state, false); - ecs_id_t id = 0; - if (pred && obj) { - id = ecs_pair(pred, obj); - } else if (pred) { - id = pred; - } + ecs_table_cache_init(&result->cache); - if (id && (ecs_get_typeid(world, id) != 0)) { - scope_assignment = true; - } - } + result->world = world; + result->iterable.init = query_iter_init; + result->system = desc->system; + result->prev_match_count = -1; + + process_signature(world, result); + + /* Group before matching so we won't have to move tables around later */ + int32_t cascade_by = result->cascade_by; + if (cascade_by) { + query_group_by(result, result->filter.terms[cascade_by - 1].id, + group_by_cascade); + result->group_by_ctx = &result->filter.terms[cascade_by - 1]; } - bool prev = state->assign_stmt; - if (scope_assignment) { - state->assign_stmt = true; - state->assign_to = scope; + if (desc->group_by) { + /* Can't have a cascade term and group by at the same time, as cascade + * uses the group_by mechanism */ + ecs_check(!result->cascade_by, ECS_INVALID_PARAMETER, NULL); + query_group_by(result, desc->group_by_id, desc->group_by); + result->group_by_ctx = desc->group_by_ctx; + result->group_by_ctx_free = desc->group_by_ctx_free; } - if (create_term(world, &term, name, expr, (ptr - expr), state)) { - ecs_term_fini(&term); - return NULL; /* Failed to create term */ + + if (desc->parent != NULL) { + result->flags |= EcsQueryIsSubquery; } - if (scope_assignment) { - state->last_subject = state->last_assign_id; - state->scope_assign_stmt = true; + + /* If a system is specified, ensure that if there are any subjects in the + * filter that refer to the system, the component is added */ + if (desc->system) { + int32_t t, term_count = result->filter.term_count; + ecs_term_t *terms = result->filter.terms; + + for (t = 0; t < term_count; t ++) { + ecs_term_t *term = &terms[t]; + if (term->subj.entity == desc->system) { + ecs_add_id(world, desc->system, term->id); + } + } } - state->assign_stmt = prev; - ecs_term_fini(&term); + if (ecs_should_log_1()) { + char *filter_expr = ecs_filter_str(world, &result->filter); + ecs_dbg_1("#[green]query#[normal] [%s] created", filter_expr); + ecs_os_free(filter_expr); + } - return ptr; -} + ecs_log_push_1(); -static -const char* parse_stmt( - ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - plecs_state_t *state) -{ - state->assign_stmt = false; - state->scope_assign_stmt = false; - state->isa_stmt = false; - state->with_stmt = false; - state->using_stmt = false; - state->last_subject = 0; - state->last_predicate = 0; - state->last_object = 0; + if (!desc->parent) { + if (result->flags & EcsQueryNeedsTables) { + match_tables(world, result); + } else { + /* Add stub table that resolves references (if any) so everything is + * preprocessed when the query is evaluated. */ + add_table(world, result, NULL); + } + } else { + add_subquery(world, desc->parent, result); + result->parent = desc->parent; + } - ptr = parse_fluff(expr, ptr, state); + if (desc->order_by) { + query_order_by( + world, result, desc->order_by_component, desc->order_by); + } - char ch = ptr[0]; + result->constraints_satisfied = satisfy_constraints(world, &result->filter); - if (!ch) { - goto done; - } else if (ch == '{') { - ptr = parse_fluff(expr, ptr + 1, state); - goto scope_open; - } else if (ch == '}') { - ptr = parse_fluff(expr, ptr + 1, state); - goto scope_close; - } else if (ch == '(') { - goto term_expr; - } else if (!ecs_os_strncmp(ptr, TOK_USING " ", 5)) { - ptr = parse_using_stmt(name, expr, ptr, state); - if (!ptr) goto error; - goto term_expr; - } else if (!ecs_os_strncmp(ptr, TOK_WITH " ", 5)) { - ptr = parse_with_stmt(name, expr, ptr, state); - if (!ptr) goto error; - goto term_expr; - } else { - goto term_expr; + ecs_log_pop_1(); + + return result; +error: + if (result) { + ecs_filter_fini(&result->filter); + if (result->observer) { + ecs_delete(world, result->observer); + } + flecs_sparse_remove(world->queries, result->id); } + return NULL; +} -term_expr: - if (!ptr[0]) { - goto done; +static +void table_cache_free( + ecs_query_t *query) +{ + ecs_table_cache_iter_t it; + ecs_query_table_t *qt; + + if (flecs_table_cache_iter(&query->cache, &it)) { + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + query_table_free(query, qt); + } } - if (!(ptr = parse_plecs_term(world, name, ptr, ptr, state))) { - goto error; + if (flecs_table_cache_empty_iter(&query->cache, &it)) { + while ((qt = flecs_table_cache_next(&it, ecs_query_table_t))) { + query_table_free(query, qt); + } } - ptr = parse_fluff(expr, ptr, state); + ecs_table_cache_fini(&query->cache); +} - if (ptr[0] == '{' && !isspace(ptr[-1])) { - /* A '{' directly after an identifier (no whitespace) is a literal */ - goto assign_expr; +void ecs_query_fini( + ecs_query_t *query) +{ + ecs_poly_assert(query, ecs_query_t); + ecs_world_t *world = query->world; + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + + if (!world->is_fini) { + ecs_delete(world, query->observer); } - if (!state->using_stmt) { - if (ptr[0] == ':') { - ptr = parse_fluff(expr, ptr + 1, state); - goto inherit_stmt; - } else if (ptr[0] == '=') { - ptr = parse_fluff(expr, ptr + 1, state); - goto assign_stmt; - } else if (ptr[0] == ',') { - ptr = parse_fluff(expr, ptr + 1, state); - goto term_expr; - } else if (ptr[0] == '{') { - state->assign_stmt = false; - ptr = parse_fluff(expr, ptr + 1, state); - goto scope_open; + if (query->group_by_ctx_free) { + if (query->group_by_ctx) { + query->group_by_ctx_free(query->group_by_ctx); } } - state->assign_stmt = false; - goto done; + if ((query->flags & EcsQueryIsSubquery) && + !(query->flags & EcsQueryIsOrphaned)) + { + remove_subquery(query->parent, query); + } -inherit_stmt: - ptr = parse_inherit_stmt(name, expr, ptr, state); - if (!ptr) goto error; + notify_subqueries(world, query, &(ecs_query_event_t){ + .kind = EcsQueryOrphan + }); - /* Expect base identifier */ - goto term_expr; + unregister_monitors(world, query); -assign_stmt: - ptr = parse_assign_stmt(world, name, expr, ptr, state); - if (!ptr) goto error; + table_cache_free(query); - ptr = parse_fluff(expr, ptr, state); + ecs_map_fini(&query->groups); - /* Assignment without a preceding component */ - if (ptr[0] == '{') { - goto assign_expr; - } + ecs_vector_free(query->subqueries); + ecs_vector_free(query->table_slices); + ecs_filter_fini(&query->filter); - /* Expect component identifiers */ - goto term_expr; + ecs_poly_fini(query, ecs_query_t); + + /* Remove query from storage */ + flecs_sparse_remove(world->queries, query->id); +error: + return; +} -assign_expr: - ptr = parse_assign_expr(world, name, expr, ptr, state); - if (!ptr) goto error; +const ecs_filter_t* ecs_query_get_filter( + ecs_query_t *query) +{ + ecs_poly_assert(query, ecs_query_t); + return &query->filter; +} - ptr = parse_fluff(expr, ptr, state); - if (ptr[0] == ',') { - ptr ++; - goto term_expr; - } else if (ptr[0] == '{') { - state->assign_stmt = false; - ptr ++; - goto scope_open; +/* Create query iterator */ +ecs_iter_t ecs_query_iter( + const ecs_world_t *stage, + ecs_query_t *query) +{ + ecs_poly_assert(query, ecs_query_t); + ecs_check(!(query->flags & EcsQueryIsOrphaned), + ECS_INVALID_PARAMETER, NULL); + + query->constraints_satisfied = satisfy_constraints(query->world, &query->filter); + + ecs_world_t *world = (ecs_world_t*)ecs_get_world(stage); + + flecs_process_pending_tables(world); + + sort_tables(world, query); + + if (!world->is_readonly && query->flags & EcsQueryHasRefs) { + flecs_eval_component_monitors(world); + } + + query->prev_match_count = query->match_count; + + int32_t table_count; + if (query->table_slices) { + table_count = ecs_vector_count(query->table_slices); } else { - state->assign_stmt = false; - goto done; + table_count = ecs_query_table_count(query); } -scope_open: - ptr = parse_scope_open(world, name, expr, ptr, state); - if (!ptr) goto error; - goto done; + ecs_query_iter_t it = { + .query = query, + .node = query->list.first + }; -scope_close: - ptr = parse_scope_close(world, name, expr, ptr, state); - if (!ptr) goto error; - goto done; + if (query->order_by && query->list.count) { + it.node = ecs_vector_first(query->table_slices, ecs_query_table_node_t); + } -done: - return ptr; + return (ecs_iter_t){ + .real_world = world, + .world = (ecs_world_t*)stage, + .terms = query->filter.terms, + .term_count = query->filter.term_count_actual, + .table_count = table_count, + .is_filter = query->filter.filter, + .is_instanced = query->filter.instanced, + .priv.iter.query = it, + .next = ecs_query_next, + }; error: - return NULL; + return (ecs_iter_t){ 0 }; } -int ecs_plecs_from_str( - ecs_world_t *world, - const char *name, - const char *expr) +static +int find_smallest_column( + ecs_table_t *table, + ecs_query_table_match_t *table_data, + ecs_vector_t *sparse_columns) { - const char *ptr = expr; - ecs_term_t term = {0}; - plecs_state_t state = {0}; + flecs_sparse_column_t *sparse_column_array = + ecs_vector_first(sparse_columns, flecs_sparse_column_t); + int32_t i, count = ecs_vector_count(sparse_columns); + int32_t min = INT_MAX, index = 0; - if (!expr) { - return 0; - } + for (i = 0; i < count; i ++) { + /* The array with sparse queries for the matched table */ + flecs_sparse_column_t *sparse_column = &sparse_column_array[i]; - state.scope[0] = 0; - ecs_entity_t prev_scope = ecs_set_scope(world, 0); - ecs_entity_t prev_with = ecs_set_with(world, 0); + /* Pointer to the switch column struct of the table */ + ecs_sw_column_t *sc = sparse_column->sw_column; - do { - expr = ptr = parse_stmt(world, name, expr, ptr, &state); - if (!ptr) { - goto error; + /* If the sparse column pointer hadn't been retrieved yet, do it now */ + if (!sc) { + /* Get the table column index from the signature column index */ + int32_t table_column_index = table_data->columns[ + sparse_column->signature_column_index]; + + /* Translate the table column index to switch column index */ + table_column_index -= table->sw_column_offset; + ecs_assert(table_column_index >= 1, ECS_INTERNAL_ERROR, NULL); + + /* Get the sparse column */ + ecs_data_t *data = &table->storage; + sc = sparse_column->sw_column = + &data->sw_columns[table_column_index - 1]; } - if (!ptr[0]) { - break; /* End of expression */ + /* Find the smallest column */ + ecs_switch_t *sw = sc->data; + int32_t case_count = flecs_switch_case_count(sw, sparse_column->sw_case); + if (case_count < min) { + min = case_count; + index = i + 1; } - } while (true); + } - ecs_set_scope(world, prev_scope); - ecs_set_with(world, prev_with); - - clear_comment(expr, ptr, &state); + return index; +} - if (state.sp != 0) { - ecs_parser_error(name, expr, 0, "missing end of scope"); - goto error; +typedef struct { + int32_t first; + int32_t count; +} query_iter_cursor_t; + +static +int sparse_column_next( + ecs_table_t *table, + ecs_query_table_match_t *matched_table, + ecs_vector_t *sparse_columns, + ecs_query_iter_t *iter, + query_iter_cursor_t *cur, + bool filter) +{ + bool first_iteration = false; + int32_t sparse_smallest; + + if (!(sparse_smallest = iter->sparse_smallest)) { + sparse_smallest = iter->sparse_smallest = find_smallest_column( + table, matched_table, sparse_columns); + first_iteration = true; } - if (state.assign_stmt) { - ecs_parser_error(name, expr, 0, "unfinished assignment"); - goto error; + sparse_smallest -= 1; + + flecs_sparse_column_t *columns = ecs_vector_first( + sparse_columns, flecs_sparse_column_t); + flecs_sparse_column_t *column = &columns[sparse_smallest]; + ecs_switch_t *sw, *sw_smallest = column->sw_column->data; + ecs_entity_t case_smallest = column->sw_case; + + /* Find next entity to iterate in sparse column */ + int32_t first, sparse_first = iter->sparse_first; + + if (!filter) { + if (first_iteration) { + first = flecs_switch_first(sw_smallest, case_smallest); + } else { + first = flecs_switch_next(sw_smallest, sparse_first); + } + } else { + int32_t cur_first = cur->first, cur_count = cur->count; + first = cur_first; + while (flecs_switch_get(sw_smallest, first) != case_smallest) { + first ++; + if (first >= (cur_first + cur_count)) { + first = -1; + break; + } + } } - if (state.errors) { - goto error; + if (first == -1) { + goto done; } + /* Check if entity matches with other sparse columns, if any */ + int32_t i, count = ecs_vector_count(sparse_columns); + do { + for (i = 0; i < count; i ++) { + if (i == sparse_smallest) { + /* Already validated this one */ + continue; + } + + column = &columns[i]; + sw = column->sw_column->data; + + if (flecs_switch_get(sw, first) != column->sw_case) { + first = flecs_switch_next(sw_smallest, first); + if (first == -1) { + goto done; + } + } + } + } while (i != count); + + cur->first = iter->sparse_first = first; + cur->count = 1; + return 0; -error: - ecs_set_scope(world, state.scope[0]); - ecs_set_with(world, prev_with); - ecs_term_fini(&term); +done: + /* Iterated all elements in the sparse list, we should move to the + * next matched table. */ + iter->sparse_smallest = 0; + iter->sparse_first = 0; + return -1; } -int ecs_plecs_from_file( - ecs_world_t *world, - const char *filename) +#define BS_MAX ((uint64_t)0xFFFFFFFFFFFFFFFF) + +static +int bitset_column_next( + ecs_table_t *table, + ecs_vector_t *bitset_columns, + ecs_query_iter_t *iter, + query_iter_cursor_t *cur) { - FILE* file; - char* content = NULL; - int32_t bytes; - size_t size; + /* Precomputed single-bit test */ + static const uint64_t bitmask[64] = { + (uint64_t)1 << 0, (uint64_t)1 << 1, (uint64_t)1 << 2, (uint64_t)1 << 3, + (uint64_t)1 << 4, (uint64_t)1 << 5, (uint64_t)1 << 6, (uint64_t)1 << 7, + (uint64_t)1 << 8, (uint64_t)1 << 9, (uint64_t)1 << 10, (uint64_t)1 << 11, + (uint64_t)1 << 12, (uint64_t)1 << 13, (uint64_t)1 << 14, (uint64_t)1 << 15, + (uint64_t)1 << 16, (uint64_t)1 << 17, (uint64_t)1 << 18, (uint64_t)1 << 19, + (uint64_t)1 << 20, (uint64_t)1 << 21, (uint64_t)1 << 22, (uint64_t)1 << 23, + (uint64_t)1 << 24, (uint64_t)1 << 25, (uint64_t)1 << 26, (uint64_t)1 << 27, + (uint64_t)1 << 28, (uint64_t)1 << 29, (uint64_t)1 << 30, (uint64_t)1 << 31, + (uint64_t)1 << 32, (uint64_t)1 << 33, (uint64_t)1 << 34, (uint64_t)1 << 35, + (uint64_t)1 << 36, (uint64_t)1 << 37, (uint64_t)1 << 38, (uint64_t)1 << 39, + (uint64_t)1 << 40, (uint64_t)1 << 41, (uint64_t)1 << 42, (uint64_t)1 << 43, + (uint64_t)1 << 44, (uint64_t)1 << 45, (uint64_t)1 << 46, (uint64_t)1 << 47, + (uint64_t)1 << 48, (uint64_t)1 << 49, (uint64_t)1 << 50, (uint64_t)1 << 51, + (uint64_t)1 << 52, (uint64_t)1 << 53, (uint64_t)1 << 54, (uint64_t)1 << 55, + (uint64_t)1 << 56, (uint64_t)1 << 57, (uint64_t)1 << 58, (uint64_t)1 << 59, + (uint64_t)1 << 60, (uint64_t)1 << 61, (uint64_t)1 << 62, (uint64_t)1 << 63 + }; - /* Open file for reading */ - ecs_os_fopen(&file, filename, "r"); - if (!file) { - ecs_err("%s (%s)", ecs_os_strerror(errno), filename); - goto error; - } + /* Precomputed test to verify if remainder of block is set (or not) */ + static const uint64_t bitmask_remain[64] = { + BS_MAX, BS_MAX - (BS_MAX >> 63), BS_MAX - (BS_MAX >> 62), + BS_MAX - (BS_MAX >> 61), BS_MAX - (BS_MAX >> 60), BS_MAX - (BS_MAX >> 59), + BS_MAX - (BS_MAX >> 58), BS_MAX - (BS_MAX >> 57), BS_MAX - (BS_MAX >> 56), + BS_MAX - (BS_MAX >> 55), BS_MAX - (BS_MAX >> 54), BS_MAX - (BS_MAX >> 53), + BS_MAX - (BS_MAX >> 52), BS_MAX - (BS_MAX >> 51), BS_MAX - (BS_MAX >> 50), + BS_MAX - (BS_MAX >> 49), BS_MAX - (BS_MAX >> 48), BS_MAX - (BS_MAX >> 47), + BS_MAX - (BS_MAX >> 46), BS_MAX - (BS_MAX >> 45), BS_MAX - (BS_MAX >> 44), + BS_MAX - (BS_MAX >> 43), BS_MAX - (BS_MAX >> 42), BS_MAX - (BS_MAX >> 41), + BS_MAX - (BS_MAX >> 40), BS_MAX - (BS_MAX >> 39), BS_MAX - (BS_MAX >> 38), + BS_MAX - (BS_MAX >> 37), BS_MAX - (BS_MAX >> 36), BS_MAX - (BS_MAX >> 35), + BS_MAX - (BS_MAX >> 34), BS_MAX - (BS_MAX >> 33), BS_MAX - (BS_MAX >> 32), + BS_MAX - (BS_MAX >> 31), BS_MAX - (BS_MAX >> 30), BS_MAX - (BS_MAX >> 29), + BS_MAX - (BS_MAX >> 28), BS_MAX - (BS_MAX >> 27), BS_MAX - (BS_MAX >> 26), + BS_MAX - (BS_MAX >> 25), BS_MAX - (BS_MAX >> 24), BS_MAX - (BS_MAX >> 23), + BS_MAX - (BS_MAX >> 22), BS_MAX - (BS_MAX >> 21), BS_MAX - (BS_MAX >> 20), + BS_MAX - (BS_MAX >> 19), BS_MAX - (BS_MAX >> 18), BS_MAX - (BS_MAX >> 17), + BS_MAX - (BS_MAX >> 16), BS_MAX - (BS_MAX >> 15), BS_MAX - (BS_MAX >> 14), + BS_MAX - (BS_MAX >> 13), BS_MAX - (BS_MAX >> 12), BS_MAX - (BS_MAX >> 11), + BS_MAX - (BS_MAX >> 10), BS_MAX - (BS_MAX >> 9), BS_MAX - (BS_MAX >> 8), + BS_MAX - (BS_MAX >> 7), BS_MAX - (BS_MAX >> 6), BS_MAX - (BS_MAX >> 5), + BS_MAX - (BS_MAX >> 4), BS_MAX - (BS_MAX >> 3), BS_MAX - (BS_MAX >> 2), + BS_MAX - (BS_MAX >> 1) + }; - /* Determine file size */ - fseek(file, 0 , SEEK_END); - bytes = (int32_t)ftell(file); - if (bytes == -1) { - goto error; - } - rewind(file); + int32_t i, count = ecs_vector_count(bitset_columns); + flecs_bitset_column_t *columns = ecs_vector_first( + bitset_columns, flecs_bitset_column_t); + int32_t bs_offset = table->bs_column_offset; - /* Load contents in memory */ - content = ecs_os_malloc(bytes + 1); - size = (size_t)bytes; - if (!(size = fread(content, 1, size, file)) && bytes) { - ecs_err("%s: read zero bytes instead of %d", filename, size); - ecs_os_free(content); - content = NULL; - goto error; - } else { - content[size] = '\0'; - } + int32_t first = iter->bitset_first; + int32_t last = 0; - fclose(file); + for (i = 0; i < count; i ++) { + flecs_bitset_column_t *column = &columns[i]; + ecs_bs_column_t *bs_column = columns[i].bs_column; - int result = ecs_plecs_from_str(world, filename, content); - ecs_os_free(content); - return result; -error: - ecs_os_free(content); - return -1; -} + if (!bs_column) { + int32_t index = column->column_index; + ecs_assert((index - bs_offset >= 0), ECS_INTERNAL_ERROR, NULL); + bs_column = &table->storage.bs_columns[index - bs_offset]; + columns[i].bs_column = bs_column; + } + + ecs_bitset_t *bs = &bs_column->data; + int32_t bs_elem_count = bs->count; + int32_t bs_block = first >> 6; + int32_t bs_block_count = ((bs_elem_count - 1) >> 6) + 1; -#endif + if (bs_block >= bs_block_count) { + goto done; + } + uint64_t *data = bs->data; + int32_t bs_start = first & 0x3F; -#ifdef FLECS_PIPELINE + /* Step 1: find the first non-empty block */ + uint64_t v = data[bs_block]; + uint64_t remain = bitmask_remain[bs_start]; + while (!(v & remain)) { + /* If no elements are remaining, move to next block */ + if ((++bs_block) >= bs_block_count) { + /* No non-empty blocks left */ + goto done; + } -/* Worker thread */ -static -void* worker(void *arg) { - ecs_stage_t *stage = arg; - ecs_world_t *world = stage->world; + bs_start = 0; + remain = BS_MAX; /* Test the full block */ + v = data[bs_block]; + } - /* Start worker thread, increase counter so main thread knows how many - * workers are ready */ - ecs_os_mutex_lock(world->sync_mutex); - world->workers_running ++; + /* Step 2: find the first non-empty element in the block */ + while (!(v & bitmask[bs_start])) { + bs_start ++; - if (!world->quit_workers) { - ecs_os_cond_wait(world->worker_cond, world->sync_mutex); - } + /* Block was not empty, so bs_start must be smaller than 64 */ + ecs_assert(bs_start < 64, ECS_INTERNAL_ERROR, NULL); + } + + /* Step 3: Find number of contiguous enabled elements after start */ + int32_t bs_end = bs_start, bs_block_end = bs_block; + + remain = bitmask_remain[bs_end]; + while ((v & remain) == remain) { + bs_end = 0; + bs_block_end ++; + + if (bs_block_end == bs_block_count) { + break; + } + + v = data[bs_block_end]; + remain = BS_MAX; /* Test the full block */ + } + + /* Step 4: find remainder of enabled elements in current block */ + if (bs_block_end != bs_block_count) { + while ((v & bitmask[bs_end])) { + bs_end ++; + } + } + + /* Block was not 100% occupied, so bs_start must be smaller than 64 */ + ecs_assert(bs_end < 64, ECS_INTERNAL_ERROR, NULL); + + /* Step 5: translate to element start/end and make sure that each column + * range is a subset of the previous one. */ + first = bs_block * 64 + bs_start; + int32_t cur_last = bs_block_end * 64 + bs_end; + + /* No enabled elements found in table */ + if (first == cur_last) { + goto done; + } + + /* If multiple bitsets are evaluated, make sure each subsequent range + * is equal or a subset of the previous range */ + if (i) { + /* If the first element of a subsequent bitset is larger than the + * previous last value, start over. */ + if (first >= last) { + i = -1; + continue; + } - ecs_os_mutex_unlock(world->sync_mutex); + /* Make sure the last element of the range doesn't exceed the last + * element of the previous range. */ + if (cur_last > last) { + cur_last = last; + } + } - while (!world->quit_workers) { - ecs_entity_t old_scope = ecs_set_scope((ecs_world_t*)stage, 0); - - ecs_run_pipeline( - (ecs_world_t*)stage, - world->pipeline, - world->stats.delta_time); + last = cur_last; + int32_t elem_count = last - first; - ecs_set_scope((ecs_world_t*)stage, old_scope); + /* Make sure last element doesn't exceed total number of elements in + * the table */ + if (elem_count > (bs_elem_count - first)) { + elem_count = (bs_elem_count - first); + if (!elem_count) { + iter->bitset_first = 0; + goto done; + } + } + + cur->first = first; + cur->count = elem_count; + iter->bitset_first = first; } + + /* Keep track of last processed element for iteration */ + iter->bitset_first = last; - ecs_os_mutex_lock(world->sync_mutex); - world->workers_running --; - ecs_os_mutex_unlock(world->sync_mutex); - - return NULL; + return 0; +done: + iter->sparse_smallest = 0; + iter->sparse_first = 0; + return -1; } -/* Start threads */ static -void start_workers( - ecs_world_t *world, - int32_t threads) +void mark_columns_dirty( + ecs_query_t *query, + ecs_query_table_match_t *table_data) { - ecs_set_stages(world, threads); + ecs_table_t *table = table_data->table; - ecs_assert(ecs_get_stage_count(world) == threads, ECS_INTERNAL_ERROR, NULL); + if (table && table->dirty_state) { + ecs_term_t *terms = query->filter.terms; + int32_t i, count = query->filter.term_count_actual; + for (i = 0; i < count; i ++) { + ecs_term_t *term = &terms[i]; + int32_t ti = term->index; - int32_t i; - for (i = 0; i < threads; i ++) { - ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); - ecs_assert(stage != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_poly_assert(stage, ecs_stage_t); + if (term->inout == EcsIn || term->inout == EcsInOutFilter) { + /* Don't mark readonly terms dirty */ + continue; + } - ecs_vector_get(world->worker_stages, ecs_stage_t, i); - stage->thread = ecs_os_thread_new(worker, stage); - ecs_assert(stage->thread != 0, ECS_OPERATION_FAILED, NULL); - } -} + if (table_data->subjects[ti] != 0) { + /* Don't mark table dirty if term is not from the table */ + continue; + } -/* Wait until all workers are running */ -static -void wait_for_workers( - ecs_world_t *world) -{ - int32_t stage_count = ecs_get_stage_count(world); - bool wait = true; + int32_t index = table_data->columns[ti]; + if (index <= 0) { + /* If term is not set, there's nothing to mark dirty */ + continue; + } - do { - ecs_os_mutex_lock(world->sync_mutex); - if (world->workers_running == stage_count) { - wait = false; + /* Potential candidate for marking table dirty, if a component */ + int32_t storage_index = ecs_table_type_to_storage_index( + table, index - 1); + if (storage_index >= 0) { + table->dirty_state[storage_index + 1] ++; + } } - ecs_os_mutex_unlock(world->sync_mutex); - } while (wait); + } } -/* Synchronize worker threads */ -static -void sync_worker( - ecs_world_t *world) +bool ecs_query_next( + ecs_iter_t *it) { - int32_t stage_count = ecs_get_stage_count(world); + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); - /* Signal that thread is waiting */ - ecs_os_mutex_lock(world->sync_mutex); - if (++ world->workers_waiting == stage_count) { - /* Only signal main thread when all threads are waiting */ - ecs_os_cond_signal(world->sync_cond); + if (flecs_iter_next_row(it)) { + return true; } - /* Wait until main thread signals that thread can continue */ - ecs_os_cond_wait(world->worker_cond, world->sync_mutex); - ecs_os_mutex_unlock(world->sync_mutex); + return flecs_iter_next_instanced(it, ecs_query_next_instanced(it)); +error: + return false; } -/* Wait until all threads are waiting on sync point */ -static -void wait_for_sync( - ecs_world_t *world) +bool ecs_query_next_instanced( + ecs_iter_t *it) { - int32_t stage_count = ecs_get_stage_count(world); + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); - ecs_os_mutex_lock(world->sync_mutex); - if (world->workers_waiting != stage_count) { - ecs_os_cond_wait(world->sync_cond, world->sync_mutex); - } - - /* We should have been signalled unless all workers are waiting on sync */ - ecs_assert(world->workers_waiting == stage_count, - ECS_INTERNAL_ERROR, NULL); + ecs_query_iter_t *iter = &it->priv.iter.query; + ecs_query_t *query = iter->query; + ecs_world_t *world = query->world; + ecs_flags32_t flags = query->flags; + (void)world; - ecs_os_mutex_unlock(world->sync_mutex); -} + it->is_valid = true; -/* Signal workers that they can start/resume work */ -static -void signal_workers( - ecs_world_t *world) -{ - ecs_os_mutex_lock(world->sync_mutex); - ecs_os_cond_broadcast(world->worker_cond); - ecs_os_mutex_unlock(world->sync_mutex); -} + ecs_poly_assert(world, ecs_world_t); -/** Stop worker threads */ -static -bool ecs_stop_threads( - ecs_world_t *world) -{ - bool threads_active = false; + if (!query->constraints_satisfied) { + goto done; + } - /* Test if threads are created. Cannot use workers_running, since this is - * a potential race if threads haven't spun up yet. */ - ecs_vector_each(world->worker_stages, ecs_stage_t, stage, { - if (stage->thread) { - threads_active = true; - break; + query_iter_cursor_t cur; + ecs_query_table_node_t *node, *next, *prev; + if ((prev = iter->prev)) { + /* Match has been iterated, update monitor for change tracking */ + if (flags & EcsQueryHasMonitor) { + sync_match_monitor(query, prev->match); + } + if (flags & EcsQueryHasOutColumns) { + mark_columns_dirty(query, prev->match); } - stage->thread = 0; - }); - - /* If no threads are active, just return */ - if (!threads_active) { - return false; } - /* Make sure all threads are running, to ensure they catch the signal */ - wait_for_workers(world); + iter->skip_count = 0; - /* Signal threads should quit */ - world->quit_workers = true; - signal_workers(world); + for (node = iter->node; node != NULL; node = next) { + ecs_query_table_match_t *match = node->match; + ecs_table_t *table = match->table; - /* Join all threads with main */ - ecs_stage_t *stages = ecs_vector_first(world->worker_stages, ecs_stage_t); - int32_t i, count = ecs_vector_count(world->worker_stages); - for (i = 0; i < count; i ++) { - ecs_os_thread_join(stages[i].thread); - stages[i].thread = 0; - } + next = node->next; - world->quit_workers = false; - ecs_assert(world->workers_running == 0, ECS_INTERNAL_ERROR, NULL); + if (table) { + cur.first = node->offset; + cur.count = node->count; + if (!cur.count) { + cur.count = ecs_table_count(table); - /* Deinitialize stages */ - ecs_set_stages(world, 0); + /* List should never contain empty tables */ + ecs_assert(cur.count != 0, ECS_INTERNAL_ERROR, NULL); + } - return true; -} + ecs_vector_t *bitset_columns = match->bitset_columns; + ecs_vector_t *sparse_columns = match->sparse_columns; -/* -- Private functions -- */ + if (bitset_columns || sparse_columns) { + bool found = false; -void ecs_worker_begin( - ecs_world_t *world) -{ - flecs_stage_from_world(&world); - int32_t stage_count = ecs_get_stage_count(world); - ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); - - if (stage_count == 1) { - ecs_entity_t pipeline = world->pipeline; - const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); - ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); + do { + found = false; - ecs_pipeline_op_t *op = ecs_vector_first(pq->ops, ecs_pipeline_op_t); - if (!op || !op->no_staging) { - ecs_staging_begin(world); - } - } -} + if (bitset_columns) { + if (bitset_column_next(table, bitset_columns, iter, + &cur) == -1) + { + /* No more enabled components for table */ + iter->bitset_first = 0; + break; + } else { + found = true; + next = node; + } + } -int32_t ecs_worker_sync( - ecs_world_t *world, - const EcsPipelineQuery *pq, - ecs_iter_t *it, - int32_t i, - ecs_pipeline_op_t **op_out, - ecs_pipeline_op_t **last_op_out) -{ - int32_t stage_count = ecs_get_stage_count(world); - ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); - int32_t build_count = world->stats.pipeline_build_count_total; + if (sparse_columns) { + if (sparse_column_next(table, match, + sparse_columns, iter, &cur, found) == -1) + { + /* No more elements in sparse column */ + if (found) { + /* Try again */ + next = node->next; + found = false; + } else { + /* Nothing found */ + iter->bitset_first = 0; + break; + } + } else { + found = true; + next = node; + iter->bitset_first = cur.first + cur.count; + } + } + } while (!found); - /* If there are no threads, merge in place */ - if (stage_count == 1) { - if (!op_out[0]->no_staging) { - ecs_staging_end(world); + if (!found) { + continue; + } + } + } else { + cur.count = 0; + cur.first = 0; } - ecs_pipeline_update(world, world->pipeline, false); - - /* Synchronize all workers. The last worker to reach the sync point will - * signal the main thread, which will perform the merge. */ - } else { - sync_worker(world); - } + it->ids = match->ids; + it->columns = match->columns; + it->subjects = match->subjects; + it->sizes = match->sizes; + it->references = match->references; + it->instance_count = 0; - if (build_count != world->stats.pipeline_build_count_total) { - i = ecs_pipeline_reset_iter(world, pq, it, op_out, last_op_out); - } else { - op_out[0] ++; - } + flecs_iter_init(it); + flecs_iter_populate_data(world, it, match->table, cur.first, cur.count, + it->ptrs, NULL); - if (stage_count == 1) { - if (!op_out[0]->no_staging) { - ecs_staging_begin(world); - } + iter->node = next; + iter->prev = node; + goto yield; } - return i; +done: +error: + ecs_iter_fini(it); + return false; + +yield: + return true; } -void ecs_worker_end( - ecs_world_t *world) +bool ecs_query_changed( + ecs_query_t *query, + const ecs_iter_t *it) { - flecs_stage_from_world(&world); + if (it) { + ecs_check(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - int32_t stage_count = ecs_get_stage_count(world); - ecs_assert(stage_count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_query_table_match_t *qt = + (ecs_query_table_match_t*)it->priv.iter.query.prev; + ecs_assert(qt != NULL, ECS_INVALID_PARAMETER, NULL); - /* If there are no threads, merge in place */ - if (stage_count == 1) { - if (ecs_stage_is_readonly(world)) { - ecs_staging_end(world); + if (!query) { + query = it->priv.iter.query.query; + } else { + ecs_check(query == it->priv.iter.query.query, + ECS_INVALID_PARAMETER, NULL); } - /* Synchronize all workers. The last worker to reach the sync point will - * signal the main thread, which will perform the merge. */ - } else { - sync_worker(world); - } -} + ecs_check(query != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_poly_assert(query, ecs_query_t); -void ecs_workers_progress( - ecs_world_t *world, - ecs_entity_t pipeline, - FLECS_FLOAT delta_time) -{ - ecs_poly_assert(world, ecs_world_t); - int32_t stage_count = ecs_get_stage_count(world); + flecs_process_pending_tables(it->real_world); - ecs_time_t start = {0}; - if (world->measure_frame_time) { - ecs_time_measure(&start); + return check_match_monitor(query, qt); } - if (stage_count == 1) { - ecs_pipeline_update(world, pipeline, true); - ecs_entity_t old_scope = ecs_set_scope(world, 0); - ecs_world_t *stage = ecs_get_stage(world, 0); - ecs_run_pipeline(stage, pipeline, delta_time); - ecs_set_scope(world, old_scope); - } else { - ecs_pipeline_update(world, pipeline, true); - - const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); - ecs_vector_t *ops = pq->ops; - ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); - ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); - - /* Make sure workers are running and ready */ - wait_for_workers(world); + ecs_poly_assert(query, ecs_query_t); + ecs_check(!(query->flags & EcsQueryIsOrphaned), + ECS_INVALID_PARAMETER, NULL); - /* Synchronize n times for each op in the pipeline */ - for (; op <= op_last; op ++) { - if (!op->no_staging) { - ecs_staging_begin(world); - } + flecs_process_pending_tables(query->world); - /* Signal workers that they should start running systems */ - world->workers_waiting = 0; - signal_workers(world); + if (!(query->flags & EcsQueryHasMonitor)) { + query->flags |= EcsQueryHasMonitor; + init_query_monitors(query); + return true; /* Monitors didn't exist yet */ + } - /* Wait until all workers are waiting on sync point */ - wait_for_sync(world); + if (query->match_count != query->prev_match_count) { + return true; + } - /* Merge */ - if (!op->no_staging) { - ecs_staging_end(world); - } + return check_query_monitor(query); +error: + return false; +} - if (ecs_pipeline_update(world, pipeline, false)) { - /* Refetch, in case pipeline itself has moved */ - pq = ecs_get(world, pipeline, EcsPipelineQuery); +void ecs_query_skip( + ecs_iter_t *it) +{ + ecs_assert(it->next == ecs_query_next, ECS_INVALID_PARAMETER, NULL); + ecs_assert(it->is_valid, ECS_INVALID_PARAMETER, NULL); - /* Pipeline has changed, reset position in pipeline */ - ecs_iter_t it; - ecs_pipeline_reset_iter(world, pq, &it, &op, &op_last); - op --; - } + if (it->instance_count > it->count) { + it->priv.iter.query.skip_count ++; + if (it->priv.iter.query.skip_count == it->instance_count) { + /* For non-instanced queries, make sure all entities are skipped */ + it->priv.iter.query.prev = NULL; } + } else { + it->priv.iter.query.prev = NULL; } +} - if (world->measure_frame_time) { - world->stats.system_time_total += (float)ecs_time_measure(&start); - } +bool ecs_query_orphaned( + ecs_query_t *query) +{ + ecs_poly_assert(query, ecs_query_t); + return query->flags & EcsQueryIsOrphaned; } -/* -- Public functions -- */ +#include -void ecs_set_threads( - ecs_world_t *world, - int32_t threads) -{ - ecs_assert(threads <= 1 || ecs_os_has_threading(), ECS_MISSING_OS_API, NULL); +/* Marker object used to differentiate a component vs. a tag edge */ +static ecs_table_diff_t ecs_table_edge_is_component; - int32_t stage_count = ecs_get_stage_count(world); +static +uint64_t ids_hash(const void *ptr) { + const ecs_ids_t *type = ptr; + ecs_id_t *ids = type->array; + int32_t count = type->count; + uint64_t hash = flecs_hash(ids, count * ECS_SIZEOF(ecs_id_t)); + return hash; +} - if (stage_count != threads) { - /* Stop existing threads */ - if (stage_count > 1) { - if (ecs_stop_threads(world)) { - ecs_os_cond_free(world->worker_cond); - ecs_os_cond_free(world->sync_cond); - ecs_os_mutex_free(world->sync_mutex); - } - } +static +int ids_compare(const void *ptr_1, const void *ptr_2) { + const ecs_ids_t *type_1 = ptr_1; + const ecs_ids_t *type_2 = ptr_2; - /* Start threads if number of threads > 1 */ - if (threads > 1) { - world->worker_cond = ecs_os_cond_new(); - world->sync_cond = ecs_os_cond_new(); - world->sync_mutex = ecs_os_mutex_new(); - start_workers(world, threads); + int32_t count_1 = type_1->count; + int32_t count_2 = type_2->count; + + if (count_1 != count_2) { + return (count_1 > count_2) - (count_1 < count_2); + } + + const ecs_id_t *ids_1 = type_1->array; + const ecs_id_t *ids_2 = type_2->array; + + int32_t i; + for (i = 0; i < count_1; i ++) { + ecs_id_t id_1 = ids_1[i]; + ecs_id_t id_2 = ids_2[i]; + + if (id_1 != id_2) { + return (id_1 > id_2) - (id_1 < id_2); } } -} - -#endif + return 0; +} -#ifdef FLECS_PIPELINE - -static ECS_DTOR(EcsPipelineQuery, ptr, { - ecs_vector_free(ptr->ops); -}) - -static -int compare_entity( - ecs_entity_t e1, - const void *ptr1, - ecs_entity_t e2, - const void *ptr2) -{ - (void)ptr1; - (void)ptr2; - return (e1 > e2) - (e1 < e2); +void flecs_table_hashmap_init(ecs_hashmap_t *hm) { + flecs_hashmap_init(hm, ecs_ids_t, ecs_table_t*, ids_hash, ids_compare); } -static -uint64_t group_by_phase( - ecs_world_t *world, - ecs_type_t type, - ecs_entity_t pipeline, - void *ctx) +const EcsComponent* flecs_component_from_id( + const ecs_world_t *world, + ecs_entity_t e) { - (void)ctx; - - const EcsType *pt = ecs_get(world, pipeline, EcsType); - ecs_assert(pt != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t pair = 0; - /* Find tag in system that belongs to pipeline */ - ecs_entity_t *sys_comps = ecs_vector_first(type, ecs_entity_t); - int32_t c, t, count = ecs_vector_count(type); - - ecs_type_t pipeline_type = NULL; - if (pt->normalized) { - pipeline_type = pt->normalized->type; + /* If this is a pair, get the pair component from the identifier */ + if (ECS_HAS_ROLE(e, PAIR)) { + pair = e; + e = ecs_get_alive(world, ECS_PAIR_FIRST(e)); + + if (ecs_has_id(world, e, EcsTag)) { + return NULL; + } } - if (!pipeline_type) { - return 0; + if (e & ECS_ROLE_MASK) { + return NULL; } - ecs_entity_t *tags = ecs_vector_first(pipeline_type, ecs_entity_t); - int32_t tag_count = ecs_vector_count(pipeline_type); + const EcsComponent *component = ecs_get(world, e, EcsComponent); + if ((!component || !component->size) && pair) { + /* If this is a pair column and the pair is not a component, use + * the component type of the component the pair is applied to. */ + e = ECS_PAIR_SECOND(pair); - ecs_entity_t result = 0; + /* Because generations are not stored in the pair, get the currently + * alive id */ + e = ecs_get_alive(world, e); - for (c = 0; c < count; c ++) { - ecs_entity_t comp = sys_comps[c]; - for (t = 0; t < tag_count; t ++) { - if (comp == tags[t]) { - result = comp; - break; - } - } - if (result) { - break; - } - } + /* If a pair is used with a not alive id, the pair is not valid */ + ecs_assert(e != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result != 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(result < INT_MAX, ECS_INTERNAL_ERROR, NULL); + component = ecs_get(world, e, EcsComponent); + } - return result; + return component; } -typedef enum ComponentWriteState { - NotWritten = 0, - WriteToMain, - WriteToStage -} ComponentWriteState; - -typedef struct write_state_t { - ecs_map_t *components; - bool wildcard; -} write_state_t; - +/* Ensure the ids used in the columns exist */ static -int32_t get_write_state( - ecs_map_t *write_state, - ecs_entity_t component) +int32_t ensure_columns( + ecs_world_t *world, + ecs_table_t *table) { - int32_t *ptr = ecs_map_get(write_state, int32_t, component); - if (ptr) { - return *ptr; - } else { - return 0; + int32_t i, count = ecs_vector_count(table->type); + ecs_id_t* ids = ecs_vector_first(table->type, ecs_id_t); + + for (i = 0; i < count; i++) { + ecs_ensure_id(world, ids[i]); } + + return count; } static -void set_write_state( - write_state_t *write_state, - ecs_entity_t component, - int32_t value) +ecs_vector_t* ids_to_vector( + const ecs_ids_t *entities) { - if (component == EcsWildcard) { - ecs_assert(value == WriteToStage, ECS_INTERNAL_ERROR, NULL); - write_state->wildcard = true; + if (entities->count) { + ecs_vector_t *result = NULL; + ecs_vector_set_count(&result, ecs_entity_t, entities->count); + ecs_entity_t *array = ecs_vector_first(result, ecs_entity_t); + ecs_os_memcpy_n(array, entities->array, ecs_entity_t, entities->count); + return result; } else { - ecs_map_set(write_state->components, component, &value); + return NULL; } } static -void reset_write_state( - write_state_t *write_state) +void table_diff_free( + ecs_table_diff_t *diff) { - ecs_map_clear(write_state->components); - write_state->wildcard = false; + ecs_os_free(diff->added.array); + ecs_os_free(diff->removed.array); + ecs_os_free(diff->on_set.array); + ecs_os_free(diff->un_set.array); + ecs_os_free(diff); } static -int32_t get_any_write_state( - write_state_t *write_state) +ecs_graph_edge_t* graph_edge_new( + ecs_world_t *world) { - if (write_state->wildcard) { - return WriteToStage; - } - - ecs_map_iter_t it = ecs_map_iter(write_state->components); - int32_t *elem; - while ((elem = ecs_map_next(&it, int32_t, NULL))) { - if (*elem == WriteToStage) { - return WriteToStage; - } + ecs_graph_edge_t *result = (ecs_graph_edge_t*)world->store.first_free; + if (result) { + world->store.first_free = result->hdr.next; + ecs_os_zeromem(result); + } else { + result = ecs_os_calloc_t(ecs_graph_edge_t); } - - return 0; + return result; } static -bool check_term_component( - ecs_term_t *term, - bool is_active, - ecs_entity_t component, - write_state_t *write_state) +void graph_edge_free( + ecs_world_t *world, + ecs_graph_edge_t *edge) { - int32_t state = get_write_state(write_state->components, component); - - ecs_term_id_t *subj = &term->subj; - - if ((subj->set.mask & EcsSelf) && subj->entity == EcsThis && term->oper != EcsNot) { - switch(term->inout) { - case EcsInOutFilter: - /* Ignore terms that aren't read/written */ - break; - case EcsInOutDefault: - case EcsInOut: - case EcsIn: - if (state == WriteToStage || write_state->wildcard) { - return true; - } - // fall through - case EcsOut: - if (is_active && term->inout != EcsIn) { - set_write_state(write_state, component, WriteToMain); - } - }; - - } else if (!subj->entity || term->oper == EcsNot) { - bool needs_merge = false; - - switch(term->inout) { - case EcsInOutDefault: - case EcsIn: - case EcsInOut: - if (state == WriteToStage) { - needs_merge = true; - } - if (component == EcsWildcard) { - if (get_any_write_state(write_state) == WriteToStage) { - needs_merge = true; - } - } - break; - default: - break; - }; - - switch(term->inout) { - case EcsInOutDefault: - if ((!(subj->set.mask & EcsSelf) || (subj->entity != EcsThis)) && (subj->set.mask != EcsNothing)) { - /* Default inout behavior is [inout] for This terms, and [in] - * for terms that match other entities */ - break; - } - // fall through - case EcsInOut: - case EcsOut: - if (is_active) { - set_write_state(write_state, component, WriteToStage); - } - break; - default: - break; - }; - - if (needs_merge) { - return true; - } + if (world->is_fini) { + ecs_os_free(edge); + } else { + edge->hdr.next = world->store.first_free; + world->store.first_free = &edge->hdr; } - - return false; } static -bool check_term( - ecs_term_t *term, - bool is_active, - write_state_t *write_state) +ecs_graph_edge_t* ensure_hi_edge( + ecs_world_t *world, + ecs_graph_edges_t *edges, + ecs_id_t id) { - if (term->oper != EcsOr) { - return check_term_component( - term, is_active, term->id, write_state); - } + if (!ecs_map_is_initialized(&edges->hi)) { + ecs_map_init(&edges->hi, ecs_graph_edge_t*, 1); + } - return false; + ecs_graph_edge_t **ep = ecs_map_ensure(&edges->hi, ecs_graph_edge_t*, id); + ecs_graph_edge_t *edge = ep[0]; + if (edge) { + return edge; + } + + if (id < ECS_HI_COMPONENT_ID) { + edge = &edges->lo[id]; + } else { + edge = graph_edge_new(world); + } + + ep[0] = edge; + return edge; } static -bool check_terms( - ecs_filter_t *filter, - bool is_active, - write_state_t *ws) +ecs_graph_edge_t* ensure_edge( + ecs_world_t *world, + ecs_graph_edges_t *edges, + ecs_id_t id) { - bool needs_merge = false; - ecs_term_t *terms = filter->terms; - int32_t t, term_count = filter->term_count; - - /* Check This terms first. This way if a term indicating writing to a stage - * was added before the term, it won't cause merging. */ - for (t = 0; t < term_count; t ++) { - ecs_term_t *term = &terms[t]; - if (term->subj.entity == EcsThis) { - needs_merge |= check_term(term, is_active, ws); + ecs_graph_edge_t *edge; + + if (id < ECS_HI_COMPONENT_ID) { + if (!edges->lo) { + edges->lo = ecs_os_calloc_n(ecs_graph_edge_t, ECS_HI_COMPONENT_ID); } - } - - /* Now check staged terms */ - for (t = 0; t < term_count; t ++) { - ecs_term_t *term = &terms[t]; - if (term->subj.entity != EcsThis) { - needs_merge |= check_term(term, is_active, ws); + edge = &edges->lo[id]; + } else { + if (!ecs_map_is_initialized(&edges->hi)) { + ecs_map_init(&edges->hi, ecs_graph_edge_t*, 1); } + edge = ensure_hi_edge(world, edges, id); } - return needs_merge; + return edge; } static -bool build_pipeline( +void disconnect_edge( ecs_world_t *world, - ecs_entity_t pipeline, - EcsPipelineQuery *pq) + ecs_id_t id, + ecs_graph_edge_t *edge) { - (void)pipeline; + ecs_assert(edge != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->id == id, ECS_INTERNAL_ERROR, NULL); + (void)id; - ecs_query_iter(world, pq->query); + /* Remove backref from destination table */ + ecs_graph_edge_hdr_t *next = edge->hdr.next; + ecs_graph_edge_hdr_t *prev = edge->hdr.prev; - if (pq->match_count == pq->query->match_count) { - /* No need to rebuild the pipeline */ - return false; + if (next) { + next->prev = prev; + } + if (prev) { + prev->next = next; } - world->stats.pipeline_build_count_total ++; - pq->rebuild_count ++; - - write_state_t ws = { - .components = ecs_map_new(int32_t, ECS_HI_COMPONENT_ID), - .wildcard = false - }; - - ecs_pipeline_op_t *op = NULL; - ecs_vector_t *ops = NULL; - ecs_query_t *query = pq->build_query; + /* Remove data associated with edge */ + ecs_table_diff_t *diff = edge->diff; + if (diff && diff != &ecs_table_edge_is_component) { + table_diff_free(diff); + } - if (pq->ops) { - ecs_vector_free(pq->ops); + /* If edge id is low, clear it from fast lookup array */ + if (id < ECS_HI_COMPONENT_ID) { + edge->from = NULL; + } else { + graph_edge_free(world, edge); } +} - bool multi_threaded = false; - bool no_staging = false; - bool first = true; +static +void remove_edge( + ecs_world_t *world, + ecs_graph_edges_t *edges, + ecs_id_t id, + ecs_graph_edge_t *edge) +{ + ecs_assert(edges != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ecs_map_is_initialized(&edges->hi), ECS_INTERNAL_ERROR, NULL); + disconnect_edge(world, id, edge); + ecs_map_remove(&edges->hi, id); +} - /* Iterate systems in pipeline, add ops for running / merging */ - ecs_iter_t it = ecs_query_iter(world, query); - while (ecs_query_next(&it)) { - EcsSystem *sys = ecs_term(&it, EcsSystem, 1); +static +void init_edges( + ecs_graph_edges_t *edges) +{ + edges->lo = NULL; + ecs_os_zeromem(&edges->hi); +} - int i; - for (i = 0; i < it.count; i ++) { - ecs_query_t *q = sys[i].query; - if (!q) { - continue; - } +static +void init_node( + ecs_graph_node_t *node) +{ + init_edges(&node->add); + init_edges(&node->remove); +} - bool needs_merge = false; - bool is_active = !ecs_has_id( - world, it.entities[i], EcsInactive); - needs_merge = check_terms(&q->filter, is_active, &ws); +typedef struct { + int32_t first; + int32_t count; +} id_first_count_t; - if (is_active) { - if (first) { - multi_threaded = sys[i].multi_threaded; - no_staging = sys[i].no_staging; - first = false; - } +static +void set_trigger_flags_for_id( + ecs_world_t *world, + ecs_table_t *table, + ecs_id_t id) +{ + /* Set flags if triggers are registered for table */ + if (flecs_check_triggers_for_event(world, id, EcsOnAdd)) { + table->flags |= EcsTableHasOnAdd; + } + if (flecs_check_triggers_for_event(world, id, EcsOnRemove)) { + table->flags |= EcsTableHasOnRemove; + } + if (flecs_check_triggers_for_event(world, id, EcsOnSet)) { + table->flags |= EcsTableHasOnSet; + } + if (flecs_check_triggers_for_event(world, id, EcsUnSet)) { + table->flags |= EcsTableHasUnSet; + } +} - if (sys[i].multi_threaded != multi_threaded) { - needs_merge = true; - multi_threaded = sys[i].multi_threaded; - } - if (sys[i].no_staging != no_staging) { - needs_merge = true; - no_staging = sys[i].no_staging; - } - } +static +void register_table_for_id( + ecs_world_t *world, + ecs_table_t *table, + ecs_id_t id, + int32_t column, + int32_t count, + ecs_table_record_t *tr) +{ + id = ecs_strip_generation(id); - if (needs_merge) { - /* After merge all components will be merged, so reset state */ - reset_write_state(&ws); - op = NULL; + ecs_id_record_t *idr = flecs_ensure_id_record(world, id); + ecs_table_cache_insert(&idr->cache, table, &tr->hdr); + tr->column = column; + tr->count = count; + tr->id = id; + set_trigger_flags_for_id(world, table, id); + ecs_assert(tr->hdr.table == table, ECS_INTERNAL_ERROR, NULL); +} - /* Re-evaluate columns to set write flags if system is active. - * If system is inactive, it can't write anything and so it - * should not insert unnecessary merges. */ - needs_merge = false; - if (is_active) { - needs_merge = check_terms(&q->filter, true, &ws); - } +static +void flecs_table_records_register( + ecs_world_t *world, + ecs_table_t *table) +{ + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + int32_t count = ecs_vector_count(table->type); - /* The component states were just reset, so if we conclude that - * another merge is needed something is wrong. */ - ecs_assert(needs_merge == false, ECS_INTERNAL_ERROR, NULL); - } + if (!count) { + return; + } - if (!op) { - op = ecs_vector_add(&ops, ecs_pipeline_op_t); - op->count = 0; - op->multi_threaded = false; - op->no_staging = false; - } + /* Count number of unique ids, pairs, relations and objects so we can figure + * out how many table records are needed for this table. */ + int32_t id_count = 0, pair_count = 0, type_flag_count = 0; + int32_t first_id = -1, first_pair = -1; + ecs_map_t relations = ECS_MAP_INIT(0), objects = ECS_MAP_INIT(0); + bool has_childof = false; - /* Don't increase count for inactive systems, as they are ignored by - * the query used to run the pipeline. */ - if (is_active) { - if (!op->count) { - op->multi_threaded = multi_threaded; - op->no_staging = no_staging; - } - op->count ++; - } - } - } + int32_t i; + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; + ecs_entity_t rel = 0, obj = 0; - ecs_map_free(ws.components); + if (ECS_HAS_ROLE(id, PAIR)) { + id_first_count_t *r; - /* Find the system ran last this frame (helps workers reset iter) */ - ecs_entity_t last_system = 0; - op = ecs_vector_first(ops, ecs_pipeline_op_t); - int32_t i, ran_since_merge = 0, op_index = 0; + rel = ECS_PAIR_FIRST(id); + obj = ECS_PAIR_SECOND(id); - ecs_assert(op != NULL, ECS_INTERNAL_ERROR, NULL); + if (0 == pair_count ++) { + first_pair = i; + } - /* Add schedule to debug tracing */ - ecs_dbg("#[green]pipeline#[reset] rebuild:"); - ecs_log_push_1(); + if (rel == EcsChildOf) { + has_childof = true; + } - ecs_dbg("#[green]schedule#[reset]: threading: %d, staging: %d:", - op->multi_threaded, !op->no_staging); - ecs_log_push_1(); - - it = ecs_query_iter(world, pq->query); - while (ecs_query_next(&it)) { - EcsSystem *sys = ecs_term(&it, EcsSystem, 1); - for (i = 0; i < it.count; i ++) { - if (ecs_should_log_1()) { - char *path = ecs_get_fullpath(world, it.entities[i]); - ecs_dbg("#[green]system#[reset] %s", path); - ecs_os_free(path); + if (!ecs_map_is_initialized(&relations)) { + ecs_map_init(&relations, id_first_count_t, count); + ecs_map_init(&objects, id_first_count_t, count); } - ran_since_merge ++; - if (ran_since_merge == op[op_index].count) { - ecs_dbg("#[magenta]merge#[reset]"); - ecs_log_pop_1(); - ran_since_merge = 0; - op_index ++; - if (op_index < ecs_vector_count(ops)) { - ecs_dbg("#[green]schedule#[reset]: threading: %d, staging: %d:", - op[op_index].multi_threaded, !op[op_index].no_staging); - } - ecs_log_push_1(); + r = ecs_map_ensure(&relations, id_first_count_t, rel); + if ((++r->count) == 1) { + r->first = i; } - if (sys[i].last_frame == (world->stats.frame_count_total + 1)) { - last_system = it.entities[i]; + r = ecs_map_ensure(&objects, id_first_count_t, obj); + if ((++r->count) == 1) { + r->first = i; + } + } else { + rel = id & ECS_COMPONENT_MASK; + if (rel != id) { + type_flag_count ++; + } - /* Can't break from loop yet. It's possible that previously - * inactive systems that ran before the last ran system are now - * active. */ + if (0 == id_count ++) { + first_id = i; } } } - ecs_log_pop_1(); - ecs_log_pop_1(); + int32_t record_count = count + type_flag_count + (id_count != 0) + + (pair_count != 0) + ecs_map_count(&relations) + ecs_map_count(&objects) + + 1 /* for any */; + int32_t r = 0; - /* Force sort of query as this could increase the match_count */ - pq->match_count = pq->query->match_count; - pq->ops = ops; - pq->last_system = last_system; + if (!has_childof) { + record_count ++; + } - return true; -} + table->records = ecs_os_calloc_n(ecs_table_record_t, record_count); + table->record_count = record_count; -int32_t ecs_pipeline_reset_iter( - ecs_world_t *world, - const EcsPipelineQuery *pq, - ecs_iter_t *iter_out, - ecs_pipeline_op_t **op_out, - ecs_pipeline_op_t **last_op_out) -{ - ecs_pipeline_op_t *op = ecs_vector_first(pq->ops, ecs_pipeline_op_t); - int32_t i, ran_since_merge = 0, op_index = 0; + /* First initialize records for regular (non-wildcard) ids */ + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; + register_table_for_id(world, table, id, i, 1, &table->records[r]); + r ++; + + ecs_entity_t role = id & ECS_ROLE_MASK; + if (role && role != ECS_PAIR) { + id &= ECS_COMPONENT_MASK; + id = ecs_pair(id, EcsWildcard); + register_table_for_id(world, table, id, i, 1, &table->records[r]); + r ++; + } + } - if (!pq->last_system) { - /* It's possible that all systems that were ran were removed entirely - * from the pipeline (they could have been deleted or disabled). In that - * case (which should be very rare) the pipeline can't make assumptions - * about where to continue, so end frame. */ - return -1; + /* Initialize records for relation wildcards */ + ecs_map_iter_t mit = ecs_map_iter(&relations); + id_first_count_t *elem; + uint64_t key; + while ((elem = ecs_map_next(&mit, id_first_count_t, &key))) { + ecs_id_t id = ecs_pair(key, EcsWildcard); + register_table_for_id(world, table, id, elem->first, elem->count, + &table->records[r]); + r ++; } - /* Move iterator to last ran system */ - *iter_out = ecs_query_iter(world, pq->query); - while (ecs_query_next(iter_out)) { - for (i = 0; i < iter_out->count; i ++) { - ran_since_merge ++; - if (ran_since_merge == op[op_index].count) { - ran_since_merge = 0; - op_index ++; - } + /* Initialize records for object wildcards */ + mit = ecs_map_iter(&objects); + while ((elem = ecs_map_next(&mit, id_first_count_t, &key))) { + ecs_id_t id = ecs_pair(EcsWildcard, key); + register_table_for_id(world, table, id, elem->first, elem->count, + &table->records[r]); + r ++; + } - if (iter_out->entities[i] == pq->last_system) { - *op_out = &op[op_index]; - *last_op_out = ecs_vector_last(pq->ops, ecs_pipeline_op_t); - return i; - } - } + /* Initialize records for all wildcards ids */ + if (id_count) { + register_table_for_id(world, table, EcsWildcard, + first_id, id_count, &table->records[r]); + r ++; + } + if (pair_count) { + register_table_for_id(world, table, ecs_pair(EcsWildcard, EcsWildcard), + first_pair, pair_count, &table->records[r]); + r ++; + } + if (count) { + register_table_for_id(world, table, EcsAny, 0, 1, &table->records[r]); + r ++; } - ecs_abort(ECS_INTERNAL_ERROR, NULL); + /* Insert into (ChildOf, 0) (root) if table doesn't have childof */ + if (!has_childof && count) { + register_table_for_id(world, table, ecs_pair(EcsChildOf, 0), + 0, 1, &table->records[r]); + } - return -1; + ecs_map_fini(&relations); + ecs_map_fini(&objects); } -bool ecs_pipeline_update( +void flecs_table_records_unregister( ecs_world_t *world, - ecs_entity_t pipeline, - bool start_of_frame) + ecs_table_t *table) { - ecs_poly_assert(world, ecs_world_t); - ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); - ecs_assert(pipeline != 0, ECS_INTERNAL_ERROR, NULL); + int32_t i, count = table->record_count; + for (i = 0; i < count; i ++) { + ecs_table_record_t *tr = &table->records[i]; + ecs_table_cache_t *cache = tr->hdr.cache; + ecs_id_t id = tr->id; - /* If any entity mutations happened that could have affected query matching - * notify appropriate queries so caches are up to date. This includes the - * pipeline query. */ - if (start_of_frame) { - ecs_force_aperiodic(world); - } + ecs_assert(tr->hdr.cache == cache, ECS_INTERNAL_ERROR, NULL); + ecs_assert(tr->hdr.table == table, ECS_INTERNAL_ERROR, NULL); + ecs_assert(flecs_get_id_record(world, id) == (ecs_id_record_t*)cache, + ECS_INTERNAL_ERROR, NULL); - bool added = false; - EcsPipelineQuery *pq = ecs_get_mut(world, pipeline, EcsPipelineQuery, &added); - ecs_assert(added == false, ECS_INTERNAL_ERROR, NULL); - ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(pq->query != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_table_cache_remove(cache, table, &tr->hdr); - return build_pipeline(world, pipeline, pq); + if (ecs_table_cache_is_empty(cache)) { + ecs_id_record_t *idr = (ecs_id_record_t*)cache; + flecs_remove_id_record(world, id, idr); + } + } + + ecs_os_free(table->records); } -void ecs_run_pipeline( - ecs_world_t *world, - ecs_entity_t pipeline, - FLECS_FLOAT delta_time) +bool flecs_table_records_update_empty( + ecs_table_t *table) { - ecs_assert(world != NULL, ECS_INVALID_OPERATION, NULL); + bool result = false; + bool is_empty = ecs_table_count(table) == 0; - if (!pipeline) { - pipeline = world->pipeline; + int32_t i, count = table->record_count; + for (i = 0; i < count; i ++) { + ecs_table_record_t *tr = &table->records[i]; + ecs_table_cache_t *cache = tr->hdr.cache; + result |= ecs_table_cache_set_empty(cache, table, is_empty); } - ecs_assert(pipeline != 0, ECS_INVALID_PARAMETER, NULL); - - /* If the world is passed to ecs_run_pipeline, the function will take care - * of staging, so the world should not be in staged mode when called. */ - if (ecs_poly_is(world, ecs_world_t)) { - ecs_assert(!world->is_readonly, ECS_INVALID_OPERATION, NULL); - - /* Forward to worker_progress. This function handles staging, threading - * and synchronization across workers. */ - ecs_workers_progress(world, pipeline, delta_time); - return; - - /* If a stage is passed, the function could be ran from a worker thread. In - * that case the main thread should manage staging, and staging should be - * enabled. */ - } else { - ecs_poly_assert(world, ecs_stage_t); - } + return result; +} - ecs_stage_t *stage = flecs_stage_from_world(&world); - - const EcsPipelineQuery *pq = ecs_get(world, pipeline, EcsPipelineQuery); - ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_assert(pq->query != NULL, ECS_INTERNAL_ERROR, NULL); +static +void init_flags( + ecs_world_t *world, + ecs_table_t *table) +{ + ecs_id_t *ids = ecs_vector_first(table->type, ecs_id_t); + int32_t count = ecs_vector_count(table->type); - ecs_vector_t *ops = pq->ops; - ecs_pipeline_op_t *op = ecs_vector_first(ops, ecs_pipeline_op_t); - ecs_pipeline_op_t *op_last = ecs_vector_last(ops, ecs_pipeline_op_t); - int32_t ran_since_merge = 0; + /* Iterate components to initialize table flags */ + int32_t i; + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; - int32_t stage_index = ecs_get_stage_id(stage->thread_ctx); - int32_t stage_count = ecs_get_stage_count(world); + /* As we're iterating over the table components, also set the table + * flags. These allow us to quickly determine if the table contains + * data that needs to be handled in a special way, like prefabs or + * containers */ + if (id <= EcsLastInternalComponentId) { + table->flags |= EcsTableHasBuiltins; + } - ecs_worker_begin(stage->thread_ctx); + if (id == EcsModule) { + table->flags |= EcsTableHasBuiltins; + table->flags |= EcsTableHasModule; + } - ecs_iter_t it = ecs_query_iter(world, pq->query); - while (ecs_query_next(&it)) { - EcsSystem *sys = ecs_term(&it, EcsSystem, 1); + if (id == EcsPrefab) { + table->flags |= EcsTableIsPrefab; + } - int32_t i; - for(i = 0; i < it.count; i ++) { - ecs_entity_t e = it.entities[i]; + /* If table contains disabled entities, mark it as disabled */ + if (id == EcsDisabled) { + table->flags |= EcsTableIsDisabled; + } - if (!stage_index) { - ecs_dbg_3("pipeline: run system %s", ecs_get_name(world, e)); - } + /* Does table have exclusive or columns */ + if (ECS_HAS_ROLE(id, XOR)) { + table->flags |= EcsTableHasXor; + } - if (!stage_index || op->multi_threaded) { - ecs_stage_t *s = NULL; - if (!op->no_staging) { - s = stage; - } + /* Does the table have pairs */ + if (ECS_HAS_ROLE(id, PAIR)) { + table->flags |= EcsTableHasPairs; + } - ecs_run_intern(world, s, e, &sys[i], stage_index, - stage_count, delta_time, 0, 0, NULL); - } + /* Does table have IsA relations */ + if (ECS_HAS_RELATION(id, EcsIsA)) { + table->flags |= EcsTableHasIsA; + } - sys[i].last_frame = world->stats.frame_count_total + 1; + /* Does table have ChildOf relations */ + if (ECS_HAS_RELATION(id, EcsChildOf)) { + table->flags |= EcsTableHasChildOf; + } - ran_since_merge ++; - world->stats.systems_ran_frame ++; + /* Does table have switch columns */ + if (ECS_HAS_ROLE(id, SWITCH)) { + table->flags |= EcsTableHasSwitch; + } - if (op != op_last && ran_since_merge == op->count) { - ran_since_merge = 0; + /* Does table support component disabling */ + if (ECS_HAS_ROLE(id, DISABLED)) { + table->flags |= EcsTableHasDisabled; + } - if (!stage_index) { - ecs_dbg_3("merge"); - } + if (ECS_HAS_RELATION(id, EcsChildOf)) { + ecs_poly_assert(world, ecs_world_t); + ecs_entity_t obj = ecs_pair_second(world, id); + ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); - /* If the set of matched systems changed as a result of the - * merge, we have to reset the iterator and move it to our - * current position (system). If there are a lot of systems - * in the pipeline this can be an expensive operation, but - * should happen infrequently. */ - i = ecs_worker_sync(world, pq, &it, i, &op, &op_last); - sys = ecs_term(&it, EcsSystem, 1); + if (obj == EcsFlecs || obj == EcsFlecsCore || + ecs_has_id(world, obj, EcsModule)) + { + /* If table contains entities that are inside one of the builtin + * modules, it contains builtin entities */ + table->flags |= EcsTableHasBuiltins; + table->flags |= EcsTableHasModule; } - } + } } - - ecs_worker_end(stage->thread_ctx); } static -void add_pipeline_tags_to_sig( +void init_table( ecs_world_t *world, - ecs_term_t *terms, - ecs_type_t type) + ecs_table_t *table) { - (void)world; - - int32_t i, count = ecs_vector_count(type); - ecs_entity_t *entities = ecs_vector_first(type, ecs_entity_t); + table->type_info = NULL; + table->flags = 0; + table->dirty_state = NULL; + table->alloc_count = 0; + table->lock = 0; + table->refcount = 1; - for (i = 0; i < count; i ++) { - terms[i] = (ecs_term_t){ - .inout = EcsIn, - .oper = EcsOr, - .pred.entity = entities[i], - .subj = { - .entity = EcsThis, - .set.mask = EcsSelf | EcsSuperSet - } - }; - } + /* Ensure the component ids for the table exist */ + ensure_columns(world, table); + + init_node(&table->node); + init_flags(world, table); + flecs_table_records_register(world, table); + flecs_table_init_data(world, table); } static -ecs_query_t* build_pipeline_query( +ecs_table_t *create_table( ecs_world_t *world, - ecs_entity_t pipeline, - const char *name, - bool not_inactive) + ecs_vector_t *type, + flecs_hashmap_result_t table_elem) { - const EcsType *type_ptr = ecs_get(world, pipeline, EcsType); - ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); - - ecs_type_t type = NULL; - if (type_ptr->normalized) { - type = type_ptr->normalized->type; - } - - int32_t type_count = ecs_vector_count(type); - int32_t term_count = 1; - - if (not_inactive) { - term_count ++; - } - - ecs_term_t *terms = ecs_os_malloc( - (type_count + term_count) * ECS_SIZEOF(ecs_term_t)); - - terms[0] = (ecs_term_t){ - .inout = EcsIn, - .oper = EcsAnd, - .pred.entity = ecs_id(EcsSystem), - .subj = { - .entity = EcsThis, - .set.mask = EcsSelf | EcsSuperSet - } - }; - - if (not_inactive) { - terms[1] = (ecs_term_t){ - .inout = EcsIn, - .oper = EcsNot, - .pred.entity = EcsInactive, - .subj = { - .entity = EcsThis, - .set.mask = EcsSelf | EcsSuperSet - } - }; - } - - add_pipeline_tags_to_sig(world, &terms[term_count], type); - - ecs_query_t *result = ecs_query_init(world, &(ecs_query_desc_t){ - .filter = { - .name = name, - .terms_buffer = terms, - .terms_buffer_count = term_count + type_count - }, - .order_by = compare_entity, - .group_by = group_by_phase, - .group_by_id = pipeline - }); - + ecs_table_t *result = flecs_sparse_add(&world->store.tables, ecs_table_t); ecs_assert(result != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_os_free(terms); - - return result; -} + ecs_vector_reclaim(&type, ecs_id_t); -static -void OnUpdatePipeline( - ecs_iter_t *it) -{ - ecs_world_t *world = it->world; - ecs_entity_t *entities = it->entities; + result->id = flecs_sparse_last_id(&world->store.tables); + result->type = type; - int32_t i; - for (i = it->count - 1; i >= 0; i --) { - ecs_entity_t pipeline = entities[i]; - - ecs_trace("#[green]pipeline#[reset] %s created", - ecs_get_name(world, pipeline)); - ecs_log_push(); + init_table(world, result); - /* Build signature for pipeline query that matches EcsSystems, has the - * pipeline phases as OR columns, and ignores systems with EcsInactive. - * Note that EcsDisabled is automatically ignored - * by the regular query matching */ - ecs_query_t *query = build_pipeline_query( - world, pipeline, "BuiltinPipelineQuery", true); - ecs_assert(query != NULL, ECS_INTERNAL_ERROR, NULL); + if (ecs_should_log_2()) { + char *expr = ecs_type_str(world, result->type); + ecs_dbg_2( + "#[green]table#[normal] [%s] #[green]created#[normal] with id %d", + expr, result->id); + ecs_os_free(expr); + } - /* Build signature for pipeline build query. The build query includes - * systems that are inactive, as an inactive system may become active as - * a result of another system, and as a result the correct merge - * operations need to be put in place. */ - ecs_query_t *build_query = build_pipeline_query( - world, pipeline, "BuiltinPipelineBuildQuery", false); - ecs_assert(build_query != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_log_push_2(); - bool added = false; - EcsPipelineQuery *pq = ecs_get_mut( - world, pipeline, EcsPipelineQuery, &added); - ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); + /* Store table in table hashmap */ + *(ecs_table_t**)table_elem.value = result; - if (added) { - /* Should not modify pipeline after it has been used */ - ecs_assert(pq->ops == NULL, ECS_INVALID_OPERATION, NULL); + /* Set keyvalue to one that has the same lifecycle as the table */ + ecs_ids_t key = { + .array = ecs_vector_first(result->type, ecs_id_t), + .count = ecs_vector_count(result->type) + }; + *(ecs_ids_t*)table_elem.key = key; - if (pq->query) { - ecs_query_fini(pq->query); - } - if (pq->build_query) { - ecs_query_fini(pq->build_query); - } - } + flecs_notify_queries(world, &(ecs_query_event_t) { + .kind = EcsQueryTableMatch, + .table = result + }); - pq->query = query; - pq->build_query = build_query; - pq->match_count = -1; - pq->ops = NULL; - pq->last_system = 0; + ecs_log_pop_2(); - ecs_log_pop(); - } + return result; } -/* -- Public API -- */ - -bool ecs_progress( +static +ecs_table_t* find_or_create( ecs_world_t *world, - FLECS_FLOAT user_delta_time) -{ - float delta_time = ecs_frame_begin(world, user_delta_time); - - ecs_dbg_3("#[normal]begin progress(dt = %.2f)", (double)delta_time); + const ecs_ids_t *ids, + ecs_vector_t *type) +{ + ecs_poly_assert(world, ecs_world_t); - ecs_run_pipeline(world, 0, delta_time); + /* Make sure array is ordered and does not contain duplicates */ + int32_t id_count = ids->count; - ecs_dbg_3("#[normal]end progress"); + if (!id_count) { + return &world->store.root; + } - ecs_frame_end(world); + ecs_table_t *table; + flecs_hashmap_result_t elem = flecs_hashmap_ensure( + &world->store.table_map, ids, ecs_table_t*); + if ((table = *(ecs_table_t**)elem.value)) { + if (type) { + ecs_vector_free(type); + } + return table; + } - return !world->should_quit; -} + if (!type) { + type = ids_to_vector(ids); + } -void ecs_set_time_scale( - ecs_world_t *world, - FLECS_FLOAT scale) -{ - world->stats.time_scale = scale; -} + /* If we get here, table needs to be created which is only allowed when the + * application is not currently in progress */ + ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); -void ecs_reset_clock( - ecs_world_t *world) -{ - world->stats.world_time_total = 0; - world->stats.world_time_total_raw = 0; + /* If we get here, the table has not been found, so create it. */ + return create_table(world, type, elem); } -void ecs_deactivate_systems( - ecs_world_t *world) +static +void add_id_to_ids( + ecs_vector_t **idv, + ecs_entity_t add, + ecs_entity_t r_exclusive) { - ecs_assert(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); - - ecs_entity_t pipeline = world->pipeline; - const EcsPipelineQuery *pq = ecs_get( world, pipeline, EcsPipelineQuery); - ecs_assert(pq != NULL, ECS_INTERNAL_ERROR, NULL); + int32_t i, count = ecs_vector_count(idv[0]); + ecs_id_t *array = ecs_vector_first(idv[0], ecs_id_t); - /* Iterate over all systems, add EcsInvalid tag if queries aren't matched - * with any tables */ - ecs_iter_t it = ecs_query_iter(world, pq->build_query); + for (i = 0; i < count; i ++) { + ecs_id_t e = array[i]; - /* Make sure that we defer adding the inactive tags until after iterating - * the query */ - flecs_defer_none(world, &world->stage); + if (e == add) { + return; + } - while( ecs_query_next(&it)) { - EcsSystem *sys = ecs_term(&it, EcsSystem, 1); + if (r_exclusive && ECS_HAS_ROLE(e, PAIR)) { + if (ECS_PAIR_FIRST(e) == r_exclusive) { + array[i] = add; /* Replace */ + return; + } + } - int32_t i; - for (i = 0; i < it.count; i ++) { - ecs_query_t *query = sys[i].query; - if (query) { - if (!ecs_query_table_count(query)) { - ecs_add_id(world, it.entities[i], EcsInactive); - } + if (e >= add) { + if (e != add) { + ecs_id_t *ptr = ecs_vector_insert_at(idv, ecs_id_t, i); + ptr[0] = add; + return; } } } - flecs_defer_flush(world, &world->stage); -} - -void ecs_set_pipeline( - ecs_world_t *world, - ecs_entity_t pipeline) -{ - ecs_poly_assert(world, ecs_world_t); - ecs_check( ecs_get(world, pipeline, EcsPipelineQuery) != NULL, - ECS_INVALID_PARAMETER, "not a pipeline"); - - world->pipeline = pipeline; -error: - return; -} - -ecs_entity_t ecs_get_pipeline( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - world = ecs_get_world(world); - return world->pipeline; -error: - return 0; + ecs_id_t *ptr = ecs_vector_add(idv, ecs_id_t); + ptr[0] = add; } -/* -- Module implementation -- */ - static -void FlecsPipelineFini( - ecs_world_t *world, - void *ctx) +void remove_id_from_ids( + ecs_type_t type, + ecs_id_t remove, + ecs_ids_t *out) { - (void)ctx; - if (ecs_get_stage_count(world)) { - ecs_set_threads(world, 0); + int32_t count = ecs_vector_count(type); + ecs_id_t *array = ecs_vector_first(type, ecs_id_t); + int32_t i, el = 0; + + if (ecs_id_is_wildcard(remove)) { + for (i = 0; i < count; i ++) { + ecs_id_t id = array[i]; + if (!ecs_id_match(id, remove)) { + out->array[el ++] = id; + ecs_assert(el <= count, ECS_INTERNAL_ERROR, NULL); + } + } + } else { + for (i = 0; i < count; i ++) { + ecs_id_t id = array[i]; + if (id != remove) { + out->array[el ++] = id; + ecs_assert(el <= count, ECS_INTERNAL_ERROR, NULL); + } + } } + + out->count = el; } -void FlecsPipelineImport( - ecs_world_t *world) +int32_t flecs_table_switch_from_case( + const ecs_world_t *world, + const ecs_table_t *table, + ecs_entity_t add) { - ECS_MODULE(world, FlecsPipeline); + ecs_type_t type = table->type; + ecs_entity_t *array = ecs_vector_first(type, ecs_entity_t); - ECS_IMPORT(world, FlecsSystem); + int32_t i, count = table->sw_column_count; + ecs_assert(count != 0, ECS_INTERNAL_ERROR, NULL); - ecs_set_name_prefix(world, "Ecs"); + add = add & ECS_COMPONENT_MASK; - flecs_bootstrap_tag(world, EcsPipeline); - flecs_bootstrap_component(world, EcsPipelineQuery); + ecs_sw_column_t *sw_columns = NULL; - /* Phases of the builtin pipeline are regular entities. Names are set so - * they can be resolved by type expressions. */ - flecs_bootstrap_tag(world, EcsPreFrame); - flecs_bootstrap_tag(world, EcsOnLoad); - flecs_bootstrap_tag(world, EcsPostLoad); - flecs_bootstrap_tag(world, EcsPreUpdate); - flecs_bootstrap_tag(world, EcsOnUpdate); - flecs_bootstrap_tag(world, EcsOnValidate); - flecs_bootstrap_tag(world, EcsPostUpdate); - flecs_bootstrap_tag(world, EcsPreStore); - flecs_bootstrap_tag(world, EcsOnStore); - flecs_bootstrap_tag(world, EcsPostFrame); + if ((sw_columns = table->storage.sw_columns)) { + /* Fast path, we can get the switch type from the column data */ + for (i = 0; i < count; i ++) { + ecs_table_t *sw_type = sw_columns[i].type; + if (ecs_search(world, sw_type, add, 0) != -1) { + return i; + } + } + } else { + /* Slow path, table is empty, so we'll have to get the switch types by + * actually inspecting the switch type entities. */ + for (i = 0; i < count; i ++) { + ecs_entity_t e = array[i + table->sw_column_offset]; + ecs_assert(ECS_HAS_ROLE(e, SWITCH), ECS_INTERNAL_ERROR, NULL); + e = e & ECS_COMPONENT_MASK; - /* Set ctor and dtor for PipelineQuery */ - ecs_set(world, ecs_id(EcsPipelineQuery), EcsComponentLifecycle, { - .ctor = ecs_default_ctor, - .dtor = ecs_dtor(EcsPipelineQuery) - }); + const EcsType *type_ptr = ecs_get(world, e, EcsType); + ecs_assert(type_ptr != NULL, ECS_INTERNAL_ERROR, NULL); - /* When the Pipeline tag is added a pipeline will be created */ - ecs_observer_init(world, &(ecs_observer_desc_t) { - .entity.name = "OnUpdatePipeline", - .filter.terms = { - { .id = EcsPipeline }, - { .id = ecs_id(EcsType) } - }, - .events = { EcsOnSet }, - .callback = OnUpdatePipeline - }); + if (ecs_search(world, type_ptr->normalized, add, 0) != -1) { + return i; + } + } + } - /* Create the builtin pipeline */ - world->pipeline = ecs_type_init(world, &(ecs_type_desc_t){ - .entity = { - .name = "BuiltinPipeline", - .add = {EcsPipeline} - }, - .ids = { - EcsPreFrame, EcsOnLoad, EcsPostLoad, EcsPreUpdate, EcsOnUpdate, - EcsOnValidate, EcsPostUpdate, EcsPreStore, EcsOnStore, EcsPostFrame - } - }); + /* If a table was not found, this is an invalid switch case */ + ecs_abort(ECS_TYPE_INVALID_CASE, NULL); - /* Cleanup thread administration when world is destroyed */ - ecs_atfini(world, FlecsPipelineFini, NULL); + return -1; } -#endif - - -#ifdef FLECS_OS_API_IMPL -#ifdef ECS_TARGET_MSVC -#ifndef WIN32_LEAN_AND_MEAN -#define WIN32_LEAN_AND_MEAN -#endif -#include -#include - static -ecs_os_thread_t win_thread_new( - ecs_os_thread_callback_t callback, - void *arg) +void ids_append( + ecs_ids_t *ids, + ecs_id_t id) { - HANDLE *thread = ecs_os_malloc_t(HANDLE); - *thread = CreateThread( - NULL, 0, (LPTHREAD_START_ROUTINE)callback, arg, 0, NULL); - return (ecs_os_thread_t)(uintptr_t)thread; + ids->array = ecs_os_realloc_n(ids->array, ecs_id_t, ids->count + 1); + ids->array[ids->count ++] = id; } static -void* win_thread_join( - ecs_os_thread_t thr) +void diff_insert_isa( + ecs_world_t *world, + ecs_table_t *table, + ecs_table_diff_t *base_diff, + ecs_ids_t *append_to, + ecs_ids_t *append_from, + ecs_id_t add) { - HANDLE *thread = (HANDLE*)(uintptr_t)thr; - DWORD r = WaitForSingleObject(*thread, INFINITE); - if (r == WAIT_FAILED) { - ecs_err("win_thread_join: WaitForSingleObject failed"); + ecs_entity_t base = ecs_pair_second(world, add); + ecs_table_t *base_table = ecs_get_table(world, base); + if (!base_table) { + return; } - ecs_os_free(thread); - return NULL; -} -static -int32_t win_ainc( - int32_t *count) -{ - return InterlockedIncrement(count); -} + ecs_type_t base_type = base_table->type, type = table->type; + ecs_table_t *table_wo_base = base_table; -static -int32_t win_adec( - int32_t *count) -{ - return InterlockedDecrement(count); -} + /* If the table does not have a component from the base, it should + * trigger an OnSet */ + ecs_id_t *ids = ecs_vector_first(base_type, ecs_id_t); + int32_t j, i, count = ecs_vector_count(base_type); + for (i = 0; i < count; i ++) { + ecs_id_t id = ids[i]; -static -ecs_os_mutex_t win_mutex_new(void) { - CRITICAL_SECTION *mutex = ecs_os_malloc_t(CRITICAL_SECTION); - InitializeCriticalSection(mutex); - return (ecs_os_mutex_t)(uintptr_t)mutex; -} + if (ECS_HAS_RELATION(id, EcsIsA)) { + /* The base has an IsA relation. Find table without the base, which + * gives us the list of ids the current base inherits and doesn't + * override. This saves us from having to recursively check for each + * base in the hierarchy whether the component is overridden. */ + table_wo_base = flecs_table_traverse_remove( + world, table_wo_base, &id, base_diff); -static -void win_mutex_free( - ecs_os_mutex_t m) -{ - CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; - DeleteCriticalSection(mutex); - ecs_os_free(mutex); + /* Because we removed, the ids are stored in un_set vs. on_set */ + for (j = 0; j < append_from->count; j ++) { + ecs_id_t base_id = append_from->array[j]; + /* We still have to make sure the id isn't overridden by the + * current table */ + if (!type || ecs_search(world, table, base_id, NULL) == -1) { + ids_append(append_to, base_id); + } + } + + continue; + } + + /* Identifiers are not inherited */ + if (ECS_HAS_RELATION(id, ecs_id(EcsIdentifier))) { + continue; + } + + if (!ecs_get_typeid(world, id)) { + continue; + } + + if (!type || ecs_search(world, table, id, NULL) == -1) { + ids_append(append_to, id); + } + } } static -void win_mutex_lock( - ecs_os_mutex_t m) +void diff_insert_added_isa( + ecs_world_t *world, + ecs_table_t *table, + ecs_table_diff_t *diff, + ecs_id_t id) { - CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; - EnterCriticalSection(mutex); + ecs_table_diff_t base_diff; + diff_insert_isa(world, table, &base_diff, &diff->on_set, + &base_diff.un_set, id); } static -void win_mutex_unlock( - ecs_os_mutex_t m) +void diff_insert_removed_isa( + ecs_world_t *world, + ecs_table_t *table, + ecs_table_diff_t *diff, + ecs_id_t id) { - CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; - LeaveCriticalSection(mutex); + ecs_table_diff_t base_diff; + diff_insert_isa(world, table, &base_diff, &diff->un_set, + &base_diff.un_set, id); } static -ecs_os_cond_t win_cond_new(void) { - CONDITION_VARIABLE *cond = ecs_os_malloc_t(CONDITION_VARIABLE); - InitializeConditionVariable(cond); - return (ecs_os_cond_t)(uintptr_t)cond; -} - -static -void win_cond_free( - ecs_os_cond_t c) +void diff_insert_added( + ecs_world_t *world, + ecs_table_t *table, + ecs_table_diff_t *diff, + ecs_id_t id) { - (void)c; -} + diff->added.array[diff->added.count ++] = id; -static -void win_cond_signal( - ecs_os_cond_t c) -{ - CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; - WakeConditionVariable(cond); + if (ECS_HAS_RELATION(id, EcsIsA)) { + diff_insert_added_isa(world, table, diff, id); + } } -static -void win_cond_broadcast( - ecs_os_cond_t c) +static +void diff_insert_removed( + ecs_world_t *world, + ecs_table_t *table, + ecs_table_diff_t *diff, + ecs_id_t id) { - CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; - WakeAllConditionVariable(cond); -} + diff->removed.array[diff->removed.count ++] = id; -static -void win_cond_wait( - ecs_os_cond_t c, - ecs_os_mutex_t m) -{ - CRITICAL_SECTION *mutex = (CRITICAL_SECTION*)(intptr_t)m; - CONDITION_VARIABLE *cond = (CONDITION_VARIABLE*)(intptr_t)c; - SleepConditionVariableCS(cond, mutex, INFINITE); -} + if (ECS_HAS_RELATION(id, EcsIsA)) { + /* Removing an IsA relation also "removes" all components from the + * instance. Any id from base that's not overridden should be UnSet. */ + diff_insert_removed_isa(world, table, diff, id); + return; + } -static bool win_time_initialized; -static double win_time_freq; -static LARGE_INTEGER win_time_start; + if (table->flags & EcsTableHasIsA) { + if (!ecs_get_typeid(world, id)) { + /* Do nothing if id is not a component */ + return; + } -static -void win_time_setup(void) { - if ( win_time_initialized) { - return; + /* If next table has a base and component is removed, check if + * the removed component was an override. Removed overrides reexpose the + * base component, thus "changing" the value which requires an OnSet. */ + if (ecs_search_relation(world, table, 0, id, EcsIsA, + 1, -1, NULL, NULL, NULL) != -1) + { + ids_append(&diff->on_set, id); + return; + } } - - win_time_initialized = true; - LARGE_INTEGER freq; - QueryPerformanceFrequency(&freq); - QueryPerformanceCounter(&win_time_start); - win_time_freq = (double)freq.QuadPart / 1000000000.0; + if (ecs_get_typeid(world, id) != 0) { + ids_append(&diff->un_set, id); + } } static -void win_sleep( - int32_t sec, - int32_t nanosec) +void compute_table_diff( + ecs_world_t *world, + ecs_table_t *node, + ecs_table_t *next, + ecs_graph_edge_t *edge, + ecs_id_t id) { - HANDLE timer; - LARGE_INTEGER ft; + if (node == next) { + return; + } - ft.QuadPart = -((int64_t)sec * 10000000 + (int64_t)nanosec / 100); + ecs_type_t node_type = node->type; + ecs_type_t next_type = next->type; - timer = CreateWaitableTimer(NULL, TRUE, NULL); - SetWaitableTimer(timer, &ft, 0, NULL, NULL, 0); - WaitForSingleObject(timer, INFINITE); - CloseHandle(timer); -} + ecs_id_t *ids_node = ecs_vector_first(node_type, ecs_id_t); + ecs_id_t *ids_next = ecs_vector_first(next_type, ecs_id_t); + int32_t i_node = 0, node_count = ecs_vector_count(node_type); + int32_t i_next = 0, next_count = ecs_vector_count(next_type); + int32_t added_count = 0; + int32_t removed_count = 0; + bool trivial_edge = !ECS_HAS_RELATION(id, EcsIsA) && + !(node->flags & EcsTableHasIsA) && !(next->flags & EcsTableHasIsA); -static double win_time_freq; -static ULONG win_current_resolution; + /* First do a scan to see how big the diff is, so we don't have to realloc + * or alloc more memory than required. */ + for (; i_node < node_count && i_next < next_count; ) { + ecs_id_t id_node = ids_node[i_node]; + ecs_id_t id_next = ids_next[i_next]; -static -void win_enable_high_timer_resolution(bool enable) -{ - HMODULE hntdll = GetModuleHandle((LPCTSTR)"ntdll.dll"); - if (!hntdll) { - return; - } + bool added = id_next < id_node; + bool removed = id_node < id_next; - LONG (__stdcall *pNtSetTimerResolution)( - ULONG desired, BOOLEAN set, ULONG * current); + trivial_edge &= !added || id_next == id; + trivial_edge &= !removed || id_node == id; - pNtSetTimerResolution = (LONG(__stdcall*)(ULONG, BOOLEAN, ULONG*)) - GetProcAddress(hntdll, "NtSetTimerResolution"); + added_count += added; + removed_count += removed; - if(!pNtSetTimerResolution) { - return; + i_node += id_node <= id_next; + i_next += id_next <= id_node; } - ULONG current, resolution = 10000; /* 1 ms */ + added_count += next_count - i_next; + removed_count += node_count - i_node; - if (!enable && win_current_resolution) { - pNtSetTimerResolution(win_current_resolution, 0, ¤t); - win_current_resolution = 0; - return; - } else if (!enable) { + trivial_edge &= (added_count + removed_count) <= 1 && + !ecs_id_is_wildcard(id); + + if (trivial_edge) { + /* If edge is trivial there's no need to create a diff element for it. + * Store whether the id is a tag or not, so that we can still tell + * whether an UnSet handler should be called or not. */ + if (node->storage_table != next->storage_table) { + edge->diff = &ecs_table_edge_is_component; + } return; } - if (resolution == win_current_resolution) { - return; + ecs_table_diff_t *diff = ecs_os_calloc_t(ecs_table_diff_t); + edge->diff = diff; + if (added_count) { + diff->added.array = ecs_os_malloc_n(ecs_id_t, added_count); + diff->added.count = 0; + diff->added.size = added_count; + } + if (removed_count) { + diff->removed.array = ecs_os_malloc_n(ecs_id_t, removed_count); + diff->removed.count = 0; + diff->removed.size = removed_count; } - if (win_current_resolution) { - pNtSetTimerResolution(win_current_resolution, 0, ¤t); + for (i_node = 0, i_next = 0; i_node < node_count && i_next < next_count; ) { + ecs_id_t id_node = ids_node[i_node]; + ecs_id_t id_next = ids_next[i_next]; + + if (id_next < id_node) { + diff_insert_added(world, node, diff, id_next); + } else if (id_node < id_next) { + diff_insert_removed(world, next, diff, id_node); + } + + i_node += id_node <= id_next; + i_next += id_next <= id_node; } - if (pNtSetTimerResolution(resolution, 1, ¤t)) { - /* Try setting a lower resolution */ - resolution *= 2; - if(pNtSetTimerResolution(resolution, 1, ¤t)) return; + for (; i_next < next_count; i_next ++) { + diff_insert_added(world, node, diff, ids_next[i_next]); + } + for (; i_node < node_count; i_node ++) { + diff_insert_removed(world, next, diff, ids_node[i_node]); } - win_current_resolution = resolution; + ecs_assert(diff->added.count == added_count, ECS_INTERNAL_ERROR, NULL); + ecs_assert(diff->removed.count == removed_count, ECS_INTERNAL_ERROR, NULL); } static -uint64_t win_time_now(void) { - uint64_t now; +void add_with_ids_to_ids( + ecs_world_t *world, + ecs_vector_t **idv, + ecs_entity_t r, + ecs_entity_t o) +{ + /* Check if component/relation has With pairs, which contain ids + * that need to be added to the table. */ + ecs_table_t *id_table = ecs_get_table(world, r); + if (!id_table) { + return; + } + + ecs_table_record_t *tr = flecs_get_table_record(world, id_table, + ecs_pair(EcsWith, EcsWildcard)); + if (tr) { + int32_t i, with_count = tr->count; + int32_t start = tr->column; + int32_t end = start + with_count; + ecs_id_t *id_ids = ecs_vector_first(id_table->type, ecs_id_t); - LARGE_INTEGER qpc_t; - QueryPerformanceCounter(&qpc_t); - now = (uint64_t)(qpc_t.QuadPart / win_time_freq); + for (i = start; i < end; i ++) { + ecs_assert(ECS_PAIR_FIRST(id_ids[i]) == EcsWith, + ECS_INTERNAL_ERROR, NULL); + ecs_id_t id_r = ECS_PAIR_SECOND(id_ids[i]); + ecs_id_t id = id_r; + if (o) { + id = ecs_pair(id_r, o); + } - return now; + /* Always make sure vector has room for one more */ + add_id_to_ids(idv, id, 0); + + /* Add recursively in case id also has With pairs */ + add_with_ids_to_ids(world, idv, id_r, o); + } + } } -void ecs_set_os_api_impl(void) { - ecs_os_set_api_defaults(); +static +ecs_table_t* find_or_create_table_with_id( + ecs_world_t *world, + ecs_table_t *node, + ecs_entity_t id) +{ + /* If table has one or more switches and this is a case, return self */ + if (ECS_HAS_ROLE(id, CASE)) { + ecs_assert((node->flags & EcsTableHasSwitch) != 0, + ECS_TYPE_INVALID_CASE, NULL); + return node; + } else { + ecs_type_t type = node->type; + ecs_entity_t r_exclusive = 0; + ecs_entity_t r = 0, o = 0, re = 0; - ecs_os_api_t api = ecs_os_api; + if (ECS_HAS_ROLE(id, PAIR)) { + r = ECS_PAIR_FIRST(id); + o = ECS_PAIR_SECOND(id); + re = ecs_get_alive(world, r); + if (re && ecs_has_id(world, re, EcsExclusive)) { + r_exclusive = (uint32_t)re; + } + } else { + r = id & ECS_COMPONENT_MASK; + re = ecs_get_alive(world, r); + } - api.thread_new_ = win_thread_new; - api.thread_join_ = win_thread_join; - api.ainc_ = win_ainc; - api.adec_ = win_adec; - api.mutex_new_ = win_mutex_new; - api.mutex_free_ = win_mutex_free; - api.mutex_lock_ = win_mutex_lock; - api.mutex_unlock_ = win_mutex_unlock; - api.cond_new_ = win_cond_new; - api.cond_free_ = win_cond_free; - api.cond_signal_ = win_cond_signal; - api.cond_broadcast_ = win_cond_broadcast; - api.cond_wait_ = win_cond_wait; - api.sleep_ = win_sleep; - api.now_ = win_time_now; - api.enable_high_timer_resolution_ = win_enable_high_timer_resolution; + ecs_vector_t *idv = ecs_vector_copy(type, ecs_id_t); + add_id_to_ids(&idv, id, r_exclusive); + if (re) { + add_with_ids_to_ids(world, &idv, re, o); + } - win_time_setup(); + ecs_ids_t ids = { + .array = ecs_vector_first(idv, ecs_id_t), + .count = ecs_vector_count(idv) + }; - ecs_os_set_api(&api); + return find_or_create(world, &ids, idv); + } } -#else -#include "pthread.h" - -#if defined(__APPLE__) && defined(__MACH__) -#include -#elif defined(__EMSCRIPTEN__) -#include -#else -#include -#endif - static -ecs_os_thread_t posix_thread_new( - ecs_os_thread_callback_t callback, - void *arg) +ecs_table_t* find_or_create_table_without_id( + ecs_world_t *world, + ecs_table_t *node, + ecs_entity_t id) { - pthread_t *thread = ecs_os_malloc(sizeof(pthread_t)); + /* If table has one or more switches and this is a case, return self */ + if (ECS_HAS_ROLE(id, CASE)) { + ecs_assert((node->flags & EcsTableHasSwitch) != 0, + ECS_TYPE_INVALID_CASE, NULL); + return node; + } else { + ecs_type_t type = node->type; + int32_t count = ecs_vector_count(type); - if (pthread_create (thread, NULL, callback, arg) != 0) { - ecs_os_abort(); - } + ecs_ids_t ids = { + .array = ecs_os_alloca_n(ecs_id_t, count), + .count = count + }; - return (ecs_os_thread_t)(uintptr_t)thread; -} + remove_id_from_ids(type, id, &ids); -static -void* posix_thread_join( - ecs_os_thread_t thread) -{ - void *arg; - pthread_t *thr = (pthread_t*)(uintptr_t)thread; - pthread_join(*thr, &arg); - ecs_os_free(thr); - return arg; + return flecs_table_find_or_create(world, &ids);; + } } static -int32_t posix_ainc( - int32_t *count) +ecs_table_t* find_or_create_table_with_isa( + ecs_world_t *world, + ecs_table_t *node, + ecs_entity_t base) { - int value; -#ifdef __GNUC__ - value = __sync_add_and_fetch (count, 1); - return value; -#else - /* Unsupported */ - abort(); -#endif -} + ecs_type_t base_type = ecs_get_type(world, base); + ecs_id_t *ids = ecs_vector_first(base_type, ecs_id_t); + int32_t i, count = ecs_vector_count(base_type); -static -int32_t posix_adec( - int32_t *count) -{ - int value; -#ifdef __GNUC__ - value = __sync_sub_and_fetch (count, 1); - return value; -#else - /* Unsupported */ - abort(); -#endif -} + /* Start from back, as roles have high ids */ + for (i = count - 1; i >= 0; i --) { + ecs_id_t id = ids[i]; + if (!(id & ECS_ROLE_MASK)) { /* early out if we found everything */ + break; + } -static -ecs_os_mutex_t posix_mutex_new(void) { - pthread_mutex_t *mutex = ecs_os_malloc(sizeof(pthread_mutex_t)); - if (pthread_mutex_init(mutex, NULL)) { - abort(); + if (ECS_HAS_RELATION(id, EcsIsA)) { + ecs_entity_t base_of_base = ecs_pair_second(world, id); + node = find_or_create_table_with_isa(world, node, base_of_base); + } + + if (ECS_HAS_ROLE(id, OVERRIDE)) { + /* Override found, add it to table */ + id &= ECS_COMPONENT_MASK; + node = flecs_table_traverse_add(world, node, &id, NULL); + } } - return (ecs_os_mutex_t)(uintptr_t)mutex; -} -static -void posix_mutex_free( - ecs_os_mutex_t m) -{ - pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; - pthread_mutex_destroy(mutex); - ecs_os_free(mutex); + return node; } static -void posix_mutex_lock( - ecs_os_mutex_t m) +void init_edge( + ecs_table_t *table, + ecs_graph_edge_t *edge, + ecs_id_t id, + ecs_table_t *to) { - pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; - if (pthread_mutex_lock(mutex)) { - abort(); - } + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->id == 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->hdr.next == NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->hdr.prev == NULL, ECS_INTERNAL_ERROR, NULL); + + edge->from = table; + edge->to = to; + edge->id = id; } static -void posix_mutex_unlock( - ecs_os_mutex_t m) +void init_add_edge( + ecs_world_t *world, + ecs_table_t *table, + ecs_graph_edge_t *edge, + ecs_id_t id, + ecs_table_t *to) { - pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; - if (pthread_mutex_unlock(mutex)) { - abort(); - } -} + init_edge(table, edge, id, to); -static -ecs_os_cond_t posix_cond_new(void) { - pthread_cond_t *cond = ecs_os_malloc(sizeof(pthread_cond_t)); - if (pthread_cond_init(cond, NULL)) { - abort(); - } - return (ecs_os_cond_t)(uintptr_t)cond; -} + ensure_hi_edge(world, &table->node.add, id); -static -void posix_cond_free( - ecs_os_cond_t c) -{ - pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; - if (pthread_cond_destroy(cond)) { - abort(); - } - ecs_os_free(cond); -} + if (table != to) { + /* Add edges are appended to refs.next */ + ecs_graph_edge_hdr_t *to_refs = &to->node.refs; + ecs_graph_edge_hdr_t *next = to_refs->next; + + to_refs->next = &edge->hdr; + edge->hdr.prev = to_refs; -static -void posix_cond_signal( - ecs_os_cond_t c) -{ - pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; - if (pthread_cond_signal(cond)) { - abort(); - } -} + edge->hdr.next = next; + if (next) { + next->prev = &edge->hdr; + } -static -void posix_cond_broadcast( - ecs_os_cond_t c) -{ - pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; - if (pthread_cond_broadcast(cond)) { - abort(); + compute_table_diff(world, table, to, edge, id); } } -static -void posix_cond_wait( - ecs_os_cond_t c, - ecs_os_mutex_t m) +static +void init_remove_edge( + ecs_world_t *world, + ecs_table_t *table, + ecs_graph_edge_t *edge, + ecs_id_t id, + ecs_table_t *to) { - pthread_cond_t *cond = (pthread_cond_t*)(intptr_t)c; - pthread_mutex_t *mutex = (pthread_mutex_t*)(intptr_t)m; - if (pthread_cond_wait(cond, mutex)) { - abort(); - } -} - -static bool posix_time_initialized; + init_edge(table, edge, id, to); -#if defined(__APPLE__) && defined(__MACH__) -static mach_timebase_info_data_t posix_osx_timebase; -static uint64_t posix_time_start; -#else -static uint64_t posix_time_start; -#endif + ensure_hi_edge(world, &table->node.remove, id); -static -void posix_time_setup(void) { - if (posix_time_initialized) { - return; - } - - posix_time_initialized = true; + if (table != to) { + /* Remove edges are appended to refs.prev */ + ecs_graph_edge_hdr_t *to_refs = &to->node.refs; + ecs_graph_edge_hdr_t *prev = to_refs->prev; - #if defined(__APPLE__) && defined(__MACH__) - mach_timebase_info(&posix_osx_timebase); - posix_time_start = mach_absolute_time(); - #else - struct timespec ts; - clock_gettime(CLOCK_MONOTONIC, &ts); - posix_time_start = (uint64_t)ts.tv_sec*1000000000 + (uint64_t)ts.tv_nsec; - #endif -} + to_refs->prev = &edge->hdr; + edge->hdr.next = to_refs; -static -void posix_sleep( - int32_t sec, - int32_t nanosec) -{ - struct timespec sleepTime; - ecs_assert(sec >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_assert(nanosec >= 0, ECS_INTERNAL_ERROR, NULL); + edge->hdr.prev = prev; + if (prev) { + prev->next = &edge->hdr; + } - sleepTime.tv_sec = sec; - sleepTime.tv_nsec = nanosec; - if (nanosleep(&sleepTime, NULL)) { - ecs_err("nanosleep failed"); + compute_table_diff(world, table, to, edge, id); } } static -void posix_enable_high_timer_resolution(bool enable) { - (void)enable; -} +ecs_table_t* find_or_create_table_without( + ecs_world_t *world, + ecs_table_t *node, + ecs_graph_edge_t *edge, + ecs_id_t id) +{ + ecs_table_t *to = find_or_create_table_without_id(world, node, id); + + init_remove_edge(world, node, edge, id, to); -/* prevent 64-bit overflow when computing relative timestamp - see https://gist.github.com/jspohr/3dc4f00033d79ec5bdaf67bc46c813e3 -*/ -#if defined(ECS_TARGET_DARWIN) -static -int64_t posix_int64_muldiv(int64_t value, int64_t numer, int64_t denom) { - int64_t q = value / denom; - int64_t r = value % denom; - return q * numer + r * numer / denom; + return to; } -#endif static -uint64_t posix_time_now(void) { - ecs_assert(posix_time_initialized != 0, ECS_INTERNAL_ERROR, NULL); +ecs_table_t* find_or_create_table_with( + ecs_world_t *world, + ecs_table_t *node, + ecs_graph_edge_t *edge, + ecs_id_t id) +{ + ecs_table_t *to = find_or_create_table_with_id(world, node, id); - uint64_t now; + if (ECS_HAS_ROLE(id, PAIR) && ECS_PAIR_FIRST(id) == EcsIsA) { + ecs_entity_t base = ecs_pair_second(world, id); + to = find_or_create_table_with_isa(world, to, base); + } - #if defined(ECS_TARGET_DARWIN) - now = (uint64_t) posix_int64_muldiv( - (int64_t)mach_absolute_time(), - (int64_t)posix_osx_timebase.numer, - (int64_t)posix_osx_timebase.denom); - #elif defined(__EMSCRIPTEN__) - now = (long long)(emscripten_get_now() * 1000.0 * 1000); - #else - struct timespec ts; - clock_gettime(CLOCK_MONOTONIC, &ts); - now = ((uint64_t)ts.tv_sec * 1000 * 1000 * 1000 + (uint64_t)ts.tv_nsec); - #endif + init_add_edge(world, node, edge, id, to); - return now; + return to; } -void ecs_set_os_api_impl(void) { - ecs_os_set_api_defaults(); - - ecs_os_api_t api = ecs_os_api; +static +void populate_diff( + ecs_graph_edge_t *edge, + ecs_id_t *add_ptr, + ecs_id_t *remove_ptr, + ecs_table_diff_t *out) +{ + if (out) { + ecs_table_diff_t *diff = edge->diff; - api.thread_new_ = posix_thread_new; - api.thread_join_ = posix_thread_join; - api.ainc_ = posix_ainc; - api.adec_ = posix_adec; - api.mutex_new_ = posix_mutex_new; - api.mutex_free_ = posix_mutex_free; - api.mutex_lock_ = posix_mutex_lock; - api.mutex_unlock_ = posix_mutex_unlock; - api.cond_new_ = posix_cond_new; - api.cond_free_ = posix_cond_free; - api.cond_signal_ = posix_cond_signal; - api.cond_broadcast_ = posix_cond_broadcast; - api.cond_wait_ = posix_cond_wait; - api.sleep_ = posix_sleep; - api.now_ = posix_time_now; - api.enable_high_timer_resolution_ = posix_enable_high_timer_resolution; + if (diff && diff != &ecs_table_edge_is_component) { + ecs_assert(!add_ptr || !ECS_HAS_ROLE(add_ptr[0], CASE), + ECS_INTERNAL_ERROR, NULL); + ecs_assert(!remove_ptr || !ECS_HAS_ROLE(remove_ptr[0], CASE), + ECS_INTERNAL_ERROR, NULL); + *out = *diff; + } else { + out->on_set.count = 0; - posix_time_setup(); + if (add_ptr) { + out->added.array = add_ptr; + out->added.count = 1; + } else { + out->added.count = 0; + } - ecs_os_set_api(&api); + if (remove_ptr) { + out->removed.array = remove_ptr; + out->removed.count = 1; + if (diff == &ecs_table_edge_is_component) { + out->un_set.array = remove_ptr; + out->un_set.count = 1; + } else { + out->un_set.count = 0; + } + } else { + out->removed.count = 0; + out->un_set.count = 0; + } + } + } } -#endif -#endif - - +ecs_table_t* flecs_table_traverse_remove( + ecs_world_t *world, + ecs_table_t *node, + ecs_id_t *id_ptr, + ecs_table_diff_t *diff) +{ + ecs_poly_assert(world, ecs_world_t); -#ifdef FLECS_COREDOC + node = node ? node : &world->store.root; -#define URL_ROOT "https://flecs.docsforge.com/master/relations-manual/" + /* Removing 0 from an entity is not valid */ + ecs_check(id_ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(id_ptr[0] != 0, ECS_INVALID_PARAMETER, NULL); -void FlecsCoreDocImport( - ecs_world_t *world) -{ - ECS_MODULE(world, FlecsCoreDoc); + ecs_id_t id = id_ptr[0]; + ecs_graph_edge_t *edge = ensure_edge(world, &node->node.remove, id); + ecs_table_t *to = edge->to; - ECS_IMPORT(world, FlecsMeta); - ECS_IMPORT(world, FlecsDoc); + if (!to) { + to = find_or_create_table_without(world, node, edge, id); + ecs_assert(to != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->to != NULL, ECS_INTERNAL_ERROR, NULL); + } - ecs_set_name_prefix(world, "Ecs"); + populate_diff(edge, NULL, id_ptr, diff); - /* Initialize reflection data for core components */ + return to; +error: + return NULL; +} - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsComponent), - .members = { - {.name = (char*)"size", .type = ecs_id(ecs_i32_t)}, - {.name = (char*)"alignment", .type = ecs_id(ecs_i32_t)} - } - }); +ecs_table_t* flecs_table_traverse_add( + ecs_world_t *world, + ecs_table_t *node, + ecs_id_t *id_ptr, + ecs_table_diff_t *diff) +{ + ecs_poly_assert(world, ecs_world_t); - ecs_struct_init(world, &(ecs_struct_desc_t) { - .entity.entity = ecs_id(EcsDocDescription), - .members = { - {.name = "value", .type = ecs_id(ecs_string_t)} - } - }); + node = node ? node : &world->store.root; - /* Initialize documentation data for core components */ - ecs_doc_set_brief(world, EcsFlecs, "Flecs root module"); - ecs_doc_set_link(world, EcsFlecs, "https://github.com/SanderMertens/flecs"); + /* Adding 0 to an entity is not valid */ + ecs_check(id_ptr != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(id_ptr[0] != 0, ECS_INVALID_PARAMETER, NULL); - ecs_doc_set_brief(world, EcsFlecsCore, "Flecs module with builtin components"); - ecs_doc_set_brief(world, EcsFlecsHidden, "Flecs module with internal/anonymous entities"); + ecs_id_t id = id_ptr[0]; + ecs_graph_edge_t *edge = ensure_edge(world, &node->node.add, id); + ecs_table_t *to = edge->to; - ecs_doc_set_brief(world, EcsWorld, "Entity associated with world"); + if (!to) { + to = find_or_create_table_with(world, node, edge, id); + ecs_assert(to != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->to != NULL, ECS_INTERNAL_ERROR, NULL); + } - ecs_doc_set_brief(world, ecs_id(EcsComponent), "Component that is added to all components"); - ecs_doc_set_brief(world, EcsModule, "Tag that is added to modules"); - ecs_doc_set_brief(world, EcsPrefab, "Tag that is added to prefabs"); - ecs_doc_set_brief(world, EcsDisabled, "Tag that is added to disabled entities"); + populate_diff(edge, id_ptr, NULL, diff); - ecs_doc_set_brief(world, ecs_id(EcsIdentifier), "Component used for entity names"); - ecs_doc_set_brief(world, EcsName, "Tag used with EcsIdentifier to signal entity name"); - ecs_doc_set_brief(world, EcsSymbol, "Tag used with EcsIdentifier to signal entity symbol"); + return to; +error: + return NULL; +} - ecs_doc_set_brief(world, ecs_id(EcsComponentLifecycle), "Callbacks for component constructors, destructors, copy and move operations"); +ecs_table_t* flecs_table_find_or_create( + ecs_world_t *world, + const ecs_ids_t *ids) +{ + ecs_poly_assert(world, ecs_world_t); + return find_or_create(world, ids, NULL); +} - ecs_doc_set_brief(world, EcsTransitive, "Transitive relation property"); - ecs_doc_set_brief(world, EcsReflexive, "Reflexive relation property"); - ecs_doc_set_brief(world, EcsFinal, "Final relation property"); - ecs_doc_set_brief(world, EcsDontInherit, "DontInherit relation property"); - ecs_doc_set_brief(world, EcsTag, "Tag relation property"); - ecs_doc_set_brief(world, EcsAcyclic, "Acyclic relation property"); - ecs_doc_set_brief(world, EcsExclusive, "Exclusive relation property"); - ecs_doc_set_brief(world, EcsSymmetric, "Symmetric relation property"); - ecs_doc_set_brief(world, EcsWith, "With relation property"); - ecs_doc_set_brief(world, EcsOnDelete, "OnDelete relation cleanup property"); - ecs_doc_set_brief(world, EcsOnDeleteObject, "OnDeleteObject relation cleanup property"); - ecs_doc_set_brief(world, EcsDefaultChildComponent, "Sets default component hint for children of entity"); - ecs_doc_set_brief(world, EcsRemove, "Remove relation cleanup property"); - ecs_doc_set_brief(world, EcsDelete, "Delete relation cleanup property"); - ecs_doc_set_brief(world, EcsThrow, "Throw relation cleanup property"); - ecs_doc_set_brief(world, EcsIsA, "Builtin IsA relation"); - ecs_doc_set_brief(world, EcsChildOf, "Builtin ChildOf relation"); - ecs_doc_set_brief(world, EcsOnAdd, "Builtin OnAdd event"); - ecs_doc_set_brief(world, EcsOnRemove, "Builtin OnRemove event"); - ecs_doc_set_brief(world, EcsOnSet, "Builtin OnSet event"); - ecs_doc_set_brief(world, EcsUnSet, "Builtin UnSet event"); +void flecs_init_root_table( + ecs_world_t *world) +{ + ecs_poly_assert(world, ecs_world_t); - ecs_doc_set_link(world, EcsTransitive, URL_ROOT "#transitive-property"); - ecs_doc_set_link(world, EcsReflexive, URL_ROOT "#reflexive-property"); - ecs_doc_set_link(world, EcsFinal, URL_ROOT "#final-property"); - ecs_doc_set_link(world, EcsDontInherit, URL_ROOT "#dontinherit-property"); - ecs_doc_set_link(world, EcsTag, URL_ROOT "#tag-property"); - ecs_doc_set_link(world, EcsAcyclic, URL_ROOT "#acyclic-property"); - ecs_doc_set_link(world, EcsExclusive, URL_ROOT "#exclusive-property"); - ecs_doc_set_link(world, EcsSymmetric, URL_ROOT "#symmetric-property"); - ecs_doc_set_link(world, EcsWith, URL_ROOT "#with-property"); - ecs_doc_set_link(world, EcsOnDelete, URL_ROOT "#cleanup-properties"); - ecs_doc_set_link(world, EcsOnDeleteObject, URL_ROOT "#cleanup-properties"); - ecs_doc_set_link(world, EcsRemove, URL_ROOT "#cleanup-properties"); - ecs_doc_set_link(world, EcsDelete, URL_ROOT "#cleanup-properties"); - ecs_doc_set_link(world, EcsThrow, URL_ROOT "#cleanup-properties"); - ecs_doc_set_link(world, EcsIsA, URL_ROOT "#the-isa-relation"); - ecs_doc_set_link(world, EcsChildOf, URL_ROOT "#the-childof-relation"); - - /* Initialize documentation for meta components */ - ecs_entity_t meta = ecs_lookup_fullpath(world, "flecs.meta"); - ecs_doc_set_brief(world, meta, "Flecs module with reflection components"); + ecs_ids_t entities = { + .array = NULL, + .count = 0 + }; - ecs_doc_set_brief(world, ecs_id(EcsMetaType), "Component added to types"); - ecs_doc_set_brief(world, ecs_id(EcsMetaTypeSerialized), "Component that stores reflection data in an optimized format"); - ecs_doc_set_brief(world, ecs_id(EcsPrimitive), "Component added to primitive types"); - ecs_doc_set_brief(world, ecs_id(EcsEnum), "Component added to enumeration types"); - ecs_doc_set_brief(world, ecs_id(EcsBitmask), "Component added to bitmask types"); - ecs_doc_set_brief(world, ecs_id(EcsMember), "Component added to struct members"); - ecs_doc_set_brief(world, ecs_id(EcsStruct), "Component added to struct types"); - ecs_doc_set_brief(world, ecs_id(EcsArray), "Component added to array types"); - ecs_doc_set_brief(world, ecs_id(EcsVector), "Component added to vector types"); + world->store.root.type = ids_to_vector(&entities); + init_table(world, &world->store.root); - ecs_doc_set_brief(world, ecs_id(ecs_bool_t), "bool component"); - ecs_doc_set_brief(world, ecs_id(ecs_char_t), "char component"); - ecs_doc_set_brief(world, ecs_id(ecs_byte_t), "byte component"); - ecs_doc_set_brief(world, ecs_id(ecs_u8_t), "8 bit unsigned int component"); - ecs_doc_set_brief(world, ecs_id(ecs_u16_t), "16 bit unsigned int component"); - ecs_doc_set_brief(world, ecs_id(ecs_u32_t), "32 bit unsigned int component"); - ecs_doc_set_brief(world, ecs_id(ecs_u64_t), "64 bit unsigned int component"); - ecs_doc_set_brief(world, ecs_id(ecs_uptr_t), "word sized unsigned int component"); - ecs_doc_set_brief(world, ecs_id(ecs_i8_t), "8 bit signed int component"); - ecs_doc_set_brief(world, ecs_id(ecs_i16_t), "16 bit signed int component"); - ecs_doc_set_brief(world, ecs_id(ecs_i32_t), "32 bit signed int component"); - ecs_doc_set_brief(world, ecs_id(ecs_i64_t), "64 bit signed int component"); - ecs_doc_set_brief(world, ecs_id(ecs_iptr_t), "word sized signed int component"); - ecs_doc_set_brief(world, ecs_id(ecs_f32_t), "32 bit floating point component"); - ecs_doc_set_brief(world, ecs_id(ecs_f64_t), "64 bit floating point component"); - ecs_doc_set_brief(world, ecs_id(ecs_string_t), "string component"); - ecs_doc_set_brief(world, ecs_id(ecs_entity_t), "entity component"); + /* Ensure table indices start at 1, as 0 is reserved for the root */ + uint64_t new_id = flecs_sparse_new_id(&world->store.tables); + ecs_assert(new_id == 0, ECS_INTERNAL_ERROR, NULL); + (void)new_id; +} - /* Initialize documentation for doc components */ - ecs_entity_t doc = ecs_lookup_fullpath(world, "flecs.doc"); - ecs_doc_set_brief(world, doc, "Flecs module with documentation components"); +void flecs_table_clear_edges( + ecs_world_t *world, + ecs_table_t *table) +{ + (void)world; + ecs_poly_assert(world, ecs_world_t); - ecs_doc_set_brief(world, ecs_id(EcsDocDescription), "Component used to add documentation"); - ecs_doc_set_brief(world, EcsDocBrief, "Used as (Description, Brief) to add a brief description"); - ecs_doc_set_brief(world, EcsDocDetail, "Used as (Description, Detail) to add a detailed description"); - ecs_doc_set_brief(world, EcsDocLink, "Used as (Description, Link) to add a link"); -} + ecs_log_push_1(); -#endif + ecs_map_iter_t it; + ecs_graph_node_t *table_node = &table->node; + ecs_graph_edges_t *node_add = &table_node->add; + ecs_graph_edges_t *node_remove = &table_node->remove; + ecs_map_t *add_hi = &node_add->hi; + ecs_map_t *remove_hi = &node_remove->hi; + ecs_graph_edge_hdr_t *node_refs = &table_node->refs; + ecs_graph_edge_t *edge; + uint64_t key; + /* Cleanup outgoing edges */ + it = ecs_map_iter(add_hi); + while ((edge = ecs_map_next_ptr(&it, ecs_graph_edge_t*, &key))) { + disconnect_edge(world, key, edge); + } -#ifdef FLECS_PARSER + it = ecs_map_iter(remove_hi); + while ((edge = ecs_map_next_ptr(&it, ecs_graph_edge_t*, &key))) { + disconnect_edge(world, key, edge); + } -#include + /* Cleanup incoming add edges */ + ecs_graph_edge_hdr_t *next, *cur = node_refs->next; + if (cur) { + do { + edge = (ecs_graph_edge_t*)cur; + ecs_assert(edge->to == table, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->from != NULL, ECS_INTERNAL_ERROR, NULL); + next = cur->next; + remove_edge(world, &edge->from->node.add, edge->id, edge); + } while ((cur = next)); + } -#define ECS_ANNOTATION_LENGTH_MAX (16) + /* Cleanup incoming remove edges */ + cur = node_refs->prev; + if (cur) { + do { + edge = (ecs_graph_edge_t*)cur; + ecs_assert(edge->to == table, ECS_INTERNAL_ERROR, NULL); + ecs_assert(edge->from != NULL, ECS_INTERNAL_ERROR, NULL); + next = cur->prev; + remove_edge(world, &edge->from->node.remove, edge->id, edge); + } while ((cur = next)); + } -#define TOK_NEWLINE '\n' -#define TOK_COLON ':' -#define TOK_AND ',' -#define TOK_OR "||" -#define TOK_NOT '!' -#define TOK_OPTIONAL '?' -#define TOK_BITWISE_OR '|' -#define TOK_NAME_SEP '.' -#define TOK_BRACKET_OPEN '[' -#define TOK_BRACKET_CLOSE ']' -#define TOK_WILDCARD '*' -#define TOK_SINGLETON '$' -#define TOK_PAREN_OPEN '(' -#define TOK_PAREN_CLOSE ')' -#define TOK_AS_ENTITY '\\' + ecs_os_free(node_add->lo); + ecs_os_free(node_remove->lo); + ecs_map_fini(add_hi); + ecs_map_fini(remove_hi); + table_node->add.lo = NULL; + table_node->remove.lo = NULL; -#define TOK_SELF "self" -#define TOK_SUPERSET "super" -#define TOK_SUBSET "sub" -#define TOK_CASCADE "cascade" -#define TOK_PARENT "parent" -#define TOK_ALL "all" + ecs_log_pop_1(); +} -#define TOK_OVERRIDE "OVERRIDE" +/* Public convenience functions for traversing table graph */ +ecs_table_t* ecs_table_add_id( + ecs_world_t *world, + ecs_table_t *table, + ecs_id_t id) +{ + return flecs_table_traverse_add(world, table, &id, NULL); +} -#define TOK_ROLE_PAIR "PAIR" -#define TOK_ROLE_AND "AND" -#define TOK_ROLE_OR "OR" -#define TOK_ROLE_XOR "XOR" -#define TOK_ROLE_NOT "NOT" -#define TOK_ROLE_SWITCH "SWITCH" -#define TOK_ROLE_CASE "CASE" -#define TOK_ROLE_DISABLED "DISABLED" +ecs_table_t* ecs_table_remove_id( + ecs_world_t *world, + ecs_table_t *table, + ecs_id_t id) +{ + return flecs_table_traverse_remove(world, table, &id, NULL); +} -#define TOK_IN "in" -#define TOK_OUT "out" -#define TOK_INOUT "inout" -#define TOK_INOUT_FILTER "filter" +#include -#define ECS_MAX_TOKEN_SIZE (256) +#define INIT_CACHE(it, f, term_count)\ + if (!it->f && term_count) {\ + if (term_count <= ECS_TERM_CACHE_SIZE) {\ + it->f = it->priv.cache.f;\ + it->priv.cache.f##_alloc = false;\ + } else {\ + it->f = ecs_os_calloc(ECS_SIZEOF(*(it->f)) * term_count);\ + it->priv.cache.f##_alloc = true;\ + }\ + } -typedef char ecs_token_t[ECS_MAX_TOKEN_SIZE]; +#define FINI_CACHE(it, f)\ + if (it->f) {\ + if (it->priv.cache.f##_alloc) {\ + ecs_os_free((void*)it->f);\ + }\ + } -const char* ecs_parse_eol_and_whitespace( - const char *ptr) +void flecs_iter_init( + ecs_iter_t *it) { - while (isspace(*ptr)) { - ptr ++; + INIT_CACHE(it, ids, it->term_count); + INIT_CACHE(it, subjects, it->term_count); + INIT_CACHE(it, match_indices, it->term_count); + INIT_CACHE(it, columns, it->term_count); + + if (!it->is_filter) { + INIT_CACHE(it, sizes, it->term_count); + INIT_CACHE(it, ptrs, it->term_count); + } else { + it->sizes = NULL; + it->ptrs = NULL; } - return ptr; + it->is_valid = true; } -/** Skip spaces when parsing signature */ -const char* ecs_parse_whitespace( - const char *ptr) +void ecs_iter_fini( + ecs_iter_t *it) { - while ((*ptr != '\n') && isspace(*ptr)) { - ptr ++; + ecs_check(it->is_valid == true, ECS_INVALID_PARAMETER, NULL); + it->is_valid = false; + + if (it->fini) { + it->fini(it); } - return ptr; + FINI_CACHE(it, ids); + FINI_CACHE(it, columns); + FINI_CACHE(it, subjects); + FINI_CACHE(it, sizes); + FINI_CACHE(it, ptrs); + FINI_CACHE(it, match_indices); +error: + return; } -const char* ecs_parse_digit( - const char *ptr, - char *token) +static +bool flecs_iter_populate_term_data( + ecs_world_t *world, + ecs_iter_t *it, + int32_t t, + int32_t column, + void **ptr_out, + ecs_size_t *size_out) { - char *tptr = token; - char ch = ptr[0]; + bool is_shared = false; - if (!isdigit(ch) && ch != '-') { - ecs_parser_error(NULL, NULL, 0, "invalid start of number '%s'", ptr); - return NULL; + if (!column) { + /* Term has no data. This includes terms that have Not operators. */ + goto no_data; } - tptr[0] = ch; - tptr ++; - ptr ++; - - for (; (ch = *ptr); ptr ++) { - if (!isdigit(ch)) { - break; - } + if (!it->terms) { + goto no_data; + } - tptr[0] = ch; - tptr ++; + /* Filter terms may match with data but don't return it */ + if (it->terms[t].inout == EcsInOutFilter) { + goto no_data; } - tptr[0] = '\0'; - - return ptr; -} + ecs_table_t *table; + ecs_vector_t *vec; + ecs_size_t size; + ecs_size_t align; + int32_t row; -static -bool is_newline_comment( - const char *ptr) -{ - if (ptr[0] == '/' && ptr[1] == '/') { - return true; - } - return false; -} + if (column < 0) { + is_shared = true; -const char* ecs_parse_fluff( - const char *ptr, - char **last_comment) -{ - const char *last_comment_start = NULL; + /* Data is not from This */ + if (it->references) { + /* Iterator provides cached references for non-This terms */ + ecs_ref_t *ref = &it->references[-column - 1]; + if (ptr_out) ptr_out[0] = (void*)ecs_get_ref_id( + world, ref, ref->entity, ref->component); - do { - /* Skip whitespaces before checking for a comment */ - ptr = ecs_parse_whitespace(ptr); + /* If cached references were provided, the code that populated + * the iterator also had a chance to cache sizes, so size array + * should already have been assigned. This saves us from having + * to do additional lookups to find the component size. */ + ecs_assert(size_out == NULL, ECS_INTERNAL_ERROR, NULL); + return true; + } else { + ecs_entity_t subj = it->subjects[t]; + ecs_assert(subj != 0, ECS_INTERNAL_ERROR, NULL); - /* Newline comment, skip until newline character */ - if (is_newline_comment(ptr)) { - ptr += 2; - last_comment_start = ptr; + /* Don't use ecs_get_id directly. Instead, go directly to the + * storage so that we can get both the pointer and size */ + ecs_record_t *r = ecs_eis_get(world, subj); + ecs_assert(r != NULL && r->table != NULL, ECS_INTERNAL_ERROR, NULL); - while (ptr[0] && ptr[0] != TOK_NEWLINE) { - ptr ++; + row = ECS_RECORD_TO_ROW(r->row); + table = r->table; + + ecs_id_t id = it->ids[t]; + ecs_table_t *s_table = table->storage_table; + ecs_table_record_t *tr; + + if (!s_table || !(tr = flecs_get_table_record(world, s_table, id))){ + /* The entity has no components or the id is not a component */ + + ecs_id_t term_id = it->terms[t].id; + if (ECS_HAS_ROLE(term_id, SWITCH) || ECS_HAS_ROLE(term_id, CASE)) { + /* Edge case: if this is a switch. Find switch column in + * actual table, as its not in the storage table */ + tr = flecs_get_table_record(world, table, id); + ecs_assert(tr != NULL, ECS_INTERNAL_ERROR, NULL); + column = tr->column; + goto has_switch; + } else { + goto no_data; + } + } + + /* We now have row and column, so we can get the storage for the id + * which gives us the pointer and size */ + column = tr->column; + ecs_column_t *s = &table->storage.columns[column]; + size = s->size; + align = s->alignment; + vec = s->data; + /* Fallthrough to has_data */ + } + } else { + /* Data is from This, use table from iterator */ + table = it->table; + if (!table || !ecs_table_count(table)) { + goto no_data; + } + + row = it->offset; + + int32_t storage_column = ecs_table_type_to_storage_index( + table, column - 1); + if (storage_column == -1) { + ecs_id_t id = it->terms[t].id; + if (ECS_HAS_ROLE(id, SWITCH) || ECS_HAS_ROLE(id, CASE)) { + goto has_switch; } + goto no_data; } - /* If a newline character is found, skip it */ - if (ptr[0] == TOK_NEWLINE) { - ptr ++; - } - - } while (isspace(ptr[0]) || is_newline_comment(ptr)); - - if (last_comment) { - *last_comment = (char*)last_comment_start; + ecs_column_t *s = &table->storage.columns[storage_column]; + size = s->size; + align = s->alignment; + vec = s->data; + /* Fallthrough to has_data */ } - return ptr; -} - -/* -- Private functions -- */ +has_data: + if (ptr_out) ptr_out[0] = ecs_vector_get_t(vec, size, align, row); + if (size_out) size_out[0] = size; + return is_shared; -static -bool valid_identifier_start_char( - char ch) -{ - if (ch && (isalpha(ch) || (ch == '.') || (ch == '_') || (ch == '*') || - (ch == '0') || (ch == TOK_AS_ENTITY) || isdigit(ch))) - { - return true; +has_switch: { + /* Edge case: if column is a switch we should return the vector with case + * identifiers. Will be replaced in the future with pluggable storage */ + ecs_switch_t *sw = table->storage.sw_columns[ + (column - 1) - table->sw_column_offset].data; + vec = flecs_switch_values(sw); + size = ECS_SIZEOF(ecs_entity_t); + align = ECS_ALIGNOF(ecs_entity_t); + goto has_data; } +no_data: + if (ptr_out) ptr_out[0] = NULL; + if (size_out) size_out[0] = 0; return false; } -static -bool valid_token_start_char( - char ch) +void flecs_iter_populate_data( + ecs_world_t *world, + ecs_iter_t *it, + ecs_table_t *table, + int32_t offset, + int32_t count, + void **ptrs, + ecs_size_t *sizes) { - if ((ch == '"') || (ch == '{') || (ch == '}') || (ch == ',') || (ch == '-') - || (ch == '[') || (ch == ']') || valid_identifier_start_char(ch)) - { - return true; + if (it->table) { + it->frame_offset += ecs_table_count(it->table); } - return false; -} + it->table = table; + it->offset = offset; + it->count = count; -static -bool valid_token_char( - char ch) -{ - if (ch && - (isalpha(ch) || isdigit(ch) || ch == '_' || ch == '.' || ch == '"')) - { - return true; + if (table) { + it->type = it->table->type; + if (!count) { + count = it->count = ecs_table_count(table); + } + if (count) { + it->entities = ecs_vector_get( + table->storage.entities, ecs_entity_t, offset); + } else { + it->entities = NULL; + } } - return false; -} - -static -bool valid_operator_char( - char ch) -{ - if (ch == TOK_OPTIONAL || ch == TOK_NOT) { - return true; + if (it->is_filter) { + it->has_shared = false; + return; } - return false; -} - -static -const char* parse_digit( - const char *ptr, - char *token_out) -{ - ptr = ecs_parse_whitespace(ptr); - ptr = ecs_parse_digit(ptr, token_out); - return ecs_parse_whitespace(ptr); -} - -const char* ecs_parse_token( - const char *name, - const char *expr, - const char *ptr, - char *token_out) -{ - int64_t column = ptr - expr; - - ptr = ecs_parse_whitespace(ptr); - char *tptr = token_out, ch = ptr[0]; + int t, term_count = it->term_count; + bool has_shared = false; - if (!valid_token_start_char(ch)) { - if (ch == '\0' || ch == '\n') { - ecs_parser_error(name, expr, column, - "unexpected end of expression"); - } else { - ecs_parser_error(name, expr, column, - "invalid start of token '%s'", ptr); + if (ptrs && sizes) { + for (t = 0; t < term_count; t ++) { + int32_t column = it->columns[t]; + has_shared |= flecs_iter_populate_term_data(world, it, t, column, + &ptrs[t], + &sizes[t]); + } + } else { + for (t = 0; t < term_count; t ++) { + int32_t column = it->columns[t]; + void **ptr = NULL; + if (ptrs) { + ptr = &ptrs[t]; + } + ecs_size_t *size = NULL; + if (sizes) { + size = &sizes[t]; + } + has_shared |= flecs_iter_populate_term_data(world, it, t, column, + ptr, size); } - return NULL; } - tptr[0] = ch; - tptr ++; - ptr ++; - - if (ch == '{' || ch == '}' || ch == '[' || ch == ']' || ch == ',') { - tptr[0] = 0; - return ptr; - } + it->has_shared = has_shared; +} - int tmpl_nesting = 0; - bool in_str = ch == '"'; +bool flecs_iter_next_row( + ecs_iter_t *it) +{ + ecs_assert(it != NULL, ECS_INTERNAL_ERROR, NULL); - for (; (ch = *ptr); ptr ++) { - if (ch == '<') { - tmpl_nesting ++; - } else if (ch == '>') { - if (!tmpl_nesting) { - break; - } - tmpl_nesting --; - } else if (ch == '"') { - in_str = !in_str; - } else - if (!valid_token_char(ch) && !in_str) { - break; - } + bool is_instanced = it->is_instanced; + if (!is_instanced) { + int32_t instance_count = it->instance_count; + int32_t count = it->count; + int32_t offset = it->offset; - tptr[0] = ch; - tptr ++; - } + if (instance_count > count && offset < (instance_count - 1)) { + ecs_assert(count == 1, ECS_INTERNAL_ERROR, NULL); + int t, term_count = it->term_count; - tptr[0] = '\0'; + for (t = 0; t < term_count; t ++) { + int32_t column = it->columns[t]; + if (column >= 0) { + void *ptr = it->ptrs[t]; + if (ptr) { + it->ptrs[t] = ECS_OFFSET(ptr, it->sizes[t]); + } + } + } - if (tmpl_nesting != 0) { - ecs_parser_error(name, expr, column, - "identifier '%s' has mismatching < > pairs", ptr); - return NULL; - } + if (it->entities) { + it->entities ++; + } + it->offset ++; - const char *next_ptr = ecs_parse_whitespace(ptr); - if (next_ptr[0] == ':' && next_ptr != ptr) { - /* Whitespace between token and : is significant */ - ptr = next_ptr - 1; - } else { - ptr = next_ptr; + return true; + } } - return ptr; + return false; } -static -const char* ecs_parse_identifier( - const char *name, - const char *expr, - const char *ptr, - char *token_out) +bool flecs_iter_next_instanced( + ecs_iter_t *it, + bool result) { - if (!valid_identifier_start_char(ptr[0])) { - ecs_parser_error(name, expr, (ptr - expr), - "expected start of identifier"); - return NULL; + it->instance_count = it->count; + if (result && !it->is_instanced && it->count && it->has_shared) { + it->count = 1; } - - ptr = ecs_parse_token(name, expr, ptr, token_out); - - return ptr; + return result; } -static -int parse_identifier( - const char *token, - ecs_term_id_t *out) +/* --- Public API --- */ + +void* ecs_term_w_size( + const ecs_iter_t *it, + size_t size, + int32_t term) { - char ch = token[0]; + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(!size || ecs_term_size(it, term) == size || + (!ecs_term_size(it, term) && (!it->ptrs || !it->ptrs[term - 1])), + ECS_INVALID_PARAMETER, NULL); - const char *tptr = token; - if (ch == TOK_AS_ENTITY) { - tptr ++; - } + (void)size; - out->name = ecs_os_strdup(tptr); + if (!term) { + return it->entities; + } - if (ch == TOK_AS_ENTITY) { - out->var = EcsVarIsEntity; + if (!it->ptrs) { + return NULL; } - return 0; + return it->ptrs[term - 1]; +error: + return NULL; } -static -ecs_entity_t parse_role( - const char *name, - const char *sig, - int64_t column, - const char *token) +bool ecs_term_is_readonly( + const ecs_iter_t *it, + int32_t term_index) { - if (!ecs_os_strcmp(token, TOK_ROLE_PAIR)) - { - return ECS_PAIR; - } else if (!ecs_os_strcmp(token, TOK_ROLE_AND)) { - return ECS_AND; - } else if (!ecs_os_strcmp(token, TOK_ROLE_OR)) { - return ECS_OR; - } else if (!ecs_os_strcmp(token, TOK_ROLE_XOR)) { - return ECS_XOR; - } else if (!ecs_os_strcmp(token, TOK_ROLE_NOT)) { - return ECS_NOT; - } else if (!ecs_os_strcmp(token, TOK_ROLE_SWITCH)) { - return ECS_SWITCH; - } else if (!ecs_os_strcmp(token, TOK_ROLE_CASE)) { - return ECS_CASE; - } else if (!ecs_os_strcmp(token, TOK_OVERRIDE)) { - return ECS_OVERRIDE; - } else if (!ecs_os_strcmp(token, TOK_ROLE_DISABLED)) { - return ECS_DISABLED; - } else { - ecs_parser_error(name, sig, column, "invalid role '%s'", token); - return 0; - } -} + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(term_index > 0, ECS_INVALID_PARAMETER, NULL); -static -ecs_oper_kind_t parse_operator( - char ch) -{ - if (ch == TOK_OPTIONAL) { - return EcsOptional; - } else if (ch == TOK_NOT) { - return EcsNot; + ecs_term_t *term = &it->terms[term_index - 1]; + ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); + + if (term->inout == EcsIn) { + return true; } else { - ecs_abort(ECS_INTERNAL_ERROR, NULL); - } -} + ecs_term_id_t *subj = &term->subj; -static -const char* parse_annotation( - const char *name, - const char *sig, - int64_t column, - const char *ptr, - ecs_inout_kind_t *inout_kind_out) -{ - char token[ECS_MAX_TOKEN_SIZE]; + if (term->inout == EcsInOutDefault) { + if (subj->entity != EcsThis) { + return true; + } - ptr = ecs_parse_identifier(name, sig, ptr, token); - if (!ptr) { - return NULL; + if (!(subj->set.mask & EcsSelf)) { + return true; + } + } } - if (!ecs_os_strcmp(token, TOK_IN)) { - *inout_kind_out = EcsIn; - } else - if (!ecs_os_strcmp(token, TOK_OUT)) { - *inout_kind_out = EcsOut; - } else - if (!ecs_os_strcmp(token, TOK_INOUT)) { - *inout_kind_out = EcsInOut; - } else if (!ecs_os_strcmp(token, TOK_INOUT_FILTER)) { - *inout_kind_out = EcsInOutFilter; - } +error: + return false; +} - ptr = ecs_parse_whitespace(ptr); +bool ecs_term_is_writeonly( + const ecs_iter_t *it, + int32_t term_index) +{ + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(term_index > 0, ECS_INVALID_PARAMETER, NULL); - if (ptr[0] != TOK_BRACKET_CLOSE) { - ecs_parser_error(name, sig, column, "expected ]"); - return NULL; + ecs_term_t *term = &it->terms[term_index - 1]; + ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); + + if (term->inout == EcsOut) { + return true; } - return ptr + 1; +error: + return false; } -static -uint8_t parse_set_token( - const char *token) +int32_t ecs_iter_find_column( + const ecs_iter_t *it, + ecs_entity_t component) { - if (!ecs_os_strcmp(token, TOK_SELF)) { - return EcsSelf; - } else if (!ecs_os_strcmp(token, TOK_SUPERSET)) { - return EcsSuperSet; - } else if (!ecs_os_strcmp(token, TOK_SUBSET)) { - return EcsSubSet; - } else if (!ecs_os_strcmp(token, TOK_CASCADE)) { - return EcsCascade; - } else if (!ecs_os_strcmp(token, TOK_ALL)) { - return EcsAll; - } else if (!ecs_os_strcmp(token, TOK_PARENT)) { - return EcsParent; - } else { - return 0; - } + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); + return ecs_search(it->real_world, it->table, component, 0); +error: + return -1; } -static -const char* parse_set_expr( - const ecs_world_t *world, - const char *name, - const char *expr, - int64_t column, - const char *ptr, - char *token, - ecs_term_id_t *id, - char tok_end) +bool ecs_term_is_set( + const ecs_iter_t *it, + int32_t index) { - char token_buf[ECS_MAX_TOKEN_SIZE] = {0}; - if (!token) { - token = token_buf; - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - return NULL; - } - } + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); - do { - uint8_t tok = parse_set_token(token); - if (!tok) { - ecs_parser_error(name, expr, column, - "invalid set token '%s'", token); - return NULL; + int32_t column = it->columns[index - 1]; + if (!column) { + return false; + } else if (column < 0) { + if (it->references) { + column = -column - 1; + ecs_ref_t *ref = &it->references[column]; + return ref->entity != 0; + } else { + return true; } + } - if (id->set.mask & tok) { - ecs_parser_error(name, expr, column, - "duplicate set token '%s'", token); - return NULL; - } + return true; +error: + return false; +} - if ((tok == EcsSubSet && id->set.mask & EcsSuperSet) || - (tok == EcsSuperSet && id->set.mask & EcsSubSet)) - { - ecs_parser_error(name, expr, column, - "cannot mix super and sub", token); - return NULL; - } - - id->set.mask |= tok; +void* ecs_iter_column_w_size( + const ecs_iter_t *it, + size_t size, + int32_t index) +{ + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); + (void)size; + + ecs_table_t *table = it->table; + int32_t storage_index = ecs_table_type_to_storage_index(table, index); + if (storage_index == -1) { + return NULL; + } - if (ptr[0] == TOK_PAREN_OPEN) { - ptr ++; + ecs_column_t *columns = table->storage.columns; + ecs_column_t *column = &columns[storage_index]; + ecs_check(!size || (ecs_size_t)size == column->size, + ECS_INVALID_PARAMETER, NULL); - /* Relationship (overrides IsA default) */ - if (!isdigit(ptr[0]) && valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - return NULL; - } + void *ptr = ecs_vector_first_t( + column->data, column->size, column->alignment); - id->set.relation = ecs_lookup_fullpath(world, token); - if (!id->set.relation) { - ecs_parser_error(name, expr, column, - "unresolved identifier '%s'", token); - return NULL; - } + return ECS_OFFSET(ptr, column->size * it->offset); +error: + return NULL; +} - if (ptr[0] == TOK_AND) { - ptr = ecs_parse_whitespace(ptr + 1); - } else if (ptr[0] != TOK_PAREN_CLOSE) { - ecs_parser_error(name, expr, column, - "expected ',' or ')'"); - return NULL; - } - } +size_t ecs_iter_column_size( + const ecs_iter_t *it, + int32_t index) +{ + ecs_check(it->is_valid, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->table != NULL, ECS_INVALID_PARAMETER, NULL); + + ecs_table_t *table = it->table; + int32_t storage_index = ecs_table_type_to_storage_index(table, index); + if (storage_index == -1) { + return 0; + } - /* Max depth of search */ - if (isdigit(ptr[0])) { - ptr = parse_digit(ptr, token); - if (!ptr) { - return NULL; - } + ecs_column_t *columns = table->storage.columns; + ecs_column_t *column = &columns[storage_index]; + + return flecs_ito(size_t, column->size); +error: + return 0; +} - id->set.max_depth = atoi(token); - if (id->set.max_depth < 0) { - ecs_parser_error(name, expr, column, - "invalid negative depth"); - return NULL; - } +char* ecs_iter_str( + const ecs_iter_t *it) +{ + ecs_world_t *world = it->world; + ecs_strbuf_t buf = ECS_STRBUF_INIT; + int i; - if (ptr[0] == ',') { - ptr = ecs_parse_whitespace(ptr + 1); - } - } + if (it->term_count) { + ecs_strbuf_list_push(&buf, "term: ", ","); + for (i = 0; i < it->term_count; i ++) { + ecs_id_t id = ecs_term_id(it, i + 1); + char *str = ecs_id_str(world, id); + ecs_strbuf_list_appendstr(&buf, str); + ecs_os_free(str); + } + ecs_strbuf_list_pop(&buf, "\n"); - /* If another digit is found, previous depth was min depth */ - if (isdigit(ptr[0])) { - ptr = parse_digit(ptr, token); - if (!ptr) { - return NULL; - } + ecs_strbuf_list_push(&buf, "subj: ", ","); + for (i = 0; i < it->term_count; i ++) { + ecs_entity_t subj = ecs_term_source(it, i + 1); + char *str = ecs_get_fullpath(world, subj); + ecs_strbuf_list_appendstr(&buf, str); + ecs_os_free(str); + } + ecs_strbuf_list_pop(&buf, "\n"); + } - id->set.min_depth = id->set.max_depth; - id->set.max_depth = atoi(token); - if (id->set.max_depth < 0) { - ecs_parser_error(name, expr, column, - "invalid negative depth"); - return NULL; - } + if (it->variable_count) { + int32_t actual_count = 0; + for (i = 0; i < it->variable_count; i ++) { + const char *var_name = it->variable_names[i]; + if (!var_name || var_name[0] == '_' || var_name[0] == '.') { + /* Skip anonymous variables */ + continue; } - if (ptr[0] != TOK_PAREN_CLOSE) { - ecs_parser_error(name, expr, column, "expected ')', got '%c'", - ptr[0]); - return NULL; - } else { - ptr = ecs_parse_whitespace(ptr + 1); - if (ptr[0] != tok_end && ptr[0] != TOK_AND && ptr[0] != 0) { - ecs_parser_error(name, expr, column, - "expected end of set expr"); - return NULL; - } + ecs_entity_t var = it->variables[i]; + if (!var) { + /* Skip table variables */ + continue; } - } - /* Next token in set expression */ - if (ptr[0] == TOK_BITWISE_OR) { - ptr ++; - if (valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - return NULL; - } + if (!actual_count) { + ecs_strbuf_list_push(&buf, "vars: ", ","); } - /* End of set expression */ - } else if (ptr[0] == tok_end || ptr[0] == TOK_AND || !ptr[0]) { - break; - } - } while (true); + char *str = ecs_get_fullpath(world, var); + ecs_strbuf_list_append(&buf, "%s=%s", var_name, str); + ecs_os_free(str); - if (id->set.mask & EcsCascade && !(id->set.mask & EcsSuperSet) && - !(id->set.mask & EcsSubSet)) - { - /* If cascade is used without specifying super or sub, assume - * super */ - id->set.mask |= EcsSuperSet; + actual_count ++; + } + if (actual_count) { + ecs_strbuf_list_pop(&buf, "\n"); + } } - if (id->set.mask & EcsSelf && id->set.min_depth != 0) { - ecs_parser_error(name, expr, column, - "min_depth must be zero for set expression with 'self'"); - return NULL; + if (it->count) { + ecs_strbuf_appendstr(&buf, "this:\n"); + for (i = 0; i < it->count; i ++) { + ecs_entity_t e = it->entities[i]; + char *str = ecs_get_fullpath(world, e); + ecs_strbuf_appendstr(&buf, " - "); + ecs_strbuf_appendstr(&buf, str); + ecs_strbuf_appendstr(&buf, "\n"); + ecs_os_free(str); + } } - return ptr; + return ecs_strbuf_get(&buf); } -static -const char* parse_arguments( +void ecs_iter_poly( const ecs_world_t *world, - const char *name, - const char *expr, - int64_t column, - const char *ptr, - char *token, - ecs_term_t *term) + const ecs_poly_t *poly, + ecs_iter_t *iter_out, + ecs_term_t *filter) { - (void)column; + ecs_iterable_t *iterable = ecs_get_iterable(poly); + iterable->init(world, poly, iter_out, filter); +} - int32_t arg = 0; +bool ecs_iter_next( + ecs_iter_t *iter) +{ + ecs_check(iter != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(iter->next != NULL, ECS_INVALID_PARAMETER, NULL); + return iter->next(iter); +error: + return false; +} - do { - if (valid_token_start_char(ptr[0])) { - if (arg == 2) { - ecs_parser_error(name, expr, (ptr - expr), - "too many arguments in term"); - return NULL; - } +bool ecs_iter_count( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + int32_t count = 0; + while (ecs_iter_next(it)) { + count += it->count; + } + return count; +error: + return 0; +} - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - return NULL; - } +bool ecs_iter_is_true( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + bool result = ecs_iter_next(it); + if (result) { + ecs_iter_fini(it); + } + return result; +error: + return false; +} - ecs_term_id_t *term_id = NULL; +ecs_entity_t ecs_iter_get_var( + ecs_iter_t *it, + int32_t var_id) +{ + ecs_check(var_id < it->variable_count, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->variables != NULL, ECS_INVALID_PARAMETER, NULL); + return it->variables[var_id]; +error: + return 0; +} - if (arg == 0) { - term_id = &term->subj; - } else if (arg == 1) { - term_id = &term->obj; - } +ecs_iter_t ecs_page_iter( + const ecs_iter_t *it, + int32_t offset, + int32_t limit) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next != NULL, ECS_INVALID_PARAMETER, NULL); - /* If token is a colon, the token is an identifier followed by a - * set expression. */ - if (ptr[0] == TOK_COLON) { - if (parse_identifier(token, term_id)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - return NULL; - } + ecs_iter_t result = *it; + result.priv.iter.page = (ecs_page_iter_t){ + .offset = offset, + .limit = limit, + .remaining = limit + }; + result.next = ecs_page_next; + result.chain_it = (ecs_iter_t*)it; - ptr = ecs_parse_whitespace(ptr + 1); - ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, - NULL, term_id, TOK_PAREN_CLOSE); - if (!ptr) { - return NULL; - } + return result; +error: + return (ecs_iter_t){ 0 }; +} - /* If token is a self, super or sub token, this is a set - * expression */ - } else if (!ecs_os_strcmp(token, TOK_ALL) || - !ecs_os_strcmp(token, TOK_CASCADE) || - !ecs_os_strcmp(token, TOK_SELF) || - !ecs_os_strcmp(token, TOK_SUPERSET) || - !ecs_os_strcmp(token, TOK_SUBSET) || - !(ecs_os_strcmp(token, TOK_PARENT))) - { - ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, - token, term_id, TOK_PAREN_CLOSE); - if (!ptr) { - return NULL; - } +static +void offset_iter( + ecs_iter_t *it, + int32_t offset) +{ + it->entities = &it->entities[offset]; - /* Regular identifier */ - } else if (parse_identifier(token, term_id)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - return NULL; - } + int32_t t, term_count = it->term_count; + for (t = 0; t < term_count; t ++) { + void *ptrs = it->ptrs[t]; + if (!ptrs) { + continue; + } - if (ptr[0] == TOK_AND) { - ptr = ecs_parse_whitespace(ptr + 1); + if (it->subjects[t]) { + continue; + } - term->role = ECS_PAIR; + it->ptrs[t] = ECS_OFFSET(ptrs, offset * it->sizes[t]); + } +} - } else if (ptr[0] == TOK_PAREN_CLOSE) { - ptr = ecs_parse_whitespace(ptr + 1); - break; +static +bool ecs_page_next_instanced( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_page_next, ECS_INVALID_PARAMETER, NULL); + + ecs_iter_t *chain_it = it->chain_it; + bool instanced = it->is_instanced; + + do { + if (!ecs_iter_next(chain_it)) { + goto done; + } + ecs_page_iter_t *iter = &it->priv.iter.page; + + /* Copy everything up to the private iterator data */ + ecs_os_memcpy(it, chain_it, offsetof(ecs_iter_t, priv)); + it->is_instanced = instanced; + + if (!chain_it->table) { + goto yield; /* Task query */ + } + + int32_t offset = iter->offset; + int32_t limit = iter->limit; + if (!(offset || limit)) { + if (it->count) { + goto yield; } else { - ecs_parser_error(name, expr, (ptr - expr), - "expected ',' or ')'"); - return NULL; + goto done; } + } - } else { - ecs_parser_error(name, expr, (ptr - expr), - "expected identifier or set expression"); - return NULL; + int32_t count = it->count; + int32_t remaining = iter->remaining; + + if (offset) { + if (offset > count) { + /* No entities to iterate in current table */ + iter->offset -= count; + it->count = 0; + continue; + } else { + it->offset += offset; + count = it->count -= offset; + iter->offset = 0; + offset_iter(it, offset); + } } - arg ++; + if (remaining) { + if (remaining > count) { + iter->remaining -= count; + } else { + it->count = remaining; + iter->remaining = 0; + } + } else if (limit) { + /* Limit hit: no more entities left to iterate */ + goto done; + } + } while (it->count == 0); - } while (true); +yield: + if (!it->is_instanced) { + it->offset = 0; + } - return ptr; + return true; +done: +error: + return false; } -static -void parser_unexpected_char( - const char *name, - const char *expr, - const char *ptr, - char ch) +bool ecs_page_next( + ecs_iter_t *it) { - if (ch && (ch != '\n')) { - ecs_parser_error(name, expr, (ptr - expr), - "unexpected character '%c'", ch); - } else { - ecs_parser_error(name, expr, (ptr - expr), - "unexpected end of term"); + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_page_next, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); + + it->chain_it->is_instanced = true; + + if (flecs_iter_next_row(it)) { + return true; } + + return flecs_iter_next_instanced(it, ecs_page_next_instanced(it)); +error: + return false; } -static -const char* parse_term( - const ecs_world_t *world, - const char *name, - const char *expr, - ecs_term_t *term_out) +ecs_iter_t ecs_worker_iter( + const ecs_iter_t *it, + int32_t index, + int32_t count) { - const char *ptr = expr; - char token[ECS_MAX_TOKEN_SIZE] = {0}; - ecs_term_t term = { .move = true /* parser never owns resources */ }; + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(count > 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(index >= 0, ECS_INVALID_PARAMETER, NULL); + ecs_check(index < count, ECS_INVALID_PARAMETER, NULL); - ptr = ecs_parse_whitespace(ptr); + return (ecs_iter_t){ + .real_world = it->real_world, + .world = it->world, + .priv.iter.worker = { + .index = index, + .count = count + }, + .next = ecs_worker_next, + .chain_it = (ecs_iter_t*)it, + .is_instanced = it->is_instanced + }; - /* Inout specifiers always come first */ - if (ptr[0] == TOK_BRACKET_OPEN) { - ptr = parse_annotation(name, expr, (ptr - expr), ptr + 1, &term.inout); - if (!ptr) { - goto error; - } - ptr = ecs_parse_whitespace(ptr); - } +error: + return (ecs_iter_t){ 0 }; +} - if (valid_operator_char(ptr[0])) { - term.oper = parse_operator(ptr[0]); - ptr = ecs_parse_whitespace(ptr + 1); - } +static +bool ecs_worker_next_instanced( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_worker_next, ECS_INVALID_PARAMETER, NULL); - /* If next token is the start of an identifier, it could be either a type - * role, source or component identifier */ - if (valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - goto error; - } + bool instanced = it->is_instanced; - /* Is token a type role? */ - if (ptr[0] == TOK_BITWISE_OR && ptr[1] != TOK_BITWISE_OR) { - ptr ++; - goto parse_role; - } + ecs_iter_t *chain_it = it->chain_it; + ecs_worker_iter_t *iter = &it->priv.iter.worker; + int32_t res_count = iter->count, res_index = iter->index; + int32_t per_worker, instances_per_worker, first; - /* Is token a predicate? */ - if (ptr[0] == TOK_PAREN_OPEN) { - goto parse_predicate; + do { + if (!ecs_iter_next(chain_it)) { + return false; } - /* Next token must be a predicate */ - goto parse_predicate; + /* Copy everything up to the private iterator data */ + ecs_os_memcpy(it, chain_it, offsetof(ecs_iter_t, priv)); + it->is_instanced = instanced; - /* If next token is a singleton, assign identifier to pred and subject */ - } else if (ptr[0] == TOK_SINGLETON) { - ptr ++; - if (valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - goto error; - } + int32_t count = it->count; + int32_t instance_count = it->instance_count; + per_worker = count / res_count; + instances_per_worker = instance_count / res_count; + first = per_worker * res_index; + count -= per_worker * res_count; - goto parse_singleton; + if (count) { + if (res_index < count) { + per_worker ++; + first += res_index; + } else { + first += count; + } + } - } else { - ecs_parser_error(name, expr, (ptr - expr), - "expected identifier after singleton operator"); - goto error; + if (!per_worker && it->table == NULL) { + if (res_index == 0) { + return true; + } else { + return false; + } } + } while (!per_worker); - /* Pair with implicit subject */ - } else if (ptr[0] == TOK_PAREN_OPEN) { - goto parse_pair; + it->instance_count = instances_per_worker; + it->frame_offset += first; + + offset_iter(it, it->offset + first); + it->count = per_worker; - /* Nothing else expected here */ + if (it->is_instanced) { + it->offset += first; } else { - parser_unexpected_char(name, expr, ptr, ptr[0]); - goto error; - } - -parse_role: - term.role = parse_role(name, expr, (ptr - expr), token); - if (!term.role) { - goto error; + it->offset = 0; } - ptr = ecs_parse_whitespace(ptr); + return true; +error: + return false; +} - /* If next token is the source token, this is an empty source */ - if (valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - goto error; - } +bool ecs_worker_next( + ecs_iter_t *it) +{ + ecs_check(it != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->next == ecs_worker_next, ECS_INVALID_PARAMETER, NULL); + ecs_check(it->chain_it != NULL, ECS_INVALID_PARAMETER, NULL); - /* If not, it's a predicate */ - goto parse_predicate; + it->chain_it->is_instanced = true; - } else if (ptr[0] == TOK_PAREN_OPEN) { - goto parse_pair; - } else { - ecs_parser_error(name, expr, (ptr - expr), - "expected identifier after role"); - goto error; + if (flecs_iter_next_row(it)) { + return true; } -parse_predicate: - if (parse_identifier(token, &term.pred)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - goto error; - } + return flecs_iter_next_instanced(it, ecs_worker_next_instanced(it)); +error: + return false; +} - /* Set expression */ - if (ptr[0] == TOK_COLON) { - ptr = ecs_parse_whitespace(ptr + 1); - ptr = parse_set_expr(world, name, expr, (ptr - expr), ptr, NULL, - &term.pred, TOK_COLON); - if (!ptr) { - goto error; - } +#include - ptr = ecs_parse_whitespace(ptr); +static +int32_t count_events( + const ecs_entity_t *events) +{ + int32_t i; - if (ptr[0] == TOK_AND || !ptr[0]) { - goto parse_done; + for (i = 0; i < ECS_TRIGGER_DESC_EVENT_COUNT_MAX; i ++) { + if (!events[i]) { + break; } + } - if (ptr[0] != TOK_COLON) { - ecs_parser_error(name, expr, (ptr - expr), - "unexpected token '%c' after predicate set expression", ptr[0]); - goto error; - } + return i; +} - ptr = ecs_parse_whitespace(ptr + 1); - } else { - ptr = ecs_parse_whitespace(ptr); - } - - if (ptr[0] == TOK_PAREN_OPEN) { - ptr ++; - if (ptr[0] == TOK_PAREN_CLOSE) { - term.subj.set.mask = EcsNothing; - ptr ++; - ptr = ecs_parse_whitespace(ptr); - } else { - ptr = parse_arguments( - world, name, expr, (ptr - expr), ptr, token, &term); +static +ecs_entity_t get_actual_event( + ecs_trigger_t *trigger, + ecs_entity_t event) +{ + /* If operator is Not, reverse the event */ + if (trigger->term.oper == EcsNot) { + if (event == EcsOnAdd) { + event = EcsOnRemove; + } else if (event == EcsOnRemove) { + event = EcsOnAdd; } - - goto parse_done; } - goto parse_done; + return event; +} -parse_pair: - ptr = ecs_parse_identifier(name, expr, ptr + 1, token); - if (!ptr) { - goto error; +static +void unregister_event_trigger( + ecs_event_record_t *evt, + ecs_id_t id) +{ + if (ecs_map_remove(&evt->event_ids, id) == 0) { + ecs_map_fini(&evt->event_ids); } +} - if (ptr[0] == TOK_AND) { - ptr ++; - term.subj.entity = EcsThis; - goto parse_pair_predicate; - } else if (ptr[0] == TOK_PAREN_CLOSE) { - term.subj.entity = EcsThis; - goto parse_pair_predicate; - } else { - parser_unexpected_char(name, expr, ptr, ptr[0]); - goto error; +static +ecs_event_id_record_t* ensure_event_id_record( + ecs_map_t *map, + ecs_id_t id) +{ + ecs_event_id_record_t **idt = ecs_map_ensure( + map, ecs_event_id_record_t*, id); + if (!idt[0]) { + idt[0] = ecs_os_calloc_t(ecs_event_id_record_t); } -parse_pair_predicate: - if (parse_identifier(token, &term.pred)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - goto error; + return idt[0]; +} + +static +void inc_trigger_count( + ecs_world_t *world, + ecs_entity_t event, + ecs_event_record_t *evt, + ecs_id_t id, + int32_t value) +{ + ecs_event_id_record_t *idt = ensure_event_id_record(&evt->event_ids, id); + ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); + + int32_t result = idt->trigger_count += value; + if (result == 1) { + /* Notify framework that there are triggers for the event/id. This + * allows parts of the code to skip event evaluation early */ + flecs_notify_tables(world, id, &(ecs_table_event_t){ + .kind = EcsTableTriggersForId, + .event = event + }); + } else if (result == 0) { + /* Ditto, but the reverse */ + flecs_notify_tables(world, id, &(ecs_table_event_t){ + .kind = EcsTableNoTriggersForId, + .event = event + }); + + /* Remove admin for id for event */ + if (!ecs_map_is_initialized(&idt->triggers) && + !ecs_map_is_initialized(&idt->set_triggers)) + { + unregister_event_trigger(evt, id); + ecs_os_free(idt); + } } +} - ptr = ecs_parse_whitespace(ptr); - if (valid_token_start_char(ptr[0])) { - ptr = ecs_parse_identifier(name, expr, ptr, token); - if (!ptr) { - goto error; +static +void register_trigger_for_id( + ecs_world_t *world, + ecs_observable_t *observable, + ecs_trigger_t *trigger, + ecs_id_t id, + size_t triggers_offset) +{ + ecs_sparse_t *events = observable->events; + ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_id_t term_id = trigger->term.id; + + int i; + for (i = 0; i < trigger->event_count; i ++) { + ecs_entity_t event = get_actual_event(trigger, trigger->events[i]); + + /* Get triggers for event */ + ecs_event_record_t *evt = flecs_sparse_ensure( + events, ecs_event_record_t, event); + ecs_assert(evt != NULL, ECS_INTERNAL_ERROR, NULL); + + if (!ecs_map_is_initialized(&evt->event_ids)) { + ecs_map_init(&evt->event_ids, ecs_event_id_record_t*, 1); } - if (ptr[0] == TOK_PAREN_CLOSE) { - ptr ++; - goto parse_pair_object; - } else { - parser_unexpected_char(name, expr, ptr, ptr[0]); - goto error; + /* Get triggers for (component) id for event */ + ecs_event_id_record_t *idt = ensure_event_id_record( + &evt->event_ids, id); + ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_map_t *triggers = ECS_OFFSET(idt, triggers_offset); + if (!ecs_map_is_initialized(triggers)) { + ecs_map_init(triggers, ecs_trigger_t*, 1); } - } else if (ptr[0] == TOK_PAREN_CLOSE) { - /* No object */ - ptr ++; - goto parse_done; - } else { - ecs_parser_error(name, expr, (ptr - expr), - "expected pair object or ')'"); - goto error; - } -parse_pair_object: - if (parse_identifier(token, &term.obj)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - goto error; - } + ecs_map_ensure(triggers, ecs_trigger_t*, trigger->id)[0] = trigger; - if (term.role != 0) { - if (term.role != ECS_PAIR && term.role != ECS_CASE) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid combination of role '%s' with pair", - ecs_role_str(term.role)); - goto error; + inc_trigger_count(world, event, evt, term_id, 1); + if (term_id != id) { + inc_trigger_count(world, event, evt, id, 1); } - } else { - term.role = ECS_PAIR; } +} - ptr = ecs_parse_whitespace(ptr); - goto parse_done; +static +void register_trigger( + ecs_world_t *world, + ecs_observable_t *observable, + ecs_trigger_t *trigger) +{ + ecs_term_t *term = &trigger->term; -parse_singleton: - if (parse_identifier(token, &term.pred)) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid identifier '%s'", token); - goto error; + if (term->subj.set.mask & EcsSelf) { + if (term->subj.entity == EcsThis) { + register_trigger_for_id(world, observable, trigger, term->id, + offsetof(ecs_event_id_record_t, triggers)); + } else { + register_trigger_for_id(world, observable, trigger, term->id, + offsetof(ecs_event_id_record_t, entity_triggers)); + } } - parse_identifier(token, &term.subj); - goto parse_done; + if (trigger->term.subj.set.mask & EcsSuperSet) { + ecs_id_t pair = ecs_pair(term->subj.set.relation, EcsWildcard); + register_trigger_for_id(world, observable, trigger, pair, + offsetof(ecs_event_id_record_t, set_triggers)); + } -parse_done: - *term_out = term; - return ptr; + if (ECS_HAS_ROLE(term->id, SWITCH)) { + ecs_entity_t sw = term->id & ECS_COMPONENT_MASK; + ecs_id_t sw_case = ecs_case(sw, EcsWildcard); + register_trigger_for_id(world, observable, trigger, sw_case, + offsetof(ecs_event_id_record_t, triggers)); + } -error: - ecs_term_fini(&term); - *term_out = (ecs_term_t){0}; - return NULL; + if (ECS_HAS_ROLE(term->id, CASE)) { + ecs_entity_t sw = ECS_PAIR_FIRST(term->id); + register_trigger_for_id(world, observable, trigger, ECS_SWITCH | sw, + offsetof(ecs_event_id_record_t, triggers)); + } } static -bool is_valid_end_of_term( - const char *ptr) +void unregister_trigger_for_id( + ecs_world_t *world, + ecs_observable_t *observable, + ecs_trigger_t *trigger, + ecs_id_t id, + size_t triggers_offset) { - if ((ptr[0] == TOK_AND) || /* another term with And operator */ - (ptr[0] == TOK_OR[0]) || /* another term with Or operator */ - (ptr[0] == '\n') || /* newlines are valid */ - (ptr[0] == '\0') || /* end of string */ - (ptr[0] == '/') || /* comment (in plecs) */ - (ptr[0] == '{') || /* scope (in plecs) */ - (ptr[0] == '}') || - (ptr[0] == ':') || /* inheritance (in plecs) */ - (ptr[0] == '=')) /* assignment (in plecs) */ - { - return true; - } - return false; -} + ecs_sparse_t *events = observable->events; + ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_id_t term_id = trigger->term.id; -char* ecs_parse_term( - const ecs_world_t *world, - const char *name, - const char *expr, - const char *ptr, - ecs_term_t *term) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(ptr != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(term != NULL, ECS_INVALID_PARAMETER, NULL); + int i; + for (i = 0; i < trigger->event_count; i ++) { + ecs_entity_t event = get_actual_event(trigger, trigger->events[i]); - ecs_term_id_t *subj = &term->subj; + /* Get triggers for event */ + ecs_event_record_t *evt = flecs_sparse_get( + events, ecs_event_record_t, event); + ecs_assert(evt != NULL, ECS_INTERNAL_ERROR, NULL); - bool prev_or = false; - if (ptr != expr) { - if (ptr[0]) { - if (ptr[0] == ',') { - ptr ++; - } else if (ptr[0] == '|') { - ptr += 2; - prev_or = true; - } else { - ecs_parser_error(name, expr, (ptr - expr), - "invalid preceding token"); - } + /* Get triggers for (component) id */ + ecs_event_id_record_t *idt = ecs_map_get_ptr( + &evt->event_ids, ecs_event_id_record_t*, id); + ecs_assert(idt != NULL, ECS_INTERNAL_ERROR, NULL); + + ecs_map_t *id_triggers = ECS_OFFSET(idt, triggers_offset); + + if (ecs_map_remove(id_triggers, trigger->id) == 0) { + ecs_map_fini(id_triggers); } - } - - ptr = ecs_parse_eol_and_whitespace(ptr); - if (!ptr[0]) { - *term = (ecs_term_t){0}; - return (char*)ptr; - } - if (ptr == expr && !strcmp(expr, "0")) { - return (char*)&ptr[1]; - } + inc_trigger_count(world, event, evt, term_id, -1); - int32_t prev_set = subj->set.mask; + if (id != term_id) { + /* Id is different from term_id in case of a set trigger. If they're + * the same, inc_trigger_count could already have done cleanup */ + if (!ecs_map_is_initialized(&idt->triggers) && + !ecs_map_is_initialized(&idt->set_triggers) && + !idt->trigger_count) + { + unregister_event_trigger(evt, id); + } - /* Parse next element */ - ptr = parse_term(world, name, ptr, term); - if (!ptr) { - goto error; + inc_trigger_count(world, event, evt, id, -1); + } } +} - /* Post-parse consistency checks */ +static +void unregister_trigger( + ecs_world_t *world, + ecs_observable_t *observable, + ecs_trigger_t *trigger) +{ + ecs_term_t *term = &trigger->term; - /* If next token is OR, term is part of an OR expression */ - if (!ecs_os_strncmp(ptr, TOK_OR, 2) || prev_or) { - /* An OR operator must always follow an AND or another OR */ - if (term->oper != EcsAnd) { - ecs_parser_error(name, expr, (ptr - expr), - "cannot combine || with other operators"); - goto error; + if (term->subj.set.mask & EcsSelf) { + if (term->subj.entity == EcsThis) { + unregister_trigger_for_id(world, observable, trigger, term->id, + offsetof(ecs_event_id_record_t, triggers)); + } else { + unregister_trigger_for_id(world, observable, trigger, term->id, + offsetof(ecs_event_id_record_t, entity_triggers)); } + } - term->oper = EcsOr; + if (term->subj.set.mask & EcsSuperSet) { + ecs_id_t pair = ecs_pair(term->subj.set.relation, EcsWildcard); + unregister_trigger_for_id(world, observable, trigger, pair, + offsetof(ecs_event_id_record_t, set_triggers)); } - /* Term must either end in end of expression, AND or OR token */ - if (!is_valid_end_of_term(ptr)) { - ecs_parser_error(name, expr, (ptr - expr), - "expected end of expression or next term"); - goto error; + if (ECS_HAS_ROLE(term->id, SWITCH)) { + ecs_entity_t sw = term->id & ECS_COMPONENT_MASK; + ecs_id_t sw_case = ecs_case(sw, EcsWildcard); + unregister_trigger_for_id(world, observable, trigger, sw_case, + offsetof(ecs_event_id_record_t, triggers)); } - /* If the term just contained a 0, the expression has nothing. Ensure - * that after the 0 nothing else follows */ - if (!ecs_os_strcmp(term->pred.name, "0")) { - if (ptr[0]) { - ecs_parser_error(name, expr, (ptr - expr), - "unexpected term after 0"); - goto error; - } + if (ECS_HAS_ROLE(term->id, CASE)) { + ecs_entity_t sw = ECS_PAIR_FIRST(term->id); + unregister_trigger_for_id(world, observable, trigger, ECS_SWITCH | sw, + offsetof(ecs_event_id_record_t, triggers)); + } +} - if (subj->set.mask != EcsDefaultSet || - (subj->entity && subj->entity != EcsThis) || - (subj->name && ecs_os_strcmp(subj->name, "This"))) - { - ecs_parser_error(name, expr, (ptr - expr), - "invalid combination of 0 with non-default subject"); - goto error; - } +static +ecs_map_t* get_triggers_for_event( + const ecs_observable_t *observable, + ecs_entity_t event) +{ + ecs_check(observable != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_assert(event != 0, ECS_INTERNAL_ERROR, NULL); - subj->set.mask = EcsNothing; - ecs_os_free(term->pred.name); - term->pred.name = NULL; - } + ecs_sparse_t *events = observable->events; + ecs_assert(events != NULL, ECS_INTERNAL_ERROR, NULL); - /* Cannot combine EcsNothing with operators other than AND */ - if (term->oper != EcsAnd && subj->set.mask == EcsNothing) { - ecs_parser_error(name, expr, (ptr - expr), - "invalid operator for empty source"); - goto error; + const ecs_event_record_t *evt = flecs_sparse_get( + events, ecs_event_record_t, event); + + if (evt) { + return (ecs_map_t*)&evt->event_ids; } - /* Verify consistency of OR expression */ - if (prev_or && term->oper == EcsOr) { - /* Set expressions must be the same for all OR terms */ - if (subj->set.mask != prev_set) { - ecs_parser_error(name, expr, (ptr - expr), - "cannot combine different sources in OR expression"); - goto error; - } +error: + return NULL; +} - term->oper = EcsOr; - } +static +ecs_event_id_record_t* get_triggers_for_id( + const ecs_map_t *evt, + ecs_id_t id) +{ + return ecs_map_get_ptr(evt, ecs_event_id_record_t*, id); +} - /* Automatically assign This if entity is not assigned and the set is - * nothing */ - if (subj->set.mask != EcsNothing) { - if (!subj->name) { - if (!subj->entity) { - subj->entity = EcsThis; - } - } +bool flecs_check_triggers_for_event( + const ecs_poly_t *object, + ecs_id_t id, + ecs_entity_t event) +{ + ecs_observable_t *observable = ecs_get_observable(object); + const ecs_map_t *evt = get_triggers_for_event(observable, event); + if (!evt) { + return false; } - if (subj->name && !ecs_os_strcmp(subj->name, "0")) { - subj->entity = 0; - subj->set.mask = EcsNothing; + ecs_event_id_record_t *edr = get_triggers_for_id(evt, id); + if (edr) { + return edr->trigger_count != 0; + } else { + return false; } +} - /* Process role */ - if (term->role == ECS_AND) { - term->oper = EcsAndFrom; - term->role = 0; - } else if (term->role == ECS_OR) { - term->oper = EcsOrFrom; - term->role = 0; - } else if (term->role == ECS_NOT) { - term->oper = EcsNotFrom; - term->role = 0; +static +void init_iter( + ecs_iter_t *it, + bool *iter_set) +{ + ecs_assert(it != NULL, ECS_INTERNAL_ERROR, NULL); + + if (*iter_set) { + return; } - ptr = ecs_parse_whitespace(ptr); - - return (char*)ptr; -error: - if (term) { - ecs_term_fini(term); + if (it->table_only) { + it->ids = it->priv.cache.ids; + it->ids[0] = it->event_id; + return; } - return NULL; -} -#endif + flecs_iter_init(it); + *iter_set = true; -#ifdef FLECS_SYSTEM + it->ids[0] = it->event_id; + ecs_assert(it->table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(!it->count || it->offset < ecs_table_count(it->table), + ECS_INTERNAL_ERROR, NULL); + ecs_assert((it->offset + it->count) <= ecs_table_count(it->table), + ECS_INTERNAL_ERROR, NULL); -static -void invoke_status_action( - ecs_world_t *world, - ecs_entity_t system, - const EcsSystem *system_data, - ecs_system_status_t status) -{ - ecs_system_status_action_t action = system_data->status_action; - if (action) { - action(world, system, status, system_data->status_ctx); + int32_t index = ecs_search_relation(it->world, it->table, 0, + it->event_id, EcsIsA, 0, 0, it->subjects, NULL, NULL); + + if (index == -1) { + it->columns[0] = 0; + } else if (it->subjects[0]) { + it->columns[0] = -index - 1; + } else { + it->columns[0] = index + 1; } + + ecs_term_t term = { + .id = it->event_id + }; + + it->term_count = 1; + it->terms = &term; + flecs_iter_populate_data(it->world, it, it->table, it->offset, + it->count, it->ptrs, it->sizes); } -/* Invoked when system becomes active or inactive */ -void ecs_system_activate( +static +bool ignore_trigger( ecs_world_t *world, - ecs_entity_t system, - bool activate, - const EcsSystem *system_data) + ecs_trigger_t *t, + ecs_table_t *table) { - ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); - - if (activate) { - /* If activating system, ensure that it doesn't have the Inactive tag. - * Systems are implicitly activated so they are kept out of the main - * loop as long as they aren't used. They are not implicitly deactivated - * to prevent overhead in case of oscillating app behavior. - * After activation, systems that aren't matched with anything can be - * deactivated again by explicitly calling ecs_deactivate_systems. - */ - ecs_remove_id(world, system, EcsInactive); + int32_t *last_event_id = t->last_event_id; + if (last_event_id && last_event_id[0] == world->event_id) { + return true; } - if (!system_data) { - system_data = ecs_get(world, system, EcsSystem); - } - if (!system_data || !system_data->query) { - return; + if (!table) { + return false; } - if (!activate) { - if (ecs_has_id(world, system, EcsDisabled)) { - if (!ecs_query_table_count(system_data->query)) { - /* If deactivating a disabled system that isn't matched with - * any active tables, there is nothing to deactivate. */ - return; - } - } + if (!t->match_prefab && (table->flags & EcsTableIsPrefab)) { + return true; } - - /* Invoke system status action */ - invoke_status_action(world, system, system_data, - activate ? EcsSystemActivated : EcsSystemDeactivated); - - ecs_dbg_1("#[green]system#[reset] %s %s", - ecs_get_name(world, system), - activate ? "activated" : "deactivated"); + if (!t->match_disabled && (table->flags & EcsTableIsDisabled)) { + return true; + } + + return false; } -/* Actually enable or disable system */ static -void ecs_enable_system( +void notify_self_triggers( ecs_world_t *world, - ecs_entity_t system, - EcsSystem *system_data, - bool enabled) + ecs_iter_t *it, + const ecs_map_t *triggers) { - ecs_poly_assert(world, ecs_world_t); - ecs_assert(!world->is_readonly, ECS_INTERNAL_ERROR, NULL); + ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_query_t *query = system_data->query; - if (!query) { - return; - } + ecs_map_iter_t mit = ecs_map_iter(triggers); + ecs_trigger_t *t; + while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { + if (ignore_trigger(world, t, it->table)) { + continue; + } - if (ecs_query_table_count(query)) { - /* Only (de)activate system if it has non-empty tables. */ - ecs_system_activate(world, system, enabled, system_data); - system_data = ecs_get_mut(world, system, EcsSystem, NULL); + it->is_filter = t->term.inout == EcsInOutFilter; + it->system = t->entity; + it->self = t->self; + it->ctx = t->ctx; + it->binding_ctx = t->binding_ctx; + it->term_index = t->term.index; + it->terms = &t->term; + + t->callback(it); } - - /* Invoke action for enable/disable status */ - invoke_status_action( - world, system, system_data, - enabled ? EcsSystemEnabled : EcsSystemDisabled); } -/* -- Public API -- */ - -ecs_entity_t ecs_run_intern( +static +void notify_entity_triggers( ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t system, - EcsSystem *system_data, - int32_t stage_current, - int32_t stage_count, - FLECS_FLOAT delta_time, - int32_t offset, - int32_t limit, - void *param) + ecs_iter_t *it, + const ecs_map_t *triggers) { - FLECS_FLOAT time_elapsed = delta_time; - ecs_entity_t tick_source = system_data->tick_source; + ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - /* Support legacy behavior */ - if (!param) { - param = system_data->ctx; + if (it->table_only) { + return; } - if (tick_source) { - const EcsTickSource *tick = ecs_get( - world, tick_source, EcsTickSource); + ecs_map_iter_t mit = ecs_map_iter(triggers); + ecs_trigger_t *t; + int32_t offset = it->offset, count = it->count; + ecs_entity_t *entities = it->entities; + + ecs_entity_t dummy = 0; + it->entities = &dummy; - if (tick) { - time_elapsed = tick->time_elapsed; + while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { + if (ignore_trigger(world, t, it->table)) { + continue; + } - /* If timer hasn't fired we shouldn't run the system */ - if (!tick->tick) { - return 0; + int32_t i, entity_count = it->count; + for (i = 0; i < entity_count; i ++) { + if (entities[i] != t->term.subj.entity) { + continue; } - } else { - /* If a timer has been set but the timer entity does not have the - * EcsTimer component, don't run the system. This can be the result - * of a single-shot timer that has fired already. Not resetting the - * timer field of the system will ensure that the system won't be - * ran after the timer has fired. */ - return 0; - } - } - ecs_time_t time_start; - bool measure_time = world->measure_system_time; - if (measure_time) { - ecs_os_get_time(&time_start); - } + it->is_filter = t->term.inout == EcsInOutFilter; + it->system = t->entity; + it->self = t->self; + it->ctx = t->ctx; + it->binding_ctx = t->binding_ctx; + it->term_index = t->term.index; + it->terms = &t->term; + it->offset = i; + it->count = 1; + it->subjects[0] = entities[i]; - ecs_world_t *thread_ctx = world; - if (stage) { - thread_ctx = stage->thread_ctx; + t->callback(it); + } } - ecs_defer_begin(thread_ctx); + it->offset = offset; + it->count = count; + it->entities = entities; + it->subjects[0] = 0; +} - /* Prepare the query iterator */ - ecs_iter_t pit, wit, qit = ecs_query_iter(thread_ctx, system_data->query); - ecs_iter_t *it = &qit; +static +void notify_set_base_triggers( + ecs_world_t *world, + ecs_iter_t *it, + const ecs_map_t *triggers) +{ + ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); - if (offset || limit) { - pit = ecs_page_iter(it, offset, limit); - it = &pit; + ecs_entity_t event_id = it->event_id; + ecs_entity_t rel = ECS_PAIR_FIRST(event_id); + ecs_entity_t obj = ecs_pair_second(world, event_id); + ecs_assert(obj != 0, ECS_INTERNAL_ERROR, NULL); + ecs_table_t *obj_table = ecs_get_table(world, obj); + if (!obj_table) { + return; } - if (stage_count > 1 && system_data->multi_threaded) { - wit = ecs_worker_iter(it, stage_current, stage_count); - it = &wit; - } + ecs_map_iter_t mit = ecs_map_iter(triggers); + ecs_trigger_t *t; + while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { + if (ignore_trigger(world, t, it->table)) { + continue; + } - qit.system = system; - qit.self = system_data->self; - qit.delta_time = delta_time; - qit.delta_system_time = time_elapsed; - qit.frame_offset = offset; - qit.param = param; - qit.ctx = system_data->ctx; - qit.binding_ctx = system_data->binding_ctx; + ecs_term_t *term = &t->term; + ecs_id_t id = term->id; + int32_t column = ecs_search_relation(world, obj_table, 0, id, rel, + 0, 0, it->subjects, it->ids, 0); + + bool result = column != -1; + if (term->oper == EcsNot) { + result = !result; + } + if (!result) { + continue; + } - ecs_iter_action_t action = system_data->action; - it->callback = action; - - ecs_run_action_t run = system_data->run; - if (run) { - run(it); - } else { - if (it == &qit) { - while (ecs_query_next(&qit)) { - action(&qit); + if (!term->subj.set.min_depth && flecs_get_table_record( + world, it->table, id) != NULL) + { + continue; + } + + if (!it->table_only) { + if (!it->subjects[0]) { + it->subjects[0] = obj; } - } else { - while (ecs_iter_next(it)) { - action(it); + + if (column != -1) { + it->columns[0] = -(column + 1); + } else { + it->columns[0] = 0; } } + + it->is_filter = t->term.inout == EcsInOutFilter; + it->event_id = t->term.id; + it->system = t->entity; + it->self = t->self; + it->ctx = t->ctx; + it->binding_ctx = t->binding_ctx; + it->term_index = t->term.index; + it->terms = &t->term; + + t->callback(it); } +} - if (measure_time) { - system_data->time_spent += (float)ecs_time_measure(&time_start); +static +void notify_set_triggers( + ecs_world_t *world, + ecs_iter_t *it, + const ecs_map_t *triggers) +{ + ecs_assert(triggers != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_assert(it->count != 0, ECS_INTERNAL_ERROR, NULL); + + if (it->table_only) { + return; } - system_data->invoke_count ++; + ecs_map_iter_t mit = ecs_map_iter(triggers); + ecs_trigger_t *t; + while ((t = ecs_map_next_ptr(&mit, ecs_trigger_t*, NULL))) { + if (!ecs_id_match(it->event_id, t->term.id)) { + continue; + } - ecs_defer_end(thread_ctx); + if (ignore_trigger(world, t, it->table)) { + continue; + } - return it->interrupted_by; -} + ecs_entity_t subj = it->entities[0]; + int32_t i, count = it->count; + ecs_entity_t term_subj = t->term.subj.entity; -/* -- Public API -- */ + /* If trigger is for a specific entity, make sure it is in the table + * being triggered for */ + if (term_subj != EcsThis) { + for (i = 0; i < count; i ++) { + if (it->entities[i] == term_subj) { + break; + } + } -ecs_entity_t ecs_run_w_filter( - ecs_world_t *world, - ecs_entity_t system, - FLECS_FLOAT delta_time, - int32_t offset, - int32_t limit, - void *param) -{ - ecs_stage_t *stage = flecs_stage_from_world(&world); + if (i == count) { + continue; + } - EcsSystem *system_data = (EcsSystem*)ecs_get( - world, system, EcsSystem); - assert(system_data != NULL); + /* If the entity matches, trigger for no other entities */ + it->entities[0] = 0; + it->count = 1; + } - return ecs_run_intern(world, stage, system, system_data, 0, 0, delta_time, - offset, limit, param); + if (flecs_term_match_table(world, &t->term, it->table, it->type, + it->ids, it->columns, it->subjects, NULL, true)) + { + if (!it->subjects[0]) { + /* Do not match owned components */ + continue; + } + + it->is_filter = t->term.inout == EcsInOutFilter; + it->system = t->entity; + it->self = t->self; + it->ctx = t->ctx; + it->binding_ctx = t->binding_ctx; + it->term_index = t->term.index; + it->terms = &t->term; + + /* Triggers for supersets can be instanced */ + if (it->count == 1 || t->instanced || it->is_filter || !it->sizes[0]) { + it->is_instanced = t->instanced; + t->callback(it); + it->is_instanced = false; + } else { + ecs_entity_t *entities = it->entities; + it->count = 1; + for (i = 0; i < count; i ++) { + it->entities = &entities[i]; + t->callback(it); + } + it->entities = entities; + } + } + + it->entities[0] = subj; + it->count = count; + } } -ecs_entity_t ecs_run_worker( +static +void notify_triggers_for_id( ecs_world_t *world, - ecs_entity_t system, - int32_t stage_current, - int32_t stage_count, - FLECS_FLOAT delta_time, - void *param) + const ecs_map_t *evt, + ecs_id_t event_id, + ecs_iter_t *it, + bool *iter_set) { - ecs_stage_t *stage = flecs_stage_from_world(&world); - - EcsSystem *system_data = (EcsSystem*)ecs_get( - world, system, EcsSystem); - assert(system_data != NULL); + const ecs_event_id_record_t *idt = get_triggers_for_id(evt, event_id); + if (!idt) { + return; + } - return ecs_run_intern( - world, stage, system, system_data, stage_current, stage_count, - delta_time, 0, 0, param); + if (ecs_map_is_initialized(&idt->triggers)) { + init_iter(it, iter_set); + notify_self_triggers(world, it, &idt->triggers); + } + if (ecs_map_is_initialized(&idt->entity_triggers)) { + init_iter(it, iter_set); + notify_entity_triggers(world, it, &idt->entity_triggers); + } + if (ecs_map_is_initialized(&idt->set_triggers)) { + init_iter(it, iter_set); + notify_set_base_triggers(world, it, &idt->set_triggers); + } } -ecs_entity_t ecs_run( +static +void notify_set_triggers_for_id( ecs_world_t *world, - ecs_entity_t system, - FLECS_FLOAT delta_time, - void *param) + const ecs_map_t *evt, + ecs_iter_t *it, + bool *iter_set, + ecs_id_t set_id) { - return ecs_run_w_filter(world, system, delta_time, 0, 0, param); + const ecs_event_id_record_t *idt = get_triggers_for_id(evt, set_id); + if (idt && ecs_map_is_initialized(&idt->set_triggers)) { + init_iter(it, iter_set); + notify_set_triggers(world, it, &idt->set_triggers); + } } -ecs_query_t* ecs_system_get_query( - const ecs_world_t *world, - ecs_entity_t system) +static +void trigger_yield_existing( + ecs_world_t *world, + ecs_trigger_t *trigger) { - const EcsQuery *q = ecs_get(world, system, EcsQuery); - if (q) { - return q->query; - } else { - const EcsSystem *s = ecs_get(world, system, EcsSystem); - if (s) { - return s->query; - } else { - return NULL; + ecs_iter_action_t callback = trigger->callback; + + /* If yield existing is enabled, trigger for each thing that matches + * the event, if the event is iterable. */ + int i, count = trigger->event_count; + for (i = 0; i < count; i ++) { + ecs_entity_t evt = trigger->events[i]; + const EcsIterable *iterable = ecs_get(world, evt, EcsIterable); + if (!iterable) { + continue; + } + + ecs_iter_t it; + iterable->init(world, world, &it, &trigger->term); + it.system = trigger->entity; + it.ctx = trigger->ctx; + it.binding_ctx = trigger->binding_ctx; + it.event = evt; + + ecs_iter_next_action_t next = it.next; + ecs_assert(next != NULL, ECS_INTERNAL_ERROR, NULL); + while (next(&it)) { + it.event_id = it.ids[0]; + callback(&it); } } } -void* ecs_get_system_ctx( - const ecs_world_t *world, - ecs_entity_t system) +void flecs_triggers_notify( + ecs_iter_t *it, + ecs_observable_t *observable, + ecs_ids_t *ids, + ecs_entity_t event) { - const EcsSystem *s = ecs_get(world, system, EcsSystem); - if (s) { - return s->ctx; - } else { - return NULL; - } -} + ecs_assert(ids != NULL && ids->count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ids->array != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t events[2] = {event, EcsWildcard}; + int32_t e, i, ids_count = ids->count; + ecs_id_t *ids_array = ids->array; + ecs_world_t *world = it->real_world; -void* ecs_get_system_binding_ctx( - const ecs_world_t *world, - ecs_entity_t system) -{ - const EcsSystem *s = ecs_get(world, system, EcsSystem); - if (s) { - return s->binding_ctx; - } else { - return NULL; - } -} + for (e = 0; e < 2; e ++) { + event = events[e]; + const ecs_map_t *evt = get_triggers_for_event(observable, event); + if (!evt) { + continue; + } -/* System destructor */ -static -ECS_DTOR(EcsSystem, ptr, { - if (!ecs_is_alive(world, entity)) { - /* This can happen when a set is deferred while a system is being - * cleaned up. The operation will be discarded, but the destructor - * still needs to be invoked for the value */ - continue; - } + it->event = event; - /* Invoke Deactivated action for active systems */ - if (ptr->query && ecs_query_table_count(ptr->query)) { - invoke_status_action(world, entity, ptr, EcsSystemDeactivated); - } + for (i = 0; i < ids_count; i ++) { + ecs_id_t id = ids_array[i]; + ecs_entity_t role = id & ECS_ROLE_MASK; + bool iter_set = false; - /* Invoke Disabled action for enabled systems */ - if (!ecs_has_id(world, entity, EcsDisabled)) { - invoke_status_action(world, entity, ptr, EcsSystemDisabled); - } + it->event_id = id; - if (ptr->ctx_free) { - ptr->ctx_free(ptr->ctx); - } + notify_triggers_for_id(world, evt, id, it, &iter_set); - if (ptr->status_ctx_free) { - ptr->status_ctx_free(ptr->status_ctx); - } + if (role == ECS_PAIR || role == ECS_CASE) { + ecs_entity_t pred = ECS_PAIR_FIRST(id); + ecs_entity_t obj = ECS_PAIR_SECOND(id); - if (ptr->binding_ctx_free) { - ptr->binding_ctx_free(ptr->binding_ctx); - } + ecs_id_t tid = role | ecs_entity_t_comb(EcsWildcard, pred); + notify_triggers_for_id(world, evt, tid, it, &iter_set); - if (ptr->query) { - ecs_query_fini(ptr->query); + tid = role | ecs_entity_t_comb(obj, EcsWildcard); + notify_triggers_for_id(world, evt, tid, it, &iter_set); + + tid = role | ecs_entity_t_comb(EcsWildcard, EcsWildcard); + notify_triggers_for_id(world, evt, tid, it, &iter_set); + } else { + notify_triggers_for_id(world, evt, EcsWildcard, it, &iter_set); + } + } } -}) +} -static -void EnableMonitor( - ecs_iter_t *it) +void flecs_set_triggers_notify( + ecs_iter_t *it, + ecs_observable_t *observable, + ecs_ids_t *ids, + ecs_entity_t event, + ecs_id_t set_id) { - if (ecs_is_fini(it->world)) { - return; - } + ecs_assert(ids != NULL && ids->count != 0, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ids->array != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t events[2] = {event, EcsWildcard}; + int32_t e, i, ids_count = ids->count; + ecs_id_t *ids_array = ids->array; + ecs_world_t *world = it->real_world; - EcsSystem *sys = ecs_term(it, EcsSystem, 1); + for (e = 0; e < 2; e ++) { + event = events[e]; + const ecs_map_t *evt = get_triggers_for_event(observable, event); + if (!evt) { + continue; + } - int32_t i; - for (i = 0; i < it->count; i ++) { - if (it->event == EcsOnAdd) { - ecs_enable_system(it->world, it->entities[i], &sys[i], true); - } else if (it->event == EcsOnRemove) { - ecs_enable_system(it->world, it->entities[i], &sys[i], false); + it->event = event; + + for (i = 0; i < ids_count; i ++) { + ecs_id_t id = ids_array[i]; + bool iter_set = false; + + it->event_id = id; + + notify_set_triggers_for_id(world, evt, it, &iter_set, set_id); } } } -ecs_entity_t ecs_system_init( +ecs_entity_t ecs_trigger_init( ecs_world_t *world, - const ecs_system_desc_t *desc) + const ecs_trigger_desc_t *desc) { + char *name = NULL; + ecs_poly_assert(world, ecs_world_t); + ecs_check(!world->is_readonly, ECS_INVALID_OPERATION, NULL); ecs_check(desc != NULL, ECS_INVALID_PARAMETER, NULL); ecs_check(desc->_canary == 0, ECS_INVALID_PARAMETER, NULL); - ecs_check(!world->is_readonly, ECS_INVALID_WHILE_ITERATING, NULL); + ecs_check(!world->is_fini, ECS_INVALID_OPERATION, NULL); + + const char *expr = desc->expr; + ecs_trigger_t *trigger = NULL; + + ecs_observable_t *observable = desc->observable; + if (!observable) { + observable = ecs_get_observable(world); + } + /* If entity is provided, create it */ ecs_entity_t existing = desc->entity.entity; - ecs_entity_t result = ecs_entity_init(world, &desc->entity); - if (!result) { - return 0; + ecs_entity_t entity = ecs_entity_init(world, &desc->entity); + if (!existing && !desc->entity.name) { + ecs_add_pair(world, entity, EcsChildOf, EcsFlecsHidden); } bool added = false; - EcsSystem *system = ecs_get_mut(world, result, EcsSystem, &added); + EcsTrigger *comp = ecs_get_mut(world, entity, EcsTrigger, &added); if (added) { ecs_check(desc->callback != NULL, ECS_INVALID_PARAMETER, NULL); + + /* Something went wrong with the construction of the entity */ + ecs_check(entity != 0, ECS_INVALID_PARAMETER, NULL); + name = ecs_get_fullpath(world, entity); - memset(system, 0, sizeof(EcsSystem)); + ecs_term_t term; + if (expr) { + #ifdef FLECS_PARSER + const char *ptr = ecs_parse_term(world, name, expr, expr, &term); + if (!ptr) { + goto error; + } - ecs_query_desc_t query_desc = desc->query; - query_desc.filter.name = desc->entity.name; - query_desc.system = result; + if (!ecs_term_is_initialized(&term)) { + ecs_parser_error( + name, expr, 0, "invalid empty trigger expression"); + goto error; + } - ecs_query_t *query = ecs_query_init(world, &query_desc); - if (!query) { - ecs_delete(world, result); - return 0; + if (ptr[0]) { + ecs_parser_error(name, expr, 0, + "too many terms in trigger expression (expected 1)"); + goto error; + } + #else + ecs_abort(ECS_UNSUPPORTED, "parser addon is not available"); + #endif + } else { + term = ecs_term_copy(&desc->term); } - /* Re-obtain pointer, as query may have added components */ - system = ecs_get_mut(world, result, EcsSystem, &added); - ecs_assert(added == false, ECS_INTERNAL_ERROR, NULL); - - /* Prevent the system from moving while we're initializing */ - ecs_defer_begin(world); - - system->entity = result; - system->query = query; - - system->run = desc->run; - system->action = desc->callback; - system->status_action = desc->status_callback; - - system->self = desc->self; - system->ctx = desc->ctx; - system->status_ctx = desc->status_ctx; - system->binding_ctx = desc->binding_ctx; - - system->ctx_free = desc->ctx_free; - system->status_ctx_free = desc->status_ctx_free; - system->binding_ctx_free = desc->binding_ctx_free; + if (ecs_term_finalize(world, name, &term)) { + ecs_term_fini(&term); + goto error; + } - system->tick_source = desc->tick_source; + trigger = flecs_sparse_add(world->triggers, ecs_trigger_t); + trigger->id = flecs_sparse_last_id(world->triggers); - system->multi_threaded = desc->multi_threaded; - system->no_staging = desc->no_staging; + trigger->term = ecs_term_move(&term); + trigger->callback = desc->callback; + trigger->ctx = desc->ctx; + trigger->binding_ctx = desc->binding_ctx; + trigger->ctx_free = desc->ctx_free; + trigger->binding_ctx_free = desc->binding_ctx_free; + trigger->event_count = count_events(desc->events); + ecs_os_memcpy(trigger->events, desc->events, + trigger->event_count * ECS_SIZEOF(ecs_entity_t)); + trigger->entity = entity; + trigger->self = desc->self; + trigger->observable = observable; + trigger->match_prefab = desc->match_prefab; + trigger->match_disabled = desc->match_disabled; + trigger->instanced = desc->instanced; + trigger->last_event_id = desc->last_event_id; - /* If tables have been matched with this system it is active, and we - * should activate the in terms, if any. This will ensure that any - * OnDemand systems get enabled. */ - if (ecs_query_table_count(query)) { - ecs_system_activate(world, result, true, system); - } else { - /* If system isn't matched with any tables, mark it as inactive. This - * causes it to be ignored by the main loop. When the system matches - * with a table it will be activated. */ - ecs_add_id(world, result, EcsInactive); + if (trigger->term.id == EcsPrefab) { + trigger->match_prefab = true; } - - if (!ecs_has_id(world, result, EcsDisabled)) { - /* If system is already enabled, generate enable status. The API - * should guarantee that it exactly matches enable-disable - * notifications and activate-deactivate notifications. */ - invoke_status_action(world, result, system, EcsSystemEnabled); - - /* If column system has active (non-empty) tables, also generate the - * activate status. */ - if (ecs_query_table_count(system->query)) { - invoke_status_action(world, result, system, EcsSystemActivated); - } + if (trigger->term.id == EcsDisabled) { + trigger->match_disabled = true; } - if (desc->interval != 0 || desc->rate != 0 || desc->tick_source != 0) { -#ifdef FLECS_TIMER - if (desc->interval != 0) { - ecs_set_interval(world, result, desc->interval); - } + comp->trigger = trigger; - if (desc->rate) { - ecs_set_rate(world, result, desc->rate, desc->tick_source); - } else if (desc->tick_source) { - ecs_set_tick_source(world, result, desc->tick_source); - } -#else - ecs_abort(ECS_UNSUPPORTED, "timer module not available"); -#endif - } + /* Trigger must have at least one event */ + ecs_check(trigger->event_count != 0, ECS_INVALID_PARAMETER, NULL); - ecs_modified(world, result, EcsSystem); + register_trigger(world, observable, trigger); + + ecs_term_fini(&term); if (desc->entity.name) { - ecs_trace("#[green]system#[reset] %s created", - ecs_get_name(world, result)); + ecs_trace("#[green]trigger#[reset] %s created", + ecs_get_name(world, entity)); } - ecs_defer_end(world); + if (desc->yield_existing) { + trigger_yield_existing(world, trigger); + } } else { - const char *expr_desc = desc->query.filter.expr; - const char *expr_sys = system->query->filter.expr; - - /* Only check expression if it's set */ - if (expr_desc) { - if (expr_sys && !strcmp(expr_sys, "0")) expr_sys = NULL; - if (expr_desc && !strcmp(expr_desc, "0")) expr_desc = NULL; + ecs_assert(comp->trigger != NULL, ECS_INTERNAL_ERROR, NULL); - if (expr_sys && expr_desc) { - if (strcmp(expr_sys, expr_desc)) { - ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); - } - } else { - if (expr_sys != expr_desc) { - ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); - } + /* If existing entity handle was provided, override existing params */ + if (existing) { + if (desc->callback) { + ((ecs_trigger_t*)comp->trigger)->callback = desc->callback; } - - /* If expr_desc is not set, and this is an existing system, don't throw - * an error because we could be updating existing parameters of the - * system such as the context or system callback. However, if no - * entity handle was provided, we have to assume that the application is - * trying to redeclare the system. */ - } else if (!existing) { - if (expr_sys) { - ecs_abort(ECS_ALREADY_DEFINED, desc->entity.name); + if (desc->ctx) { + ((ecs_trigger_t*)comp->trigger)->ctx = desc->ctx; + } + if (desc->binding_ctx) { + ((ecs_trigger_t*)comp->trigger)->binding_ctx = desc->binding_ctx; } - } - - if (desc->run) { - system->run = desc->run; - } - if (desc->callback) { - system->action = desc->callback; - } - if (desc->ctx) { - system->ctx = desc->ctx; - } - if (desc->binding_ctx) { - system->binding_ctx = desc->binding_ctx; - } - if (desc->query.filter.instanced) { - system->query->filter.instanced = true; - } - if (desc->multi_threaded) { - system->multi_threaded = desc->multi_threaded; - } - if (desc->no_staging) { - system->no_staging = desc->no_staging; } } - return result; + ecs_os_free(name); + return entity; error: + ecs_os_free(name); + ecs_delete(world, entity); return 0; } -void FlecsSystemImport( - ecs_world_t *world) +void* ecs_get_trigger_ctx( + const ecs_world_t *world, + ecs_entity_t trigger) { - ECS_MODULE(world, FlecsSystem); - - ecs_set_name_prefix(world, "Ecs"); - - flecs_bootstrap_component(world, EcsSystem); - flecs_bootstrap_component(world, EcsTickSource); - - /* Put following tags in flecs.core so they can be looked up - * without using the flecs.systems prefix. */ - ecs_entity_t old_scope = ecs_set_scope(world, EcsFlecsCore); - flecs_bootstrap_tag(world, EcsInactive); - flecs_bootstrap_tag(world, EcsMonitor); - ecs_set_scope(world, old_scope); - - /* Bootstrap ctor and dtor for EcsSystem */ - ecs_set_component_actions_w_id(world, ecs_id(EcsSystem), - &(EcsComponentLifecycle) { - .ctor = ecs_default_ctor, - .dtor = ecs_dtor(EcsSystem) - }); - - ecs_observer_init(world, &(ecs_observer_desc_t) { - .entity.name = "EnableMonitor", - .filter.terms = { - { .id = ecs_id(EcsSystem) }, - { .id = EcsDisabled, .oper = EcsNot }, - }, - .events = {EcsMonitor}, - .callback = EnableMonitor - }); + const EcsTrigger *t = ecs_get(world, trigger, EcsTrigger); + if (t) { + return t->trigger->ctx; + } else { + return NULL; + } } -#endif - - -#ifdef FLECS_DEPRECATED - - -#endif - -#include -#include - -#define ECS_NAME_BUFFER_LENGTH (64) - -static -bool path_append( - const ecs_world_t *world, - ecs_entity_t parent, - ecs_entity_t child, - const char *sep, - const char *prefix, - ecs_strbuf_t *buf) +void* ecs_get_trigger_binding_ctx( + const ecs_world_t *world, + ecs_entity_t trigger) { - ecs_poly_assert(world, ecs_world_t); - - ecs_entity_t cur = 0; - char buff[22]; - const char *name; + const EcsTrigger *t = ecs_get(world, trigger, EcsTrigger); + if (t) { + return t->trigger->binding_ctx; + } else { + return NULL; + } +} - if (ecs_is_valid(world, child)) { - cur = ecs_get_object(world, child, EcsChildOf, 0); - if (cur) { - if (cur != parent && (cur != EcsFlecsCore || prefix != NULL)) { - path_append(world, parent, cur, sep, prefix, buf); - ecs_strbuf_appendstr(buf, sep); - } - } else if (prefix) { - ecs_strbuf_appendstr(buf, prefix); - } +void flecs_trigger_fini( + ecs_world_t *world, + ecs_trigger_t *trigger) +{ + unregister_trigger(world, trigger->observable, trigger); + ecs_term_fini(&trigger->term); - name = ecs_get_name(world, child); - if (!name || !ecs_os_strlen(name)) { - ecs_os_sprintf(buff, "%u", (uint32_t)child); - name = buff; - } - } else { - ecs_os_sprintf(buff, "%u", (uint32_t)child); - name = buff; + if (trigger->ctx_free) { + trigger->ctx_free(trigger->ctx); } - ecs_strbuf_appendstr(buf, name); + if (trigger->binding_ctx_free) { + trigger->binding_ctx_free(trigger->binding_ctx); + } - return cur != 0; + flecs_sparse_remove(world->triggers, trigger->id); } -static -bool is_number( - const char *name) +#include + +#ifndef FLECS_NDEBUG +static int64_t s_min[] = { + [1] = INT8_MIN, [2] = INT16_MIN, [4] = INT32_MIN, [8] = INT64_MIN }; +static int64_t s_max[] = { + [1] = INT8_MAX, [2] = INT16_MAX, [4] = INT32_MAX, [8] = INT64_MAX }; +static uint64_t u_max[] = { + [1] = UINT8_MAX, [2] = UINT16_MAX, [4] = UINT32_MAX, [8] = UINT64_MAX }; + +uint64_t _flecs_ito( + size_t size, + bool is_signed, + bool lt_zero, + uint64_t u, + const char *err) { - ecs_assert(name != NULL, ECS_INTERNAL_ERROR, NULL); - - if (!isdigit(name[0])) { - return false; - } + union { + uint64_t u; + int64_t s; + } v; - ecs_size_t i, length = ecs_os_strlen(name); - for (i = 1; i < length; i ++) { - char ch = name[i]; + v.u = u; - if (!isdigit(ch)) { - break; - } + if (is_signed) { + ecs_assert(v.s >= s_min[size], ECS_INVALID_CONVERSION, err); + ecs_assert(v.s <= s_max[size], ECS_INVALID_CONVERSION, err); + } else { + ecs_assert(lt_zero == false, ECS_INVALID_CONVERSION, err); + ecs_assert(u <= u_max[size], ECS_INVALID_CONVERSION, err); } - return i >= length; + return u; } +#endif -static -ecs_entity_t name_to_id( - const ecs_world_t *world, - const char *name) +int32_t flecs_next_pow_of_2( + int32_t n) { - long int result = atol(name); - ecs_assert(result >= 0, ECS_INTERNAL_ERROR, NULL); - ecs_entity_t alive = ecs_get_alive(world, (ecs_entity_t)result); - if (alive) { - return alive; - } else { - return (ecs_entity_t)result; - } + n --; + n |= n >> 1; + n |= n >> 2; + n |= n >> 4; + n |= n >> 8; + n |= n >> 16; + n ++; + + return n; } -static -ecs_entity_t get_builtin( - const char *name) +/** Convert time to double */ +double ecs_time_to_double( + ecs_time_t t) { - if (name[0] == '.' && name[1] == '\0') { - return EcsThis; - } else if (name[0] == '*' && name[1] == '\0') { - return EcsWildcard; - } else if (name[0] == '_' && name[1] == '\0') { - return EcsAny; - } - - return 0; + double result; + result = t.sec; + return result + (double)t.nanosec / (double)1000000000; } -static -bool is_sep( - const char **ptr, - const char *sep) +ecs_time_t ecs_time_sub( + ecs_time_t t1, + ecs_time_t t2) { - ecs_size_t len = ecs_os_strlen(sep); + ecs_time_t result; - if (!ecs_os_strncmp(*ptr, sep, len)) { - *ptr += len; - return true; + if (t1.nanosec >= t2.nanosec) { + result.nanosec = t1.nanosec - t2.nanosec; + result.sec = t1.sec - t2.sec; } else { - return false; + result.nanosec = t1.nanosec - t2.nanosec + 1000000000; + result.sec = t1.sec - t2.sec - 1; } + + return result; } -static -const char* path_elem( - const char *path, - const char *sep, - int32_t *len) +void ecs_sleepf( + double t) { - const char *ptr; - char ch; - int32_t template_nesting = 0; - int32_t count = 0; - - for (ptr = path; (ch = *ptr); ptr ++) { - if (ch == '<') { - template_nesting ++; - } else if (ch == '>') { - template_nesting --; - } - - ecs_check(template_nesting >= 0, ECS_INVALID_PARAMETER, path); - - if (!template_nesting && is_sep(&ptr, sep)) { - break; - } - - count ++; + if (t > 0) { + int sec = (int)t; + int nsec = (int)((t - sec) * 1000000000); + ecs_os_sleep(sec, nsec); } +} - if (len) { - *len = count; - } +double ecs_time_measure( + ecs_time_t *start) +{ + ecs_time_t stop, temp; + ecs_os_get_time(&stop); + temp = stop; + stop = ecs_time_sub(stop, *start); + *start = temp; + return ecs_time_to_double(stop); +} - if (count) { - return ptr; - } else { +void* ecs_os_memdup( + const void *src, + ecs_size_t size) +{ + if (!src) { return NULL; } -error: - return NULL; + + void *dst = ecs_os_malloc(size); + ecs_assert(dst != NULL, ECS_OUT_OF_MEMORY, NULL); + ecs_os_memcpy(dst, src, size); + return dst; } -static -ecs_entity_t get_parent_from_path( - const ecs_world_t *world, - ecs_entity_t parent, - const char **path_ptr, - const char *prefix, - bool new_entity) +int flecs_entity_compare( + ecs_entity_t e1, + const void *ptr1, + ecs_entity_t e2, + const void *ptr2) { - bool start_from_root = false; - const char *path = *path_ptr; - - if (prefix) { - ecs_size_t len = ecs_os_strlen(prefix); - if (!ecs_os_strncmp(path, prefix, len)) { - path += len; - parent = 0; - start_from_root = true; - } - } - - if (!start_from_root && !parent && new_entity) { - parent = ecs_get_scope(world); - } + (void)ptr1; + (void)ptr2; + return (e1 > e2) - (e1 < e2); +} - *path_ptr = path; +int flecs_entity_compare_qsort( + const void *e1, + const void *e2) +{ + ecs_entity_t v1 = *(ecs_entity_t*)e1; + ecs_entity_t v2 = *(ecs_entity_t*)e2; + return flecs_entity_compare(v1, NULL, v2, NULL); +} - return parent; +uint64_t flecs_string_hash( + const void *ptr) +{ + const ecs_hashed_string_t *str = ptr; + ecs_assert(str->hash != 0, ECS_INTERNAL_ERROR, NULL); + return str->hash; } -static -void on_set_symbol(ecs_iter_t *it) { - EcsIdentifier *n = ecs_term(it, EcsIdentifier, 1); - ecs_world_t *world = it->world; +/* + This code was taken from sokol_time.h + + zlib/libpng license + Copyright (c) 2018 Andre Weissflog + This software is provided 'as-is', without any express or implied warranty. + In no event will the authors be held liable for any damages arising from the + use of this software. + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: + 1. The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software in a + product, an acknowledgment in the product documentation would be + appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and must not + be misrepresented as being the original software. + 3. This notice may not be removed or altered from any source + distribution. +*/ - int i; - for (i = 0; i < it->count; i ++) { - ecs_entity_t e = it->entities[i]; - flecs_name_index_ensure( - &world->symbols, e, n[i].value, n[i].length, n[i].hash); - } -} -void flecs_bootstrap_hierarchy(ecs_world_t *world) { - ecs_trigger_init(world, &(ecs_trigger_desc_t){ - .term = {.id = ecs_pair(ecs_id(EcsIdentifier), EcsSymbol), .subj.set.mask = EcsSelf }, - .callback = on_set_symbol, - .events = {EcsOnSet}, - .yield_existing = true - }); -} +/* -- Component lifecycle -- */ +/* Component lifecycle actions for EcsIdentifier */ +static ECS_CTOR(EcsIdentifier, ptr, { + ptr->value = NULL; + ptr->hash = 0; + ptr->length = 0; + ptr->index_hash = 0; + ptr->index = NULL; +}) -/* Public functions */ +static ECS_DTOR(EcsIdentifier, ptr, { + ecs_os_strset(&ptr->value, NULL); +}) -void ecs_get_path_w_sep_buf( - const ecs_world_t *world, - ecs_entity_t parent, - ecs_entity_t child, - const char *sep, - const char *prefix, - ecs_strbuf_t *buf) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(buf != NULL, ECS_INVALID_PARAMETER, NULL); +static ECS_COPY(EcsIdentifier, dst, src, { + ecs_os_strset(&dst->value, src->value); + dst->hash = src->hash; + dst->length = src->length; + dst->index_hash = src->index_hash; + dst->index = src->index; +}) - world = ecs_get_world(world); +static ECS_MOVE(EcsIdentifier, dst, src, { + ecs_os_strset(&dst->value, NULL); + dst->value = src->value; + dst->hash = src->hash; + dst->length = src->length; + dst->index_hash = src->index_hash; + dst->index = src->index; - if (child == EcsThis) { - ecs_strbuf_appendstr(buf, "."); - return; - } - if (child == EcsWildcard) { - ecs_strbuf_appendstr(buf, "*"); - return; - } - if (child == EcsAny) { - ecs_strbuf_appendstr(buf, "_"); - return; - } + src->value = NULL; + src->hash = 0; + src->index_hash = 0; + src->index = 0; + src->length = 0; +}) - if (!sep) { - sep = "."; - } +static +void ecs_on_set(EcsIdentifier)(ecs_iter_t *it) { + EcsIdentifier *ptr = ecs_term(it, EcsIdentifier, 1); + + ecs_world_t *world = it->real_world; + ecs_entity_t evt = it->event; + ecs_id_t evt_id = it->event_id; + ecs_entity_t kind = ECS_PAIR_SECOND(evt_id); /* Name, Symbol, Alias */ - if (!child || parent != child) { - path_append(world, parent, child, sep, prefix, buf); - } else { - ecs_strbuf_appendstr(buf, ""); + ecs_id_t pair = ecs_childof(0); + + ecs_hashmap_t *name_index = NULL; + if (kind == EcsSymbol) { + name_index = &world->symbols; + } else if (kind == EcsAlias) { + name_index = &world->aliases; + } else if (kind == EcsName) { + ecs_assert(it->table != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_search(world, it->table, ecs_childof(EcsWildcard), &pair); + ecs_assert(pair != 0, ECS_INTERNAL_ERROR, NULL); + + if (evt == EcsOnSet) { + name_index = flecs_ensure_id_name_index(world, pair); + } else { + name_index = flecs_get_id_name_index(world, pair); + } } -error: - return; -} + for (int i = 0; i < it->count; i ++) { + EcsIdentifier *cur = &ptr[i]; + uint64_t hash; + ecs_size_t len; + const char *name = cur->value; -char* ecs_get_path_w_sep( - const ecs_world_t *world, - ecs_entity_t parent, - ecs_entity_t child, - const char *sep, - const char *prefix) -{ - ecs_strbuf_t buf = ECS_STRBUF_INIT; - ecs_get_path_w_sep_buf(world, parent, child, sep, prefix, &buf); - return ecs_strbuf_get(&buf); -} + if (cur->index && cur->index != name_index) { + /* If index doesn't match up, the value must have been copied from + * another entity, so reset index & cached index hash */ + cur->index = NULL; + cur->index_hash = 0; + } -ecs_entity_t ecs_lookup_child( - const ecs_world_t *world, - ecs_entity_t parent, - const char *name) -{ - ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); + if (cur->value && (evt == EcsOnSet)) { + len = cur->length = ecs_os_strlen(name); + hash = cur->hash = flecs_hash(name, len); + } else { + len = cur->length = 0; + hash = cur->hash = 0; + cur->index = NULL; + } - if (is_number(name)) { - return name_to_id(world, name); - } + if (name_index) { + uint64_t index_hash = cur->index_hash; + ecs_entity_t e = it->entities[i]; - ecs_id_t pair = ecs_childof(parent); - ecs_hashmap_t *index = flecs_get_id_name_index(world, pair); - if (index) { - return flecs_name_index_find(index, name, 0, 0); - } else { - return 0; + if (hash != index_hash) { + if (index_hash) { + flecs_name_index_remove(name_index, e, index_hash); + } + if (hash) { + flecs_name_index_ensure(name_index, e, name, len, hash); + cur->index_hash = hash; + cur->index = name_index; + } + } else { + /* Name didn't change, but the string could have been + * reallocated. Make sure name index points to correct string */ + flecs_name_index_update_name(name_index, e, hash, name); + } + } } -error: - return 0; } -ecs_entity_t ecs_lookup( - const ecs_world_t *world, - const char *name) -{ - if (!name) { - return 0; +/* Component lifecycle actions for EcsTrigger */ +static ECS_CTOR(EcsTrigger, ptr, { + ptr->trigger = NULL; +}) + +static ECS_DTOR(EcsTrigger, ptr, { + if (ptr->trigger) { + flecs_trigger_fini(world, (ecs_trigger_t*)ptr->trigger); } +}) - ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); - world = ecs_get_world(world); +static ECS_COPY(EcsTrigger, dst, src, { + ecs_abort(ECS_INVALID_OPERATION, "Trigger component cannot be copied"); +}) - ecs_entity_t e = get_builtin(name); - if (e) { - return e; +static ECS_MOVE(EcsTrigger, dst, src, { + if (dst->trigger) { + flecs_trigger_fini(world, (ecs_trigger_t*)dst->trigger); } + dst->trigger = src->trigger; + src->trigger = NULL; +}) - if (is_number(name)) { - return name_to_id(world, name); +/* Component lifecycle actions for EcsObserver */ +static ECS_CTOR(EcsObserver, ptr, { + ptr->observer = NULL; +}) + +static ECS_DTOR(EcsObserver, ptr, { + if (ptr->observer) { + flecs_observer_fini(world, (ecs_observer_t*)ptr->observer); } +}) - e = flecs_name_index_find(&world->aliases, name, 0, 0); - if (e) { - return e; - } - - return ecs_lookup_child(world, 0, name); -error: - return 0; -} +static ECS_COPY(EcsObserver, dst, src, { + ecs_abort(ECS_INVALID_OPERATION, "Observer component cannot be copied"); +}) -ecs_entity_t ecs_lookup_symbol( - const ecs_world_t *world, - const char *name, - bool lookup_as_path) -{ - if (!name) { - return 0; +static ECS_MOVE(EcsObserver, dst, src, { + if (dst->observer) { + flecs_observer_fini(world, (ecs_observer_t*)dst->observer); } + dst->observer = src->observer; + src->observer = NULL; +}) - ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); - world = ecs_get_world(world); - ecs_entity_t e = flecs_name_index_find(&world->symbols, name, 0, 0); - if (e) { - return e; - } +/* -- Builtin triggers -- */ - if (lookup_as_path) { - return ecs_lookup_fullpath(world, name); +static +void assert_relation_unused( + ecs_world_t *world, + ecs_entity_t rel, + ecs_entity_t property) +{ + if (flecs_get_id_record(world, ecs_pair(rel, EcsWildcard)) != NULL) { + char *r_str = ecs_get_fullpath(world, rel); + char *p_str = ecs_get_fullpath(world, property); + + ecs_throw(ECS_ID_IN_USE, + "cannot add property '%s' to relation '%s': already in use", + p_str, r_str); + + ecs_os_free(r_str); + ecs_os_free(p_str); } error: - return 0; + return; } -ecs_entity_t ecs_lookup_path_w_sep( - const ecs_world_t *world, - ecs_entity_t parent, - const char *path, - const char *sep, - const char *prefix, - bool recursive) -{ - if (!path) { - return 0; - } - - if (!sep) { - sep = "."; +static +void register_final(ecs_iter_t *it) { + ecs_world_t *world = it->world; + + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + if (flecs_get_id_record(world, ecs_pair(EcsIsA, e)) != NULL) { + char *e_str = ecs_get_fullpath(world, e); + ecs_throw(ECS_ID_IN_USE, + "cannot add property 'Final' to '%s': already inherited from", + e_str); + ecs_os_free(e_str); + error: + continue; + } } +} - ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); - const ecs_world_t *stage = world; - world = ecs_get_world(world); +static +void register_on_delete(ecs_iter_t *it) { + ecs_world_t *world = it->world; + ecs_id_t id = ecs_term_id(it, 1); + + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + assert_relation_unused(world, e, EcsOnDelete); - ecs_entity_t e = get_builtin(path); - if (e) { - return e; - } + ecs_id_record_t *r = flecs_ensure_id_record(world, e); + ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); + r->flags |= ECS_ID_ON_DELETE_FLAG(ECS_PAIR_SECOND(id)); - e = flecs_name_index_find(&world->aliases, path, 0, 0); - if (e) { - return e; + flecs_add_flag(world, e, ECS_FLAG_OBSERVED_ID); } +} - char buff[ECS_NAME_BUFFER_LENGTH]; - const char *ptr, *ptr_start; - char *elem = buff; - int32_t len, size = ECS_NAME_BUFFER_LENGTH; - ecs_entity_t cur; - bool lookup_path_search = false; +static +void register_on_delete_object(ecs_iter_t *it) { + ecs_world_t *world = it->world; + ecs_id_t id = ecs_term_id(it, 1); - ecs_entity_t *lookup_path = ecs_get_lookup_path(stage); - ecs_entity_t *lookup_path_cur = lookup_path; - while (lookup_path_cur && *lookup_path_cur) { - lookup_path_cur ++; - } + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + assert_relation_unused(world, e, EcsOnDeleteObject); - if (!sep) { - sep = "."; - } + ecs_id_record_t *r = flecs_ensure_id_record(world, e); + ecs_assert(r != NULL, ECS_INTERNAL_ERROR, NULL); + r->flags |= ECS_ID_ON_DELETE_OBJECT_FLAG(ECS_PAIR_SECOND(id)); - parent = get_parent_from_path(stage, parent, &path, prefix, true); + flecs_add_flag(world, e, ECS_FLAG_OBSERVED_ID); + } +} -retry: - cur = parent; - ptr_start = ptr = path; +static +void register_exclusive(ecs_iter_t *it) { + ecs_world_t *world = it->world; + + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + assert_relation_unused(world, e, EcsExclusive); - while ((ptr = path_elem(ptr, sep, &len))) { - if (len < size) { - ecs_os_memcpy(elem, ptr_start, len); - } else { - if (size == ECS_NAME_BUFFER_LENGTH) { - elem = NULL; - } + ecs_id_record_t *r = flecs_ensure_id_record(world, e); + r->flags |= ECS_ID_EXCLUSIVE; + } +} - elem = ecs_os_realloc(elem, len + 1); - ecs_os_memcpy(elem, ptr_start, len); - size = len + 1; - } +static +void register_dont_inherit(ecs_iter_t *it) { + ecs_world_t *world = it->world; + + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + assert_relation_unused(world, e, EcsDontInherit); - elem[len] = '\0'; - ptr_start = ptr; + ecs_id_record_t *r = flecs_ensure_id_record(world, e); + r->flags |= ECS_ID_DONT_INHERIT; + } +} - cur = ecs_lookup_child(world, cur, elem); - if (!cur) { - goto tail; - } +static +void on_symmetric_add_remove(ecs_iter_t *it) { + ecs_entity_t pair = ecs_term_id(it, 1); + + if (!ECS_HAS_ROLE(pair, PAIR)) { + /* If relationship was not added as a pair, there's nothing to do */ + return; } -tail: - if (!cur && recursive) { - if (!lookup_path_search) { - if (parent) { - parent = ecs_get_object(world, parent, EcsChildOf, 0); - goto retry; - } else { - lookup_path_search = true; + ecs_entity_t rel = ECS_PAIR_FIRST(pair); + ecs_entity_t obj = ECS_PAIR_SECOND(pair); + ecs_entity_t event = it->event; + + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t subj = it->entities[i]; + if (event == EcsOnAdd) { + if (!ecs_has_id(it->real_world, obj, ecs_pair(rel, subj))) { + ecs_add_pair(it->world, obj, rel, subj); } - } - - if (lookup_path_search) { - if (lookup_path_cur != lookup_path) { - lookup_path_cur --; - parent = lookup_path_cur[0]; - goto retry; + } else { + if (ecs_has_id(it->real_world, obj, ecs_pair(rel, subj))) { + ecs_remove_pair(it->world, obj, rel, subj); } } } - - if (elem != buff) { - ecs_os_free(elem); - } - - return cur; -error: - return 0; } -ecs_entity_t ecs_set_scope( - ecs_world_t *world, - ecs_entity_t scope) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_stage_t *stage = flecs_stage_from_world(&world); +static +void register_symmetric(ecs_iter_t *it) { + ecs_world_t *world = it->real_world; - ecs_entity_t cur = stage->scope; - stage->scope = scope; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t r = it->entities[i]; + assert_relation_unused(world, r, EcsSymmetric); - return cur; -error: - return 0; + /* Create trigger that adds the reverse relationship when R(X, Y) is + * added, or remove the reverse relationship when R(X, Y) is removed. */ + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term.id = ecs_pair(r, EcsWildcard), + .callback = on_symmetric_add_remove, + .events = {EcsOnAdd, EcsOnRemove} + }); + } } -ecs_entity_t ecs_get_scope( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); - return stage->scope; -error: - return 0; -} +static +void on_set_component(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsComponent *c = ecs_term(it, EcsComponent, 1); -ecs_entity_t* ecs_set_lookup_path( - ecs_world_t *world, - const ecs_entity_t *lookup_path) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_stage_t *stage = flecs_stage_from_world(&world); + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_type_info_t *ti = flecs_ensure_type_info(world, e); + ti->size = c[i].size; + ti->alignment = c[i].alignment; + } +} - ecs_entity_t *cur = stage->lookup_path; - stage->lookup_path = (ecs_entity_t*)lookup_path; +static +void on_set_component_lifecycle(ecs_iter_t *it) { + ecs_world_t *world = it->world; + EcsComponentLifecycle *cl = ecs_term(it, EcsComponentLifecycle, 1); - return cur; -error: - return NULL; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_set_component_actions_w_id(world, e, &cl[i]); + } } -ecs_entity_t* ecs_get_lookup_path( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); - return stage->lookup_path; -error: - return NULL; -} +static +void ensure_module_tag(ecs_iter_t *it) { + ecs_world_t *world = it->world; -const char* ecs_set_name_prefix( - ecs_world_t *world, - const char *prefix) -{ - ecs_poly_assert(world, ecs_world_t); - const char *old_prefix = world->name_prefix; - world->name_prefix = prefix; - return old_prefix; + int i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + ecs_entity_t parent = ecs_get_object(world, e, EcsChildOf, 0); + if (parent) { + ecs_add_id(world, parent, EcsModule); + } + } } -ecs_entity_t ecs_add_path_w_sep( - ecs_world_t *world, - ecs_entity_t entity, - ecs_entity_t parent, - const char *path, - const char *sep, - const char *prefix) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - - if (!sep) { - sep = "."; - } +/* -- Triggers for keeping hashed ids in sync -- */ - if (!path) { - if (!entity) { - entity = ecs_new_id(world); - } +static +void on_parent_change(ecs_iter_t *it) { + ecs_world_t *world = it->world; + ecs_table_t *other_table = it->other_table, *table = it->table; - if (parent) { - ecs_add_pair(world, entity, EcsChildOf, entity); - } + int32_t col = ecs_search(it->real_world, table, + ecs_pair(ecs_id(EcsIdentifier), EcsName), 0); + bool has_name = col != -1; + bool other_has_name = ecs_search(it->real_world, other_table, + ecs_pair(ecs_id(EcsIdentifier), EcsName), 0) != -1; - return entity; + if (!has_name && !other_has_name) { + /* If tables don't have names, index does not need to be updated */ + return; } - parent = get_parent_from_path(world, parent, &path, prefix, entity == 0); + ecs_id_t to_pair = it->event_id; + ecs_id_t from_pair = ecs_childof(0); - char buff[ECS_NAME_BUFFER_LENGTH]; - const char *ptr = path; - const char *ptr_start = path; - char *elem = buff; - int32_t len, size = ECS_NAME_BUFFER_LENGTH; + /* Find the other ChildOf relationship */ + ecs_search(it->real_world, other_table, + ecs_pair(EcsChildOf, EcsWildcard), &from_pair); - ecs_entity_t cur = parent; + bool to_has_name = has_name, from_has_name = other_has_name; + if (it->event == EcsOnRemove) { + if (from_pair != ecs_childof(0)) { + /* Because ChildOf is an exclusive relationship, events always come + * in OnAdd/OnRemove pairs (add for the new, remove for the old + * parent). We only need one of those events, so filter out the + * OnRemove events except for the case where a parent is removed and + * not replaced with another parent. */ + return; + } - char *name = NULL; + ecs_id_t temp = from_pair; + from_pair = to_pair; + to_pair = temp; - while ((ptr = path_elem(ptr, sep, &len))) { - if (len < size) { - ecs_os_memcpy(elem, ptr_start, len); - } else { - if (size == ECS_NAME_BUFFER_LENGTH) { - elem = NULL; - } + to_has_name = other_has_name; + from_has_name = has_name; + } - elem = ecs_os_realloc(elem, len + 1); - ecs_os_memcpy(elem, ptr_start, len); - size = len + 1; + /* Get the table column with names */ + const EcsIdentifier *names = ecs_iter_column(it, EcsIdentifier, col); + + ecs_hashmap_t *from_index = 0; + if (from_has_name) { + from_index = flecs_get_id_name_index(world, from_pair); + } + ecs_hashmap_t *to_index = NULL; + if (to_has_name) { + to_index = flecs_ensure_id_name_index(world, to_pair); + } + + int32_t i, count = it->count; + for (i = 0; i < count; i ++) { + ecs_entity_t e = it->entities[i]; + const EcsIdentifier *name = &names[i]; + + uint64_t index_hash = name->index_hash; + if (from_index && index_hash) { + flecs_name_index_remove(from_index, e, index_hash); + } + const char *name_str = name->value; + if (to_index && name_str) { + ecs_assert(name->hash != 0, ECS_INTERNAL_ERROR, NULL); + flecs_name_index_ensure( + to_index, e, name_str, name->length, name->hash); } + } +} - elem[len] = '\0'; - ptr_start = ptr; - ecs_entity_t e = ecs_lookup_child(world, cur, elem); - if (!e) { - if (name) { - ecs_os_free(name); - } +/* -- Iterable mixins -- */ - name = ecs_os_strdup(elem); +static +void on_event_iterable_init( + const ecs_world_t *world, + const ecs_poly_t *poly, /* Observable */ + ecs_iter_t *it, + ecs_term_t *filter) +{ + ecs_iter_poly(world, poly, it, filter); + it->event_id = filter->id; +} - /* If this is the last entity in the path, use the provided id */ - bool last_elem = false; - if (!path_elem(ptr, sep, NULL)) { - e = entity; - last_elem = true; - } +/* -- Bootstrapping -- */ - if (!e) { - if (last_elem) { - ecs_entity_t prev = ecs_set_scope(world, 0); - e = ecs_new(world, 0); - ecs_set_scope(world, prev); - } else { - e = ecs_new_id(world); - } - } +#define bootstrap_component(world, table, name)\ + _bootstrap_component(world, table, ecs_id(name), #name, sizeof(name),\ + ECS_ALIGNOF(name)) - if (cur) { - ecs_add_pair(world, e, EcsChildOf, cur); - } +static +void _bootstrap_component( + ecs_world_t *world, + ecs_table_t *table, + ecs_entity_t entity, + const char *symbol, + ecs_size_t size, + ecs_size_t alignment) +{ + ecs_assert(table != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_set_name(world, e, name); - } + ecs_column_t *columns = table->storage.columns; + ecs_assert(columns != NULL, ECS_INTERNAL_ERROR, NULL); - cur = e; - } + ecs_record_t *record = ecs_eis_ensure(world, entity); + record->table = table; - if (entity && (cur != entity)) { - ecs_throw(ECS_ALREADY_DEFINED, name); - } + int32_t index = flecs_table_append(world, table, &table->storage, + entity, record, false); + record->row = ECS_ROW_TO_RECORD(index, 0); - if (name) { - ecs_os_free(name); - } + EcsComponent *component = ecs_vector_first(columns[0].data, EcsComponent); + component[index].size = size; + component[index].alignment = alignment; - if (elem != buff) { - ecs_os_free(elem); - } + const char *name = &symbol[3]; /* Strip 'Ecs' */ + ecs_size_t symbol_length = ecs_os_strlen(symbol); + ecs_size_t name_length = symbol_length - 3; - return cur; -error: - return 0; + EcsIdentifier *name_col = ecs_vector_first(columns[1].data, EcsIdentifier); + name_col[index].value = ecs_os_strdup(name); + name_col[index].length = name_length; + name_col[index].hash = flecs_hash(name, name_length); + name_col[index].index_hash = 0; + name_col[index].index = NULL; + + EcsIdentifier *symbol_col = ecs_vector_first(columns[2].data, EcsIdentifier); + symbol_col[index].value = ecs_os_strdup(symbol); + symbol_col[index].length = symbol_length; + symbol_col[index].hash = flecs_hash(symbol, symbol_length); + symbol_col[index].index_hash = 0; + symbol_col[index].index = NULL; } -ecs_entity_t ecs_new_from_path_w_sep( - ecs_world_t *world, - ecs_entity_t parent, - const char *path, - const char *sep, - const char *prefix) +/** Initialize component table. This table is manually constructed to bootstrap + * flecs. After this function has been called, the builtin components can be + * created. + * The reason this table is constructed manually is because it requires the size + * and alignment of the EcsComponent and EcsIdentifier components, which haven't + * been created yet */ +static +ecs_table_t* bootstrap_component_table( + ecs_world_t *world) { - if (!sep) { - sep = "."; - } + /* Before creating the table, ensure component ids are alive */ + ecs_ensure(world, ecs_id(EcsComponent)); + ecs_ensure(world, EcsFinal); + ecs_ensure(world, ecs_id(EcsIdentifier)); + ecs_ensure(world, EcsName); + ecs_ensure(world, EcsSymbol); + ecs_ensure(world, EcsAlias); + ecs_ensure(world, EcsChildOf); + ecs_ensure(world, EcsFlecsCore); + ecs_ensure(world, EcsOnDelete); + ecs_ensure(world, EcsThrow); + ecs_ensure(world, EcsWildcard); + ecs_ensure(world, EcsAny); - return ecs_add_path_w_sep(world, 0, parent, path, sep, prefix); -} + /* Before creating table, manually set flags for ChildOf/Identifier, as this + * can no longer be done after they are in use. */ + ecs_id_record_t *childof_idr = flecs_ensure_id_record(world, EcsChildOf); + childof_idr->flags |= ECS_ID_ON_DELETE_OBJECT_DELETE; + childof_idr->flags |= ECS_ID_DONT_INHERIT; + ecs_id_record_t *ident_idr = flecs_ensure_id_record( + world, ecs_id(EcsIdentifier)); + ident_idr->flags |= ECS_ID_DONT_INHERIT; -static -ecs_defer_op_t* new_defer_op(ecs_stage_t *stage) { - ecs_defer_op_t *result = ecs_vector_add(&stage->defer_queue, ecs_defer_op_t); - ecs_os_memset(result, 0, ECS_SIZEOF(ecs_defer_op_t)); + ecs_id_t entities[] = { + ecs_id(EcsComponent), + EcsFinal, + ecs_pair(ecs_id(EcsIdentifier), EcsName), + ecs_pair(ecs_id(EcsIdentifier), EcsSymbol), + ecs_pair(EcsChildOf, EcsFlecsCore), + ecs_pair(EcsOnDelete, EcsThrow) + }; + + ecs_ids_t array = { + .array = entities, + .count = 6 + }; + + ecs_table_t *result = flecs_table_find_or_create(world, &array); + ecs_data_t *data = &result->storage; + + /* Preallocate enough memory for initial components */ + data->entities = ecs_vector_new(ecs_entity_t, EcsFirstUserComponentId); + data->record_ptrs = ecs_vector_new(ecs_record_t*, EcsFirstUserComponentId); + + data->columns[0].data = ecs_vector_new(EcsComponent, EcsFirstUserComponentId); + data->columns[1].data = ecs_vector_new(EcsIdentifier, EcsFirstUserComponentId); + data->columns[2].data = ecs_vector_new(EcsIdentifier, EcsFirstUserComponentId); + return result; } static -bool defer_add_remove( +void bootstrap_entity( ecs_world_t *world, - ecs_stage_t *stage, - ecs_defer_op_kind_t op_kind, - ecs_entity_t entity, - ecs_id_t id) + ecs_entity_t id, + const char *name, + ecs_entity_t parent) { - if (stage->defer) { - if (!id) { - return true; - } - - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = op_kind; - op->id = id; - op->is._1.entity = entity; - - if (op_kind == EcsOpNew) { - world->new_count ++; - } else if (op_kind == EcsOpAdd) { - world->add_count ++; - } else if (op_kind == EcsOpRemove) { - world->remove_count ++; - } + char symbol[256]; + ecs_os_strcpy(symbol, "flecs.core."); + ecs_os_strcat(symbol, name); + + ecs_add_pair(world, id, EcsChildOf, parent); + ecs_set_name(world, id, name); + ecs_set_symbol(world, id, symbol); - return true; - } else { - stage->defer ++; + ecs_assert(ecs_get_name(world, id) != NULL, ECS_INTERNAL_ERROR, NULL); + + if (!parent || parent == EcsFlecsCore) { + ecs_assert(ecs_lookup_fullpath(world, name) == id, + ECS_INTERNAL_ERROR, NULL); } - - return false; } -static -void merge_stages( - ecs_world_t *world, - bool force_merge) +void flecs_bootstrap( + ecs_world_t *world) { - bool is_stage = ecs_poly_is(world, ecs_stage_t); - ecs_stage_t *stage = flecs_stage_from_world(&world); + ecs_log_push(); - bool measure_frame_time = world->measure_frame_time; + ecs_set_name_prefix(world, "Ecs"); - ecs_time_t t_start; - if (measure_frame_time) { - ecs_os_get_time(&t_start); - } + /* Bootstrap type info (otherwise initialized by setting EcsComponent) */ + flecs_init_type_info_t(world, EcsComponent); + flecs_init_type_info_t(world, EcsIdentifier); + flecs_init_type_info_t(world, EcsComponentLifecycle); + flecs_init_type_info_t(world, EcsType); + flecs_init_type_info_t(world, EcsQuery); + flecs_init_type_info_t(world, EcsTrigger); + flecs_init_type_info_t(world, EcsObserver); + flecs_init_type_info_t(world, EcsIterable); - if (is_stage) { - /* Check for consistency if force_merge is enabled. In practice this - * function will never get called with force_merge disabled for just - * a single stage. */ - if (force_merge || stage->auto_merge) { - ecs_defer_end((ecs_world_t*)stage); - } - } else { - /* Merge stages. Only merge if the stage has auto_merging turned on, or - * if this is a forced merge (like when ecs_merge is called) */ - int32_t i, count = ecs_get_stage_count(world); - for (i = 0; i < count; i ++) { - ecs_stage_t *s = (ecs_stage_t*)ecs_get_stage(world, i); - ecs_poly_assert(s, ecs_stage_t); - if (force_merge || s->auto_merge) { - ecs_defer_end((ecs_world_t*)s); - } - } - } + /* Setup component lifecycle actions */ + ecs_set_component_actions(world, EcsComponent, { + .ctor = ecs_default_ctor + }); - flecs_eval_component_monitors(world); + ecs_set_component_actions(world, EcsIdentifier, { + .ctor = ecs_ctor(EcsIdentifier), + .dtor = ecs_dtor(EcsIdentifier), + .copy = ecs_copy(EcsIdentifier), + .move = ecs_move(EcsIdentifier), + .on_set = ecs_on_set(EcsIdentifier), + .on_remove = ecs_on_set(EcsIdentifier) + }); - if (measure_frame_time) { - world->stats.merge_time_total += (float)ecs_time_measure(&t_start); - } + ecs_set_component_actions(world, EcsTrigger, { + .ctor = ecs_ctor(EcsTrigger), + .dtor = ecs_dtor(EcsTrigger), + .copy = ecs_copy(EcsTrigger), + .move = ecs_move(EcsTrigger) + }); - world->stats.merge_count_total ++; + ecs_set_component_actions(world, EcsObserver, { + .ctor = ecs_ctor(EcsObserver), + .dtor = ecs_dtor(EcsObserver), + .copy = ecs_copy(EcsObserver), + .move = ecs_move(EcsObserver) + }); - /* If stage is asynchronous, deferring is always enabled */ - if (stage->asynchronous) { - ecs_defer_begin((ecs_world_t*)stage); - } -} + /* Create table for initial components */ + ecs_table_t *table = bootstrap_component_table(world); + assert(table != NULL); -static -void do_auto_merge( - ecs_world_t *world) -{ - merge_stages(world, false); -} + bootstrap_component(world, table, EcsIdentifier); + bootstrap_component(world, table, EcsComponent); + bootstrap_component(world, table, EcsComponentLifecycle); -static -void do_manual_merge( - ecs_world_t *world) -{ - merge_stages(world, true); -} + bootstrap_component(world, table, EcsType); + bootstrap_component(world, table, EcsQuery); + bootstrap_component(world, table, EcsTrigger); + bootstrap_component(world, table, EcsObserver); + bootstrap_component(world, table, EcsIterable); -bool flecs_defer_none( - ecs_world_t *world, - ecs_stage_t *stage) -{ - (void)world; - return (++ stage->defer) == 1; -} + world->stats.last_component_id = EcsFirstUserComponentId; + world->stats.last_id = EcsFirstUserEntityId; + world->stats.min_id = 0; + world->stats.max_id = 0; -bool flecs_defer_modified( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_id_t id) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpModified; - op->id = id; - op->is._1.entity = entity; - return true; - } else { - stage->defer ++; - } - - return false; -} + /* Populate core module */ + ecs_set_scope(world, EcsFlecsCore); -bool flecs_defer_clone( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_entity_t src, - bool clone_value) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpClone; - op->id = src; - op->is._1.entity = entity; - op->is._1.clone_value = clone_value; - return true; - } else { - stage->defer ++; - } - - return false; -} + flecs_bootstrap_tag(world, EcsName); + flecs_bootstrap_tag(world, EcsSymbol); + flecs_bootstrap_tag(world, EcsAlias); -bool flecs_defer_delete( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpDelete; - op->is._1.entity = entity; - world->delete_count ++; - return true; - } else { - stage->defer ++; - } - return false; -} + flecs_bootstrap_tag(world, EcsModule); + flecs_bootstrap_tag(world, EcsPrivate); + flecs_bootstrap_tag(world, EcsPrefab); + flecs_bootstrap_tag(world, EcsDisabled); -bool flecs_defer_clear( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpClear; - op->is._1.entity = entity; - world->clear_count ++; - return true; - } else { - stage->defer ++; - } - return false; -} + /* Initialize builtin modules */ + ecs_set_name(world, EcsFlecs, "flecs"); + ecs_add_id(world, EcsFlecs, EcsModule); -bool flecs_defer_on_delete_action( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_id_t id, - ecs_entity_t action) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpOnDeleteAction; - op->id = id; - op->is._1.entity = action; - world->clear_count ++; - return true; - } else { - stage->defer ++; - } - return false; -} + ecs_add_pair(world, EcsFlecsCore, EcsChildOf, EcsFlecs); + ecs_set_name(world, EcsFlecsCore, "core"); + ecs_add_id(world, EcsFlecsCore, EcsModule); -bool flecs_defer_enable( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_id_t id, - bool enable) -{ - (void)world; - if (stage->defer) { - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = enable ? EcsOpEnable : EcsOpDisable; - op->is._1.entity = entity; - op->id = id; - return true; - } else { - stage->defer ++; - } - return false; -} + ecs_add_pair(world, EcsFlecsHidden, EcsChildOf, EcsFlecs); + ecs_set_name(world, EcsFlecsHidden, "hidden"); + ecs_add_id(world, EcsFlecsHidden, EcsModule); -bool flecs_defer_bulk_new( - ecs_world_t *world, - ecs_stage_t *stage, - int32_t count, - ecs_id_t id, - const ecs_entity_t **ids_out) -{ - if (stage->defer) { - ecs_entity_t *ids = ecs_os_malloc(count * ECS_SIZEOF(ecs_entity_t)); - world->bulk_new_count ++; + /* Initialize builtin entities */ + bootstrap_entity(world, EcsWorld, "World", EcsFlecsCore); + bootstrap_entity(world, EcsThis, "This", EcsFlecsCore); + bootstrap_entity(world, EcsWildcard, "*", EcsFlecsCore); + bootstrap_entity(world, EcsAny, "_", EcsFlecsCore); - /* Use ecs_new_id as this is thread safe */ - int i; - for (i = 0; i < count; i ++) { - ids[i] = ecs_new_id(world); - } + /* Component/relationship properties */ + flecs_bootstrap_tag(world, EcsTransitive); + flecs_bootstrap_tag(world, EcsReflexive); + flecs_bootstrap_tag(world, EcsSymmetric); + flecs_bootstrap_tag(world, EcsFinal); + flecs_bootstrap_tag(world, EcsDontInherit); + flecs_bootstrap_tag(world, EcsTag); + flecs_bootstrap_tag(world, EcsExclusive); + flecs_bootstrap_tag(world, EcsAcyclic); + flecs_bootstrap_tag(world, EcsWith); - *ids_out = ids; + flecs_bootstrap_tag(world, EcsOnDelete); + flecs_bootstrap_tag(world, EcsOnDeleteObject); + flecs_bootstrap_tag(world, EcsRemove); + flecs_bootstrap_tag(world, EcsDelete); + flecs_bootstrap_tag(world, EcsThrow); - /* Store data in op */ - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = EcsOpBulkNew; - op->id = id; - op->is._n.entities = ids; - op->is._n.count = count; + flecs_bootstrap_tag(world, EcsDefaultChildComponent); - return true; - } else { - stage->defer ++; - } + /* Builtin relations */ + flecs_bootstrap_tag(world, EcsIsA); + flecs_bootstrap_tag(world, EcsChildOf); - return false; -} + /* Builtin events */ + bootstrap_entity(world, EcsOnAdd, "OnAdd", EcsFlecsCore); + bootstrap_entity(world, EcsOnRemove, "OnRemove", EcsFlecsCore); + bootstrap_entity(world, EcsOnSet, "OnSet", EcsFlecsCore); + bootstrap_entity(world, EcsUnSet, "UnSet", EcsFlecsCore); + bootstrap_entity(world, EcsOnTableEmpty, "OnTableEmpty", EcsFlecsCore); + bootstrap_entity(world, EcsOnTableFill, "OnTableFilled", EcsFlecsCore); -bool flecs_defer_new( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_id_t id) -{ - return defer_add_remove(world, stage, EcsOpNew, entity, id); -} + /* Transitive relations are always Acyclic */ + ecs_add_pair(world, EcsTransitive, EcsWith, EcsAcyclic); -bool flecs_defer_add( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_id_t id) -{ - return defer_add_remove(world, stage, EcsOpAdd, entity, id); -} + /* Transitive relations */ + ecs_add_id(world, EcsIsA, EcsTransitive); + ecs_add_id(world, EcsIsA, EcsReflexive); -bool flecs_defer_remove( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_entity_t entity, - ecs_id_t id) -{ - return defer_add_remove(world, stage, EcsOpRemove, entity, id); -} + /* Tag relations (relations that should never have data) */ + ecs_add_id(world, EcsIsA, EcsTag); + ecs_add_id(world, EcsChildOf, EcsTag); + ecs_add_id(world, EcsDefaultChildComponent, EcsTag); -bool flecs_defer_set( - ecs_world_t *world, - ecs_stage_t *stage, - ecs_defer_op_kind_t op_kind, - ecs_entity_t entity, - ecs_id_t id, - ecs_size_t size, - const void *value, - void **value_out, - bool *is_added) -{ - if (stage->defer) { - world->set_count ++; - if (!size) { - const EcsComponent *cptr = flecs_component_from_id(world, id); - ecs_check(cptr != NULL, ECS_INVALID_PARAMETER, NULL); - size = cptr->size; - } + /* Acyclic relations */ + ecs_add_id(world, EcsIsA, EcsAcyclic); + ecs_add_id(world, EcsChildOf, EcsAcyclic); + ecs_add_id(world, EcsWith, EcsAcyclic); - ecs_defer_op_t *op = new_defer_op(stage); - op->kind = op_kind; - op->id = id; - op->is._1.entity = entity; - op->is._1.size = size; - op->is._1.value = ecs_os_malloc(size); + /* Exclusive properties */ + ecs_add_id(world, EcsChildOf, EcsExclusive); + ecs_add_id(world, EcsOnDelete, EcsExclusive); + ecs_add_id(world, EcsOnDeleteObject, EcsExclusive); + ecs_add_id(world, EcsDefaultChildComponent, EcsExclusive); - if (!value) { - value = ecs_get_id(world, entity, id); - if (is_added) { - *is_added = value == NULL; - } - } + /* Make EcsOnAdd, EcsOnSet events iterable to enable .yield_existing */ + ecs_set(world, EcsOnAdd, EcsIterable, { .init = on_event_iterable_init }); + ecs_set(world, EcsOnSet, EcsIterable, { .init = on_event_iterable_init }); - const ecs_type_info_t *ti = NULL; - ecs_entity_t real_id = ecs_get_typeid(world, id); - if (real_id) { - ti = flecs_get_type_info(world, real_id); - } + /* Removal of ChildOf objects (parents) deletes the subject (child) */ + ecs_add_pair(world, EcsChildOf, EcsOnDeleteObject, EcsDelete); - if (value) { - ecs_copy_t copy; - if (ti && (copy = ti->lifecycle.copy_ctor)) { - copy(world, &entity, &entity, op->is._1.value, value, 1, ti); - } else { - ecs_os_memcpy(op->is._1.value, value, size); - } - } else { - ecs_xtor_t ctor; - if (ti && (ctor = ti->lifecycle.ctor)) { - ctor(world, &entity, op->is._1.value, 1, ti); - } - } + /* ChildOf, Identifier, Disabled and Prefab should never be inherited */ + ecs_add_id(world, EcsChildOf, EcsDontInherit); + ecs_add_id(world, ecs_id(EcsIdentifier), EcsDontInherit); - if (value_out) { - *value_out = op->is._1.value; - } + /* The (IsA, *) id record is used often in searches, so cache it */ + world->idr_isa_wildcard = flecs_ensure_id_record(world, + ecs_pair(EcsIsA, EcsWildcard)); - return true; - } else { - stage->defer ++; - } + ecs_trigger_init(world, &(ecs_trigger_desc_t) { + .term = { + .id = ecs_pair(EcsChildOf, EcsWildcard), + .subj.set.mask = EcsSelf + }, + .events = { EcsOnAdd, EcsOnRemove }, + .yield_existing = true, + .callback = on_parent_change + }); -error: - return false; -} + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = EcsFinal, .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_final + }); -void flecs_stage_merge_post_frame( - ecs_world_t *world, - ecs_stage_t *stage) -{ - /* Execute post frame actions */ - ecs_vector_each(stage->post_frame_actions, ecs_action_elem_t, action, { - action->action(world, action->ctx); + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = ecs_pair(EcsOnDelete, EcsWildcard), .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_on_delete }); - ecs_vector_free(stage->post_frame_actions); - stage->post_frame_actions = NULL; -} + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = ecs_pair(EcsOnDeleteObject, EcsWildcard), .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_on_delete_object + }); -void flecs_stage_init( - ecs_world_t *world, - ecs_stage_t *stage) -{ - ecs_poly_assert(world, ecs_world_t); + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = EcsExclusive, .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_exclusive + }); - ecs_poly_init(stage, ecs_stage_t); + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = EcsSymmetric, .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_symmetric + }); - stage->world = world; - stage->thread_ctx = world; - stage->auto_merge = true; - stage->asynchronous = false; -} + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = EcsDontInherit, .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = register_dont_inherit + }); -void flecs_stage_deinit( - ecs_world_t *world, - ecs_stage_t *stage) -{ - (void)world; - ecs_poly_assert(world, ecs_world_t); - ecs_poly_assert(stage, ecs_stage_t); + /* Define trigger to make sure that adding a module to a child entity also + * adds it to the parent. */ + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = EcsModule, .subj.set.mask = EcsSelf }, + .events = {EcsOnAdd}, + .callback = ensure_module_tag + }); + + /* Define trigger for when component lifecycle is set for component */ + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = ecs_id(EcsComponentLifecycle), .subj.set.mask = EcsSelf }, + .events = {EcsOnSet}, + .callback = on_set_component_lifecycle + }); + + /* Define trigger for updating component size when it changes */ + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = ecs_id(EcsComponent), .subj.set.mask = EcsSelf }, + .events = {EcsOnSet}, + .callback = on_set_component + }); + + ecs_add_id(world, EcsDisabled, EcsDontInherit); + ecs_add_id(world, EcsPrefab, EcsDontInherit); - /* Make sure stage has no unmerged data */ - ecs_assert(ecs_vector_count(stage->defer_queue) == 0, - ECS_INTERNAL_ERROR, NULL); + /* Run bootstrap functions for other parts of the code */ + flecs_bootstrap_hierarchy(world); - ecs_poly_fini(stage, ecs_stage_t); + ecs_set_scope(world, 0); - ecs_vector_free(stage->defer_queue); + ecs_log_pop(); } -void ecs_set_stages( - ecs_world_t *world, - int32_t stage_count) +#include +#include + +#define ECS_NAME_BUFFER_LENGTH (64) + +static +bool path_append( + const ecs_world_t *world, + ecs_entity_t parent, + ecs_entity_t child, + const char *sep, + const char *prefix, + ecs_strbuf_t *buf) { ecs_poly_assert(world, ecs_world_t); - ecs_stage_t *stages; - int32_t i, count = ecs_vector_count(world->worker_stages); - - if (count && count != stage_count) { - stages = ecs_vector_first(world->worker_stages, ecs_stage_t); + ecs_entity_t cur = 0; + char buff[22]; + const char *name; - for (i = 0; i < count; i ++) { - /* If stage contains a thread handle, ecs_set_threads was used to - * create the stages. ecs_set_threads and ecs_set_stages should not - * be mixed. */ - ecs_poly_assert(&stages[i], ecs_stage_t); - ecs_check(stages[i].thread == 0, ECS_INVALID_OPERATION, NULL); - flecs_stage_deinit(world, &stages[i]); + if (ecs_is_valid(world, child)) { + cur = ecs_get_object(world, child, EcsChildOf, 0); + if (cur) { + if (cur != parent && (cur != EcsFlecsCore || prefix != NULL)) { + path_append(world, parent, cur, sep, prefix, buf); + ecs_strbuf_appendstr(buf, sep); + } + } else if (prefix) { + ecs_strbuf_appendstr(buf, prefix); } - ecs_vector_free(world->worker_stages); + name = ecs_get_name(world, child); + if (!name || !ecs_os_strlen(name)) { + ecs_os_sprintf(buff, "%u", (uint32_t)child); + name = buff; + } + } else { + ecs_os_sprintf(buff, "%u", (uint32_t)child); + name = buff; } + + ecs_strbuf_appendstr(buf, name); + + return cur != 0; +} + +static +bool is_number( + const char *name) +{ + ecs_assert(name != NULL, ECS_INTERNAL_ERROR, NULL); - if (stage_count) { - world->worker_stages = ecs_vector_new(ecs_stage_t, stage_count); + if (!isdigit(name[0])) { + return false; + } - for (i = 0; i < stage_count; i ++) { - ecs_stage_t *stage = ecs_vector_add( - &world->worker_stages, ecs_stage_t); - flecs_stage_init(world, stage); - stage->id = 1 + i; /* 0 is reserved for main/temp stage */ + ecs_size_t i, length = ecs_os_strlen(name); + for (i = 1; i < length; i ++) { + char ch = name[i]; - /* Set thread_ctx to stage, as this stage might be used in a - * multithreaded context */ - stage->thread_ctx = (ecs_world_t*)stage; + if (!isdigit(ch)) { + break; } - } else { - /* Set to NULL to prevent double frees */ - world->worker_stages = NULL; } - /* Regardless of whether the stage was just initialized or not, when the - * ecs_set_stages function is called, all stages inherit the auto_merge - * property from the world */ - for (i = 0; i < stage_count; i ++) { - ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); - stage->auto_merge = world->stage.auto_merge; - } -error: - return; + return i >= length; } -int32_t ecs_get_stage_count( - const ecs_world_t *world) +static +ecs_entity_t name_to_id( + const ecs_world_t *world, + const char *name) { - world = ecs_get_world(world); - return ecs_vector_count(world->worker_stages); + long int result = atol(name); + ecs_assert(result >= 0, ECS_INTERNAL_ERROR, NULL); + ecs_entity_t alive = ecs_get_alive(world, (ecs_entity_t)result); + if (alive) { + return alive; + } else { + return (ecs_entity_t)result; + } } -int32_t ecs_get_stage_id( - const ecs_world_t *world) +static +ecs_entity_t get_builtin( + const char *name) { - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - - if (ecs_poly_is(world, ecs_stage_t)) { - ecs_stage_t *stage = (ecs_stage_t*)world; - - /* Index 0 is reserved for main stage */ - return stage->id - 1; - } else if (ecs_poly_is(world, ecs_world_t)) { - return 0; - } else { - ecs_throw(ECS_INTERNAL_ERROR, NULL); + if (name[0] == '.' && name[1] == '\0') { + return EcsThis; + } else if (name[0] == '*' && name[1] == '\0') { + return EcsWildcard; + } else if (name[0] == '_' && name[1] == '\0') { + return EcsAny; } -error: + return 0; } -ecs_world_t* ecs_get_stage( - const ecs_world_t *world, - int32_t stage_id) +static +bool is_sep( + const char **ptr, + const char *sep) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(ecs_vector_count(world->worker_stages) > stage_id, - ECS_INVALID_PARAMETER, NULL); + ecs_size_t len = ecs_os_strlen(sep); - return (ecs_world_t*)ecs_vector_get( - world->worker_stages, ecs_stage_t, stage_id); -error: - return NULL; + if (!ecs_os_strncmp(*ptr, sep, len)) { + *ptr += len; + return true; + } else { + return false; + } } -bool ecs_staging_begin( - ecs_world_t *world) +static +const char* path_elem( + const char *path, + const char *sep, + int32_t *len) { - ecs_poly_assert(world, ecs_world_t); + const char *ptr; + char ch; + int32_t template_nesting = 0; + int32_t count = 0; - flecs_process_pending_tables(world); + for (ptr = path; (ch = *ptr); ptr ++) { + if (ch == '<') { + template_nesting ++; + } else if (ch == '>') { + template_nesting --; + } - int32_t i, count = ecs_get_stage_count(world); - for (i = 0; i < count; i ++) { - ecs_world_t *stage = ecs_get_stage(world, i); - ((ecs_stage_t*)stage)->lookup_path = world->stage.lookup_path; - ecs_defer_begin(stage); - } + ecs_check(template_nesting >= 0, ECS_INVALID_PARAMETER, path); - bool is_readonly = world->is_readonly; + if (!template_nesting && is_sep(&ptr, sep)) { + break; + } - /* From this point on, the world is "locked" for mutations, and it is only - * allowed to enqueue commands from stages */ - world->is_readonly = true; + count ++; + } - ecs_dbg_3("staging: begin"); + if (len) { + *len = count; + } - return is_readonly; + if (count) { + return ptr; + } else { + return NULL; + } +error: + return NULL; } -void ecs_staging_end( - ecs_world_t *world) +static +ecs_entity_t get_parent_from_path( + const ecs_world_t *world, + ecs_entity_t parent, + const char **path_ptr, + const char *prefix, + bool new_entity) { - ecs_poly_assert(world, ecs_world_t); - ecs_check(world->is_readonly == true, ECS_INVALID_OPERATION, NULL); + bool start_from_root = false; + const char *path = *path_ptr; + + if (prefix) { + ecs_size_t len = ecs_os_strlen(prefix); + if (!ecs_os_strncmp(path, prefix, len)) { + path += len; + parent = 0; + start_from_root = true; + } + } - /* After this it is safe again to mutate the world directly */ - world->is_readonly = false; + if (!start_from_root && !parent && new_entity) { + parent = ecs_get_scope(world); + } - ecs_dbg_3("staging: end"); + *path_ptr = path; - do_auto_merge(world); -error: - return; + return parent; } -void ecs_merge( - ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - ecs_check(ecs_poly_is(world, ecs_world_t) || - ecs_poly_is(world, ecs_stage_t), ECS_INVALID_PARAMETER, NULL); - do_manual_merge(world); -error: - return; +static +void on_set_symbol(ecs_iter_t *it) { + EcsIdentifier *n = ecs_term(it, EcsIdentifier, 1); + ecs_world_t *world = it->world; + + int i; + for (i = 0; i < it->count; i ++) { + ecs_entity_t e = it->entities[i]; + flecs_name_index_ensure( + &world->symbols, e, n[i].value, n[i].length, n[i].hash); + } } -void ecs_set_automerge( - ecs_world_t *world, - bool auto_merge) -{ - /* If a world is provided, set auto_merge globally for the world. This - * doesn't actually do anything (the main stage never merges) but it serves - * as the default for when stages are created. */ - if (ecs_poly_is(world, ecs_world_t)) { - world->stage.auto_merge = auto_merge; +void flecs_bootstrap_hierarchy(ecs_world_t *world) { + ecs_trigger_init(world, &(ecs_trigger_desc_t){ + .term = {.id = ecs_pair(ecs_id(EcsIdentifier), EcsSymbol), .subj.set.mask = EcsSelf }, + .callback = on_set_symbol, + .events = {EcsOnSet}, + .yield_existing = true + }); +} - /* Propagate change to all stages */ - int i, stage_count = ecs_get_stage_count(world); - for (i = 0; i < stage_count; i ++) { - ecs_stage_t *stage = (ecs_stage_t*)ecs_get_stage(world, i); - stage->auto_merge = auto_merge; - } - /* If a stage is provided, override the auto_merge value for the individual - * stage. This allows an application to control per-stage which stage should - * be automatically merged and which one shouldn't */ - } else { - ecs_poly_assert(world, ecs_stage_t); - ecs_stage_t *stage = (ecs_stage_t*)world; - stage->auto_merge = auto_merge; - } -} +/* Public functions */ -bool ecs_stage_is_readonly( - const ecs_world_t *stage) +void ecs_get_path_w_sep_buf( + const ecs_world_t *world, + ecs_entity_t parent, + ecs_entity_t child, + const char *sep, + const char *prefix, + ecs_strbuf_t *buf) { - const ecs_world_t *world = ecs_get_world(stage); + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_check(buf != NULL, ECS_INVALID_PARAMETER, NULL); - if (ecs_poly_is(stage, ecs_stage_t)) { - if (((ecs_stage_t*)stage)->asynchronous) { - return false; - } + world = ecs_get_world(world); + + if (child == EcsThis) { + ecs_strbuf_appendstr(buf, "."); + return; + } + if (child == EcsWildcard) { + ecs_strbuf_appendstr(buf, "*"); + return; + } + if (child == EcsAny) { + ecs_strbuf_appendstr(buf, "_"); + return; } - if (world->is_readonly) { - if (ecs_poly_is(stage, ecs_world_t)) { - return true; - } + if (!sep) { + sep = "."; + } + + if (!child || parent != child) { + path_append(world, parent, child, sep, prefix, buf); } else { - if (ecs_poly_is(stage, ecs_stage_t)) { - return true; - } + ecs_strbuf_appendstr(buf, ""); } - return false; +error: + return; } -ecs_world_t* ecs_async_stage_new( - ecs_world_t *world) +char* ecs_get_path_w_sep( + const ecs_world_t *world, + ecs_entity_t parent, + ecs_entity_t child, + const char *sep, + const char *prefix) { - ecs_stage_t *stage = ecs_os_calloc(sizeof(ecs_stage_t)); - flecs_stage_init(world, stage); - - stage->id = -1; - stage->auto_merge = false; - stage->asynchronous = true; - - ecs_defer_begin((ecs_world_t*)stage); - - return (ecs_world_t*)stage; + ecs_strbuf_t buf = ECS_STRBUF_INIT; + ecs_get_path_w_sep_buf(world, parent, child, sep, prefix, &buf); + return ecs_strbuf_get(&buf); } -void ecs_async_stage_free( - ecs_world_t *world) +ecs_entity_t ecs_lookup_child( + const ecs_world_t *world, + ecs_entity_t parent, + const char *name) { - ecs_poly_assert(world, ecs_stage_t); - ecs_stage_t *stage = (ecs_stage_t*)world; - ecs_check(stage->asynchronous == true, ECS_INVALID_PARAMETER, NULL); - flecs_stage_deinit(stage->world, stage); - ecs_os_free(stage); -error: - return; -} + ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); -bool ecs_stage_is_async( - ecs_world_t *stage) -{ - if (!stage) { - return false; - } - - if (!ecs_poly_is(stage, ecs_stage_t)) { - return false; + if (is_number(name)) { + return name_to_id(world, name); } - return ((ecs_stage_t*)stage)->asynchronous; -} - -bool ecs_is_deferred( - const ecs_world_t *world) -{ - ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); - const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); - return stage->defer != 0; + ecs_id_t pair = ecs_childof(parent); + ecs_hashmap_t *index = flecs_get_id_name_index(world, pair); + if (index) { + return flecs_name_index_find(index, name, 0, 0); + } else { + return 0; + } error: - return false; + return 0; } -#include -#include - -void ecs_os_api_impl(ecs_os_api_t *api); - -static bool ecs_os_api_initialized = false; -static bool ecs_os_api_initializing = false; -static int ecs_os_api_init_count = 0; +ecs_entity_t ecs_lookup( + const ecs_world_t *world, + const char *name) +{ + if (!name) { + return 0; + } -#ifndef __EMSCRIPTEN__ -ecs_os_api_t ecs_os_api = { - .log_with_color_ = true, - .log_level_ = -1 /* disable tracing by default, but enable >= warnings */ -}; -#else -/* Disable colors by default for emscripten */ -ecs_os_api_t ecs_os_api = { - .log_level_ = -1 -}; -#endif + ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); + world = ecs_get_world(world); -int64_t ecs_os_api_malloc_count = 0; -int64_t ecs_os_api_realloc_count = 0; -int64_t ecs_os_api_calloc_count = 0; -int64_t ecs_os_api_free_count = 0; + ecs_entity_t e = get_builtin(name); + if (e) { + return e; + } -void ecs_os_set_api( - ecs_os_api_t *os_api) -{ - if (!ecs_os_api_initialized) { - ecs_os_api = *os_api; - ecs_os_api_initialized = true; + if (is_number(name)) { + return name_to_id(world, name); } + + e = flecs_name_index_find(&world->aliases, name, 0, 0); + if (e) { + return e; + } + + return ecs_lookup_child(world, 0, name); +error: + return 0; } -void ecs_os_init(void) -{ - if (!ecs_os_api_initialized) { - ecs_os_set_api_defaults(); +ecs_entity_t ecs_lookup_symbol( + const ecs_world_t *world, + const char *name, + bool lookup_as_path) +{ + if (!name) { + return 0; } - - if (!(ecs_os_api_init_count ++)) { - if (ecs_os_api.init_) { - ecs_os_api.init_(); - } + + ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); + world = ecs_get_world(world); + + ecs_entity_t e = flecs_name_index_find(&world->symbols, name, 0, 0); + if (e) { + return e; } -} -void ecs_os_fini(void) { - if (!--ecs_os_api_init_count) { - if (ecs_os_api.fini_) { - ecs_os_api.fini_(); - } + if (lookup_as_path) { + return ecs_lookup_fullpath(world, name); } + +error: + return 0; } -#if !defined(ECS_TARGET_WINDOWS) && !defined(ECS_TARGET_EM) && !defined(ECS_TARGET_ANDROID) -#include -#define ECS_BT_BUF_SIZE 100 -static -void dump_backtrace( - FILE *stream) +ecs_entity_t ecs_lookup_path_w_sep( + const ecs_world_t *world, + ecs_entity_t parent, + const char *path, + const char *sep, + const char *prefix, + bool recursive) { - int nptrs; - void *buffer[ECS_BT_BUF_SIZE]; - char **strings; + if (!path) { + return 0; + } + + if (!sep) { + sep = "."; + } - nptrs = backtrace(buffer, ECS_BT_BUF_SIZE); + ecs_check(world != NULL, ECS_INTERNAL_ERROR, NULL); + const ecs_world_t *stage = world; + world = ecs_get_world(world); - strings = backtrace_symbols(buffer, nptrs); - if (strings == NULL) { - return; + ecs_entity_t e = get_builtin(path); + if (e) { + return e; } - for (int j = 3; j < nptrs; j++) { - fprintf(stream, "%s\n", strings[j]); + e = flecs_name_index_find(&world->aliases, path, 0, 0); + if (e) { + return e; } - free(strings); -} -#else -static -void dump_backtrace( - FILE *stream) -{ - (void)stream; -} -#endif + char buff[ECS_NAME_BUFFER_LENGTH]; + const char *ptr, *ptr_start; + char *elem = buff; + int32_t len, size = ECS_NAME_BUFFER_LENGTH; + ecs_entity_t cur; + bool lookup_path_search = false; -static -void log_msg( - int32_t level, - const char *file, - int32_t line, - const char *msg) -{ - FILE *stream; - if (level >= 0) { - stream = stdout; - } else { - stream = stderr; + ecs_entity_t *lookup_path = ecs_get_lookup_path(stage); + ecs_entity_t *lookup_path_cur = lookup_path; + while (lookup_path_cur && *lookup_path_cur) { + lookup_path_cur ++; } - if (level >= 0) { - if (level == 0) { - if (ecs_os_api.log_with_color_) fputs(ECS_MAGENTA, stream); - } else { - if (ecs_os_api.log_with_color_) fputs(ECS_GREY, stream); - } - fputs("info", stream); - } else if (level == -2) { - if (ecs_os_api.log_with_color_) fputs(ECS_YELLOW, stream); - fputs("warning", stream); - } else if (level == -3) { - if (ecs_os_api.log_with_color_) fputs(ECS_RED, stream); - fputs("error", stream); - } else if (level == -4) { - if (ecs_os_api.log_with_color_) fputs(ECS_RED, stream); - fputs("fatal", stream); + if (!sep) { + sep = "."; } - if (ecs_os_api.log_with_color_) fputs(ECS_NORMAL, stream); - fputs(": ", stream); + parent = get_parent_from_path(stage, parent, &path, prefix, true); - if (level >= 0) { - if (ecs_os_api.log_indent_) { - char indent[32]; - int i, indent_count = ecs_os_api.log_indent_; - if (indent_count > 15) indent_count = 15; +retry: + cur = parent; + ptr_start = ptr = path; - for (i = 0; i < indent_count; i ++) { - indent[i * 2] = '|'; - indent[i * 2 + 1] = ' '; + while ((ptr = path_elem(ptr, sep, &len))) { + if (len < size) { + ecs_os_memcpy(elem, ptr_start, len); + } else { + if (size == ECS_NAME_BUFFER_LENGTH) { + elem = NULL; } - if (ecs_os_api.log_indent_ != indent_count) { - indent[i * 2 - 2] = '+'; - } + elem = ecs_os_realloc(elem, len + 1); + ecs_os_memcpy(elem, ptr_start, len); + size = len + 1; + } - indent[i * 2] = '\0'; + elem[len] = '\0'; + ptr_start = ptr; - fputs(indent, stream); + cur = ecs_lookup_child(world, cur, elem); + if (!cur) { + goto tail; } } - if (level < 0) { - if (file) { - const char *file_ptr = strrchr(file, '/'); - if (!file_ptr) { - file_ptr = strrchr(file, '\\'); - } - - if (file_ptr) { - file = file_ptr + 1; +tail: + if (!cur && recursive) { + if (!lookup_path_search) { + if (parent) { + parent = ecs_get_object(world, parent, EcsChildOf, 0); + goto retry; + } else { + lookup_path_search = true; } - - fputs(file, stream); - fputs(": ", stream); } - if (line) { - fprintf(stream, "%d: ", line); + if (lookup_path_search) { + if (lookup_path_cur != lookup_path) { + lookup_path_cur --; + parent = lookup_path_cur[0]; + goto retry; + } } } - fputs(msg, stream); - - fputs("\n", stream); - - if (level == -4) { - dump_backtrace(stream); + if (elem != buff) { + ecs_os_free(elem); } -} -void ecs_os_dbg( - const char *file, - int32_t line, - const char *msg) -{ - if (ecs_os_api.log_) { - ecs_os_api.log_(1, file, line, msg); - } + return cur; +error: + return 0; } -void ecs_os_trace( - const char *file, - int32_t line, - const char *msg) +ecs_entity_t ecs_set_scope( + ecs_world_t *world, + ecs_entity_t scope) { - if (ecs_os_api.log_) { - ecs_os_api.log_(0, file, line, msg); - } -} + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_stage_t *stage = flecs_stage_from_world(&world); -void ecs_os_warn( - const char *file, - int32_t line, - const char *msg) -{ - if (ecs_os_api.log_) { - ecs_os_api.log_(-2, file, line, msg); - } -} + ecs_entity_t cur = stage->scope; + stage->scope = scope; -void ecs_os_err( - const char *file, - int32_t line, - const char *msg) -{ - if (ecs_os_api.log_) { - ecs_os_api.log_(-3, file, line, msg); - } + return cur; +error: + return 0; } -void ecs_os_fatal( - const char *file, - int32_t line, - const char *msg) +ecs_entity_t ecs_get_scope( + const ecs_world_t *world) { - if (ecs_os_api.log_) { - ecs_os_api.log_(-4, file, line, msg); - } + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); + return stage->scope; +error: + return 0; } -static -void ecs_os_gettime(ecs_time_t *time) { - ecs_assert(ecs_os_has_time() == true, ECS_MISSING_OS_API, NULL); - - uint64_t now = ecs_os_now(); - uint64_t sec = now / 1000000000; - - assert(sec < UINT32_MAX); - assert((now - sec * 1000000000) < UINT32_MAX); +ecs_entity_t* ecs_set_lookup_path( + ecs_world_t *world, + const ecs_entity_t *lookup_path) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + ecs_stage_t *stage = flecs_stage_from_world(&world); - time->sec = (uint32_t)sec; - time->nanosec = (uint32_t)(now - sec * 1000000000); -} + ecs_entity_t *cur = stage->lookup_path; + stage->lookup_path = (ecs_entity_t*)lookup_path; -static -void* ecs_os_api_malloc(ecs_size_t size) { - ecs_os_api_malloc_count ++; - ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); - return malloc((size_t)size); + return cur; +error: + return NULL; } -static -void* ecs_os_api_calloc(ecs_size_t size) { - ecs_os_api_calloc_count ++; - ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); - return calloc(1, (size_t)size); +ecs_entity_t* ecs_get_lookup_path( + const ecs_world_t *world) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); + const ecs_stage_t *stage = flecs_stage_from_readonly_world(world); + return stage->lookup_path; +error: + return NULL; } -static -void* ecs_os_api_realloc(void *ptr, ecs_size_t size) { - ecs_assert(size > 0, ECS_INVALID_PARAMETER, NULL); - - if (ptr) { - ecs_os_api_realloc_count ++; - } else { - /* If not actually reallocing, treat as malloc */ - ecs_os_api_malloc_count ++; - } - - return realloc(ptr, (size_t)size); +const char* ecs_set_name_prefix( + ecs_world_t *world, + const char *prefix) +{ + ecs_poly_assert(world, ecs_world_t); + const char *old_prefix = world->name_prefix; + world->name_prefix = prefix; + return old_prefix; } -static -void ecs_os_api_free(void *ptr) { - if (ptr) { - ecs_os_api_free_count ++; - } - free(ptr); -} +ecs_entity_t ecs_add_path_w_sep( + ecs_world_t *world, + ecs_entity_t entity, + ecs_entity_t parent, + const char *path, + const char *sep, + const char *prefix) +{ + ecs_check(world != NULL, ECS_INVALID_PARAMETER, NULL); -static -char* ecs_os_api_strdup(const char *str) { - if (str) { - int len = ecs_os_strlen(str); - char *result = ecs_os_malloc(len + 1); - ecs_assert(result != NULL, ECS_OUT_OF_MEMORY, NULL); - ecs_os_strcpy(result, str); - return result; - } else { - return NULL; - } -} + if (!sep) { + sep = "."; + } -/* Replace dots with underscores */ -static -char *module_file_base(const char *module, char sep) { - char *base = ecs_os_strdup(module); - ecs_size_t i, len = ecs_os_strlen(base); - for (i = 0; i < len; i ++) { - if (base[i] == '.') { - base[i] = sep; + if (!path) { + if (!entity) { + entity = ecs_new_id(world); } - } - - return base; -} - -static -char* ecs_os_api_module_to_dl(const char *module) { - ecs_strbuf_t lib = ECS_STRBUF_INIT; - /* Best guess, use module name with underscores + OS library extension */ - char *file_base = module_file_base(module, '_'); + if (parent) { + ecs_add_pair(world, entity, EcsChildOf, entity); + } -# if defined(ECS_TARGET_LINUX) || defined(ECS_TARGET_FREEBSD) - ecs_strbuf_appendstr(&lib, "lib"); - ecs_strbuf_appendstr(&lib, file_base); - ecs_strbuf_appendstr(&lib, ".so"); -# elif defined(ECS_TARGET_DARWIN) - ecs_strbuf_appendstr(&lib, "lib"); - ecs_strbuf_appendstr(&lib, file_base); - ecs_strbuf_appendstr(&lib, ".dylib"); -# elif defined(ECS_TARGET_WINDOWS) - ecs_strbuf_appendstr(&lib, file_base); - ecs_strbuf_appendstr(&lib, ".dll"); -# endif + return entity; + } - ecs_os_free(file_base); + parent = get_parent_from_path(world, parent, &path, prefix, entity == 0); - return ecs_strbuf_get(&lib); -} + char buff[ECS_NAME_BUFFER_LENGTH]; + const char *ptr = path; + const char *ptr_start = path; + char *elem = buff; + int32_t len, size = ECS_NAME_BUFFER_LENGTH; -static -char* ecs_os_api_module_to_etc(const char *module) { - ecs_strbuf_t lib = ECS_STRBUF_INIT; + ecs_entity_t cur = parent; - /* Best guess, use module name with dashes + /etc */ - char *file_base = module_file_base(module, '-'); + char *name = NULL; - ecs_strbuf_appendstr(&lib, file_base); - ecs_strbuf_appendstr(&lib, "/etc"); + while ((ptr = path_elem(ptr, sep, &len))) { + if (len < size) { + ecs_os_memcpy(elem, ptr_start, len); + } else { + if (size == ECS_NAME_BUFFER_LENGTH) { + elem = NULL; + } - ecs_os_free(file_base); + elem = ecs_os_realloc(elem, len + 1); + ecs_os_memcpy(elem, ptr_start, len); + size = len + 1; + } - return ecs_strbuf_get(&lib); -} + elem[len] = '\0'; + ptr_start = ptr; -void ecs_os_set_api_defaults(void) -{ - /* Don't overwrite if already initialized */ - if (ecs_os_api_initialized != 0) { - return; - } + ecs_entity_t e = ecs_lookup_child(world, cur, elem); + if (!e) { + if (name) { + ecs_os_free(name); + } - if (ecs_os_api_initializing != 0) { - return; - } + name = ecs_os_strdup(elem); - ecs_os_api_initializing = true; - - /* Memory management */ - ecs_os_api.malloc_ = ecs_os_api_malloc; - ecs_os_api.free_ = ecs_os_api_free; - ecs_os_api.realloc_ = ecs_os_api_realloc; - ecs_os_api.calloc_ = ecs_os_api_calloc; + /* If this is the last entity in the path, use the provided id */ + bool last_elem = false; + if (!path_elem(ptr, sep, NULL)) { + e = entity; + last_elem = true; + } - /* Strings */ - ecs_os_api.strdup_ = ecs_os_api_strdup; + if (!e) { + if (last_elem) { + ecs_entity_t prev = ecs_set_scope(world, 0); + e = ecs_new(world, 0); + ecs_set_scope(world, prev); + } else { + e = ecs_new_id(world); + } + } - /* Time */ - ecs_os_api.get_time_ = ecs_os_gettime; + if (cur) { + ecs_add_pair(world, e, EcsChildOf, cur); + } - /* Logging */ - ecs_os_api.log_ = log_msg; + ecs_set_name(world, e, name); + } - /* Modules */ - if (!ecs_os_api.module_to_dl_) { - ecs_os_api.module_to_dl_ = ecs_os_api_module_to_dl; + cur = e; } - if (!ecs_os_api.module_to_etc_) { - ecs_os_api.module_to_etc_ = ecs_os_api_module_to_etc; + if (entity && (cur != entity)) { + ecs_throw(ECS_ALREADY_DEFINED, name); } - ecs_os_api.abort_ = abort; - -# ifdef FLECS_OS_API_IMPL - /* Initialize defaults to OS API IMPL addon, but still allow for overriding - * by the application */ - ecs_set_os_api_impl(); - ecs_os_api_initialized = false; -# endif - - ecs_os_api_initializing = false; -} - -bool ecs_os_has_heap(void) { - return - (ecs_os_api.malloc_ != NULL) && - (ecs_os_api.calloc_ != NULL) && - (ecs_os_api.realloc_ != NULL) && - (ecs_os_api.free_ != NULL); -} - -bool ecs_os_has_threading(void) { - return - (ecs_os_api.mutex_new_ != NULL) && - (ecs_os_api.mutex_free_ != NULL) && - (ecs_os_api.mutex_lock_ != NULL) && - (ecs_os_api.mutex_unlock_ != NULL) && - (ecs_os_api.cond_new_ != NULL) && - (ecs_os_api.cond_free_ != NULL) && - (ecs_os_api.cond_wait_ != NULL) && - (ecs_os_api.cond_signal_ != NULL) && - (ecs_os_api.cond_broadcast_ != NULL) && - (ecs_os_api.thread_new_ != NULL) && - (ecs_os_api.thread_join_ != NULL); -} - -bool ecs_os_has_time(void) { - return - (ecs_os_api.get_time_ != NULL) && - (ecs_os_api.sleep_ != NULL) && - (ecs_os_api.now_ != NULL) && - (ecs_os_api.enable_high_timer_resolution_ != NULL); -} - -bool ecs_os_has_logging(void) { - return (ecs_os_api.log_ != NULL); -} + if (name) { + ecs_os_free(name); + } -bool ecs_os_has_dl(void) { - return - (ecs_os_api.dlopen_ != NULL) && - (ecs_os_api.dlproc_ != NULL) && - (ecs_os_api.dlclose_ != NULL); -} + if (elem != buff) { + ecs_os_free(elem); + } -bool ecs_os_has_modules(void) { - return - (ecs_os_api.module_to_dl_ != NULL) && - (ecs_os_api.module_to_etc_ != NULL); + return cur; +error: + return 0; } -void ecs_os_enable_high_timer_resolution(bool enable) { - if (ecs_os_api.enable_high_timer_resolution_) { - ecs_os_api.enable_high_timer_resolution_(enable); - } else { - ecs_assert(enable == false, ECS_MISSING_OS_API, - "enable_high_timer_resolution"); +ecs_entity_t ecs_new_from_path_w_sep( + ecs_world_t *world, + ecs_entity_t parent, + const char *path, + const char *sep, + const char *prefix) +{ + if (!sep) { + sep = "."; } -} - -#if defined(ECS_TARGET_WINDOWS) -static char error_str[255]; -#endif -const char* ecs_os_strerror(int err) { -# if defined(ECS_TARGET_WINDOWS) - strerror_s(error_str, 255, err); - return error_str; -# else - return strerror(err); -# endif + return ecs_add_path_w_sep(world, 0, parent, path, sep, prefix); } diff --git a/flecs.h b/flecs.h index b5c1fc6ce..d0df84285 100644 --- a/flecs.h +++ b/flecs.h @@ -3598,8 +3598,6 @@ typedef struct EcsComponentLifecycle { ecs_copy_t copy; /* copy assignment */ ecs_move_t move; /* move assignment */ - void *ctx; /* User defined context */ - /* Ctor + copy */ ecs_copy_t copy_ctor; @@ -3627,14 +3625,17 @@ typedef struct EcsComponentLifecycle { * This callback is invoked after the triggers are invoked, and before the * destructor is invoked. */ ecs_iter_action_t on_remove; + + /* User defined context */ + void *ctx; } EcsComponentLifecycle; /** Type that contains component information (passed to ctors/dtors/...) */ struct ecs_type_info_t { - EcsComponentLifecycle lifecycle; - ecs_entity_t component; ecs_size_t size; ecs_size_t alignment; + EcsComponentLifecycle lifecycle; + ecs_entity_t component; bool lifecycle_set; }; diff --git a/include/flecs.h b/include/flecs.h index 38eadc7aa..00bf78f1d 100644 --- a/include/flecs.h +++ b/include/flecs.h @@ -863,8 +863,6 @@ typedef struct EcsComponentLifecycle { ecs_copy_t copy; /* copy assignment */ ecs_move_t move; /* move assignment */ - void *ctx; /* User defined context */ - /* Ctor + copy */ ecs_copy_t copy_ctor; @@ -892,14 +890,17 @@ typedef struct EcsComponentLifecycle { * This callback is invoked after the triggers are invoked, and before the * destructor is invoked. */ ecs_iter_action_t on_remove; + + /* User defined context */ + void *ctx; } EcsComponentLifecycle; /** Type that contains component information (passed to ctors/dtors/...) */ struct ecs_type_info_t { - EcsComponentLifecycle lifecycle; - ecs_entity_t component; ecs_size_t size; ecs_size_t alignment; + EcsComponentLifecycle lifecycle; + ecs_entity_t component; bool lifecycle_set; }; diff --git a/src/private_types.h b/src/private_types.h index 05cb5dabe..7470ead2b 100644 --- a/src/private_types.h +++ b/src/private_types.h @@ -203,7 +203,7 @@ struct ecs_table_t { ecs_graph_node_t node; /* Graph node */ ecs_data_t storage; /* Component storage */ - ecs_type_info_t **type_info; /* Cached pointers to type info */ + ecs_type_info_t *type_info; /* Cached pointers to type info */ int32_t *dirty_state; /* Keep track of changes in columns */ int32_t alloc_count; /* Increases when columns are reallocd */ diff --git a/src/table.c b/src/table.c index 5c7df16de..9066ca4f8 100644 --- a/src/table.c +++ b/src/table.c @@ -47,16 +47,12 @@ void check_table_sanity(ecs_table_t *table) { } for (i = 0; i < storage_count; i ++) { - ecs_type_info_t *ti = NULL; + ecs_type_info_t *ti = &table->type_info[i]; ecs_column_t *column = &table->storage.columns[i]; - if (table->type_info) { - ti = table->type_info[i]; - } - if (ti) { - ecs_assert(ti->size == column->size, ECS_INTERNAL_ERROR, NULL); - ecs_assert(ti->alignment == column->alignment, - ECS_INTERNAL_ERROR, NULL); - } + + ecs_assert(ti->size == column->size, ECS_INTERNAL_ERROR, NULL); + ecs_assert(ti->alignment == column->alignment, + ECS_INTERNAL_ERROR, NULL); ecs_assert(size == ecs_vector_size(column->data), ECS_INTERNAL_ERROR, NULL); ecs_assert(count == ecs_vector_count(column->data), @@ -290,7 +286,7 @@ void init_type_info( ecs_id_t *ids = ecs_vector_first(type, ecs_id_t); int32_t i, count = ecs_vector_count(type); - table->type_info = ecs_os_calloc_n(ecs_type_info_t*, count); + table->type_info = ecs_os_calloc_n(ecs_type_info_t, count); for (i = 0; i < count; i ++) { ecs_id_t id = ids[i]; @@ -300,7 +296,7 @@ void init_type_info( const ecs_type_info_t *ti = flecs_get_type_info(world, t); ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); table->flags |= type_info_flags(ti); - table->type_info[i] = (ecs_type_info_t*)ti; + table->type_info[i] = *ti; } } @@ -438,9 +434,11 @@ void ctor_component( int32_t row, int32_t count) { + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + /* A new component is constructed */ - ecs_xtor_t ctor; - if (ti && (ctor = ti->lifecycle.ctor)) { + ecs_xtor_t ctor = ti->lifecycle.ctor; + if (ctor) { int16_t size = column->size; int16_t alignment = column->alignment; void *ptr = ecs_vector_get_t(column->data, size, alignment, row); @@ -490,11 +488,9 @@ void dtor_component( int32_t count, bool is_remove) { - if (!count) { - return; - } + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); - if (!ti) { + if (!count) { return; } @@ -559,18 +555,14 @@ void dtor_all_components( /* Run on_remove callbacks in bulk for improved performance */ for (c = 0; c < column_count; c++) { ecs_column_t *column = &data->columns[c]; - ecs_type_info_t *cdata = table->type_info[c]; - if (!cdata) { - continue; - } - - ecs_iter_action_t on_remove = cdata->lifecycle.on_remove; + ecs_type_info_t *ti = &table->type_info[c]; + ecs_iter_action_t on_remove = ti->lifecycle.on_remove; if (on_remove) { ecs_size_t size = column->size; ecs_size_t align = column->alignment; void *ptr = ecs_vector_get_t(column->data, size, align, row); on_remove_component(world, table, on_remove, ptr, column->size, - &entities[row], ids[c], count, cdata->lifecycle.ctx); + &entities[row], ids[c], count, ti->lifecycle.ctx); } } @@ -580,7 +572,7 @@ void dtor_all_components( for (i = row; i < end; i ++) { for (c = 0; c < column_count; c++) { ecs_column_t *column = &data->columns[c]; - dtor_component(world, table, table->type_info[c], column, + dtor_component(world, table, &table->type_info[c], column, entities, ids[c], i, 1, false); } @@ -1046,6 +1038,8 @@ void grow_column( int32_t new_size, bool construct) { + ecs_assert(ti != NULL, ECS_INTERNAL_ERROR, NULL); + ecs_vector_t *vec = column->data; int16_t alignment = column->alignment; @@ -1060,8 +1054,7 @@ void grow_column( /* If the array could possibly realloc and the component has a move action * defined, move old elements manually */ ecs_move_t move_ctor; - if (ti && count && can_realloc && - (move_ctor = ti->lifecycle.move_ctor)) + if (count && can_realloc && (move_ctor = ti->lifecycle.move_ctor)) { ecs_xtor_t ctor = ti->lifecycle.ctor; ecs_assert(ctor != NULL, ECS_INTERNAL_ERROR, NULL); @@ -1096,7 +1089,7 @@ void grow_column( void *elem = ecs_vector_addn_t(&vec, size, alignment, to_add); ecs_xtor_t ctor; - if (construct && ti && (ctor = ti->lifecycle.ctor)) { + if (construct && (ctor = ti->lifecycle.ctor)) { /* If new elements need to be constructed and component has a * constructor, construct */ ctor(world, &entities[count], elem, to_add, ti); @@ -1155,18 +1148,14 @@ int32_t grow_data( ecs_os_memset(r, 0, ECS_SIZEOF(ecs_record_t*) * to_add); /* Add elements to each column array */ - ecs_type_info_t **c_info_array = table->type_info; + ecs_type_info_t *type_info = table->type_info; ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); for (i = 0; i < column_count; i ++) { ecs_column_t *column = &columns[i]; ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); - ecs_type_info_t *c_info = NULL; - if (c_info_array) { - c_info = c_info_array[i]; - } - - grow_column(world, entities, column, c_info, to_add, size, true); + ecs_type_info_t *ti = &type_info[i]; + grow_column(world, entities, column, ti, to_add, size, true); ecs_assert(ecs_vector_size(columns[i].data) == size, ECS_INTERNAL_ERROR, NULL); } @@ -1266,7 +1255,7 @@ int32_t flecs_table_append( ecs_sw_column_t *sw_columns = table->storage.sw_columns; ecs_bs_column_t *bs_columns = table->storage.bs_columns; - ecs_type_info_t **c_info_array = table->type_info; + ecs_type_info_t *type_info = table->type_info; ecs_entity_t *entities = ecs_vector_first( data->entities, ecs_entity_t); @@ -1281,17 +1270,12 @@ int32_t flecs_table_append( ecs_column_t *column = &columns[i]; ecs_assert(column->size != 0, ECS_INTERNAL_ERROR, NULL); - ecs_type_info_t *c_info = NULL; - if (c_info_array) { - c_info = c_info_array[i]; - } - - grow_column(world, entities, column, c_info, 1, size, construct); + ecs_type_info_t *ti = &type_info[i]; + grow_column(world, entities, column, ti, 1, size, construct); ecs_assert( ecs_vector_size(columns[i].data) == ecs_vector_size(data->entities), ECS_INTERNAL_ERROR, NULL); - ecs_assert( ecs_vector_count(columns[i].data) == ecs_vector_count(data->entities), ECS_INTERNAL_ERROR, NULL); @@ -1407,7 +1391,7 @@ void flecs_table_delete( } /* Destruct component data */ - ecs_type_info_t **c_info_array = table->type_info; + ecs_type_info_t *type_info = table->type_info; ecs_column_t *columns = data->columns; int32_t column_count = ecs_vector_count(table->storage_type); int32_t i; @@ -1431,11 +1415,9 @@ void flecs_table_delete( /* Last element, destruct & remove */ if (index == count) { /* If table has component destructors, invoke */ - if (destruct && (table->flags & EcsTableHasDtors)) { - ecs_assert(c_info_array != NULL, ECS_INTERNAL_ERROR, NULL); - + if (destruct && (table->flags & EcsTableHasDtors)) { for (i = 0; i < column_count; i ++) { - ecs_type_info_t *ti = c_info_array[i]; + ecs_type_info_t *ti = &type_info[i]; if (!ti) { continue; } @@ -1451,8 +1433,6 @@ void flecs_table_delete( } else { /* If table has component destructors, invoke */ if (destruct && (table->flags & (EcsTableHasDtors | EcsTableHasMove))) { - ecs_assert(c_info_array != NULL, ECS_INTERNAL_ERROR, NULL); - for (i = 0; i < column_count; i ++) { ecs_column_t *column = &columns[i]; ecs_size_t size = column->size; @@ -1460,18 +1440,17 @@ void flecs_table_delete( ecs_vector_t *vec = column->data; void *dst = ecs_vector_get_t(vec, size, align, index); void *src = ecs_vector_last_t(vec, size, align); - - ecs_type_info_t *ti = c_info_array[i]; + ecs_type_info_t *ti = &type_info[i]; - ecs_iter_action_t on_remove; - if (ti && (on_remove = ti->lifecycle.on_remove)) { + ecs_iter_action_t on_remove = ti->lifecycle.on_remove; + if (on_remove) { on_remove_component(world, table, on_remove, dst, size, &entity_to_delete, ids[i], 1, ti->lifecycle.ctx); } - ecs_move_t move_dtor; - if (ti && (move_dtor = ti->lifecycle.move_dtor)) { + ecs_move_t move_dtor = ti->lifecycle.move_dtor; + if (move_dtor) { move_dtor(world, &entity_to_move, &entity_to_delete, dst, src, 1, ti); } else { @@ -1593,6 +1572,9 @@ void flecs_table_move( ecs_type_t new_type = new_table->storage_type; ecs_type_t old_type = old_table->storage_type; + ecs_type_info_t *new_type_info = new_table->type_info; + ecs_type_info_t *old_type_info = old_table->type_info; + int32_t i_new = 0, new_column_count = ecs_vector_count(new_table->storage_type); int32_t i_old = 0, old_column_count = ecs_vector_count(old_table->storage_type); ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); @@ -1621,18 +1603,18 @@ void flecs_table_move( ecs_assert(dst != NULL, ECS_INTERNAL_ERROR, NULL); ecs_assert(src != NULL, ECS_INTERNAL_ERROR, NULL); - ecs_type_info_t *ti = new_table->type_info[i_new]; + ecs_type_info_t *ti = &new_type_info[i_new]; if (same_entity) { - ecs_move_t callback; - if (ti && (callback = ti->lifecycle.ctor_move_dtor)) { + ecs_move_t callback = ti->lifecycle.ctor_move_dtor; + if (callback) { /* ctor + move + dtor */ callback(world, &dst_entity, &src_entity, dst, src, 1, ti); } else { ecs_os_memcpy(dst, src, size); } } else { - ecs_copy_t copy; - if (ti && (copy = ti->lifecycle.copy_ctor)) { + ecs_copy_t copy = ti->lifecycle.copy_ctor; + if (copy) { copy(world, &dst_entity, &src_entity, dst, src, 1, ti); } else { ecs_os_memcpy(dst, src, size); @@ -1641,11 +1623,11 @@ void flecs_table_move( } else { if (new_component < old_component) { if (construct) { - ctor_component(world, new_table->type_info[i_new], + ctor_component(world, &new_type_info[i_new], &new_columns[i_new], &dst_entity, new_index, 1); } } else { - dtor_component(world, old_table, old_table->type_info[i_old], + dtor_component(world, old_table, &old_type_info[i_old], &old_columns[i_old], &src_entity, old_component, old_index, 1, true); } @@ -1657,13 +1639,13 @@ void flecs_table_move( if (construct) { for (; (i_new < new_column_count); i_new ++) { - ctor_component(world, new_table->type_info[i_new], + ctor_component(world, &new_type_info[i_new], &new_columns[i_new], &dst_entity, new_index, 1); } } for (; (i_old < old_column_count); i_old ++) { - dtor_component(world, old_table, old_table->type_info[i_old], + dtor_component(world, old_table, &old_type_info[i_old], &old_columns[i_old], &src_entity, old_components[i_old], old_index, 1, true); } @@ -1876,7 +1858,7 @@ void merge_column( ecs_vector_t *src) { ecs_entity_t *entities = ecs_vector_first(data->entities, ecs_entity_t); - ecs_type_info_t *ti = table->type_info[column_id]; + ecs_type_info_t *ti = &table->type_info[column_id]; ecs_column_t *column = &data->columns[column_id]; ecs_vector_t *dst = column->data; int16_t size = column->size; @@ -1898,9 +1880,7 @@ void merge_column( column->data = dst; /* Construct new values */ - if (ti) { - ctor_component(world, ti, column, entities, dst_count, src_count); - } + ctor_component(world, ti, column, entities, dst_count, src_count); void *dst_ptr = ecs_vector_first_t(dst, size, alignment); void *src_ptr = ecs_vector_first_t(src, size, alignment); @@ -1908,8 +1888,8 @@ void merge_column( dst_ptr = ECS_OFFSET(dst_ptr, size * dst_count); /* Move values into column */ - ecs_move_t move; - if (ti && (move = ti->lifecycle.move)) { + ecs_move_t move = ti->lifecycle.move; + if (move) { move(world, entities, entities, dst_ptr, src_ptr, src_count, ti); } else { ecs_os_memcpy(dst_ptr, src_ptr, size * src_count); @@ -1936,6 +1916,9 @@ void merge_table_data( ecs_entity_t *new_components = ecs_vector_first(new_type, ecs_entity_t); ecs_entity_t *old_components = ecs_vector_first(old_type, ecs_entity_t); + ecs_type_info_t *new_type_info = new_table->type_info; + ecs_type_info_t *old_type_info = old_table->type_info; + ecs_column_t *old_columns = old_data->columns; ecs_column_t *new_columns = new_data->columns; @@ -1988,22 +1971,18 @@ void merge_table_data( old_count + new_count); /* Construct new values */ - ecs_type_info_t *c_info = new_table->type_info[i_new]; - if (c_info) { - ctor_component(world, c_info, column, - entities, 0, old_count + new_count); - } + ecs_type_info_t *ti = &new_type_info[i_new]; + ctor_component(world, ti, column, + entities, 0, old_count + new_count); i_new ++; } else if (new_component > old_component) { ecs_column_t *column = &old_columns[i_old]; /* Destruct old values */ - ecs_type_info_t *c_info = old_table->type_info[i_old]; - if (c_info) { - dtor_component(world, old_table, c_info, column, - entities, 0, 0, old_count, false); - } + ecs_type_info_t *ti = &old_type_info[i_old]; + dtor_component(world, old_table, ti, column, + entities, 0, 0, old_count, false); /* Old column does not occur in new table, remove */ ecs_vector_free(column->data); @@ -2029,11 +2008,8 @@ void merge_table_data( old_count + new_count); /* Construct new values */ - ecs_type_info_t *c_info = new_table->type_info[i_new]; - if (c_info) { - ctor_component(world, c_info, column, - entities, 0, old_count + new_count); - } + ecs_type_info_t *ti = &new_type_info[i_new]; + ctor_component(world, ti, column, entities, 0, old_count + new_count); } /* Destroy remaining columns */ @@ -2041,11 +2017,9 @@ void merge_table_data( ecs_column_t *column = &old_columns[i_old]; /* Destruct old values */ - ecs_type_info_t *c_info = old_table->type_info[i_old]; - if (c_info) { - dtor_component(world, old_table, c_info, column, entities, 0, - 0, old_count, false); - } + ecs_type_info_t *ti = &old_type_info[i_old]; + dtor_component(world, old_table, ti, column, entities, 0, + 0, old_count, false); /* Old column does not occur in new table, remove */ ecs_vector_free(column->data);