#124 implement event data API

SanderMertens · Dec 13, 2021 · 8506832 · 8506832
1 parent caddd3a
commit 8506832
Show file tree

Hide file tree

Showing 11 changed files with 225 additions and 28 deletions.
diff --git a/flecs.c b/flecs.c
@@ -13884,7 +13884,7 @@ void ecs_emit(
         .other_table = desc->other_table,
         .offset = row,
         .count = count,
-        .param = desc->param
+        .param = (void*)desc->param
     };
 
     world->event_id ++;

diff --git a/flecs.h b/flecs.h
@@ -5881,7 +5881,7 @@ typedef struct ecs_event_desc_t {
     int32_t count;
 
     /* Optional context. Assigned to iter param member */
-    void *param;
+    const void *param;
 
     /* Observable (usually the world) */
     ecs_poly_t *observable;
@@ -11392,8 +11392,9 @@ using filter_m_world = filter_m<flecs::world>;
 namespace flecs {
 
 // Event builder interface
-struct event_builder {
-    event_builder(flecs::world_t *world, flecs::entity_t event) 
+template <typename Base, typename E>
+struct event_builder_base {
+    event_builder_base(flecs::world_t *world, flecs::entity_t event)
         : m_world(world)
         , m_desc{}
         , m_ids{}
@@ -11404,23 +11405,23 @@ struct event_builder {
 
     /** Add component to trigger on */
     template <typename T>
-    event_builder& id() {
+    Base& id() {
         m_ids.array = m_ids_array;
         m_ids.array[m_ids.count] = _::cpp_type<T>().id(m_world);
         m_ids.count ++;
         return *this;
     }
 
     /** Add (component) id to trigger on */
-    event_builder& id(flecs::id_t id) {
+    Base& id(flecs::id_t id) {
         m_ids.array = m_ids_array;
         m_ids.array[m_ids.count] = id;
         m_ids.count ++;
         return *this;
     }
 
     /** Set entity for which to trigger */
-    event_builder& entity(flecs::entity_t e) {
+    Base& entity(flecs::entity_t e) {
         ecs_record_t *r = ecs_record_find(m_world, e);
 
         /* can't trigger for empty entity */
@@ -11434,13 +11435,19 @@ struct event_builder {
     }
 
     /* Set table for which to trigger */
-    event_builder& table(flecs::table_t *t, int32_t offset = 0, int32_t count = 0) {
+    Base& table(flecs::table_t *t, int32_t offset = 0, int32_t count = 0) {
         m_desc.table = t;
         m_desc.offset = offset;
         m_desc.count = count;
         return *this;
     }
 
+    /* Set event data */
+    Base& ctx(const E* ptr) {
+        m_desc.param = ptr;
+        return *this;
+    }
+
     void emit() {
         ecs_assert(m_ids.count != 0, ECS_INVALID_PARAMETER, NULL);
         ecs_assert(m_desc.table != nullptr, ECS_INVALID_PARAMETER, NULL);
@@ -11450,11 +11457,36 @@ struct event_builder {
         ecs_emit(m_world, &m_desc);
     }
 
-private:
+protected:
     flecs::world_t *m_world;
     ecs_event_desc_t m_desc;
     flecs::ids_t m_ids;
     flecs::id_t m_ids_array[ECS_EVENT_DESC_ID_COUNT_MAX];
+
+private:
+    operator Base&() {
+        return *static_cast<Base*>(this);
+    }
+};
+
+struct event_builder : event_builder_base<event_builder, void> {
+    using event_builder_base::event_builder_base;
+};
+
+template <typename E>
+struct event_builder_typed : event_builder_base<event_builder_typed<E>, E> {
+private:
+    using Class = event_builder_typed<E>;
+    using Base = event_builder_base<Class, E>;
+
+public:
+    using Base::event_builder_base;
+
+    /* Set event data */
+    Class& ctx(const E& ptr) {
+        this->m_desc.param = &ptr;
+        return *this;
+    }
 };
 
 }
@@ -11464,6 +11496,9 @@ namespace flecs {
 
 struct event_builder;
 
+template <typename E>
+struct event_builder_typed;
+
 template<typename T>
 struct event_m : mixin<T> { };
 
@@ -11474,16 +11509,19 @@ struct event_m<flecs::world> : mixin<flecs::world> {
 
   /** Create a new event.
    * 
+   * @param evt The event id.
+   * @param ctx (Optional) user data for event.
    * @return Event builder.
    */
-  flecs::event_builder event(flecs::entity_t event) const;
+  flecs::event_builder event(flecs::entity_t evt) const;
 
   /** Create a new event.
    * 
+   * @tparam E The event type.
    * @return Event builder.
    */
   template <typename E>
-  flecs::event_builder event() const;
+  flecs::event_builder_typed<E> event() const;
 };
 
 using event_m_world = event_m<flecs::world>;
@@ -13515,6 +13553,15 @@ struct iter {
         return m_iter->param;
     }
 
+    /** Access param. 
+     * param contains the pointer passed to the param argument of system::run
+     */
+    template <typename T>
+    T* param() {
+        /* TODO: type check */
+        return static_cast<T*>(m_iter->param);
+    }
+
     /** Obtain mutable handle to entity being iterated over.
      *
      * @param row Row being iterated over.
@@ -17883,8 +17930,8 @@ inline flecs::event_builder event_m_world::event(flecs::entity_t evt) const {
 }
 
 template <typename E>
-inline flecs::event_builder event_m_world::event() const {
-    return flecs::event_builder(this->me(), _::cpp_type<E>().id(this->me()));
+inline flecs::event_builder_typed<E> event_m_world::event() const {
+    return flecs::event_builder_typed<E>(this->me(), _::cpp_type<E>().id(this->me()));
 }
 
 } // namespace flecs

diff --git a/include/flecs.h b/include/flecs.h
@@ -2982,7 +2982,7 @@ typedef struct ecs_event_desc_t {
     int32_t count;
 
     /* Optional context. Assigned to iter param member */
-    void *param;
+    const void *param;
 
     /* Observable (usually the world) */
     ecs_poly_t *observable;

diff --git a/include/flecs/addons/cpp/iter.hpp b/include/flecs/addons/cpp/iter.hpp
@@ -219,6 +219,15 @@ struct iter {
         return m_iter->param;
     }
 
+    /** Access param. 
+     * param contains the pointer passed to the param argument of system::run
+     */
+    template <typename T>
+    T* param() {
+        /* TODO: type check */
+        return static_cast<T*>(m_iter->param);
+    }
+
     /** Obtain mutable handle to entity being iterated over.
      *
      * @param row Row being iterated over.

diff --git a/include/flecs/addons/cpp/mixins/event/builder.hpp b/include/flecs/addons/cpp/mixins/event/builder.hpp
@@ -5,8 +5,9 @@
 namespace flecs {
 
 // Event builder interface
-struct event_builder {
-    event_builder(flecs::world_t *world, flecs::entity_t event) 
+template <typename Base, typename E>
+struct event_builder_base {
+    event_builder_base(flecs::world_t *world, flecs::entity_t event)
         : m_world(world)
         , m_desc{}
         , m_ids{}
@@ -17,23 +18,23 @@ struct event_builder {
 
     /** Add component to trigger on */
     template <typename T>
-    event_builder& id() {
+    Base& id() {
         m_ids.array = m_ids_array;
         m_ids.array[m_ids.count] = _::cpp_type<T>().id(m_world);
         m_ids.count ++;
         return *this;
     }
 
     /** Add (component) id to trigger on */
-    event_builder& id(flecs::id_t id) {
+    Base& id(flecs::id_t id) {
         m_ids.array = m_ids_array;
         m_ids.array[m_ids.count] = id;
         m_ids.count ++;
         return *this;
     }
 
     /** Set entity for which to trigger */
-    event_builder& entity(flecs::entity_t e) {
+    Base& entity(flecs::entity_t e) {
         ecs_record_t *r = ecs_record_find(m_world, e);
 
         /* can't trigger for empty entity */
@@ -47,13 +48,19 @@ struct event_builder {
     }
 
     /* Set table for which to trigger */
-    event_builder& table(flecs::table_t *t, int32_t offset = 0, int32_t count = 0) {
+    Base& table(flecs::table_t *t, int32_t offset = 0, int32_t count = 0) {
         m_desc.table = t;
         m_desc.offset = offset;
         m_desc.count = count;
         return *this;
     }
 
+    /* Set event data */
+    Base& ctx(const E* ptr) {
+        m_desc.param = ptr;
+        return *this;
+    }
+
     void emit() {
         ecs_assert(m_ids.count != 0, ECS_INVALID_PARAMETER, NULL);
         ecs_assert(m_desc.table != nullptr, ECS_INVALID_PARAMETER, NULL);
@@ -63,11 +70,36 @@ struct event_builder {
         ecs_emit(m_world, &m_desc);
     }
 
-private:
+protected:
     flecs::world_t *m_world;
     ecs_event_desc_t m_desc;
     flecs::ids_t m_ids;
     flecs::id_t m_ids_array[ECS_EVENT_DESC_ID_COUNT_MAX];
+
+private:
+    operator Base&() {
+        return *static_cast<Base*>(this);
+    }
+};
+
+struct event_builder : event_builder_base<event_builder, void> {
+    using event_builder_base::event_builder_base;
+};
+
+template <typename E>
+struct event_builder_typed : event_builder_base<event_builder_typed<E>, E> {
+private:
+    using Class = event_builder_typed<E>;
+    using Base = event_builder_base<Class, E>;
+
+public:
+    using Base::event_builder_base;
+
+    /* Set event data */
+    Class& ctx(const E& ptr) {
+        this->m_desc.param = &ptr;
+        return *this;
+    }
 };
 
 }
diff --git a/include/flecs/addons/cpp/mixins/event/decl.hpp b/include/flecs/addons/cpp/mixins/event/decl.hpp
@@ -6,6 +6,9 @@ namespace flecs {
 
 struct event_builder;
 
+template <typename E>
+struct event_builder_typed;
+
 template<typename T>
 struct event_m : mixin<T> { };
 
@@ -16,16 +19,19 @@ struct event_m<flecs::world> : mixin<flecs::world> {
 
   /** Create a new event.
    * 
+   * @param evt The event id.
+   * @param ctx (Optional) user data for event.
    * @return Event builder.
    */
-  flecs::event_builder event(flecs::entity_t event) const;
+  flecs::event_builder event(flecs::entity_t evt) const;
 
   /** Create a new event.
    * 
+   * @tparam E The event type.
    * @return Event builder.
    */
   template <typename E>
-  flecs::event_builder event() const;
+  flecs::event_builder_typed<E> event() const;
 };
 
 using event_m_world = event_m<flecs::world>;

diff --git a/include/flecs/addons/cpp/mixins/event/impl.hpp b/include/flecs/addons/cpp/mixins/event/impl.hpp
@@ -12,8 +12,8 @@ inline flecs::event_builder event_m_world::event(flecs::entity_t evt) const {
 }
 
 template <typename E>
-inline flecs::event_builder event_m_world::event() const {
-    return flecs::event_builder(this->me(), _::cpp_type<E>().id(this->me()));
+inline flecs::event_builder_typed<E> event_m_world::event() const {
+    return flecs::event_builder_typed<E>(this->me(), _::cpp_type<E>().id(this->me()));
 }
 
 } // namespace flecs
diff --git a/src/observable.c b/src/observable.c
@@ -116,7 +116,7 @@ void ecs_emit(
         .other_table = desc->other_table,
         .offset = row,
         .count = count,
-        .param = desc->param
+        .param = (void*)desc->param
     };
 
     world->event_id ++;

diff --git a/test/cpp_api/project.json b/test/cpp_api/project.json
@@ -345,7 +345,10 @@
                 "evt_2_ids_table",
                 "evt_type",
                 "evt_1_component",
-                "evt_2_components"
+                "evt_2_components",
+                "evt_void_ctx",
+                "evt_typed_ctx",
+                "evt_implicit_typed_ctx"
             ]
         }, {
             "id": "Trigger",