o3de/Code/CryEngine/CryCommon/SimpleSerialize.h

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#ifndef CRYINCLUDE_CRYCOMMON_SIMPLESERIALIZE_H
#define CRYINCLUDE_CRYCOMMON_SIMPLESERIALIZE_H
#pragma once


#include <ISerialize.h> // <> required for Interfuscator
#include "TimeValue.h"

template <bool READING>
class CSimpleSerializeImpl_Reading;

template <>
class CSimpleSerializeImpl_Reading<true>
{
public:
    CSimpleSerializeImpl_Reading()
        : m_bCommit(true) {}
    ILINE bool IsReading() const
    {
        return true;
    }
    ILINE bool ShouldCommitValues() const
    {
        return m_bCommit;
    }
    ILINE void Update(ISerializeUpdateFunction* pFunc)
    {
        if (m_bCommit)
        {
            pFunc->Execute();
        }
    }
protected:
    bool m_bCommit;
};

template <>
class CSimpleSerializeImpl_Reading<false>
{
public:
    ILINE bool IsReading() const
    {
        return false;
    }
    ILINE bool ShouldCommitValues() const
    {
        return true;
    }
    ILINE void Update(ISerializeUpdateFunction*)
    {
    }
};

template <bool READING, ESerializationTarget TARGET>
class CSimpleSerializeImpl
    : public CSimpleSerializeImpl_Reading<READING>
{
public:
    CSimpleSerializeImpl()
        : m_failed(false) {}
    ILINE void BeginGroup(const char* szName)
    {
    }
    ILINE void EndGroup()
    {
    }
    ILINE ESerializationTarget GetSerializationTarget() const
    {
        return TARGET;
    }
    ILINE void FlagPartialRead() {}

    ILINE bool Ok() const
    {
        return !m_failed;
    }

protected:
    ILINE void Failed()
    {
        m_failed = true;
    }

private:
    bool m_failed;
};

template <class Impl>
class CSimpleSerialize
    : public ISerialize
{
public:
    ILINE CSimpleSerialize(Impl& impl)
        : m_impl(impl)
    {
    }

    void Update(ISerializeUpdateFunction* pFunc)
    {
        m_impl.Update(pFunc);
    }

    void BeginGroup(const char* szName)
    {
        m_impl.BeginGroup(szName);
    }

    bool BeginOptionalGroup(const char* szName, bool condition)
    {
        return m_impl.BeginOptionalGroup(szName, condition);
    }

    void EndGroup()
    {
        m_impl.EndGroup();
    }

    bool IsReading() const
    {
        return m_impl.IsReading();
    }

    bool ShouldCommitValues() const
    {
        return m_impl.ShouldCommitValues();
    }

    ESerializationTarget GetSerializationTarget() const
    {
        return m_impl.GetSerializationTarget();
    }

    void WriteStringValue(const char* name, SSerializeString& value, uint32 policy)
    {
        m_impl.Value(name, value, policy);
    }
    void ReadStringValue(const char* name, SSerializeString& curValue, uint32 policy)
    {
        m_impl.Value(name, curValue, policy);
    }

    bool Ok() const
    {
        return m_impl.Ok();
    }

    void FlagPartialRead()
    {
        m_impl.FlagPartialRead();
    }

#define SERIALIZATION_TYPE(T) \
    virtual void Value(const char* name, T & x, uint32 policy) { m_impl.Value(name, x, policy); }
#include "SerializationTypes.h"
#undef SERIALIZATION_TYPE

#define SERIALIZATION_TYPE(T) \
    virtual void ValueWithDefault([[maybe_unused]] const char* name, [[maybe_unused]] T & x, [[maybe_unused]] const T&defaultValue) { assert(0); }
#include "SerializationTypes.h"
    SERIALIZATION_TYPE(SSerializeString)
#undef SERIALIZATION_TYPE

    Impl * GetInnerImpl() {
        return &m_impl;
    }

protected:
    Impl& m_impl;
};

//////////////////////////////////////////////////////////////////////////
// Support serialization with default values,
// Require Implementation serialization stub to have Value() method returning boolean.
//////////////////////////////////////////////////////////////////////////
template <class Impl>
class CSimpleSerializeWithDefaults
    : public CSimpleSerialize<Impl>
{
public:
    ILINE CSimpleSerializeWithDefaults(Impl& impl)
        : CSimpleSerialize<Impl>(impl) {}

#define SERIALIZATION_TYPE(T)                                                      \
    virtual void ValueWithDefault(const char* name, T & x, const T&defaultValue) { \
        if (CSimpleSerialize<Impl>::m_impl.IsReading()) {                          \
            if (!CSimpleSerialize<Impl>::m_impl.Value(name, x, 0)) {               \
                x = defaultValue; }                                                \
        }                                                                          \
        else if (x != defaultValue) {                                              \
            CSimpleSerialize<Impl>::m_impl.Value(name, x, 0); }                    \
    }
#include "SerializationTypes.h"
    SERIALIZATION_TYPE(SSerializeString)
#undef SERIALIZATION_TYPE
};

#endif // CRYINCLUDE_CRYCOMMON_SIMPLESERIALIZE_H