Resolve #30: refl code generator (#103)

Author: VisualGMQ

.github/workflows/build.yaml

@@ -28,6 +28,15 @@ jobs:
     - name: Prepare cmake
       uses: lukka/get-cmake@latest
 
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: 'pip' # caching pip dependencies
+
+    - name: Pip install requirements
+      run: |
+        python -m pip install -r ./engine/engine/refl_code_generator/requirements.txt
+
     - name: Prepare Ubuntu
       if: contains(matrix.os, 'ubuntu') && matrix.android == 'none'
       run: |

.gitignore

@@ -12,4 +12,5 @@ local.properties
 log/
 *.spv
 .vscode
-nickel_engine_project_path.toml
+nickel_engine_project_path.toml
+engine/engine/refl_code_generator/output_dir

ReadMe.md

@@ -1,31 +1,41 @@
 NickelEngine重写中，老版本备份在[NickelEngine-backup](https://github.com/VisualGMQ/NickelEngine-backup)
 
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/VisualGMQ/NickelEngine)
+
 更多信息请参阅[wiki](https://github.com/VisualGMQ/NickelEngine/wiki)
 
 新NickelEngine的特点：
 
-* 重置底层ECS系统
+- [ ] 重置底层ECS系统
     [现在的ECS](https://github.com/VisualGMQ/gecs)是借鉴的EnTT，我希望能够改成Flecs那种基于Archetype的底层
-* 重置反射系统
+- [x] 重置反射系统
     [老的反射系统](https://github.com/VisualGMQ/mirrow)需要一套自动解析头文件的工具，以及更多的特性
-* 重置渲染
+- [x] 重置渲染
     老的渲染层中Vulkan和GL/GLES并存。新版本打算只使用Vulkan
-* 更好的工程结构
+- [ ] 重置编辑器
+    编辑器不再使用ImGui，而是使用Qt6制作
+- [x] 更好的工程结构
     老的第三方库作为submodule，由于网络问题及git submodule问题经常拉不下来/拉一半。新工程中使用小型第三方库，并且将库源码直接放在引擎工程中，这样既避免了额外拉取问题，又可以进行源码调试
-* 更好的开发流程
+- [x] 更好的开发流程
     新版本每次开发功能/修改bug都会关联issue，以方便后续溯源。CI也从最开始就使用，保证main分支一定是可编译通过的
 
 ## How To Build
 
-使用CMake进行编译（非安卓平台在`engine`目录下执行：）
+反射工具需要`Python3`
+
+先安装`Python3`依赖库：
+
+```bash
+pip install -r ./engine/engine/refl_code_generator/requirements.txt
+```
+
+然后使用CMake进行编译
 
 ```bash
 cmake --preset=default
 cmake --build cmake-build
 ```
 
-安卓平台需要将`engine`文件夹拷贝到`android-project/app/jni`下然后开启`Android Studio`进行编译
-
 ## How To Run
 
 所有可执行文件均在`engine`目录下运行。

engine/engine/CMakeLists.txt

@@ -1,9 +1,16 @@
 add_subdirectory(3rdlibs)
 
-
 option(NICKEL_BUILD_SHARED "build shared engine library" OFF)
 option(NICKEL_BUILD_STATIC "build static engine library" ON)
 
+set(NICKEL_REFL_GENERATE_INCLUDE_DIR ${CMAKE_BINARY_DIR}/refl_generate)
+set(NICKEL_REFL_GENERATE_DIR ${NICKEL_REFL_GENERATE_INCLUDE_DIR}/nickel/refl_generate/)
+file(MAKE_DIRECTORY ${NICKEL_REFL_GENERATE_DIR})
+# copy tirvial file
+file(COPY_FILE refl_code_generator/mustache/trivial_header.hpp ${NICKEL_REFL_GENERATE_DIR}/refl_generate.hpp ONLY_IF_DIFFERENT)
+file(COPY_FILE refl_code_generator/mustache/trivial_impl.cpp ${NICKEL_REFL_GENERATE_DIR}/refl_generate.cpp ONLY_IF_DIFFERENT)
+add_subdirectory(refl_code_generator)
+
 file(GLOB_RECURSE ENGINE_SRC src/*.cpp)
 file(GLOB_RECURSE ENGINE_ALL_HEADERS nickel/*.hpp)
 file(GLOB_RECURSE ENGINE_INTERNAL_HEADERS
@@ -18,15 +25,17 @@ set(ENGINE_EXPORT_HEADERS ${ENGINE_ALL_HEADERS})
 list(REMOVE_ITEM ENGINE_EXPORT_HEADERS ${ENGINE_INTERNAL_HEADERS})
 file(GLOB_RECURSE ENGINE_SHADER_FILES assets/shaders/*.frag assets/shaders/*.vert)
 file(GLOB_RECURSE ENGINE_MODEL_FILES assets/models/*)
+file(GLOB_RECURSE ENGINE_REFL_GENERATE_FILES ${NICKEL_REFL_GENERATE_DIR}/*.hpp ${NICKEL_REFL_GENERATE_DIR}/*.cpp)
 
 compile_shader(assets/shaders/shader_pbr.vert assets/shaders/shader_pbr.vert.spv)
 compile_shader(assets/shaders/shader_pbr.frag assets/shaders/shader_pbr.frag.spv)
 compile_shader(assets/shaders/shader_gridline.vert assets/shaders/shader_gridline.vert.spv)
 compile_shader(assets/shaders/shader_gridline.frag assets/shaders/shader_gridline.frag.spv)
 
 macro(attach_common_config_on_engine target_name)
-    target_sources(${target_name} PRIVATE ${ENGINE_ALL_HEADERS} ${ENGINE_SRC} ${ENGINE_MODEL_FILES} ${ENGINE_SHADER_FILES})
+    target_sources(${target_name} PRIVATE ${ENGINE_ALL_HEADERS} ${ENGINE_SRC} ${ENGINE_MODEL_FILES} ${ENGINE_SHADER_FILES} ${ENGINE_REFL_GENERATE_FILES})
     target_include_directories(${target_name} PUBLIC .)
+    target_include_directories(${target_name} PRIVATE ${NICKEL_REFL_GENERATE_INCLUDE_DIR})
     target_compile_features(${target_name} PUBLIC cxx_std_20)
     target_link_libraries(${target_name} PRIVATE SDL3::SDL3 volk::volk stb_image tinygltf tomlplusplus::tomlplusplus
         # PhysX
@@ -49,6 +58,7 @@ macro(attach_common_config_on_engine target_name)
         NvBlast::ExtStress
     )
     target_link_libraries(${target_name} PUBLIC spdlog::spdlog imgui implot)
+    add_dependencies(${target_name} refl_code_generate)
 
     target_precompile_headers(${target_name} PRIVATE nickel/internal/pch.hpp nickel/physics/internal/pch.hpp)
     target_compile_definitions(${target_name} PRIVATE _CRT_SECURE_NO_WARNINGS)
@@ -91,3 +101,5 @@ else()
 endif()
 
 add_subdirectory(main_entry)
+
+find_package(Python3 COMPONENTS Interpreter REQUIRED)

engine/engine/nickel/common/flags.hpp

@@ -7,50 +7,51 @@ template <typename T>
 requires std::is_enum_v<T>
 class Flags {
 public:
+    using enum_type = T;
     using underlying_type = std::underlying_type_t<T>;
 
     Flags() = default;
 
-    Flags(T value) : value_{static_cast<underlying_type>(value)} {}
+    Flags(T value) : m_value{static_cast<underlying_type>(value)} {}
 
-    Flags(std::underlying_type_t<T> value) : value_{value} {}
+    Flags(std::underlying_type_t<T> value) : m_value{value} {}
 
     Flags(const Flags&) = default;
     Flags(Flags&&) = default;
 
     Flags operator|(T o) const {
-        return Flags{value_ | static_cast<underlying_type>(o)};
+        return Flags{m_value | static_cast<underlying_type>(o)};
     }
 
     Flags operator&(T o) const {
-        return Flags{value_ & static_cast<underlying_type>(o)};
+        return Flags{m_value & static_cast<underlying_type>(o)};
     }
 
     Flags& operator=(const Flags&) = default;
 
     Flags& operator=(T value) {
-        value_ = static_cast<underlying_type>(value);
+        m_value = static_cast<underlying_type>(value);
         return *this;
     }
 
     Flags& operator|=(T o) {
-        value_ |= static_cast<underlying_type>(o);
+        m_value |= static_cast<underlying_type>(o);
         return *this;
     }
 
     Flags& operator&=(T o) {
-        value_ &= static_cast<underlying_type>(o);
+        m_value &= static_cast<underlying_type>(o);
         return *this;
     }
 
-    Flags operator~() const noexcept { return ~value_; }
+    Flags operator~() const noexcept { return ~m_value; }
 
-    operator T() const { return static_cast<T>(value_); }
+    operator T() const { return static_cast<T>(m_value); }
 
-    operator underlying_type() const { return value_; }
+    operator underlying_type() const { return m_value; }
 
 private:
-    underlying_type value_{};
+    underlying_type m_value{};
 };
 
 }  // namespace tl

engine/engine/nickel/common/refl_macro.hpp

@@ -0,0 +1,7 @@
+#pragma once
+
+#ifdef _NICKEL_REFLECTION_
+#define NICKEL_REFL_ATTR(...)  __attribute__((annotate("nickel(" #__VA_ARGS__ ")")))
+#else
+#define NICKEL_REFL_ATTR(...)
+#endif

engine/engine/nickel/context.hpp

@@ -18,6 +18,7 @@
 #include "nickel/graphics/debug_draw.hpp"
 #include "nickel/graphics/gltf.hpp"
 #include "nickel/physics/context.hpp"
+#include "nickel/refl/custom/flags_refl.hpp"
 
 union SDL_Event;