C header code generation for ABI compatibility

.gitignore

@@ -1 +1,2 @@
+/.cache
 /build

.vscode/launch.json

@@ -34,6 +34,39 @@
             "environment": [],
             "console": "integratedTerminal"
         },
+        {
+            "name": "Launch Benchmark C-ABI (Windows)",
+            "type": "cppvsdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/tests/Tecs-benchmark-cabi.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}/build/tests/",
+            "environment": [],
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "Launch Benchmark Tracy C-ABI (Windows)",
+            "type": "cppvsdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/tests/Tecs-benchmark-tracy-cabi.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}/build/tests/",
+            "environment": [],
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "Launch C-ABI Tests (Windows)",
+            "type": "cppvsdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/tests/Tecs-c_abi_test.exe",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}/build/tests/",
+            "environment": [],
+            "console": "integratedTerminal"
+        },
         {
             "name": "Launch Tests (Linux)",
             "type": "cppdbg",

CMakeLists.txt

@@ -81,6 +81,8 @@ if(TECS_UNCHECKED_MODE)
     target_compile_definitions(${PROJECT_NAME} INTERFACE TECS_UNCHECKED_MODE)
 endif()
 
+include(gen_c_abi.cmake)
+
 if(UNIX AND NOT ANDROID)
     target_link_libraries(
         ${PROJECT_NAME}

examples/tracing_example.cpp

@@ -1,7 +1,6 @@
 #include "complex_component.hh"
 #include "components.hh"
 
-#include <fstream>
 #include <iostream>
 #include <vector>
 
@@ -124,9 +123,7 @@ int main(int /* argc */, char ** /* argv */) {
     for (auto &[id, name] : threadNames) {
         trace.SetThreadName(name, id);
     }
-    std::ofstream traceFile("example-trace.csv");
-    trace.SaveToCSV(traceFile);
-    traceFile.close();
+    trace.SaveToCSV("example-trace.csv");
 
     return 0;
 }

gen_c_abi.cmake

@@ -0,0 +1,103 @@
+function(TecsGenerateCHeaders)
+    set(options OBJECT_TARGET)
+    set(oneValueArgs TARGET_NAME ECS_INCLUDE_PATH ECS_C_INCLUDE_PATH ECS_NAME COMPONENT_TYPE_PREFIX)
+    set(multiValueArgs SOURCES LINK_LIBRARIES INCLUDE_DIRECTORIES COMPILE_DEFINITIONS)
+    cmake_parse_arguments(PARSE_ARGV 0 arg "${options}" "${oneValueArgs}" "${multiValueArgs}")
+
+    include(CheckIPOSupported)
+    check_ipo_supported(RESULT lto_supported OUTPUT lto_error)
+
+    set(TECS_PROJECT_ROOT ${CMAKE_CURRENT_FUNCTION_LIST_DIR})
+
+    add_executable(${arg_TARGET_NAME}-codegen ${TECS_PROJECT_ROOT}/src/c_abi/codegen/gen_main.cc)
+    target_link_libraries(${arg_TARGET_NAME}-codegen PRIVATE ${arg_LINK_LIBRARIES})
+    target_include_directories(
+        ${arg_TARGET_NAME}-codegen
+        PRIVATE
+            ${TECS_PROJECT_ROOT}/inc
+            ${arg_INCLUDE_DIRECTORIES}
+    )
+    target_compile_definitions(${arg_TARGET_NAME}-codegen PRIVATE
+        TECS_C_ABI_ECS_NAME=${arg_ECS_NAME}
+        TECS_C_ABI_TYPE_PREFIX="${arg_COMPONENT_TYPE_PREFIX}"
+        TECS_SHARED_INTERNAL
+        ${arg_COMPILE_DEFINITIONS}
+    )
+    set_target_properties(${arg_TARGET_NAME}-codegen PROPERTIES
+        RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    )
+
+    if(DEFINED arg_ECS_INCLUDE_PATH)
+        target_compile_definitions(${arg_TARGET_NAME}-codegen PRIVATE
+            TECS_C_ABI_ECS_INCLUDE="${arg_ECS_INCLUDE_PATH}"
+        )
+    endif()
+
+    if(DEFINED arg_ECS_C_INCLUDE_PATH)
+        target_compile_definitions(${arg_TARGET_NAME}-codegen PRIVATE
+            TECS_C_ABI_ECS_C_INCLUDE="${arg_ECS_C_INCLUDE_PATH}"
+        )
+    endif()
+
+    string(REPLACE "-" "_" OUTPUT_PREFIX_NAME ${arg_TARGET_NAME})
+
+    add_custom_command(
+        OUTPUT
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_lock_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_entity_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_ecs_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_entity_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_lock_gen.cc
+        COMMAND
+            ${arg_TARGET_NAME}-codegen
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_lock_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_entity_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_ecs_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_entity_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_lock_gen.cc
+        DEPENDS ${arg_TARGET_NAME}-codegen
+    )
+
+    add_custom_target(${arg_TARGET_NAME}-codegen-output
+        DEPENDS
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_lock_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/include/c_abi/${OUTPUT_PREFIX_NAME}_entity_gen.h
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_ecs_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_entity_gen.cc
+            ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_lock_gen.cc
+    )
+
+    set(BUILD_FILE_LIST
+        ${TECS_PROJECT_ROOT}/src/c_abi/Tecs_entity_view.cc
+        ${TECS_PROJECT_ROOT}/src/c_abi/Tecs_tracing.cc
+        ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_ecs_gen.cc
+        ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_entity_gen.cc
+        ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_PREFIX_NAME}_lock_gen.cc
+        ${arg_SOURCES}
+    )
+
+    if(arg_OBJECT_TARGET)
+        add_library(${arg_TARGET_NAME} OBJECT ${BUILD_FILE_LIST})
+    else()
+        add_library(${arg_TARGET_NAME} SHARED ${BUILD_FILE_LIST})
+    endif()
+    target_link_libraries(${arg_TARGET_NAME} PRIVATE Tecs ${arg_LINK_LIBRARIES})
+    target_include_directories(
+        ${arg_TARGET_NAME}
+        PUBLIC
+            ${TECS_PROJECT_ROOT}/inc
+            ${CMAKE_CURRENT_BINARY_DIR}/include
+        PRIVATE
+            ${arg_INCLUDE_DIRECTORIES}
+    )
+    add_dependencies(${arg_TARGET_NAME} ${arg_TARGET_NAME}-codegen-output)
+    target_compile_definitions(${arg_TARGET_NAME} PRIVATE TECS_SHARED_INTERNAL ${arg_COMPILE_DEFINITIONS})
+    if(lto_supported)
+        if(NOT CMAKE_BUILD_TYPE STREQUAL "Debug")
+            message(STATUS "IPO / LTO enabled")
+            set_target_properties(${arg_TARGET_NAME} PROPERTIES INTERPROCEDURAL_OPTIMIZATION TRUE)
+        endif()
+    else()
+        message(STATUS "IPO / LTO not supported: ${lto_error}")
+    endif()
+endfunction()

inc/Tecs.hh

@@ -80,18 +80,22 @@ namespace Tecs {
             return (TECS_ENTITY_ECS_IDENTIFIER_TYPE)ecsId;
         }
 
+        inline uint64_t GetNextTransactionId() const {
+            return nextTransactionId;
+        }
+
         /**
          * Returns the index of a Component type for use in a bitset.
          */
         template<typename U>
-        inline static constexpr size_t GetComponentIndex() {
+        inline static constexpr uint32_t GetComponentIndex() {
             return GetComponentIndex<0, U>();
         }
 
         /**
          * Returns the number of Component types registered in this ECS instance.
          */
-        inline static constexpr size_t GetComponentCount() {
+        inline static constexpr uint32_t GetComponentCount() {
             return sizeof...(Tn);
         }
 
@@ -107,6 +111,13 @@ namespace Tecs {
             }
         }
 
+        /**
+         * Returns the registered name of the Nth Component type, or a default of "ComponentN" if none is set.
+         */
+        inline static std::string GetComponentName(uint32_t componentIndex) {
+            return GetComponentName<Tn...>(componentIndex);
+        }
+
         /**
          * Returns true if the Component type is part of this ECS.
          */
@@ -120,17 +131,29 @@ namespace Tecs {
         }
 
     private:
-        template<size_t I, typename U>
-        inline static constexpr size_t GetComponentIndex() {
+        template<uint32_t I, typename U>
+        inline static constexpr uint32_t GetComponentIndex() {
             static_assert(I < sizeof...(Tn), "Component does not exist");
 
-            if constexpr (std::is_same<U, typename std::tuple_element<I, std::tuple<Tn...>>::type>::value) {
+            if constexpr (std::is_same<U, typename std::tuple_element_t<I, std::tuple<Tn...>>>()) {
                 return I;
             } else {
                 return GetComponentIndex<I + 1, U>();
             }
         }
 
+        template<typename U, typename... Un>
+        inline static std::string GetComponentName(uint32_t index) {
+            if (index == 0) {
+                return GetComponentName<U>();
+            }
+            if constexpr (sizeof...(Un) > 0) {
+                return GetComponentName<Un...>(index - 1);
+            } else {
+                throw std::runtime_error("Component does not exist");
+            }
+        }
+
         using ComponentBitset = std::bitset<1 + sizeof...(Tn)>;
 
         struct EntityMetadata : public ComponentBitset {
@@ -162,15 +185,13 @@ namespace Tecs {
 #endif
 
 #ifndef TECS_HEADER_ONLY
-        size_t ecsId;
+        uint64_t ecsId;
 #endif
 
         template<typename, typename...>
         friend class Lock;
-        template<typename, typename...>
+        template<typename>
         friend class Transaction;
-        template<template<typename...> typename, typename...>
-        friend class BaseTransaction;
         friend struct Entity;
     };
 } // namespace Tecs