Header Re-Organization for Consistency and Readability

- Provide a consistent taxonomy for headers, where the libraries(ZEngine and Tetragrama) expose their Interface(the -I flag) as the root of the package and header naming is synchronized with namespaces
- This is especially important in libraries like Tetragrama where you have headers from ZEngine and Tetragrama in the same header file
- Make the CMake files cleaner and more consistent by having a uniform naming convention for the Targets

Author: MathewBensonCode

Obelisk/CMakeLists.txt

@@ -9,47 +9,36 @@ project (Obelisk
 set (CMAKE_CXX_STANDARD_REQUIRED ON)
 set	(CMAKE_CXX_STANDARD 20)
 
-set (TARGET_NAME Obelisk)
-
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-    add_executable (${TARGET_NAME} WIN32)
+    add_executable (Obelisk WIN32)
 else()
-    add_executable (${TARGET_NAME})
+    add_executable (Obelisk)
 endif()
 
-target_sources(${TARGET_NAME} PUBLIC EntryPoint.cpp)
+target_sources(Obelisk PRIVATE EntryPoint.cpp)
 
 # We set this debugger directory to find assets and resources file
 # after being copied to Debug and Release output directories 
 #
 if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-    set_target_properties(${TARGET_NAME} PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "$(ProjectDir)$(Configuration)")
+    set_target_properties(Obelisk PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "$(ProjectDir)$(Configuration)")
 endif ()
 
-target_include_directories (${TARGET_NAME}
-    PRIVATE
-        .
-        ${ENLISTMENT_ROOT}
-        ${ENLISTMENT_ROOT}/ZEngine
-)
-
-target_precompile_headers(${TARGET_NAME} PRIVATE pch.h)
-
-target_compile_definitions(${TARGET_NAME}
+target_compile_definitions(Obelisk
     PRIVATE
         NOMINMAX
         UNICODE
         _UNICODE
 )
 
-target_link_libraries(${TARGET_NAME} PUBLIC
-    tetragrama
+target_link_libraries(Obelisk PUBLIC
+    Tetragrama
     imported::External_obeliskLibs
 )
 
-set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/lib)
+set_target_properties(Obelisk PROPERTIES INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/lib)
 
-install(TARGETS ${TARGET_NAME} 
+install(TARGETS Obelisk 
     DESTINATION bin
 )
 

Obelisk/EntryPoint.cpp

@@ -1,10 +1,9 @@
 #include <CLI/CLI.hpp>
+#include <Tetragrama/Editor.h>
+#include <ZEngine/Applications/GameApplication.h>
 #include <ZEngine/Core/Memory/MemoryManager.h>
 #include <ZEngine/EngineConfiguration.h>
 #include <ZEngine/Logging/Logger.h>
-#include <ZEngine/Applications/GameApplication.h>
-
-#include <Tetragrama/Editor.h>
 
 #ifdef ZENGINE_PLATFORM
 
@@ -23,11 +22,9 @@ int applicationEntryPoint(int argc, char* argv[])
     LoggerConfiguration logger_cfg = {};
     Logger::Initialize(arena, logger_cfg);
 
-
     GameApplicationPtr app = nullptr;
 
-
-    CLI::App cli{"ObeliskCLI"};
+    CLI::App           cli{"ObeliskCLI"};
     argv                      = cli.ensure_utf8(argv);
 
     std::string config_file   = "";
@@ -37,10 +34,9 @@ int applicationEntryPoint(int argc, char* argv[])
 
     CLI11_PARSE(cli, argc, argv);
 
-
     if (launch_editor)
     {
-        app = ZPushStructCtor(arena, Tetragrama::Editor);    
+        app                      = ZPushStructCtor(arena, Tetragrama::Editor);
         app->EnableRenderOverlay = true;
     }
 

Obelisk/pch.h

@@ -14,41 +14,25 @@ file (GLOB_RECURSE CPP_FILES CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp
 
 source_group (TREE ${PROJECT_SOURCE_DIR} PREFIX "Source Files" FILES ${HEADER_FILES} ${CPP_FILES})
 
-set (TARGET_NAME tetragrama)
+add_library (Tetragrama)
 
-add_library (${TARGET_NAME})
-
-target_sources(${TARGET_NAME} PUBLIC ${HEADER_FILES} ${CPP_FILES})
+target_sources(Tetragrama 
+    PUBLIC FILE_SET HEADERS BASE_DIRS ${PROJECT_SOURCE_DIR}/..
+    PRIVATE ${CPP_FILES}
+)
 
 # We set this debugger directory to find assets and resources file
 # after being copied to Debug and Release output directories 
 #
 if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
-    set_target_properties(${TARGET_NAME} PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "$(ProjectDir)$(Configuration)")
+    set_target_properties(Tetragrama PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "$(ProjectDir)$(Configuration)")
 endif ()
 
-target_include_directories (${TARGET_NAME}
-    PUBLIC
-        .
-        ./Components
-        ./Components/Events
-        ./Controllers
-        ./Inputs
-        ./Layers
-        ./Messengers
-        ./Helpers
-        ./Importers
-        ./Serializers
-        ./Managers
-)
-
-target_precompile_headers(${TARGET_NAME} PRIVATE pch.h)
-
-target_compile_definitions(${TARGET_NAME}
+target_compile_definitions(Tetragrama
     PRIVATE
         NOMINMAX
         UNICODE
         _UNICODE
 )
 
-target_link_libraries(${TARGET_NAME} PUBLIC zEngineLib)
+target_link_libraries(Tetragrama PUBLIC zEngineLib)

Tetragrama/CMakeLists.txt

@@ -1,5 +1,5 @@
 #pragma once
-#include <UIComponent.h>
+#include <Tetragrama/Components/UIComponent.h>
 #include <imgui.h>
 
 namespace Tetragrama::Components

Tetragrama/Components/AboutUIComponent.h

@@ -1,5 +1,5 @@
 #pragma once
-#include <UIComponent.h>
+#include <Tetragrama/Components/UIComponent.h>
 #include <imgui.h>
 
 namespace Tetragrama::Components

Tetragrama/Components/DemoUIComponent.h

@@ -1,12 +1,13 @@
-#include <DockspaceUIComponent.h>
-#include <Editor.h>
-#include <Helpers/UIDispatcher.h>
-#include <Importers/AssimpImporter.h>
-#include <MessageToken.h>
-#include <Messengers/Messenger.h>
+#include <Tetragrama/Components/DockspaceUIComponent.h>
+#include <Tetragrama/Editor.h>
+#include <Tetragrama/Helpers/UIDispatcher.h>
+#include <Tetragrama/MessageToken.h>
+#include <Tetragrama/Messengers/Messenger.h>
+#include <ZEngine/Importers/AssimpImporter.h>
 #include <ZEngine/Logging/LoggerDefinition.h>
 #include <fmt/format.h>
 #include <imgui/imgui_internal.h>
+#include <filesystem>
 
 namespace fs = std::filesystem;
 

Tetragrama/Components/DockspaceUIComponent.cpp

@@ -1,8 +1,8 @@
 #pragma once
-#include <Importers/IAssetImporter.h>
-#include <Message.h>
-#include <Serializers/EditorSceneSerializer.h>
-#include <UIComponent.h>
+#include <Tetragrama/Components/UIComponent.h>
+#include <Tetragrama/Messengers/Message.h>
+#include <Tetragrama/Serializers/EditorSceneSerializer.h>
+#include <ZEngine/Importers/IAssetImporter.h>
 #include <imgui.h>
 
 namespace Tetragrama::Components

Tetragrama/Components/DockspaceUIComponent.h

@@ -1,5 +1,5 @@
 #pragma once
-#include <UIComponentEvent.h>
+#include <Tetragrama/UIComponentEvent.h>
 
 namespace Tetragrama::Components::Event
 {

Tetragrama/Components/Events/SceneTextureAvailableEvent.h

@@ -1,5 +1,5 @@
 #pragma once
-#include <UIComponentEvent.h>
+#include <Tetragrama/Components/Events/UIComponentEvent.h>
 
 namespace Tetragrama::Components::Event
 {