IObject.h

Go to the documentation of this file.

#pragma once

#include "IRefCounted.h"
#include "Types.h"

namespace fsdk {

    struct ISettingsProvider;

    struct IArchive {

        virtual bool write(const void* data, size_t size) = 0;

        virtual bool read(void* data, size_t size) = 0;

        virtual void setSizeHint(size_t hint) { ((void)hint); }

        virtual ~IArchive() = default;
    };

    struct ISerializableObject : IRefCounted {

        enum class Error : uint32_t {
            Ok,             
            Size,           
            Signature,      
            ArchiveRead,    
            InputArchive,   
            ArchiveWrite,   
        };

        enum Flags {

            Default = 0,

            NoSignature = 1
        };

        virtual void getSize(Sizer& sizer, uint32_t flags = Default) const noexcept = 0;

        virtual Result<Error> load(IArchive* archive, uint32_t flags = Default) = 0;

        virtual Result<Error> save(IArchive* archive, uint32_t flags = Default) const = 0;
    };

    template<>
    struct ErrorTraits<ISerializableObject::Error> {

        static bool isOk(ISerializableObject::Error error) noexcept {
            return error == ISerializableObject::Error::Ok;
        }

        static const char* toString (ISerializableObject::Error error) noexcept {
            switch(error) {
                case ISerializableObject::Error::Ok : return "Ok";
                case ISerializableObject::Error::Size: return "Size error";
                case ISerializableObject::Error::Signature: return "Signature error";
                case ISerializableObject::Error::ArchiveRead: return "Error during archive reading";
                case ISerializableObject::Error::InputArchive: return "Input archive is nullptr";
                case ISerializableObject::Error::ArchiveWrite: return "Error during archive writing";
                default: return "Unknown error";
            }
        }
    };

    struct IDataStorageObject : ISerializableObject {

        virtual void clear() noexcept = 0;

        virtual IRefCounted* getParentObject() const noexcept = 0;
    };

}