mgl_savedata_defs.h

[詳解]

// SPDX-License-Identifier: Zlib
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
 
#ifndef INCGUARD_MGL_SAVEDATA_DEFS_H_1628120644
#define INCGUARD_MGL_SAVEDATA_DEFS_H_1628120644
 
#include <cstddef>
#include <cstdint>
 
#include <mgl/file/mgl_file.h>
#include <mgl/stl/mgl_stl_string.h>
 
namespace MGL::Savedata
{
enum class AccessType : uint8_t
{
    Save,    
    Load     
};
 
using DataIdentifier = uint32_t;
 
using ChunkIdentifier = uint32_t;
 
struct FileInfo
{
    const File::PathView path;    
    size_t size;                  
};
 
enum class Error : uint8_t
{
    None,                  
    NoOperation,           
    BadImplement,          
    DelegateNotReady,      
    DelegateHasError,      
    IdentifierNotFound,    
    BufferNotEnough,       
    FailedToFileAccess,    
    MarkerNotMatching,     
    FailedToChunkParse,    
    Unknown                
};
 
struct RequestInfo
{
    DataIdentifier identifier;    
    uint32_t index;               
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    constexpr RequestInfo(DataIdentifier inIdentifier, uint32_t inIndex = 0) noexcept
        : identifier(inIdentifier)
        , index(inIndex)
    {
    }
};
 
struct Result
{
    DataIdentifier identifier;      
    Error error;                    
    File::Error fileAccessError;    
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    constexpr Result(DataIdentifier inIdentifier, Error inError, File::Error inFileAccessError = File::Error::None) noexcept
        : identifier(inIdentifier)
        , error(inError)
        , fileAccessError(inFileAccessError)
    {
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    constexpr Result() noexcept
        : Result(0, Error::NoOperation, File::Error::None)
    {
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    explicit constexpr operator bool() const noexcept
    {
        return error == Error::None;
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    constexpr bool operator!() const noexcept
    {
        return !static_cast<bool>(*this);
    }
 
    /* ------------------------------------------------------------------------- */
    /* ------------------------------------------------------------------------- */
    [[nodiscard]] constexpr bool HasError(bool errorOnFileNotExist = true) const noexcept
    {
        if (error == Error::None)
        {
            return false;
        }
 
        if (!errorOnFileNotExist)
        {
            if ((error == Error::FailedToFileAccess) && (fileAccessError == File::Error::FileNotExist))
            {
                return false;
            }
        }
 
        return true;
    }
};
 
/* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
constexpr uint32_t MakeDateVersion(uint32_t year, uint32_t month, uint32_t day, uint32_t revision = 0)
{
    return year * 1'000'000 + month * 10'000 + day * 100 + revision;
}
}    // namespace MGL::Savedata
#endif    // INCGUARD_MGL_SAVEDATA_DEFS_H_1628120644
 
// vim: et ts=4 sw=4 sts=4