gmio/0.2/stream_8h_source.html

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

 ** gmio

 ** Copyright Fougue (24 Jun. 2016)

 ** contact@fougue.pro

 **

 ** This software is a reusable library whose purpose is to provide complete

 ** I/O support for various CAD file formats (eg. STL)

 **

 ** This software is governed by the CeCILL-B license under French law and

 ** abiding by the rules of distribution of free software.  You can  use,

 ** modify and/ or redistribute the software under the terms of the CeCILL-B

 ** license as circulated by CEA, CNRS and INRIA at the following URL

 ** "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html".

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


 #ifndef GMIO_STREAM_H

 #define GMIO_STREAM_H


 #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


 #endif /* GMIO_STREAM_H */


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

gmio_stream::func_get_pos
int(* func_get_pos)(void *cookie, struct gmio_streampos *pos)
Pointer on a function that retrieves the current position in the stream.
Definition: stream.h:125

gmio_stream::func_at_end
bool(* func_at_end)(void *cookie)
Pointer on a function that checks end-of-stream indicator.
Definition: stream.h:79

gmio_stream::func_write
size_t(* func_write)(void *cookie, const void *ptr, size_t size, size_t count)
Pointer on a function that writes block of data to stream.
Definition: stream.h:115

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)
Pointer on a function that restores the current position in the stream to pos.
Definition: stream.h:133

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:181

gmio_stream::func_read
size_t(* func_read)(void *cookie, void *ptr, size_t size, size_t count)
Pointer on a function that reads block of data from stream.
Definition: stream.h:102

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:183

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

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

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

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

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

gmio_stream::func_error
int(* func_error)(void *cookie)
Pointer on a function that checks error indicator.
Definition: stream.h:89

gmio_stream::func_size
gmio_streamsize_t(* func_size)(void *cookie)
Pointer on a function that returns the size(in bytes) of the stream.
Definition: stream.h:118

gmio_stream_null
struct gmio_stream gmio_stream_null()
Returns a null stream.