source/src/engine/resources/serialize-context.hpp

/*
 * 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_SERIALIZE_CONTEXT_HPP
#define ANTKEEPER_RESOURCES_SERIALIZE_CONTEXT_HPP

#include <cstddef>
#include <bit>
#include <filesystem>

/**
 * Provides access to a serialization state.
 */
struct serialize_context
{
public:
	/**
	 * Returns the path associated with this serialize context.
	 */
	[[nodiscard]] virtual const std::filesystem::path& path() const noexcept = 0;
	
	/**
	 * Returns `true` if an error occured during a write operation or initialization, `false` otherwise.
	 */
	[[nodiscard]] virtual bool error() const noexcept = 0;
	
	/**
	 * Writes 8-bit (byte) data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of bytes to write.
	 *
	 * @return Number of bytes written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write8(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 16-bit (word) little-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of words to write.
	 *
	 * @return Number of words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write16_le(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 16-bit (word) big-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of words to write.
	 *
	 * @return Number of words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write16_be(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 16-bit (word) data.
	 *
	 * @tparam Endian Endianness of the write operation.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of words to write.
	 *
	 * @return Number of words written.
	 *
	 * @throw serialize_error Write error.
	 */
	template <std::endian Endian>
	inline std::size_t write16(const std::byte* data, std::size_t count) noexcept(false)
	{
		if constexpr (Endian == std::endian::little)
		{
			return write16_le(data, count);
		}
		else
		{
			return write16_be(data, count);
		}
	}
	
	/**
	 * Writes 32-bit (double word) little-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of double words to write.
	 *
	 * @return Number of double words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write32_le(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 32-bit (double word) big-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of double words to write.
	 *
	 * @return Number of double words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write32_be(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 32-bit (double word) data.
	 *
	 * @tparam Endian Endianness of the write operation.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of double words to write.
	 *
	 * @return Number of double words written.
	 *
	 * @throw serialize_error Write error.
	 */
	template <std::endian Endian>
	inline std::size_t write32(const std::byte* data, std::size_t count) noexcept(false)
	{
		if constexpr (Endian == std::endian::little)
		{
			return write32_le(data, count);
		}
		else
		{
			return write32_be(data, count);
		}
	}
	
	/**
	 * Writes 64-bit (quad word) little-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of quad words to write.
	 *
	 * @return Number of quad words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write64_le(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 64-bit (quad word) big-endian data.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of quad words to write.
	 *
	 * @return Number of quad words written.
	 *
	 * @throw serialize_error Write error.
	 */
	virtual std::size_t write64_be(const std::byte* data, std::size_t count) noexcept(false) = 0;
	
	/**
	 * Writes 64-bit (quad word) data.
	 *
	 * @tparam Endian Endianness of the write operation.
	 *
	 * @param data Pointer to data source.
	 * @param count Number of quad words to write.
	 *
	 * @return Number of quad words written.
	 *
	 * @throw serialize_error Write error.
	 */
	template <std::endian Endian>
	inline std::size_t write64(const std::byte* data, std::size_t count) noexcept(false)
	{
		if constexpr (Endian == std::endian::little)
		{
			return write64_le(data, count);
		}
		else
		{
			return write64_be(data, count);
		}
	}
};

#endif // ANTKEEPER_RESOURCES_SERIALIZE_CONTEXT_HPP