[script] Incremental updates

Author: SanderMertens

distr/flecs.c

@@ -17073,6 +17073,41 @@ char* ecs_script_ast_to_str(
     ecs_script_t *script,
     bool colors);
 
+/** Used with ecs_script_ast_to_buf_w_desc() and ecs_script_ast_to_str_w_desc(). */
+typedef struct ecs_script_ast_to_str_desc_t {
+    bool colors;       /**< Include ANSI color codes in the output. */
+    bool annotations;  /**< Include incremental update annotations. When set,
+                        * nodes are annotated with the source position, prop
+                        * dependency masks, slots and scope slot ranges used
+                        * for incrementally updating template instances. */
+} ecs_script_ast_to_str_desc_t;
+
+/** Convert script AST to string.
+ * Same as ecs_script_ast_to_buf(), but with additional options.
+ *
+ * @param script The script.
+ * @param buf The buffer to write to.
+ * @param desc String conversion options.
+ * @return Zero if success, non-zero if failed.
+ */
+FLECS_API
+int ecs_script_ast_to_buf_w_desc(
+    ecs_script_t *script,
+    ecs_strbuf_t *buf,
+    const ecs_script_ast_to_str_desc_t *desc);
+
+/** Convert script AST to string.
+ * Same as ecs_script_ast_to_str(), but with additional options.
+ *
+ * @param script The script.
+ * @param desc String conversion options.
+ * @return The string if success, NULL if failed.
+ */
+FLECS_API
+char* ecs_script_ast_to_str_w_desc(
+    ecs_script_t *script,
+    const ecs_script_ast_to_str_desc_t *desc);
+
 /* Managed scripts (script associated with entity that outlives the function) */
 
 /** Used with ecs_script_init(). */

distr/flecs.h

@@ -327,6 +327,41 @@ char* ecs_script_ast_to_str(
     ecs_script_t *script,
     bool colors);
 
+/** Used with ecs_script_ast_to_buf_w_desc() and ecs_script_ast_to_str_w_desc(). */
+typedef struct ecs_script_ast_to_str_desc_t {
+    bool colors;       /**< Include ANSI color codes in the output. */
+    bool annotations;  /**< Include incremental update annotations. When set,
+                        * nodes are annotated with the source position, prop
+                        * dependency masks, slots and scope slot ranges used
+                        * for incrementally updating template instances. */
+} ecs_script_ast_to_str_desc_t;
+
+/** Convert script AST to string.
+ * Same as ecs_script_ast_to_buf(), but with additional options.
+ *
+ * @param script The script.
+ * @param buf The buffer to write to.
+ * @param desc String conversion options.
+ * @return Zero if success, non-zero if failed.
+ */
+FLECS_API
+int ecs_script_ast_to_buf_w_desc(
+    ecs_script_t *script,
+    ecs_strbuf_t *buf,
+    const ecs_script_ast_to_str_desc_t *desc);
+
+/** Convert script AST to string.
+ * Same as ecs_script_ast_to_str(), but with additional options.
+ *
+ * @param script The script.
+ * @param desc String conversion options.
+ * @return The string if success, NULL if failed.
+ */
+FLECS_API
+char* ecs_script_ast_to_str_w_desc(
+    ecs_script_t *script,
+    const ecs_script_ast_to_str_desc_t *desc);
+
 
 /* Managed scripts (script associated with entity that outlives the function) */
 

include/flecs/addons/script.h

@@ -69,6 +69,7 @@ flecs_src = files(
     'src/addons/query_dsl/parser.c',
     'src/addons/rest.c',
     'src/addons/script/template.c',
+    'src/addons/script/template_check.c',
     'src/addons/script/ast.c',
     'src/addons/script/function.c',
     'src/addons/script/functions_builtin.c',

meson.build

@@ -34,6 +34,8 @@ typedef enum ecs_script_node_kind_t {
 typedef struct ecs_script_node_t {
     ecs_script_node_kind_t kind;
     const char *pos;
+    uint64_t depends_on;
+    bool contains_entities;
 } ecs_script_node_t;
 
 struct ecs_script_scope_t {
@@ -45,6 +47,13 @@ struct ecs_script_scope_t {
     /* Array with component ids that are added in scope. Used to limit
      * archetype moves. */
     ecs_vec_t components; /* vec<ecs_id_t> */
+
+    int32_t slot_start;
+    int32_t slot_end;
+    int32_t dyn_start;
+    int32_t dyn_end;
+    int32_t control_start;
+    int32_t control_end;
 };
 
 typedef struct ecs_script_id_t {
@@ -66,6 +75,9 @@ typedef struct ecs_script_id_t {
      * for entities that are defined inside of templates, which have different
      * values for each instantiation. */
     bool dynamic;
+
+    int32_t target_slot;
+    int32_t id_slot;
 } ecs_script_id_t;
 
 typedef struct ecs_script_tag_t {
@@ -107,12 +119,17 @@ struct ecs_script_entity_t {
     ecs_script_entity_t *parent;
     ecs_entity_t eval;
     ecs_entity_t eval_kind;
+
+    int32_t slot;
+    int32_t dyn_slot;
+    uint64_t name_depends_on;
 };
 
 typedef struct ecs_script_with_t {
     ecs_script_node_t node;
     ecs_script_scope_t *expressions;
     ecs_script_scope_t *scope;
+    uint64_t expr_depends_on;
 } ecs_script_with_t;
 
 typedef struct ecs_script_inherit_t {
@@ -124,6 +141,7 @@ typedef struct ecs_script_pair_scope_t {
     ecs_script_node_t node;
     ecs_script_id_t id;
     ecs_script_scope_t *scope;
+    uint64_t expr_depends_on;
 } ecs_script_pair_scope_t;
 
 typedef struct ecs_script_using_t {
@@ -160,6 +178,8 @@ typedef struct ecs_script_if_t {
     ecs_script_scope_t *if_true;
     ecs_script_scope_t *if_false;
     ecs_expr_node_t *expr;
+    uint64_t expr_depends_on;
+    int32_t control_slot;
 } ecs_script_if_t;
 
 typedef struct ecs_script_for_range_t {
@@ -168,6 +188,12 @@ typedef struct ecs_script_for_range_t {
     ecs_expr_node_t *from;
     ecs_expr_node_t *to;
     ecs_script_scope_t *scope;
+    uint64_t expr_depends_on;
+
+    /* Set when the loop contains a pair with a dynamic element that is added
+     * to a persistent entity. Such pairs can't be tracked per slot, so the
+     * matching wildcard is cleared before the loop is re-evaluated. */
+    bool has_clear_ids;
 } ecs_script_for_range_t;
 
 typedef struct ecs_script_include_t {

src/addons/script/ast.h

@@ -955,10 +955,20 @@ int flecs_expr_new_visit_eval(
     ecs_script_eval_visitor_t temp_v = {0};
     ecs_script_eval_desc_t desc = {0};
 
+    if (v && v->template) {
+        if (ecs_script_visit_node(v, node->entity)) {
+            return -1;
+        }
+
+        *(ecs_entity_t*)out->value.ptr = 0;
+        out->value.type = ecs_id(ecs_entity_t);
+        return 0;
+    }
+
     if (!v) {
-        /* Safe const cast, script won't modify variables since it only contains 
+        /* Safe const cast, script won't modify variables since it only contains
          * an entity statement. */
-        desc.vars = ctx->desc ? 
+        desc.vars = ctx->desc ?
             ECS_CONST_CAST(ecs_script_vars_t*, ctx->desc->vars) : NULL;
         flecs_script_eval_visit_init(
             (const ecs_script_impl_t*)ctx->script, &temp_v, &desc);

src/addons/script/expr/visit_eval.c

@@ -722,8 +722,16 @@ template_stmt: {
 
         Parse(
             // template SpaceShip {
-            case '{':
-                return flecs_script_scope(parser, template->scope, pos);
+            case '{': {
+                pos = flecs_script_scope(parser, template->scope, pos);
+                if (!pos) {
+                    goto error;
+                }
+                if (flecs_script_template_check(parser, template)) {
+                    goto error;
+                }
+                return pos;
+            }
 
             // template SpaceShip\n
             EcsTokEndOfStatement: