Serialization.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2018 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_SERIALIZATION_H
#define GF_SERIALIZATION_H

#include <cstddef>
#include <cstdint>

#include "BinaryFile.h"
#include "BufferRef.h"
#include "Portability.h"
#include "StringRef.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  class GF_API Serializer {
  public:
    Serializer(const Path& filename, uint16_t version = 0);

    operator bool() const {
      return static_cast<bool>(m_file);
    }

    uint16_t getVersion() const {
      return m_version;
    }

    void writeBoolean(bool data);

    void writeChar(char data);

    void writeSigned8(int8_t data);

    void writeSigned16(int16_t data);

    void writeSigned32(int32_t data);

    void writeSigned64(int64_t data);

    void writeUnsigned8(uint8_t data);

    void writeUnsigned16(uint16_t data);

    void writeUnsigned32(uint32_t data);

    void writeUnsigned64(uint64_t data);

    void writeFloat(float data);

    void writeDouble(double data);

    void writeString(const char *data, std::size_t size);

    void writeSizeHeader(std::size_t size);

  private:
    void writeBigEndian64(uint64_t data);
    void writeBigEndian32(uint32_t data);
    void writeBigEndian16(uint16_t data);
    void writeBigEndian8(uint8_t data);

  private:
    BinaryFile m_file;
    uint16_t m_version;
  };

  class GF_API Deserializer {
  public:
    Deserializer(const Path& filename);

    operator bool() const {
      return static_cast<bool>(m_file);
    }

    uint16_t getVersion() const {
      return m_version;
    }

    bool readBoolean(bool& data);

    bool readChar(char& data);

    bool readSigned8(int8_t& data);

    bool readSigned16(int16_t& data);

    bool readSigned32(int32_t& data);

    bool readSigned64(int64_t& data);

    bool readUnsigned8(uint8_t& data);

    bool readUnsigned16(uint16_t& data);

    bool readUnsigned32(uint32_t& data);

    bool readUnsigned64(uint64_t& data);

    bool readFloat(float& data);

    bool readDouble(double& data);

    bool readString(char *data, std::size_t size);

    bool readSizeHeader(std::size_t& size);

  private:
    bool readBigEndian64(uint64_t& data);
    bool readBigEndian32(uint32_t& data);
    bool readBigEndian16(uint16_t& data);
    bool readBigEndian8(uint8_t& data);

    bool isEof() const;

  private:
    BinaryFile m_file;
    uint16_t m_version;
    bool m_eof;
  };


#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_SERIALIZATION_H