gmio/0.4/stream_8h_source.html

 /****************************************************************************

 ** Copyright (c) 2017, Fougue Ltd. <http://www.fougue.pro>

 ** All rights reserved.

 **

 ** Redistribution and use in source and binary forms, with or without

 ** modification, are permitted provided that the following conditions

 ** are met:

 **

 **     1. Redistributions of source code must retain the above copyright

 **        notice, this list of conditions and the following disclaimer.

 **

 **     2. Redistributions in binary form must reproduce the above

 **        copyright notice, this list of conditions and the following

 **        disclaimer in the documentation and/or other materials provided

 **        with the distribution.

 **

 ** 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.

 ****************************************************************************/


 #pragma once


 #include "global.h"

 #include "memblock.h"

 #include "streampos.h"

 #include <stdio.h>


 #ifndef DOXYGEN

 #  ifdef GMIO_HAVE_INT64_TYPE

 typedef int64_t gmio_streamsize_t;

 typedef int64_t gmio_streamoffset_t;

 #  else

 typedef long gmio_streamsize_t;

 typedef long gmio_streamoffset_t;

 #  endif

 #else


 typedef int64_or_long gmio_streamsize_t;

 typedef int64_or_long gmio_streamoffset_t;

 #endif


 struct gmio_stream

 {

     void* cookie;


     bool (*func_at_end)(void* cookie);


     int (*func_error)(void* cookie);


     size_t (*func_read)(void* cookie, void* ptr, size_t size, size_t count);


     size_t (*func_write)(void* cookie, const void* ptr, size_t size, size_t count);


     gmio_streamsize_t (*func_size)(void* cookie);


     int (*func_get_pos)(void* cookie, struct gmio_streampos* pos);


     int (*func_set_pos)(void* cookie, const struct gmio_streampos* pos);

 };


 GMIO_C_LINKAGE_BEGIN


 /* Initialization */


 GMIO_API struct gmio_stream gmio_stream_null();


 GMIO_API struct gmio_stream gmio_stream_stdio(FILE* file);


 GMIO_C_LINKAGE_END


GMIO_API
#define GMIO_API
Expands either to GMIO_DECL_EXPORT or GMIO_DECL_IMPORT when respectively compiling/using the DLL...
Definition: global.h:89

gmio_stream::func_get_pos
int(* func_get_pos)(void *cookie, struct gmio_streampos *pos)
Function that retrieves the current position in the stream.
Definition: stream.h:138

gmio_stream::func_at_end
bool(* func_at_end)(void *cookie)
Function that checks end-of-stream indicator.
Definition: stream.h:92

gmio_stream::func_write
size_t(* func_write)(void *cookie, const void *ptr, size_t size, size_t count)
Function that writes block of data to stream.
Definition: stream.h:128

global.h
Fundamental global declarations, included by almost all other header/source files.

memblock.h
Declaration of gmio_memblock and utility functions.

gmio_stream::func_set_pos
int(* func_set_pos)(void *cookie, const struct gmio_streampos *pos)
Function that restores the current position in the stream to pos.
Definition: stream.h:146

gmio_stream_stdio
struct gmio_stream gmio_stream_stdio(FILE *file)
Returns a stream for standard FILE* (cookie will hold file)

GMIO_C_LINKAGE_BEGIN
#define GMIO_C_LINKAGE_BEGIN
Expands to extern "C" { when building with a C++ compiler.
Definition: global.h:203

gmio_stream::func_read
size_t(* func_read)(void *cookie, void *ptr, size_t size, size_t count)
Function that reads block of data from stream.
Definition: stream.h:115

streampos.h
Declaration of gmio_streampos and utility functions.

GMIO_C_LINKAGE_END
#define GMIO_C_LINKAGE_END
Expands to } when building with a C++ compiler.
Definition: global.h:205

gmio_streampos
Specifies a position within a stream.
Definition: streampos.h:54

gmio_streamsize_t
int64_or_long gmio_streamsize_t
Type able to represent the size(in bytes) of a stream.
Definition: stream.h:57

gmio_stream
Stream that can get input from an arbitrary data source or can write output to an arbitrary data sink...
Definition: stream.h:78

gmio_streamoffset_t
int64_or_long gmio_streamoffset_t
Type able to represent the offset position within a stream.
Definition: stream.h:62

gmio_stream::cookie
void * cookie
Opaque pointer on the user stream, passed as first argument to hook functions.
Definition: stream.h:82

gmio_stream::func_error
int(* func_error)(void *cookie)
Function that checks error indicator.
Definition: stream.h:102

gmio_stream::func_size
gmio_streamsize_t(* func_size)(void *cookie)
Function that returns the size(in bytes) of the stream.
Definition: stream.h:131

gmio_stream_null
struct gmio_stream gmio_stream_null()
Returns a null stream.