gh-1: rework engine code structure

EgorOrachyov · May 12, 2024 · 71b0d93 · 71b0d93
1 parent 620705a
commit 71b0d93
Show file tree

Hide file tree

Showing 645 changed files with 967 additions and 625 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -10,7 +10,8 @@
             "request": "launch",
             "program": "${workspaceRoot}/build-Debug/template/template.exe",
             "args": [
-                "--root_remap=${workspaceRoot}/template"
+                "--root_remap=${workspaceRoot}/template",
+                "--engine_remap=root://../engine/"
             ],
             "stopAtEntry": false,
             "cwd": "${workspaceRoot}/build-Debug/template",
@@ -23,7 +24,8 @@
             "request": "launch",
             "program": "${workspaceRoot}/build-Release/template/template.exe",
             "args": [
-                "--root_remap=${workspaceRoot}/template"
+                "--root_remap=${workspaceRoot}/template",
+                "--engine_remap=root://../engine/"
             ],
             "stopAtEntry": false,
             "cwd": "${workspaceRoot}/build-Release/template",

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -127,11 +127,6 @@ add_subdirectory(deps)
 
 add_subdirectory(engine)
 
-###########################################################
-# Plugins sources (standard plugins for engine)
-
-add_subdirectory(plugins)
-
 ###########################################################
 # Game template for test purposes and to kick-off new projects
 

diff --git a/engine/CMakeLists.txt b/engine/CMakeLists.txt
@@ -1,51 +1,9 @@
-# egnine sources
-file(GLOB_RECURSE ENGINE_SOURCES ${CMAKE_CURRENT_LIST_DIR}/**/*.cpp ${CMAKE_CURRENT_LIST_DIR}/**/*.hpp)
+###########################################################
+# Engine runtime source code
 
-# declare static engine library
-add_library(wmoge STATIC ${ENGINE_SOURCES})
+add_subdirectory(code)
 
-# add interface to the engine for plugins
-add_library(wmoge_headers INTERFACE)
+###########################################################
+# Plugins sources (standard plugins for engine)
 
-# specify public include path, so user can reference engine files by modules names
-target_include_directories(wmoge_headers INTERFACE ${CMAKE_CURRENT_LIST_DIR}/)
-
-# engine dependencies, which are also visible to the engine users
-target_link_libraries(wmoge_headers INTERFACE cxxopts)
-target_link_libraries(wmoge_headers INTERFACE tinyxml2)
-target_link_libraries(wmoge_headers INTERFACE ryml)
-target_link_libraries(wmoge_headers INTERFACE magic_enum)
-target_link_libraries(wmoge_headers INTERFACE robin_hood)
-target_link_libraries(wmoge_headers INTERFACE svector)
-target_link_libraries(wmoge_headers INTERFACE yamc)
-
-# generic functions to setup target
-wmoge_target_iface_defs(wmoge_headers)
-
-# engine headers target link to engine library
-target_link_libraries(wmoge PUBLIC wmoge_headers)
-
-# engine dependencies, private
-target_link_libraries(wmoge PRIVATE glfw)
-target_link_libraries(wmoge PRIVATE whereami)
-target_link_libraries(wmoge PRIVATE stbimage)
-target_link_libraries(wmoge PRIVATE filewatch)
-target_link_libraries(wmoge PRIVATE lz4)
-target_link_libraries(wmoge PRIVATE compressonator)
-target_link_libraries(wmoge PRIVATE base64)
-target_link_libraries(wmoge PRIVATE dynalo)
-target_link_libraries(wmoge PRIVATE sha256)
-
-# audio dependencies, private
-target_link_libraries(wmoge PRIVATE OpenAL)
-target_link_libraries(wmoge PRIVATE audio_file)
-
-# lua scripting dependencies, private
-target_link_libraries(wmoge PRIVATE lua_static)
-target_link_libraries(wmoge PRIVATE LuaBridge)
-
-# vulkan rendering backend related dependencies, private
-target_link_libraries(wmoge PRIVATE volk)
-target_link_libraries(wmoge PRIVATE vma)
-target_link_libraries(wmoge PRIVATE glslang)
-target_link_libraries(wmoge PRIVATE SPIRV)
+add_subdirectory(plugins)
diff --git a/engine/code/CMakeLists.txt b/engine/code/CMakeLists.txt
@@ -0,0 +1,51 @@
+# egnine sources
+file(GLOB_RECURSE ENGINE_SOURCES ${CMAKE_CURRENT_LIST_DIR}/**/*.cpp ${CMAKE_CURRENT_LIST_DIR}/**/*.hpp)
+
+# declare static engine library
+add_library(wmoge STATIC ${ENGINE_SOURCES})
+
+# add interface to the engine for plugins
+add_library(wmoge_headers INTERFACE)
+
+# specify public include path, so user can reference engine files by modules names
+target_include_directories(wmoge_headers INTERFACE ${CMAKE_CURRENT_LIST_DIR}/)
+
+# engine dependencies, which are also visible to the engine users
+target_link_libraries(wmoge_headers INTERFACE cxxopts)
+target_link_libraries(wmoge_headers INTERFACE tinyxml2)
+target_link_libraries(wmoge_headers INTERFACE ryml)
+target_link_libraries(wmoge_headers INTERFACE magic_enum)
+target_link_libraries(wmoge_headers INTERFACE robin_hood)
+target_link_libraries(wmoge_headers INTERFACE svector)
+target_link_libraries(wmoge_headers INTERFACE yamc)
+
+# generic functions to setup target
+wmoge_target_iface_defs(wmoge_headers)
+
+# engine headers target link to engine library
+target_link_libraries(wmoge PUBLIC wmoge_headers)
+
+# engine dependencies, private
+target_link_libraries(wmoge PRIVATE glfw)
+target_link_libraries(wmoge PRIVATE whereami)
+target_link_libraries(wmoge PRIVATE stbimage)
+target_link_libraries(wmoge PRIVATE filewatch)
+target_link_libraries(wmoge PRIVATE lz4)
+target_link_libraries(wmoge PRIVATE compressonator)
+target_link_libraries(wmoge PRIVATE base64)
+target_link_libraries(wmoge PRIVATE dynalo)
+target_link_libraries(wmoge PRIVATE sha256)
+
+# audio dependencies, private
+target_link_libraries(wmoge PRIVATE OpenAL)
+target_link_libraries(wmoge PRIVATE audio_file)
+
+# lua scripting dependencies, private
+target_link_libraries(wmoge PRIVATE lua_static)
+target_link_libraries(wmoge PRIVATE LuaBridge)
+
+# vulkan rendering backend related dependencies, private
+target_link_libraries(wmoge PRIVATE volk)
+target_link_libraries(wmoge PRIVATE vma)
+target_link_libraries(wmoge PRIVATE glslang)
+target_link_libraries(wmoge PRIVATE SPIRV)
diff --git a/engine/asset/_rtti.cpp → engine/code/asset/_rtti.cpp b/engine/asset/_rtti.cpp → engine/code/asset/_rtti.cpp
diff --git a/engine/asset/_rtti.hpp → engine/code/asset/_rtti.hpp b/engine/asset/_rtti.hpp → engine/code/asset/_rtti.hpp
diff --git a/engine/asset/asset.cpp → engine/code/asset/asset.cpp b/engine/asset/asset.cpp → engine/code/asset/asset.cpp
@@ -38,19 +38,19 @@ namespace wmoge {
 
     Status yaml_read(IoContext& context, YamlConstNodeRef node, AssetId& id) {
         WG_YAML_READ(context, node, id.m_name);
-        return StatusCode::Ok;
+        return WG_OK;
     }
     Status yaml_write(IoContext& context, YamlNodeRef node, const AssetId& id) {
         WG_YAML_WRITE(context, node, id.m_name);
-        return StatusCode::Ok;
+        return WG_OK;
     }
     Status archive_read(IoContext& context, Archive& archive, AssetId& id) {
         WG_ARCHIVE_READ(context, archive, id.m_name);
-        return StatusCode::Ok;
+        return WG_OK;
     }
     Status archive_write(IoContext& context, Archive& archive, const AssetId& id) {
         WG_ARCHIVE_WRITE(context, archive, id.m_name);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     AssetId::AssetId(const std::string& id) {

diff --git a/engine/asset/asset.hpp → engine/code/asset/asset.hpp b/engine/asset/asset.hpp → engine/code/asset/asset.hpp
diff --git a/engine/asset/asset_import_data.hpp → engine/code/asset/asset_import_data.hpp b/engine/asset/asset_import_data.hpp → engine/code/asset/asset_import_data.hpp
diff --git a/engine/asset/asset_loader.hpp → engine/code/asset/asset_loader.hpp b/engine/asset/asset_loader.hpp → engine/code/asset/asset_loader.hpp
diff --git a/engine/asset/asset_manager.cpp → engine/code/asset/asset_manager.cpp b/engine/asset/asset_manager.cpp → engine/code/asset/asset_manager.cpp
diff --git a/engine/asset/asset_manager.hpp → engine/code/asset/asset_manager.hpp b/engine/asset/asset_manager.hpp → engine/code/asset/asset_manager.hpp
diff --git a/engine/asset/asset_meta.hpp → engine/code/asset/asset_meta.hpp b/engine/asset/asset_meta.hpp → engine/code/asset/asset_meta.hpp
diff --git a/engine/asset/asset_pak.hpp → engine/code/asset/asset_pak.hpp b/engine/asset/asset_pak.hpp → engine/code/asset/asset_pak.hpp
diff --git a/engine/asset/asset_pak_fs.cpp → engine/code/asset/asset_pak_fs.cpp b/engine/asset/asset_pak_fs.cpp → engine/code/asset/asset_pak_fs.cpp
@@ -65,7 +65,7 @@ namespace wmoge {
         meta.deps        = std::move(asset_file.deps);
         meta.import_data = std::move(asset_file.import_data);
 
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
 }// namespace wmoge
diff --git a/engine/asset/asset_pak_fs.hpp → engine/code/asset/asset_pak_fs.hpp b/engine/asset/asset_pak_fs.hpp → engine/code/asset/asset_pak_fs.hpp
diff --git a/engine/asset/asset_ref.hpp → engine/code/asset/asset_ref.hpp b/engine/asset/asset_ref.hpp → engine/code/asset/asset_ref.hpp
@@ -75,7 +75,7 @@ namespace wmoge {
             return StatusCode::NoAsset;
         }
         ref = AssetRef<T>(ptr);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
@@ -85,7 +85,7 @@ namespace wmoge {
             return StatusCode::NoAsset;
         }
         WG_YAML_WRITE(context, node, ref->get_id());
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
@@ -97,7 +97,7 @@ namespace wmoge {
             return StatusCode::NoAsset;
         }
         ref = AssetRef<T>(ptr);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
@@ -107,37 +107,37 @@ namespace wmoge {
             return StatusCode::NoAsset;
         }
         WG_ARCHIVE_WRITE(context, archive, ref->get_id());
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
     Status yaml_read(IoContext& context, YamlConstNodeRef node, AssetRefWeak<T>& ref) {
         AssetId id;
         WG_YAML_READ(context, node, id);
         ref = AssetRefWeak<T>(id);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
     Status yaml_write(IoContext& context, YamlNodeRef node, const AssetRefWeak<T>& ref) {
         AssetId id = ref;
         WG_YAML_WRITE(context, node, id);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
     Status archive_read(IoContext& context, Archive& archive, AssetRefWeak<T>& ref) {
         AssetId id;
         WG_ARCHIVE_READ(context, archive, id);
         ref = AssetRefWeak<T>(id);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T>
     Status archive_write(IoContext& context, Archive& archive, const AssetRefWeak<T>& ref) {
         AssetId id = ref;
         WG_ARCHIVE_WRITE(context, archive, id);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
 }// namespace wmoge
diff --git a/engine/audio/_rtti.cpp → engine/code/audio/_rtti.cpp b/engine/audio/_rtti.cpp → engine/code/audio/_rtti.cpp
diff --git a/engine/audio/_rtti.hpp → engine/code/audio/_rtti.hpp b/engine/audio/_rtti.hpp → engine/code/audio/_rtti.hpp
diff --git a/engine/audio/audio_bus.hpp → engine/code/audio/audio_bus.hpp b/engine/audio/audio_bus.hpp → engine/code/audio/audio_bus.hpp
diff --git a/engine/audio/audio_defs.hpp → engine/code/audio/audio_defs.hpp b/engine/audio/audio_defs.hpp → engine/code/audio/audio_defs.hpp
diff --git a/engine/audio/audio_engine.hpp → engine/code/audio/audio_engine.hpp b/engine/audio/audio_engine.hpp → engine/code/audio/audio_engine.hpp
diff --git a/engine/audio/audio_playback.hpp → engine/code/audio/audio_playback.hpp b/engine/audio/audio_playback.hpp → engine/code/audio/audio_playback.hpp
diff --git a/engine/audio/audio_stream.cpp → engine/code/audio/audio_stream.cpp b/engine/audio/audio_stream.cpp → engine/code/audio/audio_stream.cpp
diff --git a/engine/audio/audio_stream.hpp → engine/code/audio/audio_stream.hpp b/engine/audio/audio_stream.hpp → engine/code/audio/audio_stream.hpp
diff --git a/engine/audio/audio_stream_wav.cpp → engine/code/audio/audio_stream_wav.cpp b/engine/audio/audio_stream_wav.cpp → engine/code/audio/audio_stream_wav.cpp
@@ -73,7 +73,7 @@ namespace wmoge {
             m_data.push_back(buffer);
         }
 
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     Ref<Data> AudioStreamWav::get_channel_data(int channel) {

diff --git a/engine/audio/audio_stream_wav.hpp → engine/code/audio/audio_stream_wav.hpp b/engine/audio/audio_stream_wav.hpp → engine/code/audio/audio_stream_wav.hpp
diff --git a/engine/audio/openal/al_bus.cpp → engine/code/audio/openal/al_bus.cpp b/engine/audio/openal/al_bus.cpp → engine/code/audio/openal/al_bus.cpp
diff --git a/engine/audio/openal/al_bus.hpp → engine/code/audio/openal/al_bus.hpp b/engine/audio/openal/al_bus.hpp → engine/code/audio/openal/al_bus.hpp
diff --git a/engine/audio/openal/al_defs.cpp → engine/code/audio/openal/al_defs.cpp b/engine/audio/openal/al_defs.cpp → engine/code/audio/openal/al_defs.cpp
diff --git a/engine/audio/openal/al_defs.hpp → engine/code/audio/openal/al_defs.hpp b/engine/audio/openal/al_defs.hpp → engine/code/audio/openal/al_defs.hpp
diff --git a/engine/audio/openal/al_engine.cpp → engine/code/audio/openal/al_engine.cpp b/engine/audio/openal/al_engine.cpp → engine/code/audio/openal/al_engine.cpp
diff --git a/engine/audio/openal/al_engine.hpp → engine/code/audio/openal/al_engine.hpp b/engine/audio/openal/al_engine.hpp → engine/code/audio/openal/al_engine.hpp
diff --git a/engine/audio/openal/al_playback.cpp → engine/code/audio/openal/al_playback.cpp b/engine/audio/openal/al_playback.cpp → engine/code/audio/openal/al_playback.cpp
diff --git a/engine/audio/openal/al_playback.hpp → engine/code/audio/openal/al_playback.hpp b/engine/audio/openal/al_playback.hpp → engine/code/audio/openal/al_playback.hpp
diff --git a/engine/core/array_view.hpp → engine/code/core/array_view.hpp b/engine/core/array_view.hpp → engine/code/core/array_view.hpp
diff --git a/engine/core/async.cpp → engine/code/core/async.cpp b/engine/core/async.cpp → engine/code/core/async.cpp
diff --git a/engine/core/async.hpp → engine/code/core/async.hpp b/engine/core/async.hpp → engine/code/core/async.hpp
diff --git a/engine/core/buffered_vector.hpp → engine/code/core/buffered_vector.hpp b/engine/core/buffered_vector.hpp → engine/code/core/buffered_vector.hpp
@@ -51,7 +51,7 @@ namespace wmoge {
         for (const auto& entry : vector) {
             WG_ARCHIVE_WRITE(context, archive, entry);
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T, std::size_t MinCapacity>
@@ -63,7 +63,7 @@ namespace wmoge {
         for (int i = 0; i < size; i++) {
             WG_ARCHIVE_READ(context, archive, vector[i]);
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T, std::size_t MinCapacity>
@@ -73,7 +73,7 @@ namespace wmoge {
             YamlNodeRef child = node.append_child();
             WG_YAML_WRITE(context, child, value);
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T, std::size_t MinCapacity>
@@ -85,7 +85,7 @@ namespace wmoge {
             WG_YAML_READ(context, child, vector[element_id]);
             element_id += 1;
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 #endif
 

diff --git a/engine/core/callback_queue.cpp → engine/code/core/callback_queue.cpp b/engine/core/callback_queue.cpp → engine/code/core/callback_queue.cpp
diff --git a/engine/core/callback_queue.hpp → engine/code/core/callback_queue.hpp b/engine/core/callback_queue.hpp → engine/code/core/callback_queue.hpp
diff --git a/engine/core/callback_stream.cpp → engine/code/core/callback_stream.cpp b/engine/core/callback_stream.cpp → engine/code/core/callback_stream.cpp
diff --git a/engine/core/callback_stream.hpp → engine/code/core/callback_stream.hpp b/engine/core/callback_stream.hpp → engine/code/core/callback_stream.hpp
diff --git a/engine/core/class.cpp → engine/code/core/class.cpp b/engine/core/class.cpp → engine/code/core/class.cpp
diff --git a/engine/core/class.hpp → engine/code/core/class.hpp b/engine/core/class.hpp → engine/code/core/class.hpp
@@ -259,7 +259,7 @@ namespace wmoge {
             else if constexpr (sizeof...(Args) == 4)
                 (*target.*p_method)(*argvp[0], *argvp[1], *argvp[2], *argvp[3]);
 
-            return StatusCode::Ok;
+            return WG_OK;
         };
 
         auto ptr_method = std::make_shared<ClassMethod>(std::move(method));
@@ -307,7 +307,7 @@ namespace wmoge {
             else if constexpr (sizeof...(Args) == 4)
                 res = (*target.*p_method)(*argvp[0], *argvp[1], *argvp[2], *argvp[3]);
 
-            return StatusCode::Ok;
+            return WG_OK;
         };
 
         auto ptr_method = std::make_shared<ClassMethod>(std::move(method));
@@ -340,7 +340,7 @@ namespace wmoge {
             T* target = (T*) obj;
             res       = Var(*target.*p_field);
 
-            return StatusCode::Ok;
+            return WG_OK;
         };
 
         setter.m_args_values = {std::move(default_value)};
@@ -353,7 +353,7 @@ namespace wmoge {
             T* target          = (T*) obj;
             (*target.*p_field) = std::move((F) (*argvp[0]));
 
-            return StatusCode::Ok;
+            return WG_OK;
         };
 
         auto ptr_getter = std::make_shared<ClassMethod>(std::move(getter));

diff --git a/engine/core/cmd_line.cpp → engine/code/core/cmd_line.cpp b/engine/core/cmd_line.cpp → engine/code/core/cmd_line.cpp
diff --git a/engine/core/cmd_line.hpp → engine/code/core/cmd_line.hpp b/engine/core/cmd_line.hpp → engine/code/core/cmd_line.hpp
diff --git a/engine/core/crc32.cpp → engine/code/core/crc32.cpp b/engine/core/crc32.cpp → engine/code/core/crc32.cpp
diff --git a/engine/core/crc32.hpp → engine/code/core/crc32.hpp b/engine/core/crc32.hpp → engine/code/core/crc32.hpp
diff --git a/engine/core/data.cpp → engine/code/core/data.cpp b/engine/core/data.cpp → engine/code/core/data.cpp
@@ -88,7 +88,7 @@ namespace wmoge {
     Status yaml_write(IoContext& context, YamlNodeRef node, const Ref<Data>& data) {
         if (!data) {
             node << "";
-            return StatusCode::Ok;
+            return WG_OK;
         }
 
         std::string encoded;

diff --git a/engine/core/data.hpp → engine/code/core/data.hpp b/engine/core/data.hpp → engine/code/core/data.hpp
diff --git a/engine/core/date_time.cpp → engine/code/core/date_time.cpp b/engine/core/date_time.cpp → engine/code/core/date_time.cpp
diff --git a/engine/core/date_time.hpp → engine/code/core/date_time.hpp b/engine/core/date_time.hpp → engine/code/core/date_time.hpp
diff --git a/engine/core/flat_map.hpp → engine/code/core/flat_map.hpp b/engine/core/flat_map.hpp → engine/code/core/flat_map.hpp
@@ -52,7 +52,7 @@ namespace wmoge {
             WG_ARCHIVE_WRITE(context, archive, entry.first);
             WG_ARCHIVE_WRITE(context, archive, entry.second);
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename K, typename V>
@@ -66,7 +66,7 @@ namespace wmoge {
             WG_ARCHIVE_READ(context, archive, entry.second);
             map.insert(std::move(entry));
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename K, typename V>
@@ -78,7 +78,7 @@ namespace wmoge {
             WG_YAML_READ(context, child, entry);
             map.insert(std::move(entry));
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename K, typename V>
@@ -88,7 +88,7 @@ namespace wmoge {
             YamlNodeRef entry_child = node.append_child();
             WG_YAML_WRITE(context, entry_child, entry);
         }
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
 #endif

diff --git a/engine/core/flat_set.hpp → engine/code/core/flat_set.hpp b/engine/core/flat_set.hpp → engine/code/core/flat_set.hpp
diff --git a/engine/core/log.cpp → engine/code/core/log.cpp b/engine/core/log.cpp → engine/code/core/log.cpp
diff --git a/engine/core/log.hpp → engine/code/core/log.hpp b/engine/core/log.hpp → engine/code/core/log.hpp
diff --git a/engine/core/mask.hpp → engine/code/core/mask.hpp b/engine/core/mask.hpp → engine/code/core/mask.hpp
@@ -115,7 +115,7 @@ namespace wmoge {
             mask.set(flag);
         }
 
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T, int size>
@@ -127,7 +127,7 @@ namespace wmoge {
         });
 
         WG_YAML_WRITE(context, node, flags);
-        return StatusCode::Ok;
+        return WG_OK;
     }
 
     template<typename T, int size>

diff --git a/engine/core/object.cpp → engine/code/core/object.cpp b/engine/core/object.cpp → engine/code/core/object.cpp