Refactored entity serialization

.github/workflows/build-tests.yml

@@ -78,7 +78,6 @@ jobs:
           -DECSTASY_INTEGRATIONS_SFML_BUILD_DEMO=TRUE
           -DECSTASY_INTEGRATIONS_USER_ACTION=TRUE
           -DECSTASY_THREAD_SAFE=TRUE
-          -DECSTASY_ENABLE_ENTITY_SERIALIZERS=FALSE
 
       - name: Build
         run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} -j

CMakePresets.json

@@ -30,10 +30,6 @@
         "ECSTASY_THREAD_SAFE": {
           "type": "BOOL",
           "value": "TRUE"
-        },
-        "ECSTASY_ENABLE_ENTITY_SERIALIZERS": {
-          "type": "BOOL",
-          "value": "FALSE"
         }
       }
     },

cmake/Options.cmake

@@ -30,7 +30,6 @@ CMAKE_DEPENDENT_OPTION(ECSTASY_INTEGRATIONS_SFML_BUILD_DEMO "Build SFML integrat
 CMAKE_DEPENDENT_OPTION(ECSTASY_INTEGRATIONS_USER_ACTION "User Action integration." OFF ECSTASY_INTEGRATIONS_EVENT OFF)
 
 ## Serializer formats
-option(ECSTASY_ENABLE_ENTITY_SERIALIZERS "Enable serialization methods in I/AStorage classes" OFF)
 option(ECSTASY_SERIALIZER_TOML "Build Toml serializer." OFF)
 
 if (${ECSTASY_INTEGRATIONS_USER_ACTION})

doc/Building.md

@@ -107,4 +107,3 @@ _In case this documentation is not up to date with the [Options.cmake](/cmake/Op
 | ECSTASY_INTEGRATIONS_SFML_BUILD_DEMO | Enable the Sfml integration demos. Requires **ECSTASY_INTEGRATIONS_SFML**                                                               | OFF           |
 | ECSTASY_INTEGRATIONS_USER_ACTION     | Enable the User Actions integration. Requires **ECSTASY_INTEGRATIONS_EVENT**                                                            | OFF           |
 | ECSTASY_SERIALIZER_TOML              | Enable the Toml Serializer. Force set if **ECSTASY_INTEGRATIONS_USER_ACTION** is set                                                    | OFF           |
-| ECSTASY_ENABLE_ENTITY_SERIALIZERS    | **WIP** - Enable the serialization methods in I/AStorage classes. This allows easy entity (de)serialization.                            | OFF           |

doc/Tutorial.md

@@ -654,14 +654,22 @@ Position &operator<<(RawSerializer &serializer)
 }
 ```
 
-#### Working with Entities (WIP)
+If you need to (de)serialize the type from the save/update/loadEntity methods, you first need to register the type as serializable by the expected Serializer using the variadic macro @ref REGISTER_SERIALIZABLES
+
+For example, if you want you type Position to be serializable by the RawSerializer and the (maybe to come) JsonSerializer:
+
+```cpp
+REGISTER_SERIALIZABLES(Position, RawSerializer, JsonSerializer)
+```
+
+#### Working with Entities
 
 Since you can serialize any type, you can serialize entity components manually using the functions above.
 
-If you define **ECSTASY_ENABLE_ENTITY_SERIALIZERS**, you can serialize an entire entity.
+You can save entity components explicitly using the templated saveEntity method, or every registered components with the classic saveEntity method.
 
 @warning
-This is still work in progress and will certainly be refactored because the underlying code is shit.
+To use the non templated `saveEntity` method, you need to register them using the @ref REGISTER_SERIALIZABLES macro (see below).
 
 ```cpp
 RawSerializer serializer();

src/ecstasy/config.hpp.in

@@ -40,8 +40,6 @@ namespace ecstasy::thread
 #endif
 } // namespace ecstasy::thread
 
-// Enable serialization methods in I/AStorage classes
-#cmakedefine ECSTASY_ENABLE_ENTITY_SERIALIZERS
 // Toml Serializer is available
 #cmakedefine ECSTASY_SERIALIZER_TOML
 

src/ecstasy/registry/Registry.hpp

@@ -1037,7 +1037,7 @@ namespace ecstasy
         template <std::derived_from<ISystem> S>
         S &getSystem()
         {
-            return _storages.get<S>();
+            return _systems.get<S>();
         }
 
         ///
@@ -1179,7 +1179,7 @@ namespace ecstasy
         void runSystems(size_t group, size_t mask);
 
         ///
-        /// @brief Get a reference to the storages instances.
+        /// @brief Get a const reference to the storages instances.
         ///
         /// @return constexpr const Instances<IStorage>& Const reference to the storages instance.
         ///
@@ -1191,6 +1191,19 @@ namespace ecstasy
             return _storages;
         }
 
+        ///
+        /// @brief Get a reference to the storages instances.
+        ///
+        /// @return constexpr Instances<IStorage>& Reference to the storages instance.
+        ///
+        /// @author Andréas Leroux ([email protected])
+        /// @since 1.0.0 (2024-10-04)
+        ///
+        constexpr Instances<IStorage> &getStorages()
+        {
+            return _storages;
+        }
+
       private:
         Instances<ResourceBase> _resources;
         Instances<IStorage> _storages;

src/ecstasy/serialization/CMakeLists.txt

@@ -6,7 +6,8 @@ add_subdirectory(traits)
 
 set(SRC
     ${SRC}
-    ${INCROOT}/ComponentSerializer.hpp
+    ${INCROOT}/EntityComponentSerializer.hpp
+    ${INCROOT}/IEntityComponentSerializer.hpp
     ${INCROOT}/include.hpp
     ${INCROOT}/ISerializer.hpp
     ${INCROOT}/RawSerializer.hpp