#include <JsonSerializer.hpp>

Inheritance diagram for ecstasy::serialization::JsonSerializer:

[legend]

Collaboration diagram for ecstasy::serialization::JsonSerializer:

[legend]

Public Types
enum class	NestedContextOp { NewObject , NewArray , Close }
	Nested context operations, used to open and close nested objects and arrays in streams easily. More...

Public Member Functions
	JsonSerializer ()
	Construct a new Raw Serializer instance.

	JsonSerializer (const std::string &content)
	Construct a new Raw Serializer and import the content from a string.

	JsonSerializer (const std::filesystem::path &filename)
	Construct a new Raw Serializer and import the content from a file.

	JsonSerializer (std::istream &stream)
	Construct a new Raw Serializer and import the content from a stream.

	~JsonSerializer () override=default
	Destroy the JsonSerializer.

void	clear () override final
	Clear the serializer content.

size_t	size () const override final
	Get the size of the serializer content (in bytes).

void	importStream (std::istream &stream) override final
	Import data from a stream into the serializer.

void	exportStream (std::ostream &stream) const override final
	Export the serializer content to a stream.

void	resetCursor ()
	Reset the json read/write cursor to the begining of the document.

template<typename T , typename = typename std::enable_if< (std::is_same_v<T, std::string> \|\| std::is_same_v<T, std::string_view>) \|\| std::is_bounded_array_v<T> \|\| util::meta::is_std_vector<T>::value \|\| std::is_fundamental_v<T> \|\| std::is_same_v<T, std::type_info> \|\| std::is_same_v<T, NestedContextOp> , int>::type>
JsonSerializer &	saveImpl (const T &object)
	Save an object to the serializer.

template<typename U > requires std::is_same_v<U, NestedContextOp>
JsonSerializer &	updateImpl (const U &object)
	Update an existing object from the serializer.

template<typename U , typename = typename std::enable_if<( std::is_same_v<U, std::string> \|\| std::is_same_v<U, std::string_view> \|\| std::is_bounded_array_v<U> \|\| util::meta::is_std_vector<U>::value) , int>::type>
JsonSerializer &	updateImpl (U &object)
	Update an existing object from the serializer.

template<typename U > requires std::is_fundamental_v<U> \|\| std::is_same_v<U, std::string>
U	loadImpl ()
	Load an object from the serializer.

rapidjson::Value &	readCurrentValue (bool andMoveCursor=true)
	Access the current value in the json document, and move the cursor to the next value.

JsonSerializer &	newNested (rapidjson::Type type, bool create=true)
	Open a new nested object or array context in the current object (see getWriteCursor).

JsonSerializer &	newNestedObject (bool create=true)
	Wrapper for JsonSerializer::newNested() with rapidjson::kObjectType as parameter.

JsonSerializer &	newNestedArray (bool create=true)
	Wrapper for JsonSerializer::newNested() with rapidjson::kArrayType as parameter.

JsonSerializer &	closeNested ()
	Close the current nested object or array opened with newNestedObject or newNestedArray (or newNested).

rapidjson::Value &	getWriteCursor () noexcept
	Get a reference to the current cursor (ie nested objects or arrays).

JsonSerializer &	addValue (rapidjson::Value &&value)
	Add a value to the current object or array.

bool	isArrayEnd ()
	Check if the current cursor is at the end of an array.

size_t	getArraySize ()
	Get the size of the current array.

Public Member Functions inherited from ecstasy::serialization::Serializer< JsonSerializer >
	Serializer ()=default
	Construct a new Serializer.

	~Serializer () override=default
	Destroy the Serializer.

constexpr JsonSerializer &	inner ()
	Get a reference to the inner serializer.

void	importFile (const std::filesystem::path &filename) override
	Import data from a file into the serializer.

void	importBytes (const std::string &content) override
	Import data from a string into the serializer.

void	exportFile (const std::filesystem::path &filename) const override
	Export the serializer content to a file.

std::string	exportBytes () const override
	Export the serializer content to a string.

JsonSerializer &	save (const U &object)
	Save an object to the serializer.

JsonSerializer &	saveEntityComponent (const C &component)
	Save an entity component to the serializer.

JsonSerializer &	saveEntity (const RegistryEntity &entity)
	Save an entity to the serializer with explicit components.

JsonSerializer &	saveEntity (RegistryEntity &entity)
	Save all registered components of an entity to the serializer.

U	load ()
	Load an object from the serializer.

RegistryEntity	loadEntity (Registry &registry)
	Load an entity component from the serializer.

JsonSerializer &	update (U &object)
	Update an existing object from the serializer.

JsonSerializer &	updateEntity (RegistryEntity &entity)
	Update all registered components of an entity from the serializer.

JsonSerializer &	operator<< (const U &object)
	Operator overload to simplify the save method.

JsonSerializer &	operator>> (U &object)
	Operator overload to simplify the update method.

Public Member Functions inherited from ecstasy::serialization::ISerializer
virtual	~ISerializer ()=default
	Destroy the ISerializer.

virtual void	clear ()=0
	Clear the serializer content.

virtual size_t	size () const =0
	Get the size of the serializer content (in bytes).

virtual void	importFile (const std::filesystem::path &filename)=0
	Import data from a file into the serializer.

virtual void	importBytes (const std::string &content)=0
	Import data from a string into the serializer.

virtual void	importStream (std::istream &stream)=0
	Import data from a stream into the serializer.

virtual void	exportFile (const std::filesystem::path &filename) const =0
	Export the serializer content to a file.

virtual std::string	exportBytes () const =0
	Export the serializer content to a string.

virtual void	exportStream (std::ostream &stream) const =0
	Export the serializer content to a stream.

Static Public Attributes
static constexpr NestedContextOp	NewObject = NestedContextOp::NewObject
	Open a new object (Creating it in save mode)

static constexpr NestedContextOp	NewArray = NestedContextOp::NewArray
	Open a new array (Creating it in save mode)

static constexpr NestedContextOp	Close = NestedContextOp::Close
	Close the current object or array.

Static Public Attributes inherited from ecstasy::serialization::Serializer< JsonSerializer >
static constexpr bool	is_constructible
	Check if a type is constructible from the serializer.

Private Member Functions
OptionalEntityComponentSerializer	loadComponentSerializer () override final
	Load the next component serializer from the stream.

void	beforeSaveEntity (RegistryEntity &entity) override final
	Optional method triggered at the start of saveEntity.

void	afterSaveEntity (RegistryEntity &entity) override final
	Optional method triggered at the end of saveEntity.

void	beforeUpdateEntity (RegistryEntity &entity) override final
	Optional method triggered at the start of updateEntity.

void	afterUpdateEntity (RegistryEntity &entity) override final
	Optional method triggered at the end of updateEntity.

Private Attributes
rapidjson::Document	_document
	RapidJson document.

std::stack< std::reference_wrapper< rapidjson::Value > >	_stack
	Stack of nested objects or arrays, to keep track of the current context.

std::stack< rapidjson::Value::ValueIterator >	_arrayIterators
	Stack of array iterators, to keep track of the current array element.

std::stack< rapidjson::Value::MemberIterator >	_objectIterators
	Stack of object iterators, to keep track of the current object element.

std::string	_nextKey
	Next key to use for the next object value.

Additional Inherited Members
Static Public Member Functions inherited from ecstasy::serialization::Serializer< JsonSerializer >
static IEntityComponentSerializer &	registerComponent (std::string_view name)
	Register a component to this serializer type.

static bool	hasEntityComponentSerializer ()
	Get the registered components of the serializer.

Protected Types inherited from ecstasy::serialization::Serializer< JsonSerializer >
using	Parent = Serializer< JsonSerializer >
	Parent serializer type, used for inheriting classes.

using	OptionalEntityComponentSerializer = std::optional< std::reference_wrapper< IEntityComponentSerializer > >

virtual OptionalEntityComponentSerializer	loadComponentSerializer ()=0
	Load the next component serializer from the stream.

virtual void	beforeSaveEntity (RegistryEntity &entity)
	Optional method triggered at the start of saveEntity.

virtual void	afterSaveEntity (RegistryEntity &entity)
	Optional method triggered at the end of saveEntity.

virtual void	beforeUpdateEntity (RegistryEntity &entity)
	Optional method triggered at the start of updateEntity.

virtual void	afterUpdateEntity (RegistryEntity &entity)
	Optional method triggered at the end of updateEntity.

Detailed Description

JsonSerializer class.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 38 of file JsonSerializer.hpp.

Member Enumeration Documentation

◆ NestedContextOp

enum class ecstasy::serialization::JsonSerializer::NestedContextOp

strong

Nested context operations, used to open and close nested objects and arrays in streams easily.

Note: Use the static constexpr instances to use them in stream operations.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Enumerator
NewObject	Open a new object (Creating it in save mode)
NewArray	Open a new array (Creating it in save mode)
Close	Close the current object or array.

Definition at line 48 of file JsonSerializer.hpp.

                                   {
            NewObject, 
            NewArray,  
            Close      
        };

Constructor & Destructor Documentation

◆ JsonSerializer() [1/4]

ecstasy::serialization::JsonSerializer::JsonSerializer ( )

inline

Construct a new Raw Serializer instance.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 66 of file JsonSerializer.hpp.

        {
            _document.SetArray();
        };

◆ JsonSerializer() [2/4]

ecstasy::serialization::JsonSerializer::JsonSerializer ( const std::string & content )

inline

Construct a new Raw Serializer and import the content from a string.

Parameters

[in] content String to import.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Definition at line 79 of file JsonSerializer.hpp.

        {
            importBytes(content);
        }

◆ JsonSerializer() [3/4]

ecstasy::serialization::JsonSerializer::JsonSerializer ( const std::filesystem::path & filename )

inlineexplicit

Construct a new Raw Serializer and import the content from a file.

Parameters

[in] filename Path to the file to import.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Definition at line 92 of file JsonSerializer.hpp.

        {
            importFile(filename);
        }

◆ JsonSerializer() [4/4]

ecstasy::serialization::JsonSerializer::JsonSerializer ( std::istream & stream )

inline

Construct a new Raw Serializer and import the content from a stream.

Parameters

[in] stream Input stream.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Definition at line 104 of file JsonSerializer.hpp.

        {
            importStream(stream);
        }

◆ ~JsonSerializer()

ecstasy::serialization::JsonSerializer::~JsonSerializer ( )

overridedefault

Destroy the JsonSerializer.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-06-11)

Member Function Documentation

◆ addValue()

JsonSerializer & ecstasy::serialization::JsonSerializer::addValue ( rapidjson::Value && value )

inline

Add a value to the current object or array.

If the current object is an array, the value will be appended to it. If the current object is an object, the first call will set the key (string) for the next value, and the second call will add the value to the object (using the previous key identifier).

Parameters

[in] value Value to add.

Returns: JsonSerializer& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 480 of file JsonSerializer.hpp.

        {
            rapidjson::Value &cursor = getWriteCursor();
 
            if (cursor.IsObject()) {
                if (_nextKey.empty()) {
                    if (value.IsString())
                        _nextKey = value.GetString();
                    else
                        throw std::logic_error("Json object key is missing.");
                } else {
                    cursor.AddMember(
                        rapidjson::Value(_nextKey.c_str(), _document.GetAllocator()), value, _document.GetAllocator());
                    _nextKey.clear();
                }
            } else {
                cursor.PushBack(value, _document.GetAllocator());
            }
            return *this;
        }

◆ afterSaveEntity()

void ecstasy::serialization::JsonSerializer::afterSaveEntity ( RegistryEntity & entity )

inlinefinaloverrideprivatevirtual

Optional method triggered at the end of saveEntity.

Parameters

[in] entity Entity being saved.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Reimplemented from ecstasy::serialization::Serializer< JsonSerializer >.

Definition at line 577 of file JsonSerializer.hpp.

        {
            closeNested();
        }

◆ afterUpdateEntity()

void ecstasy::serialization::JsonSerializer::afterUpdateEntity ( RegistryEntity & entity )

inlinefinaloverrideprivatevirtual

Optional method triggered at the end of updateEntity.

Parameters

[in] entity Entity being updated.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Reimplemented from ecstasy::serialization::Serializer< JsonSerializer >.

Definition at line 590 of file JsonSerializer.hpp.

        {
            _objectIterators.pop();
            closeNested();
        }

◆ beforeSaveEntity()

void ecstasy::serialization::JsonSerializer::beforeSaveEntity ( RegistryEntity & entity )

inlinefinaloverrideprivatevirtual

Optional method triggered at the start of saveEntity.

Parameters

[in] entity Entity being saved.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Reimplemented from ecstasy::serialization::Serializer< JsonSerializer >.

Definition at line 571 of file JsonSerializer.hpp.

        {
            newNestedObject();
        }

◆ beforeUpdateEntity()

void ecstasy::serialization::JsonSerializer::beforeUpdateEntity ( RegistryEntity & entity )

inlinefinaloverrideprivatevirtual

Optional method triggered at the start of updateEntity.

Parameters

[in] entity Entity being updated.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Reimplemented from ecstasy::serialization::Serializer< JsonSerializer >.

Definition at line 583 of file JsonSerializer.hpp.

        {
            newNestedObject(false);
            _objectIterators.push(getWriteCursor().MemberBegin());
        }

◆ clear()

void ecstasy::serialization::JsonSerializer::clear ( )

inlinefinaloverridevirtual

Clear the serializer content.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 118 of file JsonSerializer.hpp.

        {
            _document.Clear();
            _document.SetArray();
        }

◆ closeNested()

JsonSerializer & ecstasy::serialization::JsonSerializer::closeNested ( )

inline

Close the current nested object or array opened with newNestedObject or newNestedArray (or newNested).

Returns: JsonSerializer& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 444 of file JsonSerializer.hpp.

        {
            if (_stack.top().get().IsArray() && !_arrayIterators.empty())
                _arrayIterators.pop();
            _stack.pop();
            return *this;
        }

◆ exportStream()

void ecstasy::serialization::JsonSerializer::exportStream ( std::ostream & stream ) const

inlinefinaloverridevirtual

Export the serializer content to a stream.

Parameters

[in] stream Stream to export the serializer content to.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 140 of file JsonSerializer.hpp.

        {
            rapidjson::OStreamWrapper osw(stream);
            rapidjson::Writer<rapidjson::OStreamWrapper> writer(osw);
 
            _document.Accept(writer);
        }

◆ getArraySize()

size_t ecstasy::serialization::JsonSerializer::getArraySize ( )

inline

Get the size of the current array.

Returns: size_t Size of the current array.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2025-04-10)

Definition at line 530 of file JsonSerializer.hpp.

        {
            rapidjson::Value &cursor = getWriteCursor();
 
            if (!cursor.IsArray()) {
                throw std::invalid_argument("Invalid cursor type. Expected object or array.");
            }
            return cursor.Size();
        }

◆ getWriteCursor()

rapidjson::Value & ecstasy::serialization::JsonSerializer::getWriteCursor ( )

inlinenoexcept

Get a reference to the current cursor (ie nested objects or arrays).

Returns: rapidjson::Value& Reference to the current cursor.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 460 of file JsonSerializer.hpp.

        {
            if (_stack.empty())
                return _document;
            return _stack.top();
        }

◆ importStream()

void ecstasy::serialization::JsonSerializer::importStream ( std::istream & stream )

inlinefinaloverridevirtual

Import data from a stream into the serializer.

Parameters

[in] stream Stream to import.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 131 of file JsonSerializer.hpp.

        {
            rapidjson::IStreamWrapper isw(stream);
 
            clear();
            _document.ParseStream(isw);
        }

◆ isArrayEnd()

bool ecstasy::serialization::JsonSerializer::isArrayEnd ( )

inline

Check if the current cursor is at the end of an array.

Returns: bool True if the cursor is at the end of an array, false otherwise.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2025-04-10)

Definition at line 509 of file JsonSerializer.hpp.

        {
            rapidjson::Value &cursor = getWriteCursor();
 
            if (!cursor.IsArray()) {
                throw std::invalid_argument("Invalid cursor type. Expected object or array.");
            }
            // If the array is empty, push the first element (first document element)
            if (_arrayIterators.empty())
                _arrayIterators.push(cursor.Begin());
            return _arrayIterators.top() == cursor.End();
        }

◆ loadComponentSerializer()

OptionalEntityComponentSerializer ecstasy::serialization::JsonSerializer::loadComponentSerializer ( )

inlinefinaloverrideprivatevirtual

Load the next component serializer from the stream.

Note: Return std::nullopt_t if no more components are available.

Returns: OptionalEntityComponentSerializer Optional reference to the next component serializer.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-04)

Implements ecstasy::serialization::Serializer< JsonSerializer >.

Definition at line 553 of file JsonSerializer.hpp.

        {
            if (getWriteCursor().IsObject()) {
                if (_objectIterators.empty())
                    throw std::logic_error(
                        "No object iterator. This function should be called in an updateEntity context.");
                if (_objectIterators.top() == getWriteCursor().MemberEnd())
                    return std::nullopt;
                _nextKey = _objectIterators.top()->name.GetString();
                ++_objectIterators.top();
                return ecstasy::rtti::TypeRegistry::getInstance().get(_nextKey).getSerializer<JsonSerializer>();
            } else
                return ecstasy::rtti::TypeRegistry::getInstance()
                    .get(load<std::size_t>())
                    .getSerializer<JsonSerializer>();
        }

◆ loadImpl()

template<typename U >
requires std::is_fundamental_v<U> || std::is_same_v<U, std::string>

U ecstasy::serialization::JsonSerializer::loadImpl ( )

inline

Load an object from the serializer.

Note: This construct a new object and consume the associated data from the serializer.

Template Parameters

U	Type of the object to load.

Returns: U Loaded object.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 297 of file JsonSerializer.hpp.

        {
            const rapidjson::Value &value = readCurrentValue(true);
 
            // Read Boolean
            if constexpr (std::is_same_v<U, bool>) {
                return value.GetBool();
            }
            // Read Integer
            else if constexpr (std::numeric_limits<U>::is_integer) {
                if constexpr (std::numeric_limits<U>::is_signed) {
                    if constexpr (sizeof(U) < 8)
                        return static_cast<U>(value.GetInt());
                    else
                        return static_cast<U>(value.GetInt64());
                } else {
                    if constexpr (sizeof(U) < 8)
                        return static_cast<U>(value.GetUint());
                    else
                        return static_cast<U>(value.GetUint64());
                }
            }
            // Read Floating point
            else if constexpr (std::is_floating_point_v<U>) {
                if constexpr (sizeof(U) == 4)
                    return value.GetFloat();
                else
                    return value.GetDouble();
            }
            // Read String
            else if constexpr (std::is_same_v<U, std::string>) {
                return std::string(value.GetString(), value.GetStringLength());
            }
        }

◆ newNested()

JsonSerializer & ecstasy::serialization::JsonSerializer::newNested	(	rapidjson::Type	type,
		bool	create = `true`
	)

inline

Open a new nested object or array context in the current object (see getWriteCursor).

The context can be closed with closeNested.

Warning: If the context is an object you must set a key before adding a value to it.

Parameters

[in]	type	Type of the nested object or array.
[in]	create	If true, create the nested object or array (for save mode).

Returns: JsonSerializer& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 387 of file JsonSerializer.hpp.

        {
            if (type != rapidjson::kObjectType && type != rapidjson::kArrayType)
                throw std::invalid_argument("Invalid type for nested object.");
 
            if (create) {
                rapidjson::Value &cursor = getWriteCursor();
                std::string key = _nextKey;
 
                addValue(rapidjson::Value(type));
                if (cursor.IsArray())
                    _stack.push(cursor[cursor.Size() - 1]);
                else
                    _stack.push(cursor[key.c_str()]);
            } else {
                _stack.push(readCurrentValue());
                if (getWriteCursor().IsArray())
                    _arrayIterators.push(getWriteCursor().Begin());
            }
            return *this;
        }

◆ newNestedArray()

JsonSerializer & ecstasy::serialization::JsonSerializer::newNestedArray ( bool create = true )

inline

Wrapper for JsonSerializer::newNested() with rapidjson::kArrayType as parameter.

Returns: JsonSerializer& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 430 of file JsonSerializer.hpp.

        {
            return newNested(rapidjson::kArrayType, create);
        }

◆ newNestedObject()

JsonSerializer & ecstasy::serialization::JsonSerializer::newNestedObject ( bool create = true )

inline

Wrapper for JsonSerializer::newNested() with rapidjson::kObjectType as parameter.

Returns: JsonSerializer& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-10)

Definition at line 417 of file JsonSerializer.hpp.

        {
            return newNested(rapidjson::kObjectType, create);
        }

◆ readCurrentValue()

rapidjson::Value & ecstasy::serialization::JsonSerializer::readCurrentValue ( bool andMoveCursor = true )

inline

Access the current value in the json document, and move the cursor to the next value.

Parameters

[in] andMoveCursor If true, move the cursor to the next value.

Returns: rapidjson::Value& Reference to the current value.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Definition at line 342 of file JsonSerializer.hpp.

        {
            rapidjson::Value &cursor = getWriteCursor();
 
            if (cursor.IsObject()) {
                if (_nextKey.empty())
                    throw std::invalid_argument("No key set for object value.");
                rapidjson::Value &result = cursor[_nextKey.c_str()];
                if (andMoveCursor)
                    _nextKey.clear();
                return result;
            } else {
                if (!cursor.IsArray()) {
                    throw std::invalid_argument("Invalid cursor type. Expected object or array.");
                }
                // If the array is empty, push the first element (first document element)
                if (_arrayIterators.empty())
                    _arrayIterators.push(cursor.Begin());
 
                // If we reached the end of the array, throw an exception
                if (_arrayIterators.top() == cursor.End())
                    throw std::out_of_range("End of array reached.");
 
                rapidjson::Value *value = _arrayIterators.top();
                // Move the cursor to the next element
                if (andMoveCursor)
                    ++_arrayIterators.top();
                return *value;
            }
        }

◆ resetCursor()

void ecstasy::serialization::JsonSerializer::resetCursor ( )

inline

Reset the json read/write cursor to the begining of the document.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-10-11)

Definition at line 154 of file JsonSerializer.hpp.

        {
            while (!_stack.empty())
                _stack.pop();
            while (!_arrayIterators.empty())
                _arrayIterators.pop();
        }

◆ saveImpl()

template<typename T , typename = typename std::enable_if< (std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>) || std::is_bounded_array_v<T> || util::meta::is_std_vector<T>::value || std::is_fundamental_v<T> || std::is_same_v<T, std::type_info> || std::is_same_v<T, NestedContextOp> , int>::type>

JsonSerializer & ecstasy::serialization::JsonSerializer::saveImpl ( const T & object )

inline

Save an object to the serializer.

Template Parameters

U	Type of the object to save.

Parameters

[in] object Object to save.

Returns: S& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 174 of file JsonSerializer.hpp.

        {
            if constexpr (std::is_same_v<T, NestedContextOp>) {
                switch (object) {
                    case NestedContextOp::NewObject: newNestedObject(); break;
                    case NestedContextOp::NewArray: newNestedArray(); break;
                    case NestedContextOp::Close: closeNested(); break;
                }
            } else if constexpr (std::is_same_v<T, std::string> || std::is_same_v<T, std::string_view>
                || util::meta::is_type_bounded_array_v<T, char>) {
                rapidjson::Value value;
 
                if constexpr (std::is_same_v<T, std::string>)
                    value.SetString(
                        object.c_str(), static_cast<rapidjson::SizeType>(object.length()), _document.GetAllocator());
                else if constexpr (std::is_same_v<T, std::string_view>)
                    value.SetString(
                        object.data(), static_cast<rapidjson::SizeType>(object.length()), _document.GetAllocator());
                else
                    value.SetString(object, _document.GetAllocator());
 
                addValue(std::move(value.Move()));
            } else if constexpr (std::is_bounded_array_v<T>) {
                rapidjson::Value array(rapidjson::kArrayType);
 
                for (size_t i = 0; i < std::extent_v<T>; i++)
                    array.PushBack(object[i], _document.GetAllocator());
                addValue(std::move(array.Move()));
            } else if constexpr (util::meta::is_std_vector<T>::value) {
                rapidjson::Value array(rapidjson::kArrayType);
 
                for (const auto &elem : object)
                    array.PushBack(elem, _document.GetAllocator());
                addValue(std::move(array.Move()));
            } else if constexpr (std::is_same_v<T, std::type_info>) {
                // Will raise an exception if the serializer is not registered
                rtti::AType &type = rtti::TypeRegistry::getInstance().get(object);
 
                if (getWriteCursor().IsObject()) {
                    save(type.getTypeName());
                } else
                    save(type.getHash());
            } else if constexpr (std::is_fundamental_v<T>) {
                addValue(rapidjson::Value(object));
            } else {
                return Parent::save(object);
            }
            return *this;
        }

◆ size()

size_t ecstasy::serialization::JsonSerializer::size ( ) const

inlinefinaloverridevirtual

Get the size of the serializer content (in bytes).

Returns: size_t Size of the serializer content in bytes.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-09-12)

Implements ecstasy::serialization::ISerializer.

Definition at line 125 of file JsonSerializer.hpp.

        {
            return exportBytes().size();
        }

◆ updateImpl() [1/2]

template<typename U >
requires std::is_same_v<U, NestedContextOp>

JsonSerializer & ecstasy::serialization::JsonSerializer::updateImpl ( const U & object )

inline

Update an existing object from the serializer.

Note: If the object is fundamental, it will use the assignment operator, otherwise the << operator is expected to be implemented in U.

Template Parameters

U	Type of the object to update.

Parameters

[in] object Existing object to update.

Returns: S& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 227 of file JsonSerializer.hpp.

        {
            switch (object) {
                case NestedContextOp::NewObject: newNestedObject(false); break;
                case NestedContextOp::NewArray: newNestedArray(false); break;
                case NestedContextOp::Close: closeNested(); break;
            }
            return *this;
        }

◆ updateImpl() [2/2]

template<typename U , typename = typename std::enable_if<( std::is_same_v<U, std::string> || std::is_same_v<U, std::string_view> || std::is_bounded_array_v<U> || util::meta::is_std_vector<U>::value) , int>::type>

JsonSerializer & ecstasy::serialization::JsonSerializer::updateImpl ( U & object )

inline

Update an existing object from the serializer.

Note: If the object is fundamental, it will use the assignment operator, otherwise the << operator is expected to be implemented in U.

Template Parameters

U	Type of the object to update.

Parameters

[in] object Existing object to update.

Returns: S& Reference to this for chain calls.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-04-30)

Definition at line 246 of file JsonSerializer.hpp.

        {
            // Handle string key for object values
            if constexpr (std::is_same_v<U, std::string> || std::is_same_v<U, std::string_view>
                || util::meta::is_type_bounded_array_v<U, char>) {
                if (getWriteCursor().IsObject() && _nextKey.empty())
                    _nextKey = object;
                else {
                    if constexpr (std::is_same_v<U, std::string>)
                        object = load<U>();
                    else
                        throw std::invalid_argument("string_view and char[] can only be used for object keys.");
                }
            }
            // Handle bounded arrays
            else if constexpr (std::is_bounded_array_v<U>) {
                newNestedArray(false);
 
                // Need to fetch the new cursor after the new nested array
                if (getWriteCursor().Size() != std::extent_v<U>)
                    throw std::invalid_argument("Array size mismatch.");
 
                for (size_t i = 0; i < std::extent_v<U>; i++)
                    update(object[i]);
                closeNested();
            }
            // Handle std::vector
            else if constexpr (util::meta::is_std_vector<U>::value) {
                newNestedArray(false);
                rapidjson::SizeType size = getWriteCursor().Size();
 
                object.clear();
                object.reserve(size);
                for (size_t i = 0; i < size; i++) {
                    if constexpr (is_constructible<typename U::value_type>)
                        object.emplace_back(*this);
                    else
                        object.push_back(std::move(load<typename U::value_type>()));
                }
                closeNested();
            } else
                return Parent::update(object);
            return *this;
        }

Member Data Documentation

◆ _arrayIterators

std::stack<rapidjson::Value::ValueIterator> ecstasy::serialization::JsonSerializer::_arrayIterators

private

Stack of array iterators, to keep track of the current array element.

Definition at line 546 of file JsonSerializer.hpp.

◆ _document

rapidjson::Document ecstasy::serialization::JsonSerializer::_document

private

RapidJson document.

Definition at line 542 of file JsonSerializer.hpp.

◆ _nextKey

std::string ecstasy::serialization::JsonSerializer::_nextKey

private

Next key to use for the next object value.

Definition at line 550 of file JsonSerializer.hpp.

◆ _objectIterators

std::stack<rapidjson::Value::MemberIterator> ecstasy::serialization::JsonSerializer::_objectIterators

private

Stack of object iterators, to keep track of the current object element.

Definition at line 548 of file JsonSerializer.hpp.

◆ _stack

std::stack<std::reference_wrapper<rapidjson::Value> > ecstasy::serialization::JsonSerializer::_stack

private

Stack of nested objects or arrays, to keep track of the current context.

Definition at line 544 of file JsonSerializer.hpp.

◆ Close

constexpr NestedContextOp ecstasy::serialization::JsonSerializer::Close = NestedContextOp::Close

staticconstexpr

Close the current object or array.

Definition at line 58 of file JsonSerializer.hpp.

◆ NewArray

constexpr NestedContextOp ecstasy::serialization::JsonSerializer::NewArray = NestedContextOp::NewArray

staticconstexpr

Open a new array (Creating it in save mode)

Definition at line 56 of file JsonSerializer.hpp.

◆ NewObject

constexpr NestedContextOp ecstasy::serialization::JsonSerializer::NewObject = NestedContextOp::NewObject

staticconstexpr

Open a new object (Creating it in save mode)

Definition at line 54 of file JsonSerializer.hpp.

The documentation for this class was generated from the following file:

src/ecstasy/serialization/JsonSerializer.hpp

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ NestedContextOp

Constructor & Destructor Documentation

◆ JsonSerializer() [1/4]

◆ JsonSerializer() [2/4]

◆ JsonSerializer() [3/4]

◆ JsonSerializer() [4/4]

◆ ~JsonSerializer()

Member Function Documentation

◆ addValue()

◆ afterSaveEntity()

◆ afterUpdateEntity()

◆ beforeSaveEntity()

◆ beforeUpdateEntity()

◆ clear()

◆ closeNested()

◆ exportStream()

◆ getArraySize()

◆ getWriteCursor()

◆ importStream()

◆ isArrayEnd()

◆ loadComponentSerializer()

◆ loadImpl()

◆ newNested()

◆ newNestedArray()

◆ newNestedObject()

◆ readCurrentValue()

◆ resetCursor()

◆ saveImpl()

◆ size()

◆ updateImpl() [1/2]

◆ updateImpl() [2/2]

Member Data Documentation

◆ _arrayIterators

◆ _document

◆ _nextKey

◆ _objectIterators

◆ _stack

◆ Close

◆ NewArray

◆ NewObject