deserialize-context.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Antkeeper source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_RESOURCES_DESERIALIZE_CONTEXT_HPP
#define ANTKEEPER_RESOURCES_DESERIALIZE_CONTEXT_HPP
 
#include <cstddef>
#include <bit>
#include <filesystem>
 
struct deserialize_context
{
public:
    [[nodiscard]] virtual const std::filesystem::path& path() const noexcept = 0;
    
    [[nodiscard]] virtual bool error() const noexcept = 0;
    
    [[nodiscard]] virtual bool eof() const noexcept = 0;
    
    [[nodiscard]] virtual std::size_t size() const noexcept = 0;
    
    [[nodiscard]] virtual std::size_t tell() const = 0;
    
    virtual void seek(std::size_t offset) = 0;
    
    virtual std::size_t read8(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    virtual std::size_t read16_le(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    virtual std::size_t read16_be(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    template <std::endian Endian>
    inline std::size_t read16(std::byte* data, std::size_t count) noexcept(false)
    {
        if constexpr (Endian == std::endian::little)
        {
            return read16_le(data, count);
        }
        else
        {
            return read16_be(data, count);
        }
    }
    
    virtual std::size_t read32_le(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    virtual std::size_t read32_be(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    template <std::endian Endian>
    inline std::size_t read32(std::byte* data, std::size_t count) noexcept(false)
    {
        if constexpr (Endian == std::endian::little)
        {
            return read32_le(data, count);
        }
        else
        {
            return read32_be(data, count);
        }
    }
    
    virtual std::size_t read64_le(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    virtual std::size_t read64_be(std::byte* data, std::size_t count) noexcept(false) = 0;
    
    template <std::endian Endian>
    inline std::size_t read64(std::byte* data, std::size_t count) noexcept(false)
    {
        if constexpr (Endian == std::endian::little)
        {
            return read64_le(data, count);
        }
        else
        {
            return read64_be(data, count);
        }
    }
};
 
#endif // ANTKEEPER_RESOURCES_DESERIALIZE_CONTEXT_HPP