ECS Refactor: Alternate Universe

.clang-tidy

@@ -24,7 +24,7 @@ Checks: >
 
 FormatStyle: file
 
-HeaderFilterRegex: '^NovelRT/.*'
+HeaderFilterRegex: '^(?!.*ThirdParty).*'
 
 CheckOptions:
   - key: readability-identifier-naming.ClassCase
@@ -33,7 +33,7 @@ CheckOptions:
     value: CamelCase
 
   - key: readability-identifier-naming.PublicMemberCase
-    value: camelBack
+    value: CamelCase
   - key: readability-identifier-naming.PrivateMemberCase
     value: camelBack
   - key: readability-identifier-naming.PrivateMemberPrefix
@@ -48,7 +48,7 @@ CheckOptions:
     value: CamelCase
 
   - key: readability-identifier-naming.EnumConstantCase
-    value: UPPER_CASE
+    value: CamelCase
 
   - key: readability-identifier-naming.FunctionCase
     value: CamelCase
@@ -79,5 +79,5 @@ CheckOptions:
     value: CamelCase
 
   - key: readability-identifier-naming.VariableCase
-    value: camelCase
+    value: camelBack
 ...

.github/workflows/build-pr.yml

@@ -25,7 +25,7 @@ jobs:
           legacySrcDir="$(pwd)/LegacySrc"
           artefactsDir="$(pwd)/artefacts"
           find "$(pwd)" \( -path "$buildDir" -o -path "$legacySrcDir" -o -path "$artefactsDir" \) -prune -o \
-            -name '*.cpp' -o -name '*.hpp' -exec clang-format --dry-run --Werror --style=file '{}' \+
+            -name '*.cpp' -o -name '*.hpp' -exec clang-format -i --verbose --dry-run --Werror --style=file '{}' \+
 
       - name: Preinstall dependencies
         if: ${{ runner.os == 'Linux' }}
@@ -64,7 +64,7 @@ jobs:
       fail-fast: false
       matrix:
         configuration: [Debug, RelWithDebInfo]
-        os: [windows-2025, ubuntu-24.04, macos-15, macos-13]
+        os: [windows-2025, ubuntu-24.04, macos-15, macos-26]
         vulkan: [1.4.313.0]
 
     steps:

Audio/Legacy/XAudio2/XAudio2AudioProvider.cpp

@@ -7,31 +7,33 @@
 namespace NovelRT::Audio::XAudio2
 {
 
-    XAudio2AudioProvider::XAudio2AudioProvider():
-    _device(nullptr),
-    _masterVoice(nullptr),
-    _sources(std::map<uint32_t, IXAudio2SourceVoice*>()),
-    _sourceCounter(0),
-    _logger(spdlog::stdout_color_mt("XAudio2")),
-    _buffers(std::map<uint32_t, XAUDIO2_BUFFER>()),
-    _bufferCounter(0)
+    XAudio2AudioProvider::XAudio2AudioProvider()
+        : _device(nullptr),
+          _masterVoice(nullptr),
+          _sources(std::map<uint32_t, IXAudio2SourceVoice*>()),
+          _sourceCounter(0),
+          _logger(spdlog::stdout_color_mt("XAudio2")),
+          _buffers(std::map<uint32_t, XAUDIO2_BUFFER>()),
+          _bufferCounter(0)
     {
-        //Logger init
+        // Logger init
         _logger->set_level(spdlog::level::debug);
 
-        //Device and Context Init
-        _hr = CoInitializeEx( nullptr, COINIT_MULTITHREADED );
+        // Device and Context Init
+        _hr = CoInitializeEx(nullptr, COINIT_MULTITHREADED);
         if (FAILED(_hr))
         {
             throw new Exceptions::InitialisationFailureException("Failed to initialise COM!", _hr);
         }
 
-        if (FAILED(_hr = XAudio2Create( &_device, 0, XAUDIO2_DEFAULT_PROCESSOR)))
+        if (FAILED(_hr = XAudio2Create(&_device, 0, XAUDIO2_DEFAULT_PROCESSOR)))
         {
-            throw new Exceptions::InitialisationFailureException("Failed to create an instance of the XAudio2 engine!", _hr);
+            throw new Exceptions::InitialisationFailureException("Failed to create an instance of the XAudio2 engine!",
+                                                                 _hr);
         }
 
-        if (FAILED(_hr = _device->CreateMasteringVoice(&_masterVoice, XAUDIO2_DEFAULT_CHANNELS, XAUDIO2_DEFAULT_SAMPLERATE)))
+        if (FAILED(_hr = _device->CreateMasteringVoice(&_masterVoice, XAUDIO2_DEFAULT_CHANNELS,
+                                                       XAUDIO2_DEFAULT_SAMPLERATE)))
         {
             throw new Exceptions::InitialisationFailureException("Failed to create an output voice!", _hr);
         }
@@ -52,7 +54,7 @@ namespace NovelRT::Audio::XAudio2
 
     void XAudio2AudioProvider::Dispose()
     {
-        for(auto [id, source] : _sources)
+        for (auto [id, source] : _sources)
         {
             source->FlushSourceBuffers();
             source->DestroyVoice();
@@ -73,11 +75,11 @@ namespace NovelRT::Audio::XAudio2
         waveFormatContainer.wBitsPerSample = 32;
         waveFormatContainer.nBlockAlign = 8;
         waveFormatContainer.nSamplesPerSec = static_cast<long>(context.SampleRate);
-        waveFormatContainer.nAvgBytesPerSec = static_cast<long>(waveFormatContainer.nSamplesPerSec * waveFormatContainer.nBlockAlign);
-
+        waveFormatContainer.nAvgBytesPerSec =
+            static_cast<long>(waveFormatContainer.nSamplesPerSec * waveFormatContainer.nBlockAlign);
 
         IXAudio2SourceVoice* newVoice;
-        if(FAILED(_hr = _device->CreateSourceVoice(&newVoice, &waveFormatContainer)))
+        if (FAILED(_hr = _device->CreateSourceVoice(&newVoice, &waveFormatContainer)))
         {
             _logger->error("Could not create source voice - Code: {hr}", _hr);
         }
@@ -89,15 +91,15 @@ namespace NovelRT::Audio::XAudio2
 
     void XAudio2AudioProvider::PlaySource(uint32_t sourceId)
     {
-        if(FAILED(_hr = _sources.at(sourceId)->Start(0)))
+        if (FAILED(_hr = _sources.at(sourceId)->Start(0)))
         {
             _logger->error("Error when attempting to play source {id} - Code: {hr}", sourceId, _hr);
         }
     }
 
     void XAudio2AudioProvider::StopSource(uint32_t sourceId)
     {
-        if(FAILED(_hr = _sources.at(sourceId)->Stop(0)))
+        if (FAILED(_hr = _sources.at(sourceId)->Stop(0)))
         {
             _logger->error("Error when stopping source {id} - Code: {hr}", sourceId, _hr);
         }
@@ -108,26 +110,26 @@ namespace NovelRT::Audio::XAudio2
         StopSource(sourceId);
     }
 
-    uint32_t XAudio2AudioProvider::SubmitAudioBuffer(const NovelRT::Utilities::Misc::Span<float> buffer, AudioSourceContext& context)
+    uint32_t XAudio2AudioProvider::SubmitAudioBuffer(const NovelRT::Utilities::Misc::Span<float> buffer,
+                                                     AudioSourceContext& context)
     {
-        //uint32_t nextBuffer = ++_bufferCounter;
-        XAUDIO2_BUFFER xABuffer =
-        {
-            XAUDIO2_END_OF_STREAM,          // Flags
-            static_cast<uint32_t>(buffer.size()*sizeof(float)),  // AudioBytes
-            static_cast<byte*>(new byte[buffer.size()*sizeof(float)]) //new buffer to copy float* to
+        // uint32_t nextBuffer = ++_bufferCounter;
+        XAUDIO2_BUFFER xABuffer = {
+            XAUDIO2_END_OF_STREAM,                                      // Flags
+            static_cast<uint32_t>(buffer.size() * sizeof(float)),       // AudioBytes
+            static_cast<byte*>(new byte[buffer.size() * sizeof(float)]) // new buffer to copy float* to
         };
 
-        //Because XAudio2 expects a BYTE*, we'll have to cast it up and copy the data from the provided span :(
-        std::memcpy((void*)(xABuffer.pAudioData),
-             reinterpret_cast<void*>(buffer.data()), buffer.size()*sizeof(float));
-        if(context.Loop)
+        // Because XAudio2 expects a BYTE*, we'll have to cast it up and copy the data from the provided span :(
+        std::memcpy((void*)(xABuffer.pAudioData), reinterpret_cast<void*>(buffer.data()),
+                    buffer.size() * sizeof(float));
+        if (context.Loop)
         {
             xABuffer.LoopCount = XAUDIO2_LOOP_INFINITE;
         }
 
         uint32_t sourceId = OpenSource(context);
-        if(FAILED(_hr = _sources.at(sourceId)->SubmitSourceBuffer(&xABuffer)))
+        if (FAILED(_hr = _sources.at(sourceId)->SubmitSourceBuffer(&xABuffer)))
         {
             _logger->error("Failed to submit buffer to source {sourceId} - Code: {hr}", sourceId, std::to_string(_hr));
         }
@@ -138,13 +140,13 @@ namespace NovelRT::Audio::XAudio2
 
     void XAudio2AudioProvider::SetSourceProperties(uint32_t sourceId, AudioSourceContext& context)
     {
-        //volume
-        if(FAILED(_hr = _sources.at(sourceId)->SetVolume(context.Volume)))
+        // volume
+        if (FAILED(_hr = _sources.at(sourceId)->SetVolume(context.Volume)))
         {
             _logger->error("Error when setting volume for source {id} - Code: {hr}", sourceId, _hr);
         }
-        //pitch
-        if(FAILED(_hr = _sources.at(sourceId)->SetFrequencyRatio(context.Pitch)))
+        // pitch
+        if (FAILED(_hr = _sources.at(sourceId)->SetFrequencyRatio(context.Pitch)))
         {
             _logger->error("Error when setting pitch for source {id} - Code: {hr}", sourceId, _hr);
         }
@@ -155,9 +157,10 @@ namespace NovelRT::Audio::XAudio2
         XAUDIO2_VOICE_STATE voiceState;
         _sources.at(sourceId)->GetState(&voiceState, 0);
         AudioSourceState state = ConvertToAudioSourceState(voiceState);
-        if(state == AudioSourceState::SOURCE_STOPPED)
+        if (state == AudioSourceState::SOURCE_STOPPED)
         {
-            if(voiceState.pCurrentBufferContext == NULL && voiceState.BuffersQueued == 0 && voiceState.SamplesPlayed == 0)
+            if (voiceState.pCurrentBufferContext == NULL && voiceState.BuffersQueued == 0 &&
+                voiceState.SamplesPlayed == 0)
             {
                 auto source = _sources.at(sourceId);
                 source->Stop(0);
@@ -169,9 +172,10 @@ namespace NovelRT::Audio::XAudio2
 
     AudioSourceState XAudio2AudioProvider::ConvertToAudioSourceState(XAUDIO2_VOICE_STATE sourceState)
     {
-        if(sourceState.BuffersQueued == 0)
+        if (sourceState.BuffersQueued == 0)
         {
-            if(sourceState.SamplesPlayed > 0 || (sourceState.pCurrentBufferContext == NULL && sourceState.SamplesPlayed == 0))
+            if (sourceState.SamplesPlayed > 0 ||
+                (sourceState.pCurrentBufferContext == NULL && sourceState.SamplesPlayed == 0))
             {
                 return AudioSourceState::SOURCE_STOPPED;
             }
@@ -182,7 +186,7 @@ namespace NovelRT::Audio::XAudio2
         }
         else
         {
-            if(sourceState.SamplesPlayed > 0)
+            if (sourceState.SamplesPlayed > 0)
             {
                 return AudioSourceState::SOURCE_PLAYING;
             }

Audio/OpenAL/OpenALAudioProvider.cpp

@@ -86,7 +86,7 @@ namespace NovelRT::Audio
     static void InstallLogger(const Logging::LoggingService& logger)
     {
         using CallbackType = void ALC_APIENTRY(void* userptr, char level, const char* message, int length) noexcept;
-        using FnType = void ALC_APIENTRY(CallbackType* callback, void* userptr);
+        using FnType = void ALC_APIENTRY(CallbackType * callback, void* userptr);
 
         void* callback = alcGetProcAddress(nullptr, "alsoft_set_log_callback");
         if (callback == nullptr)

CMakeLists.txt

@@ -43,6 +43,7 @@ add_subdirectory(ThirdParty)
 add_subdirectory(Exceptions)
 add_subdirectory(Logging)
 add_subdirectory(Maths)
+add_subdirectory(ResourceManagement)
 add_subdirectory(Threading)
 add_subdirectory(Timing)
 add_subdirectory(Utilities)
@@ -53,6 +54,8 @@ add_subdirectory(Input)
 add_subdirectory(UI)
 add_subdirectory(Windowing)
 
+add_subdirectory(Ecs)
+
 add_subdirectory(Samples)
 
 if(NOVELRT_INSTALL)

Ecs/CMakeLists.txt

@@ -0,0 +1,12 @@
+include(NovelRTBuildSystem)
+
+NovelRTBuildSystem_DeclareModule(LIBRARY NovelRT::Ecs
+  DEPENDS
+    NovelRT::Ecs::Core
+
+  OPTIONAL_DEPENDS
+    NovelRT::Ecs::Graphics
+)
+
+add_subdirectory(Core)
+add_subdirectory(Graphics)

Ecs/Core/CMakeLists.txt

@@ -0,0 +1,44 @@
+include(NovelRTBuildSystem)
+
+NovelRTBuildSystem_DeclareModule(LIBRARY NovelRT::Ecs::Core
+  DEPENDS
+    NovelRT::Maths
+    NovelRT::Timing
+    NovelRT::Utilities
+
+  SOURCES
+    PRIVATE
+      Catalogue.cpp
+      ComponentBufferMemoryContainer.cpp
+      ComponentCache.cpp
+      EcsDefaultsBuilder.cpp
+      EcsUtils.cpp
+      EntityCache.cpp
+      EntityGraphView.cpp
+      LinkedEntityListView.cpp
+      SparseSetMemoryContainer.cpp
+      SystemScheduler.cpp
+      UnsafeComponentView.cpp
+
+  HEADERS
+    PUBLIC
+      include/NovelRT/Ecs/Components/EntityGraphComponent.hpp
+      include/NovelRT/Ecs/Components/LinkedEntityListNodeComponent.hpp
+      include/NovelRT/Ecs/Components/TransformComponent.hpp
+      include/NovelRT/Ecs/Catalogue.hpp
+      include/NovelRT/Ecs/ComponentBuffer.hpp
+      include/NovelRT/Ecs/ComponentBufferMemoryContainer.hpp
+      include/NovelRT/Ecs/ComponentCache.hpp
+      include/NovelRT/Ecs/ComponentView.hpp
+      include/NovelRT/Ecs/EcsDefaultsBuilder.hpp
+      include/NovelRT/Ecs/EcsUtils.hpp
+      include/NovelRT/Ecs/EntityCache.hpp
+      include/NovelRT/Ecs/EntityGraphView.hpp
+      include/NovelRT/Ecs/IEcsSystem.hpp
+      include/NovelRT/Ecs/LinkedEntityListView.hpp
+      include/NovelRT/Ecs/SparseSet.hpp
+      include/NovelRT/Ecs/SparseSetMemoryContainer.hpp
+      include/NovelRT/Ecs/SystemScheduler.hpp
+      include/NovelRT/Ecs/SystemSchedulerBuilder.hpp
+      include/NovelRT/Ecs/UnsafeComponentView.hpp
+)

LegacySrc/NovelRT/Ecs/Catalogue.cpp → Ecs/Core/Catalogue.cpp

@@ -1,7 +1,12 @@
 // Copyright © Matt Jones and Contributors. Licensed under the MIT Licence (MIT). See LICENCE.md in the repository root
 // for more information.
 
-#include <NovelRT/Ecs/Ecs.h>
+#include <NovelRT/Ecs/Catalogue.hpp>
+#include <NovelRT/Ecs/ComponentCache.hpp>
+#include <NovelRT/Ecs/EntityCache.hpp>
+#include <NovelRT/Ecs/UnsafeComponentView.hpp>
+
+#include <algorithm>
 
 namespace NovelRT::Ecs
 {
@@ -45,4 +50,4 @@ namespace NovelRT::Ecs
     {
         return UnsafeComponentView(_poolId, _componentCache.GetComponentBufferById(componentTypeId));
     }
-} // namespace NovelRT::Ecs
+} // namespace NovelRT::Ecs

LegacySrc/NovelRT/Ecs/ComponentBufferMemoryContainer.cpp → Ecs/Core/ComponentBufferMemoryContainer.cpp

@@ -1,28 +1,35 @@
 // Copyright © Matt Jones and Contributors. Licensed under the MIT Licence (MIT). See LICENCE.md in the repository root
 // for more information.
 
-#include <NovelRT/Ecs/Ecs.h>
+#include <NovelRT/Ecs/ComponentBufferMemoryContainer.hpp>
+#include <NovelRT/Ecs/SparseSetMemoryContainer.hpp>
+#include <NovelRT/Exceptions/KeyNotFoundException.hpp>
+
+#include <NovelRT/Utilities/Memory.hpp>
+
 #include <utility>
 
 namespace NovelRT::Ecs
 {
     ComponentBufferMemoryContainer::ComponentBufferMemoryContainer(
         size_t poolSize,
-        const void* deleteInstructionState,
+        const std::byte* deleteInstructionState,
         size_t sizeOfDataTypeInBytes,
         std::function<void(void*, const void*, size_t)> componentUpdateLogic,
         std::function<bool(const void*, const void*)> componentComparatorLogic,
         const std::string& serialisedTypeName) noexcept
         : _rootSet(SparseSetMemoryContainer(sizeOfDataTypeInBytes)),
           _updateSets(std::vector<SparseSetMemoryContainer>{}),
-          _deleteInstructionState(std::vector<uint8_t>(sizeOfDataTypeInBytes)),
+          _deleteInstructionState(sizeOfDataTypeInBytes),
           _sizeOfDataTypeInBytes(sizeOfDataTypeInBytes),
           _componentUpdateLogic(std::move(componentUpdateLogic)),
           _componentComparatorLogic(std::move(componentComparatorLogic)),
           _serialisedTypeName(serialisedTypeName)
     {
-        NovelRT::Utilities::Memory::Copy(_deleteInstructionState.data(), _sizeOfDataTypeInBytes, deleteInstructionState,
-                                         _sizeOfDataTypeInBytes);
+        NovelRT::Utilities::Memory::Copy(
+            NovelRT::Utilities::Span<const std::byte>{deleteInstructionState, _sizeOfDataTypeInBytes},
+            NovelRT::Utilities::Span<std::byte>{_deleteInstructionState.data(), _sizeOfDataTypeInBytes});
+
         for (size_t i = 0; i < poolSize; i++)
         {
             _updateSets.emplace_back(sizeOfDataTypeInBytes);