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 "Portability.h"

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

  struct DataObject;

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

    void writeNil();

    void writeBoolean(bool data);

    void writeSigned(int64_t data);

    void writeUnsigned(uint64_t data);

    void writeFloat(float data);

    void writeDouble(double data);

    void writeString(const char *data, uint32_t size);

    void writeBinary(const uint8_t *data, uint32_t size);

    void writeArrayHeader(uint32_t size);

    void writeMapHeader(uint32_t size);

    void writeExtension(int8_t type, const uint8_t *data, uint32_t size);

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

  private:
    BinaryFile m_file;
  };

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

    bool readNil();

    bool readBoolean(bool& data);

    bool readSigned(int64_t& data);

    bool readUnsigned(uint64_t& data);

    bool readFloat(float& data);

    bool readDouble(double& data);

    bool readStringHeader(uint32_t& size);

    bool readString(char *data, uint32_t size);

    bool readBinaryHeader(uint32_t& size);

    bool readBinary(uint8_t *data, uint32_t size);

    bool readArrayHeader(uint32_t& size);

    bool readMapHeader(uint32_t& size);

    bool readExtensionHeader(int8_t& type, uint32_t& size);

    bool readExtension(uint8_t *data, uint32_t size);


    bool readDataObject(DataObject& object);

  private:
    bool readRawInt8(uint64_t& raw);
    bool readRawInt16(uint64_t& raw);
    bool readRawInt32(uint64_t& raw);
    bool readRawInt64(uint64_t& raw);

    bool readSize8(uint32_t& size);
    bool readSize16(uint32_t& size);
    bool readSize32(uint32_t& size);

    bool readDataObjectMap(DataObject& object);
    bool readDataObjectArray(DataObject& object);
    bool readDataObjectString(DataObject& object);
    bool readDataObjectBinary(DataObject& object);
    bool readDataObjectExtension(DataObject& object);

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

    bool isEof() const;
    uint8_t getByte() const;
    void nextByte();

  private:
    BinaryFile m_file;
    uint8_t m_next;
    bool m_eof;
  };


#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_SERIALIZATION_H