/*
  Copyright (c) 2015 Alex Diener
  
  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.
  
  Alex Diener alex@ludobloom.com
*/

#ifndef __BinaryDeserializationContext_H__
#define __BinaryDeserializationContext_H__
#ifdef __cplusplus
extern "C" {
#endif

typedef struct BinaryDeserializationContext BinaryDeserializationContext;
#define BinaryDeserializationContext_superclass DeserializationContext

#include "binaryserialization/BinarySerializationShared.h"
#include "serialization/DeserializationContext.h"

struct BinaryDeserializationContext_containerNode {
	enum BinarySerializationContainerType type;
	uint32_t count;
	uint32_t nextItemIndex;
	size_t startOffset;
	size_t endOffset;
};

#define BinaryDeserializationContext_ivars \
	DeserializationContext_ivars \
	\
	bool bigEndian; \
	const unsigned char * bytes; \
	size_t length; \
	size_t position; \
	size_t containerCount; \
	size_t containerListSize; \
	struct BinaryDeserializationContext_containerNode * containerStack; \
	bool finished;

#define BinaryDeserializationContext_vtable(self_type) \
	DeserializationContext_vtable(self_type)

stemobject_declare(BinaryDeserializationContext)

BinaryDeserializationContext * BinaryDeserializationContext_createWithFile(const char * filePath);
BinaryDeserializationContext * BinaryDeserializationContext_createWithResourceFile(const char * fileID);
BinaryDeserializationContext * BinaryDeserializationContext_createWithBytes(const void * bytes, size_t length);
bool BinaryDeserializationContext_initWithFile(BinaryDeserializationContext * self, const char * filePath);
bool BinaryDeserializationContext_initWithResourceFile(BinaryDeserializationContext * self, const char * fileID);
bool BinaryDeserializationContext_initWithBytes(BinaryDeserializationContext * self, const void * bytes, size_t length);
void BinaryDeserializationContext_dispose(BinaryDeserializationContext * self);

void BinaryDeserializationContext_reset(BinaryDeserializationContext * self);
void BinaryDeserializationContext_beginStructure(BinaryDeserializationContext * self, const char * key);
size_t BinaryDeserializationContext_beginDictionary(BinaryDeserializationContext * self, const char * key);
size_t BinaryDeserializationContext_beginArray(BinaryDeserializationContext * self, const char * key);
void BinaryDeserializationContext_endStructure(BinaryDeserializationContext * self);
void BinaryDeserializationContext_endDictionary(BinaryDeserializationContext * self);
void BinaryDeserializationContext_endArray(BinaryDeserializationContext * self);
bool BinaryDeserializationContext_readBoolean(BinaryDeserializationContext * self, const char * key);
int8_t BinaryDeserializationContext_readInt8(BinaryDeserializationContext * self, const char * key);
uint8_t BinaryDeserializationContext_readUInt8(BinaryDeserializationContext * self, const char * key);
int16_t BinaryDeserializationContext_readInt16(BinaryDeserializationContext * self, const char * key);
uint16_t BinaryDeserializationContext_readUInt16(BinaryDeserializationContext * self, const char * key);
int32_t BinaryDeserializationContext_readInt32(BinaryDeserializationContext * self, const char * key);
uint32_t BinaryDeserializationContext_readUInt32(BinaryDeserializationContext * self, const char * key);
int64_t BinaryDeserializationContext_readInt64(BinaryDeserializationContext * self, const char * key);
uint64_t BinaryDeserializationContext_readUInt64(BinaryDeserializationContext * self, const char * key);
float BinaryDeserializationContext_readFloat(BinaryDeserializationContext * self, const char * key);
double BinaryDeserializationContext_readDouble(BinaryDeserializationContext * self, const char * key);
fixed16_16 BinaryDeserializationContext_readFixed16_16(BinaryDeserializationContext * self, const char * key);
int BinaryDeserializationContext_readEnumeration(BinaryDeserializationContext * self, const char * key, unsigned int valueCount, Serialization_enumKeyValue * values);
int8_t BinaryDeserializationContext_readEnumeration8(BinaryDeserializationContext * self, const char * key, unsigned int valueCount, Serialization_enumKeyValue * values);
int16_t BinaryDeserializationContext_readEnumeration16(BinaryDeserializationContext * self, const char * key, unsigned int valueCount, Serialization_enumKeyValue * values);
int32_t BinaryDeserializationContext_readEnumeration32(BinaryDeserializationContext * self, const char * key, unsigned int valueCount, Serialization_enumKeyValue * values);
uint8_t BinaryDeserializationContext_readBitfield8(BinaryDeserializationContext * self, const char * key, unsigned int bitNameCount, Serialization_bitName * bitNames);
uint16_t BinaryDeserializationContext_readBitfield16(BinaryDeserializationContext * self, const char * key, unsigned int bitNameCount, Serialization_bitName * bitNames);
uint32_t BinaryDeserializationContext_readBitfield32(BinaryDeserializationContext * self, const char * key, unsigned int bitNameCount, Serialization_bitName * bitNames);
uint64_t BinaryDeserializationContext_readBitfield64(BinaryDeserializationContext * self, const char * key, unsigned int bitNameCount, Serialization_bitName * bitNames);
const char * BinaryDeserializationContext_readString(BinaryDeserializationContext * self, const char * key);
const char * BinaryDeserializationContext_readStringNullable(BinaryDeserializationContext * self, const char * key);
const void * BinaryDeserializationContext_readBlob(BinaryDeserializationContext * self, const char * key, size_t * outLength);
const char * BinaryDeserializationContext_readNextDictionaryKey(BinaryDeserializationContext * self);
bool BinaryDeserializationContext_hasDictionaryKey(BinaryDeserializationContext * self, const char * key);

#ifdef __cplusplus
}
#endif
#endif