Split off query DSL parser into separate addon

SanderMertens · SanderMertens · commit 8ef3e0ac8188 · 2025-02-05T14:58:08.000-08:00
diff --git a/distr/flecs.c b/distr/flecs.c
diff --git a/distr/flecs.h b/distr/flecs.h
@@ -191,17 +191,19 @@
 // #define FLECS_C           /**< C API convenience macros, always enabled */
 #define FLECS_CPP            /**< C++ API */
 #define FLECS_DOC            /**< Document entities & components */
-// #define FLECS_JOURNAL     /**< Journaling addon (disabled by default) */
+// #define FLECS_JOURNAL     /**< Journaling addon */
 #define FLECS_JSON           /**< Parsing JSON to/from component values */
 #define FLECS_HTTP           /**< Tiny HTTP server for connecting to remote UI */
 #define FLECS_LOG            /**< When enabled ECS provides more detailed logs */
 #define FLECS_META           /**< Reflection support */
 #define FLECS_METRICS        /**< Expose component data as statistics */
 #define FLECS_MODULE         /**< Module support */
 #define FLECS_OS_API_IMPL    /**< Default implementation for OS API */
-// #define FLECS_PERF_TRACE  /**< Enable performance tracing (disabled by default) */
+// #define FLECS_PERF_TRACE  /**< Enable performance tracing */
 #define FLECS_PIPELINE       /**< Pipeline support */
 #define FLECS_REST           /**< REST API for querying application data */
+#define FLECS_PARSER         /**< Utilities for script and query DSL parsers */
+#define FLECS_QUERY_DSL      /**< Flecs query DSL parser */
 #define FLECS_SCRIPT         /**< Flecs entity notation language */
 // #define FLECS_SCRIPT_MATH /**< Math functions for flecs script (may require linking with libm) */
 #define FLECS_SYSTEM         /**< System support */
@@ -10473,6 +10475,12 @@ int ecs_value_move_ctor(
 #ifdef FLECS_NO_SCRIPT
 #undef FLECS_SCRIPT
 #endif
+#ifdef FLECS_NO_PARSER
+#undef FLECS_PARSER
+#endif
+#ifdef FLECS_NO_QUERY_DSL
+#undef FLECS_QUERY_DSL
+#endif
 #ifdef FLECS_NO_SCRIPT_MATH
 #undef FLECS_SCRIPT_MATH
 #endif
@@ -13535,8 +13543,8 @@ void FlecsAlertsImport(
 #define FLECS_META
 #endif
 
-#ifndef FLECS_SCRIPT
-#define FLECS_SCRIPT
+#ifndef FLECS_QUERY_DSL
+#define FLECS_QUERY_DSL /* For parsing component id expressions */
 #endif
 
 #ifndef FLECS_JSON_H
@@ -14377,6 +14385,21 @@ void FlecsScriptMathImport(
 
 #endif
 
+#ifdef FLECS_PARSER
+#ifdef FLECS_NO_PARSER
+#error "FLECS_NO_PARSER failed: PARSER is required by other addons"
+#endif
+#endif
+
+#ifdef FLECS_QUERY_DSL
+#ifdef FLECS_NO_QUERY_DSL
+#error "FLECS_NO_QUERY_DSL failed: QUERY_DSL is required by other addons"
+#endif
+#ifndef FLECS_PARSER
+#define FLECS_PARSER
+#endif
+#endif
+
 #ifdef FLECS_SCRIPT
 #ifdef FLECS_NO_SCRIPT
 #error "FLECS_NO_SCRIPT failed: SCRIPT is required by other addons"
@@ -14406,6 +14429,9 @@ void FlecsScriptMathImport(
 #define FLECS_DOC
 #endif
 
+#ifndef FLECS_PARSER
+#define FLECS_PARSER
+#endif
 
 #ifndef FLECS_SCRIPT_H
 #define FLECS_SCRIPT_H
diff --git a/docs/Quickstart.md b/docs/Quickstart.md
@@ -119,7 +119,8 @@ Addon         | Description                                      | Define
 [Doc](/flecs/group__c__addons__doc.html)                   | Add documentation to components, systems & more  | FLECS_DOC           |
 [Http](/flecs/group__c__addons__http.html)                 | Tiny HTTP server for processing simple requests  | FLECS_HTTP          |
 [Rest](/flecs/group__c__addons__rest.html)                 | REST API for showing entities in the browser     | FLECS_REST          |
-[Parser](/flecs/group__c__addons__parser.html)             | Parser utilities used by script & query DSL      | FLECS_PARSER        |
+Parser                                                     | Parser utilities used by script & query DSL      | FLECS_PARSER        |
+[Query DSL](https://www.flecs.dev/flecs/md_docs_2FlecsQueryLanguage.html) | Query DSL parser                  | FLECS_QUERY_DSL     |
 [Script](/flecs/group__c__addons__script.html)             | DSL for scenes, assets and configuration         | FLECS_SCRIPT        |
 [Stats](/flecs/group__c__addons__stats.html)               | Functions for collecting statistics              | FLECS_STATS         |
 [Metrics](/flecs/group__c__addons__metrics.html)           | Create metrics from user-defined components      | FLECS_METRICS       |
diff --git a/include/flecs.h b/include/flecs.h
@@ -189,17 +189,19 @@
 // #define FLECS_C           /**< C API convenience macros, always enabled */
 #define FLECS_CPP            /**< C++ API */
 #define FLECS_DOC            /**< Document entities & components */
-// #define FLECS_JOURNAL     /**< Journaling addon (disabled by default) */
+// #define FLECS_JOURNAL     /**< Journaling addon */
 #define FLECS_JSON           /**< Parsing JSON to/from component values */
 #define FLECS_HTTP           /**< Tiny HTTP server for connecting to remote UI */
 #define FLECS_LOG            /**< When enabled ECS provides more detailed logs */
 #define FLECS_META           /**< Reflection support */
 #define FLECS_METRICS        /**< Expose component data as statistics */
 #define FLECS_MODULE         /**< Module support */
 #define FLECS_OS_API_IMPL    /**< Default implementation for OS API */
-// #define FLECS_PERF_TRACE  /**< Enable performance tracing (disabled by default) */
+// #define FLECS_PERF_TRACE  /**< Enable performance tracing */
 #define FLECS_PIPELINE       /**< Pipeline support */
 #define FLECS_REST           /**< REST API for querying application data */
+#define FLECS_PARSER         /**< Utilities for script and query DSL parsers */
+#define FLECS_QUERY_DSL      /**< Flecs query DSL parser */
 #define FLECS_SCRIPT         /**< Flecs entity notation language */
 // #define FLECS_SCRIPT_MATH /**< Math functions for flecs script (may require linking with libm) */
 #define FLECS_SYSTEM         /**< System support */
diff --git a/include/flecs/addons/json.h b/include/flecs/addons/json.h
@@ -14,8 +14,8 @@
 #define FLECS_META
 #endif
 
-#ifndef FLECS_SCRIPT
-#define FLECS_SCRIPT
+#ifndef FLECS_QUERY_DSL
+#define FLECS_QUERY_DSL /* For parsing component id expressions */
 #endif
 
 #ifndef FLECS_JSON_H
diff --git a/include/flecs/addons/script.h b/include/flecs/addons/script.h
@@ -23,6 +23,9 @@
 #define FLECS_DOC
 #endif
 
+#ifndef FLECS_PARSER
+#define FLECS_PARSER
+#endif
 
 #ifndef FLECS_SCRIPT_H
 #define FLECS_SCRIPT_H
diff --git a/include/flecs/private/addons.h b/include/flecs/private/addons.h
@@ -18,6 +18,12 @@
 #ifdef FLECS_NO_SCRIPT
 #undef FLECS_SCRIPT
 #endif
+#ifdef FLECS_NO_PARSER
+#undef FLECS_PARSER
+#endif
+#ifdef FLECS_NO_QUERY_DSL
+#undef FLECS_QUERY_DSL
+#endif
 #ifdef FLECS_NO_SCRIPT_MATH
 #undef FLECS_SCRIPT_MATH
 #endif
@@ -171,6 +177,21 @@
 #include "../addons/script_math.h"
 #endif
 
+#ifdef FLECS_PARSER
+#ifdef FLECS_NO_PARSER
+#error "FLECS_NO_PARSER failed: PARSER is required by other addons"
+#endif
+#endif
+
+#ifdef FLECS_QUERY_DSL
+#ifdef FLECS_NO_QUERY_DSL
+#error "FLECS_NO_QUERY_DSL failed: QUERY_DSL is required by other addons"
+#endif
+#ifndef FLECS_PARSER
+#define FLECS_PARSER
+#endif
+#endif
+
 #ifdef FLECS_SCRIPT
 #ifdef FLECS_NO_SCRIPT
 #error "FLECS_NO_SCRIPT failed: SCRIPT is required by other addons"
diff --git a/src/addons/json/deserialize.c b/src/addons/json/deserialize.c
@@ -5,7 +5,7 @@
 
 #include "../../private_api.h"
 #include "json.h"
-#include "../script/script.h"
+#include "../query_dsl/query_dsl.h"
 #include <ctype.h>
 
 #ifdef FLECS_JSON
@@ -377,7 +377,7 @@ const char* flecs_json_deser_components(
         } else {
             char token_buffer[256];
             ecs_term_t term = {0};
-            if (!flecs_term_parse(world, NULL, token, &term, token_buffer)) {
+            if (!flecs_term_parse(world, NULL, token, token_buffer, &term)) {
                 goto error;
             }
 
diff --git a/src/addons/meta/cursor.c b/src/addons/meta/cursor.c
@@ -8,8 +8,8 @@
 #include <ctype.h>
 
 #ifdef FLECS_META
-#ifdef FLECS_SCRIPT
-#include "../script/script.h"
+#ifdef FLECS_QUERY_DSL
+#include "../query_dsl/query_dsl.h"
 #endif
 
 static
@@ -1470,7 +1470,7 @@ int ecs_meta_set_string(
         break;
     }
     case EcsOpId: {
-    #ifdef FLECS_SCRIPT
+    #ifdef FLECS_QUERY_DSL
         ecs_id_t id = 0;
         if (flecs_id_parse(cursor->world, NULL, value, &id) == NULL) {
             goto error;
diff --git a/src/addons/parser/grammar.h b/src/addons/parser/grammar.h
@@ -8,6 +8,8 @@
 #ifndef FLECS_PARSER_GRAMMAR_H
 #define FLECS_PARSER_GRAMMAR_H
 
+#include "parser.h"
+
 #if defined(ECS_TARGET_CLANG)
 /* Ignore unused enum constants in switch as it would blow up the parser code */
 #pragma clang diagnostic ignored "-Wswitch-enum"
diff --git a/src/addons/parser/parser.h b/src/addons/parser/parser.h
@@ -1,7 +1,6 @@
-
 /**
  * @file addons/parser/parser.h
- * @brief Script parser.
+ * @brief Parser addon.
  */
 
 #ifndef FLECS_PARSER_H
@@ -23,6 +22,8 @@ typedef struct ecs_parser_t {
     bool significant_newline;
     bool merge_variable_members;
 
+    ecs_world_t *world;
+
     /* For script parser */
     ecs_script_impl_t *script;
     ecs_script_scope_t *scope;
diff --git a/src/addons/parser/tokenizer.c b/src/addons/parser/tokenizer.c
@@ -5,7 +5,7 @@
 
 #include "flecs.h"
 
-#ifdef FLECS_SCRIPT
+#ifdef FLECS_PARSER
 
 #include "parser.h"
 
diff --git a/src/addons/query_dsl/parser.c b/src/addons/query_dsl/parser.c
@@ -5,8 +5,7 @@
 
 #include "flecs.h"
 
-#ifdef FLECS_SCRIPT
-#include "script.h"
+#ifdef FLECS_QUERY_DSL
 #include "../parser/grammar.h"
 
 #define EcsTokTermIdentifier\
@@ -113,7 +112,7 @@ const char* flecs_term_parse_trav(
                 case EcsTokIdentifier:
                     pos = lookahead;
                     parser->term->trav = ecs_lookup(
-                        parser->script->pub.world, Token(1));
+                        parser->world, Token(1));
                     if (!parser->term->trav) {
                         Error(
                             "unresolved traversal relationship '%s'", Token(1));
@@ -190,7 +189,7 @@ const char* flecs_term_parse_arg(
                         LookAhead_1(EcsTokIdentifier,
                             pos = lookahead;
                             parser->term->trav = ecs_lookup(
-                                parser->script->pub.world, Token(1));
+                                parser->world, Token(1));
                             if (!parser->term->trav) {
                                 Error(
                                     "unresolved trav identifier '%s'", Token(1));
@@ -511,27 +510,30 @@ const char* flecs_query_term_parse(
 }
 
 int flecs_terms_parse(
-    ecs_script_t *script,
+    ecs_world_t *world,
+    const char *name,
+    const char *code,
+    char *token_buffer,
     ecs_term_t *terms,
     int32_t *term_count_out)
 {
-    if (!ecs_os_strcmp(script->code, "0")) {
+    if (!ecs_os_strcmp(code, "0")) {
         *term_count_out = 0;
         return 0;
     }
 
     ecs_parser_t parser = {
-        .name = script->name,
-        .code = script->code,
-        .script = flecs_script_impl(script),
-        .pos = script->code,
+        .name = name,
+        .code = code,
+        .world = world,
+        .pos = code,
         .merge_variable_members = true
     };
 
-    parser.token_cur = flecs_script_impl(script)->token_buffer;
+    parser.token_cur = token_buffer;
 
     int32_t term_count = 0;
-    const char *ptr = script->code;
+    const char *ptr = code;
     ecs_term_ref_t extra_args[FLECS_TERM_ARG_COUNT_MAX];
     ecs_os_memset_n(extra_args, 0, ecs_term_ref_t, 
         FLECS_TERM_ARG_COUNT_MAX);
@@ -621,14 +623,20 @@ const char* flecs_term_parse(
     ecs_world_t *world,
     const char *name,
     const char *expr,
-    ecs_term_t *term,
-    char *token_buffer)
+    char *token_buffer,
+    ecs_term_t *term)
 {
     ecs_assert(world != NULL, ECS_INVALID_PARAMETER, NULL);
     ecs_assert(expr != NULL, ECS_INVALID_PARAMETER, name);
     ecs_assert(term != NULL, ECS_INVALID_PARAMETER, NULL);
 
-    EcsParserFixedBuffer(world, name, expr, token_buffer, 256);
+    ecs_parser_t parser = {
+        .name = name,
+        .code = expr,
+        .world = world,
+        .token_cur = token_buffer
+    };
+
     parser.term = term;
 
     const char *result = flecs_query_term_parse(&parser, expr);
@@ -652,8 +660,15 @@ const char* flecs_id_parse(
     ecs_assert(id != NULL, ECS_INVALID_PARAMETER, NULL);
 
     char token_buffer[256];
+
+    ecs_parser_t parser = {
+        .name = name,
+        .code = expr,
+        .world = ECS_CONST_CAST(ecs_world_t*, world),  /* Safe, won't modify */
+        .token_cur = token_buffer
+    };
+
     ecs_term_t term = {0};
-    EcsParserFixedBuffer(world, name, expr, token_buffer, 256);
     parser.term = &term;
 
     expr = flecs_scan_whitespace(&parser, expr);
@@ -778,7 +793,13 @@ const char* ecs_query_args_parse(
     }
 
     char token_buffer[1024];
-    EcsParserFixedBuffer(q->world, q_name, expr, token_buffer, 256);
+    ecs_parser_t parser = {
+        .name = q_name,
+        .code = expr,
+        .world = q->real_world,
+        .token_cur = token_buffer
+    };
+
     return flecs_query_args_parse(&parser, q, it, expr);
 error:
     return NULL;
diff --git a/src/addons/query_dsl/query_dsl.h b/src/addons/query_dsl/query_dsl.h
@@ -0,0 +1,32 @@
+/**
+ * @file addons/query_dsl/query_dsl.h
+ * @brief Query DSL parser addon.
+ */
+
+#ifndef FLECS_QUERY_DSL_H
+#define FLECS_QUERY_DSL_H
+
+#include "../../private_api.h"
+
+int flecs_terms_parse(
+    ecs_world_t *world,
+    const char *name,
+    const char *code,
+    char *token_buffer,
+    ecs_term_t *terms,
+    int32_t *term_count_out);
+
+const char* flecs_term_parse(
+    ecs_world_t *world,
+    const char *name,
+    const char *expr,
+    char *token_buffer,
+    ecs_term_t *term);
+
+const char* flecs_id_parse(
+    const ecs_world_t *world,
+    const char *name,
+    const char *expr,
+    ecs_id_t *id);
+
+#endif
diff --git a/src/addons/rest.c b/src/addons/rest.c
diff --git a/src/addons/script/script.h b/src/addons/script/script.h
diff --git a/src/entity.c b/src/entity.c
diff --git a/src/id.c b/src/id.c
diff --git a/src/query/validator.c b/src/query/validator.c
