Move system stuff to the ecs/system directory

core/CMakeLists.txt

@@ -75,11 +75,11 @@ set(CUBOS_CORE_SOURCE
     "src/cubos/core/ecs/entity/manager.cpp"
     "src/cubos/core/ecs/component/registry.cpp"
     "src/cubos/core/ecs/component/manager.cpp"
-    "src/cubos/core/ecs/commands.cpp"
+    "src/cubos/core/ecs/system/system.cpp"
+    "src/cubos/core/ecs/system/dispatcher.cpp"
+    "src/cubos/core/ecs/system/commands.cpp"
     "src/cubos/core/ecs/blueprint.cpp"
     "src/cubos/core/ecs/world.cpp"
-    "src/cubos/core/ecs/system.cpp"
-    "src/cubos/core/ecs/dispatcher.cpp"
 )
 
 # Create core library

core/include/cubos/core/ecs/blueprint.hpp

@@ -7,8 +7,8 @@
 #include <cubos/core/data/old/binary_deserializer.hpp>
 #include <cubos/core/data/old/binary_serializer.hpp>
 #include <cubos/core/data/old/serialization_map.hpp>
-#include <cubos/core/ecs/commands.hpp>
 #include <cubos/core/ecs/entity/hash.hpp>
+#include <cubos/core/ecs/system/commands.hpp>
 #include <cubos/core/memory/buffer_stream.hpp>
 #include <cubos/core/memory/type_map.hpp>
 

core/include/cubos/core/ecs/accessors.hpp → core/include/cubos/core/ecs/system/accessors.hpp

@@ -1,6 +1,6 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::Read and related types.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
@@ -14,7 +14,7 @@ namespace cubos::core::ecs
     /// Can be used as a pointer with both the `->` and `*` operators.
     ///
     /// @tparam T Resource or component type.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class Read
     {
@@ -50,7 +50,7 @@ namespace cubos::core::ecs
     /// Can be used as a pointer with both the `->` and `*` operators.
     ///
     /// @tparam T Resource or component type.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class Write
     {
@@ -87,7 +87,7 @@ namespace cubos::core::ecs
     /// Can be used as a pointer with both the `->` and `*` operators.
     ///
     /// @tparam T Resource or component type.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class OptRead
     {
@@ -139,7 +139,7 @@ namespace cubos::core::ecs
     /// Can be used as a pointer with both the `->` and `*` operators.
     ///
     /// @tparam T Resource or component type.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class OptWrite
     {

core/include/cubos/core/ecs/commands.hpp → core/include/cubos/core/ecs/system/commands.hpp

@@ -1,6 +1,6 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::Commands and related types.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
@@ -18,7 +18,7 @@ namespace cubos::core::ecs
     class Dispatcher;
 
     /// @brief Allows editing an entity created by a @ref Commands object.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     class EntityBuilder final
     {
     public:
@@ -54,7 +54,7 @@ namespace cubos::core::ecs
     };
 
     /// @brief Used to edit a blueprint spawned by a @ref Commands object.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     class BlueprintBuilder final
     {
     public:
@@ -102,11 +102,11 @@ namespace cubos::core::ecs
         BlueprintBuilder(data::old::SerializationMap<Entity, std::string, EntityHash>&& map, CommandBuffer& commands);
     };
 
-    /// @brief Used to write ECS commands and execute them at a later time.
+    /// @brief System argument used to write ECS commands and execute them at a later time.
     ///
     /// Internally wraps a reference to a CommandBuffer object.
     ///
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     class Commands final
     {
     public:
@@ -151,7 +151,7 @@ namespace cubos::core::ecs
     };
 
     /// @brief Stores commands to execute them later.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     class CommandBuffer final
     {
     public:

core/include/cubos/core/ecs/dispatcher.hpp → core/include/cubos/core/ecs/system/dispatcher.hpp

@@ -1,6 +1,6 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::Dispatcher.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
@@ -10,7 +10,7 @@
 #include <utility>
 #include <vector>
 
-#include <cubos/core/ecs/system.hpp>
+#include <cubos/core/ecs/system/system.hpp>
 #include <cubos/core/log.hpp>
 
 #define ENSURE_CURR_SYSTEM()                                                                                           \
@@ -51,7 +51,7 @@
 namespace cubos::core::ecs
 {
     /// @brief Used to add systems and relations between them and then dispatch them all at once.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     class Dispatcher
     {
     public:

core/include/cubos/core/ecs/event_pipe.hpp → core/include/cubos/core/ecs/system/event/pipe.hpp

@@ -1,6 +1,6 @@
 /// @file
 /// @brief Resource @ref cubos::core::ecs::EventPipe.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
@@ -15,7 +15,7 @@ namespace cubos::core::ecs
     /// @brief Resource which stores events of type @p T.
     /// @note This resource is meant to be used through @ref EventReader and @ref EventWriter.
     /// @tparam T Event type.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class EventPipe
     {

core/include/cubos/core/ecs/event_reader.hpp → core/include/cubos/core/ecs/system/event/reader.hpp

@@ -1,12 +1,12 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::EventReader.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
 #include <optional>
 
-#include <cubos/core/ecs/event_pipe.hpp>
+#include <cubos/core/ecs/system/event/pipe.hpp>
 
 namespace cubos::core::ecs
 {
@@ -18,7 +18,7 @@ namespace cubos::core::ecs
     /// @see Systems can send events using @ref EventWriter.
     /// @tparam T Event.
     /// @tparam M Filter mask.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T, unsigned int M = DEFAULT_FILTER_MASK>
     class EventReader
     {

core/include/cubos/core/ecs/event_writer.hpp → core/include/cubos/core/ecs/system/event/writer.hpp

@@ -1,18 +1,18 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::EventWriter.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
-#include <cubos/core/ecs/event_pipe.hpp>
+#include <cubos/core/ecs/system/event/pipe.hpp>
 
 namespace cubos::core::ecs
 {
     /// @brief System argument which allows the system to send events of type @p T to other
     /// systems.
     /// @see Systems can read sent events using @ref EventReader.
     /// @tparam T
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename T>
     class EventWriter
     {

core/include/cubos/core/ecs/system/module.dox

@@ -0,0 +1,12 @@
+/// @dir
+/// @brief @ref core-ecs-system directory.
+
+/// @dir event
+/// @brief Event system arguments directory.
+
+namespace cubos::core::ecs
+{
+    /// @defgroup core-ecs-system System
+    /// @ingroup core-ecs
+    /// @brief System part of the ECS.
+}

core/include/cubos/core/ecs/query.hpp → core/include/cubos/core/ecs/system/query.hpp

@@ -4,7 +4,7 @@
 /// This file is a bit scary, but it's not as bad as it looks. It's mostly template specializations
 /// to handle the different types of arguments a query can take.
 ///
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
@@ -13,13 +13,13 @@
 #include <unordered_set>
 #include <utility>
 
-#include <cubos/core/ecs/accessors.hpp>
+#include <cubos/core/ecs/system/accessors.hpp>
 #include <cubos/core/ecs/world.hpp>
 
 namespace cubos::core::ecs
 {
     /// @brief Describes a query.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     struct QueryInfo
     {
         std::unordered_set<std::type_index> read;    ///< Componenst read.
@@ -89,8 +89,8 @@ namespace cubos::core::ecs
         };
     } // namespace impl
 
-    /// @brief Holds the result of a query over all entities in world which match the given
-    /// arguments.
+    /// @brief System argument which holds the result of a query over all entities in world which
+    /// match the given arguments.
     ///
     /// An example of a valid query is:
     ///
@@ -103,7 +103,7 @@ namespace cubos::core::ecs
     /// not present in the entity. Whenever mutability is not needed, Read/OptRead should be used.
     ///
     /// @tparam ComponentTypes Component accessor types to be queried.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename... ComponentTypes>
     class Query
     {

core/include/cubos/core/ecs/system.hpp → core/include/cubos/core/ecs/system/system.hpp

@@ -4,25 +4,25 @@
 /// This file is a bit scary, but it's not as bad as it looks. It's mostly template specializations
 /// to handle the different types of arguments a system can take.
 ///
-/// @ingroup core-ecs
+/// @ingroup core-ecs-system
 
 #pragma once
 
 #include <functional>
 #include <typeindex>
 #include <unordered_set>
 
-#include <cubos/core/ecs/accessors.hpp>
-#include <cubos/core/ecs/commands.hpp>
-#include <cubos/core/ecs/event_reader.hpp>
-#include <cubos/core/ecs/event_writer.hpp>
-#include <cubos/core/ecs/query.hpp>
+#include <cubos/core/ecs/system/accessors.hpp>
+#include <cubos/core/ecs/system/commands.hpp>
+#include <cubos/core/ecs/system/event/reader.hpp>
+#include <cubos/core/ecs/system/event/writer.hpp>
+#include <cubos/core/ecs/system/query.hpp>
 #include <cubos/core/ecs/world.hpp>
 
 namespace cubos::core::ecs
 {
     /// @brief Describes a system.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     struct SystemInfo
     {
         /// @brief Whether the system uses commands or not.
@@ -62,7 +62,7 @@ namespace cubos::core::ecs
 
     /// @brief Base class for system wrappers.
     /// @tparam R Return type of the wrapped system.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename R>
     class AnySystemWrapper
     {
@@ -304,7 +304,7 @@ namespace cubos::core::ecs
 
     /// @brief Wrapper for a system of type @p F.
     /// @tparam F Type of the system function/method/lambda.
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-system
     template <typename F>
     class SystemWrapper final : public AnySystemWrapper<typename impl::SystemTraits<F>::Return>
     {

core/samples/ecs/events/main.cpp

@@ -1,6 +1,6 @@
-#include <cubos/core/ecs/event_pipe.hpp>
-#include <cubos/core/ecs/event_reader.hpp>
-#include <cubos/core/ecs/event_writer.hpp>
+#include <cubos/core/ecs/system/event/pipe.hpp>
+#include <cubos/core/ecs/system/event/reader.hpp>
+#include <cubos/core/ecs/system/event/writer.hpp>
 #include <cubos/core/log.hpp>
 #include <cubos/core/memory/stream.hpp>
 

core/samples/ecs/general/main.cpp

@@ -1,13 +1,13 @@
 #include <iostream>
 
 #include <cubos/core/ecs/blueprint.hpp>
-#include <cubos/core/ecs/commands.hpp>
 #include <cubos/core/ecs/component/map_storage.hpp>
 #include <cubos/core/ecs/component/null_storage.hpp>
 #include <cubos/core/ecs/component/registry.hpp>
 #include <cubos/core/ecs/component/vec_storage.hpp>
-#include <cubos/core/ecs/dispatcher.hpp>
-#include <cubos/core/ecs/system.hpp>
+#include <cubos/core/ecs/system/commands.hpp>
+#include <cubos/core/ecs/system/dispatcher.hpp>
+#include <cubos/core/ecs/system/system.hpp>
 #include <cubos/core/ecs/world.hpp>
 
 using namespace cubos::core;

core/src/cubos/core/ecs/commands.cpp → core/src/cubos/core/ecs/system/commands.cpp

@@ -1,5 +1,5 @@
 #include <cubos/core/ecs/blueprint.hpp>
-#include <cubos/core/ecs/commands.hpp>
+#include <cubos/core/ecs/system/commands.hpp>
 
 using namespace cubos::core::ecs;
 

core/src/cubos/core/ecs/dispatcher.cpp → core/src/cubos/core/ecs/system/dispatcher.cpp

@@ -1,6 +1,6 @@
 #include <algorithm>
 
-#include <cubos/core/ecs/dispatcher.hpp>
+#include <cubos/core/ecs/system/dispatcher.hpp>
 
 using namespace cubos::core::ecs;
 

core/src/cubos/core/ecs/system.cpp → core/src/cubos/core/ecs/system/system.cpp

@@ -1,4 +1,4 @@
-#include <cubos/core/ecs/system.hpp>
+#include <cubos/core/ecs/system/system.hpp>
 
 using namespace cubos::core::ecs;
 

core/tests/ecs/commands.cpp

@@ -1,6 +1,6 @@
 #include <doctest/doctest.h>
 
-#include <cubos/core/ecs/commands.hpp>
+#include <cubos/core/ecs/system/commands.hpp>
 
 #include "utils.hpp"
 

core/tests/ecs/dispatcher.cpp

@@ -2,7 +2,7 @@
 
 #include <doctest/doctest.h>
 
-#include <cubos/core/ecs/dispatcher.hpp>
+#include <cubos/core/ecs/system/dispatcher.hpp>
 
 #include "utils.hpp"
 

core/tests/ecs/query.cpp

@@ -1,6 +1,6 @@
 #include <doctest/doctest.h>
 
-#include <cubos/core/ecs/query.hpp>
+#include <cubos/core/ecs/system/query.hpp>
 
 #include "utils.hpp"
 

core/tests/ecs/system.cpp

@@ -3,7 +3,7 @@
 
 #include <doctest/doctest.h>
 
-#include <cubos/core/ecs/system.hpp>
+#include <cubos/core/ecs/system/system.hpp>
 
 #include "utils.hpp"