#1553 Add FLECS_CPP_NO_ENUM_REFLECTION flag

Author: SanderMertens

distr/flecs.c

@@ -6758,10 +6758,10 @@ ecs_entity_t ecs_component_init(
         ptr->alignment = desc->type.alignment;
         if (!new_component || ptr->size != desc->type.size) {
             if (!ptr->size) {
-                ecs_trace("#[green]tag#[reset] %s created", 
+                ecs_trace("#[green]tag#[reset] %s registered", 
                     ecs_get_name(world, result));
             } else {
-                ecs_trace("#[green]component#[reset] %s created", 
+                ecs_trace("#[green]component#[reset] %s registered", 
                     ecs_get_name(world, result));
             }
         }
@@ -18093,9 +18093,6 @@ static const char *flecs_addons_info[] = {
 #ifdef FLECS_MODULE
     "FLECS_MODULE",
 #endif
-#ifdef FLECS_SCRIPT
-    "FLECS_SCRIPT",
-#endif
 #ifdef FLECS_STATS
     "FLECS_STATS",
 #endif
@@ -18138,6 +18135,12 @@ static const char *flecs_addons_info[] = {
 #ifdef FLECS_OS_API_IMPL
     "FLECS_OS_API_IMPL",
 #endif
+#ifdef FLECS_PARSER
+    "FLECS_PARSER",
+#endif
+#ifdef FLECS_QUERY_DSL
+    "FLECS_QUERY_DSL",
+#endif
 #ifdef FLECS_SCRIPT
     "FLECS_SCRIPT",
 #endif

distr/flecs.h

@@ -156,6 +156,15 @@
  */
 // #define FLECS_CPP_NO_AUTO_REGISTRATION
 
+/** @def FLECS_CPP_NO_ENUM_REFLECTION 
+ * When set, the C++ API will not attempt to discover and register enum 
+ * constants for registered enum components. This will cause C++ APIs that 
+ * accept enum constants to not work.
+ * Disabling this feature can significantly improve compile times and reduces
+ * the RAM footprint of an application.
+ */
+// #define FLECS_CPP_NO_ENUM_REFLECTION
+
 /** @def FLECS_CUSTOM_BUILD
  * This macro lets you customize which addons to build flecs with.
  * Without any addons Flecs is just a minimal ECS storage, but addons add
@@ -17880,6 +17889,12 @@ struct string_view : string {
 #define FLECS_ENUM_MAX(T) _::to_constant<T, 126>::value
 #define FLECS_ENUM_MAX_COUNT (FLECS_ENUM_MAX(int) + 1)
 
+// Flag to turn off enum reflection
+#ifdef FLECS_CPP_NO_ENUM_REFLECTION
+#define FLECS_CPP_ENUM_REFLECTION_SUPPORT 0
+#endif
+
+// Test if we're using a compiler that supports the required features
 #ifndef FLECS_CPP_ENUM_REFLECTION_SUPPORT
 #if !defined(__clang__) && defined(__GNUC__)
 #if __GNUC__ > 7 || (__GNUC__ == 7 && __GNUC_MINOR__ >= 5)

include/flecs.h

@@ -154,6 +154,15 @@
  */
 // #define FLECS_CPP_NO_AUTO_REGISTRATION
 
+/** @def FLECS_CPP_NO_ENUM_REFLECTION 
+ * When set, the C++ API will not attempt to discover and register enum 
+ * constants for registered enum components. This will cause C++ APIs that 
+ * accept enum constants to not work.
+ * Disabling this feature can significantly improve compile times and reduces
+ * the RAM footprint of an application.
+ */
+// #define FLECS_CPP_NO_ENUM_REFLECTION
+
 /** @def FLECS_CUSTOM_BUILD
  * This macro lets you customize which addons to build flecs with.
  * Without any addons Flecs is just a minimal ECS storage, but addons add

include/flecs/addons/cpp/utils/enum.hpp

@@ -14,6 +14,12 @@
 #define FLECS_ENUM_MAX(T) _::to_constant<T, 126>::value
 #define FLECS_ENUM_MAX_COUNT (FLECS_ENUM_MAX(int) + 1)
 
+// Flag to turn off enum reflection
+#ifdef FLECS_CPP_NO_ENUM_REFLECTION
+#define FLECS_CPP_ENUM_REFLECTION_SUPPORT 0
+#endif
+
+// Test if we're using a compiler that supports the required features
 #ifndef FLECS_CPP_ENUM_REFLECTION_SUPPORT
 #if !defined(__clang__) && defined(__GNUC__)
 #if __GNUC__ > 7 || (__GNUC__ == 7 && __GNUC_MINOR__ >= 5)

src/entity.c

@@ -2272,10 +2272,10 @@ ecs_entity_t ecs_component_init(
         ptr->alignment = desc->type.alignment;
         if (!new_component || ptr->size != desc->type.size) {
             if (!ptr->size) {
-                ecs_trace("#[green]tag#[reset] %s created", 
+                ecs_trace("#[green]tag#[reset] %s registered", 
                     ecs_get_name(world, result));
             } else {
-                ecs_trace("#[green]component#[reset] %s created", 
+                ecs_trace("#[green]component#[reset] %s registered", 
                     ecs_get_name(world, result));
             }
         }

src/world.c

@@ -812,9 +812,6 @@ static const char *flecs_addons_info[] = {
 #ifdef FLECS_MODULE
     "FLECS_MODULE",
 #endif
-#ifdef FLECS_SCRIPT
-    "FLECS_SCRIPT",
-#endif
 #ifdef FLECS_STATS
     "FLECS_STATS",
 #endif
@@ -857,6 +854,12 @@ static const char *flecs_addons_info[] = {
 #ifdef FLECS_OS_API_IMPL
     "FLECS_OS_API_IMPL",
 #endif
+#ifdef FLECS_PARSER
+    "FLECS_PARSER",
+#endif
+#ifdef FLECS_QUERY_DSL
+    "FLECS_QUERY_DSL",
+#endif
 #ifdef FLECS_SCRIPT
     "FLECS_SCRIPT",
 #endif

test/custom_builds/cpp/no_enum_reflection/include/no_enum_reflection.h

@@ -0,0 +1,16 @@
+#ifndef NO_ENUM_REFLECTION_H
+#define NO_ENUM_REFLECTION_H
+
+/* This generated file contains includes for project dependencies */
+#include "no_enum_reflection/bake_config.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+

test/custom_builds/cpp/no_enum_reflection/include/no_enum_reflection/bake_config.h

@@ -0,0 +1,24 @@
+/*
+                                   )
+                                  (.)
+                                  .|.
+                                  | |
+                              _.--| |--._
+                           .-';  ;`-'& ; `&.
+                          \   &  ;    &   &_/
+                           |"""---...---"""|
+                           \ | | | | | | | /
+                            `---.|.|.|.---'
+
+ * This file is generated by bake.lang.c for your convenience. Headers of
+ * dependencies will automatically show up in this file. Include bake_config.h
+ * in your main project file. Do not edit! */
+
+#ifndef NO_ENUM_REFLECTION_BAKE_CONFIG_H
+#define NO_ENUM_REFLECTION_BAKE_CONFIG_H
+
+/* Headers of public dependencies */
+#include <flecs.h>
+
+#endif
+

test/custom_builds/cpp/no_enum_reflection/project.json

@@ -0,0 +1,14 @@
+{
+    "id": "no_enum_reflection",
+    "type": "application",
+    "value": {
+        "use": [
+            "flecs"
+        ],
+        "language": "c++",
+        "public": false
+    },
+    "lang.cpp": {
+        "defines": ["FLECS_CPP_NO_ENUM_REFLECTION"]
+    }
+}

test/custom_builds/cpp/no_enum_reflection/src/main.cpp

@@ -0,0 +1,29 @@
+#include <no_enum_reflection.h>
+#include <iostream>
+
+enum Color {
+    Red, Green, Blue
+};
+
+int main(int argc, char *argv[]) {    
+    flecs::world world(argc, argv);
+
+    auto c = world.component<Color>();
+
+    if (c.lookup("Red") != 0) {
+        printf("enum constant should not be defined\n");
+        return -1;
+    }
+
+    if (c.lookup("Green") != 0) {
+        printf("enum constant should not be defined\n");
+        return -1;
+    }
+
+    if (c.lookup("Blue") != 0) {
+        printf("enum constant should not be defined\n");
+        return -1;
+    }
+
+    return 0;
+}