on_replace: always set both fields, expose other_table for prior-presence check

Updated: set_fields is now always (1 << 2) - 1, ecs_table_has_id call removed. other_table is still set to the pre-operation table so callers that need to know whether the component existed can check it on demand.

Author: Indra-db

distr/flecs.c

@@ -7031,7 +7031,7 @@ void flecs_invoke_replace_hook(
     it.offset = 0; /* Don't set row because we don't want to offset ptrs */
     it.flags = EcsIterIsValid;
     it.other_table = prev_table;
-    it.set_fields = (prev_table != NULL && ecs_table_has_id(world, prev_table, id)) ? 3 : 2;
+    it.set_fields = (1 << 2) - 1;
 
     ti->hooks.on_replace(&it);
 
@@ -18987,6 +18987,8 @@ void ecs_remove_all(
     flecs_journal_end();
 }
 
+#include <time.h>
+
 void ecs_os_api_impl(ecs_os_api_t *api);
 
 static bool ecs_os_api_initialized = false;
@@ -41123,6 +41125,8 @@ void flecs_component_update_childof_depth(
     flecs_component_update_childof_w_depth(world, cr, new_depth);
 }
 
+#include <inttypes.h>
+
 ecs_entity_index_page_t* flecs_entity_index_ensure_page(
     ecs_entity_index_t *index,
     uint32_t id)
@@ -47839,6 +47843,8 @@ ecs_table_t* ecs_table_find(
     return flecs_table_ensure(world, &type, false, NULL);
 }
 
+#include <errno.h>
+
 #ifdef FLECS_HTTP
 
 #ifndef FLECS_HTTP_IMPL_H
@@ -56789,6 +56795,7 @@ int ecs_meta_from_desc(
 #endif
 
 #include <ctype.h>
+#include <inttypes.h>
 
 #ifdef FLECS_META
 #ifdef FLECS_QUERY_DSL
@@ -69670,6 +69677,8 @@ void FlecsScriptImport(
 
 #endif
 
+#include <inttypes.h>
+
 #ifdef FLECS_SCRIPT
 
 static

distr/flecs.h

@@ -4659,7 +4659,10 @@ struct ecs_type_hooks_t {
     /** Callback that is invoked with the existing and new value before the
      * value is assigned. Invoked after on_add and before on_set. Registering
      * an on_replace hook prevents using operations that return a mutable
-     * pointer to the component, like get_mut(), ensure(), and emplace(). */
+     * pointer to the component, like get_mut(), ensure(), and emplace().
+     * The iterator's other_table field is set to the table of the entity
+     * before the operation. To find out whether the component existed before
+     * the operation, call ecs_table_has_id() on other_table. */
     ecs_iter_action_t on_replace;
 
     /** Callback that is invoked before the on_set/OnSet hooks and observers are

distr/flecs_no_addons.c

@@ -6966,7 +6966,7 @@ void flecs_invoke_replace_hook(
     it.offset = 0; /* Don't set row because we don't want to offset ptrs */
     it.flags = EcsIterIsValid;
     it.other_table = prev_table;
-    it.set_fields = (prev_table != NULL && ecs_table_has_id(world, prev_table, id)) ? 3 : 2;
+    it.set_fields = (1 << 2) - 1;
 
     ti->hooks.on_replace(&it);
 
@@ -18835,6 +18835,8 @@ void ecs_remove_all(
     flecs_journal_end();
 }
 
+#include <time.h>
+
 void ecs_os_api_impl(ecs_os_api_t *api);
 
 static bool ecs_os_api_initialized = false;
@@ -32926,6 +32928,8 @@ void flecs_component_update_childof_depth(
     flecs_component_update_childof_w_depth(world, cr, new_depth);
 }
 
+#include <inttypes.h>
+
 ecs_entity_index_page_t* flecs_entity_index_ensure_page(
     ecs_entity_index_t *index,
     uint32_t id)
@@ -39642,6 +39646,8 @@ ecs_table_t* ecs_table_find(
     return flecs_table_ensure(world, &type, false, NULL);
 }
 
+#include <errno.h>
+
 #ifndef FLECS_SCRIPT_PRIVATE_H
 #define FLECS_SCRIPT_PRIVATE_H
 
@@ -39807,6 +39813,7 @@ int64_t flecs_parser_errpos(
 #endif
 
 #include <ctype.h>
+#include <inttypes.h>
 
 #ifndef FLECS_META_TYPE_SUPPORT_H
 #define FLECS_META_TYPE_SUPPORT_H
@@ -40766,6 +40773,8 @@ void ecs_set_os_api_impl(void) {
 
 #endif
 
+#include <inttypes.h>
+
 #ifndef FLECS_STATS_PRIVATE_H
 #define FLECS_STATS_PRIVATE_H
 

distr/flecs_no_addons.h

@@ -4632,7 +4632,10 @@ struct ecs_type_hooks_t {
     /** Callback that is invoked with the existing and new value before the
      * value is assigned. Invoked after on_add and before on_set. Registering
      * an on_replace hook prevents using operations that return a mutable
-     * pointer to the component, like get_mut(), ensure(), and emplace(). */
+     * pointer to the component, like get_mut(), ensure(), and emplace().
+     * The iterator's other_table field is set to the table of the entity
+     * before the operation. To find out whether the component existed before
+     * the operation, call ecs_table_has_id() on other_table. */
     ecs_iter_action_t on_replace;
 
     /** Callback that is invoked before the on_set/OnSet hooks and observers are

include/flecs.h

@@ -1013,7 +1013,10 @@ struct ecs_type_hooks_t {
     /** Callback that is invoked with the existing and new value before the
      * value is assigned. Invoked after on_add and before on_set. Registering
      * an on_replace hook prevents using operations that return a mutable
-     * pointer to the component, like get_mut(), ensure(), and emplace(). */
+     * pointer to the component, like get_mut(), ensure(), and emplace().
+     * The iterator's other_table field is set to the table of the entity
+     * before the operation. To find out whether the component existed before
+     * the operation, call ecs_table_has_id() on other_table. */
     ecs_iter_action_t on_replace;
 
     /** Callback that is invoked before the on_set/OnSet hooks and observers are

src/component_actions.c

@@ -107,7 +107,7 @@ void flecs_invoke_replace_hook(
     it.offset = 0; /* Don't set row because we don't want to offset ptrs */
     it.flags = EcsIterIsValid;
     it.other_table = prev_table;
-    it.set_fields = (prev_table != NULL && ecs_table_has_id(world, prev_table, id)) ? 3 : 2;
+    it.set_fields = (1 << 2) - 1;
 
     ti->hooks.on_replace(&it);
 

test/core/src/ComponentLifecycle.c

@@ -4581,11 +4581,10 @@ void ComponentLifecycle_on_replace_other_table_new_entity(void) {
     ecs_set(world, e, Position, {10, 20});
     test_int(ctx.invoked, 1);
 
-    /* prev_table captured before flecs_ensure: root table, no Position.
-     * set_fields=2: bit 0 unset (no old value), bit 1 set (new value). */
+    /* prev_table captured before flecs_ensure: root table, no Position. */
     test_assert(ctx.other_table == prev);
-    test_assert(!(ctx.set_fields & 1));
-    test_assert(ctx.set_fields & 2);
+    test_assert(ctx.set_fields == 3);
+    test_assert(!ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
 
     ecs_fini(world);
 }
@@ -4612,10 +4611,10 @@ void ComponentLifecycle_on_replace_other_table_existing_entity(void) {
     ecs_set(world, e, Position, {10, 20});
     test_int(ctx.invoked, 1);
 
-    /* prev_table = {Velocity} before ensure; set_fields=2: Position not yet in prev. */
+    /* prev_table = {Velocity} before ensure: Position not yet in prev. */
     test_assert(ctx.other_table == prev);
-    test_assert(!(ctx.set_fields & 1));
-    test_assert(ctx.set_fields & 2);
+    test_assert(ctx.set_fields == 3);
+    test_assert(!ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
 
     ecs_fini(world);
 }
@@ -4643,9 +4642,10 @@ void ComponentLifecycle_on_replace_other_table_set_existing(void) {
     ecs_set(world, e, Position, {11, 21});
     test_int(ctx.invoked, 1);
 
-    /* prev_table = {Position} (unchanged by ensure); set_fields=3: Position in prev. */
+    /* prev_table = {Position} (unchanged by ensure): Position in prev. */
     test_assert(ctx.other_table == table_with_pos);
     test_assert(ctx.set_fields == 3);
+    test_assert(ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
 
     ecs_fini(world);
 }
@@ -4675,11 +4675,10 @@ void ComponentLifecycle_on_replace_other_table_batched_new_entity(void) {
     ecs_defer_end(world);
     test_int(ctx.invoked, 1);
 
-    /* Batch flush second-pass: uses start_table (root, no Position).
-     * set_fields=2: bit 0 unset because start_table lacks Position. */
+    /* Batch flush second-pass: uses start_table (root, no Position). */
     test_assert(ctx.other_table == start_table);
-    test_assert(!(ctx.set_fields & 1));
-    test_assert(ctx.set_fields & 2);
+    test_assert(ctx.set_fields == 3);
+    test_assert(!ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
 
     ecs_fini(world);
 }
@@ -4712,6 +4711,7 @@ void ComponentLifecycle_on_replace_other_table_batched_existing(void) {
     test_int(ctx.invoked, 1);
     test_assert(ctx.other_table == table_with_pos);
     test_assert(ctx.set_fields == 3);
+    test_assert(ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
     ecs_defer_end(world);
 
     ecs_fini(world);
@@ -4730,16 +4730,15 @@ void ComponentLifecycle_on_replace_other_table_entity_init(void) {
         .ctx = &ctx,
     });
 
-    /* init_table = r->table before any components added (root, no Position).
-     * set_fields=2: bit 0 unset, new add. */
+    /* init_table = r->table before any components added (root, no Position). */
     ecs_entity_t e = ecs_entity(world, {
         .set = ecs_values(ecs_value(Position, {10, 20}))
     });
     test_int(ctx.invoked, 1);
 
     test_assert(ctx.other_table != ecs_get_table(world, e));
-    test_assert(!(ctx.set_fields & 1));
-    test_assert(ctx.set_fields & 2);
+    test_assert(ctx.set_fields == 3);
+    test_assert(!ecs_table_has_id(world, ctx.other_table, ecs_id(Position)));
 
     ecs_fini(world);
 }

test/cpp/src/Entity.cpp

@@ -6697,10 +6697,10 @@ void Entity_on_replace_other_table_set_new(void) {
     e.set(Position{10, 20});
     test_int(ctx.invoked, 1);
 
-    /* prev captured before ensure: root table, no Position -> bit 0 unset */
+    /* prev captured before ensure: root table, no Position */
     test_assert(ctx.other_table == prev);
-    test_assert(!(ctx.set_fields & 1));
-    test_assert(ctx.set_fields & 2);
+    test_assert(ctx.set_fields == 3);
+    test_assert(!ecs_table_has_id(world, ctx.other_table, pos_id));
 }
 
 void Entity_on_replace_other_table_set_existing(void) {
@@ -6724,9 +6724,10 @@ void Entity_on_replace_other_table_set_existing(void) {
     e.set(Position{11, 21});
     test_int(ctx.invoked, 1);
 
-    /* Entity already had Position -> other_table == {Position} table, both bits set */
+    /* Entity already had Position -> other_table == {Position} table */
     test_assert(ctx.other_table == table_with_pos);
     test_assert(ctx.set_fields == 3);
+    test_assert(ecs_table_has_id(world, ctx.other_table, pos_id));
 }
 
 void Entity_on_replace_other_table_assign_new(void) {
@@ -6749,9 +6750,10 @@ void Entity_on_replace_other_table_assign_new(void) {
     e.assign(Position{10, 20});
     test_int(ctx.invoked, 1);
 
-    /* assign requires component to already exist; other_table == {Position}, both bits set */
+    /* assign requires component to already exist; other_table == {Position} */
     test_assert(ctx.other_table == table_with_pos);
     test_assert(ctx.set_fields == 3);
+    test_assert(ecs_table_has_id(world, ctx.other_table, pos_id));
 }
 
 void Entity_on_replace_other_table_assign_existing(void) {
@@ -6775,9 +6777,10 @@ void Entity_on_replace_other_table_assign_existing(void) {
     e.assign(Position{11, 21});
     test_int(ctx.invoked, 1);
 
-    /* Replacing existing via assign: other_table == {Position}, both bits set */
+    /* Replacing existing via assign: other_table == {Position} */
     test_assert(ctx.other_table == table_with_pos);
     test_assert(ctx.set_fields == 3);
+    test_assert(ecs_table_has_id(world, ctx.other_table, pos_id));
 }
 
 void Entity_set_lvalue_to_mutable(void) {