/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4strmu.ctr
*/

/*
Copyright (C) 2016-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef DK4STRMU_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4STRMU_H_INCLUDED 1


#line 8 "dk4strmu.ctr"

/**	@file	dk4strmu.h	Unserialize data from stream.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef	DK4STRM_H_INCLUDED
#include <dk4strm.h>
#endif


#ifdef	__cplusplus
extern "C" {
#endif


/**	Retrieve 32 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 4 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u32(uint32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 32 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 4 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i32(int32_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 16 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 2 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u16(uint16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 16 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 2 bytes,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i16(int16_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 8 bit unsigned value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 1 byte,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_u8(uint8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve 8 bit signed value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  if the end of data stream was reached before reading 1 byte,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_i8(int8_t *ptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve string from stream.
	The variable strptr points to should be initialized to NULL.
	On success (string found) this variable is set to dynamically allocated
	memory. Use dk4mem_release() or dk4mem_free() to release that
	memory after use.
	The function sets the destination pointer variable to NULL and reports
	success if a leading string length 0 was found.
	@param	strptr	Address of pointer variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  on unexpected end of data stream or when missing the finalizing
	  0x00 byte on end of string,
	- DK4_E_NOT_FOUND<br>
	  if EOF was reached,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  with mem.elsize and mem.nelem
	  set if there is not enough memory available.
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_string(char **strptr, dk4_stream_t *strm, dk4_er_t *erp);


/**	Retrieve double value from stream.
	@param	ptr		Address of result variable.
	@param	strm	Data stream to read from.
	@param	erp		Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if ptr is NULL or strm is NULL or not opened for reading,
	- DK4_E_SYNTAX<br>
	  on
	  	- unexpected end of data stream
		- or when missing the finalizing 0x00 byte on end of string
		- or when the string is too long
		- or when the string does not contain a double number,
	- DK4_E_NOT_FOUND<br>
	  if not further data was found (EOF reached),
	- DK4_E_READ_FAILED<br>
	  if a read attempt failed for other reasons.
*/

int
dk4stream_unser_double(double *ptr, dk4_stream_t *strm, dk4_er_t *erp);


#ifdef	__cplusplus
}
#endif



#endif