doc/api/reader_8h_source.html

 #ifndef READER_H_0811231336

 #define READER_H_0811231336


 #include "export.h"


 #include "bool.h"


 #include <expat.h>


 #include <stddef.h>


 #ifdef __cplusplus

 extern "C" {

 #endif /* __cplusplus */


 typedef struct scew_reader scew_reader;


 typedef struct

 {

   size_t (*read) (scew_reader *, XML_Char *, size_t);


   scew_bool (*end) (scew_reader *);


   scew_bool (*error) (scew_reader *);


   scew_bool (*close) (scew_reader *);


   void (*free) (scew_reader *);

 } scew_reader_hooks;


 extern SCEW_API scew_reader*

 scew_reader_create (scew_reader_hooks const *hooks, void *data);


 extern SCEW_API void* scew_reader_data (scew_reader *reader);


 extern SCEW_API size_t scew_reader_read (scew_reader *reader,

                                          XML_Char *buffer,

                                          size_t char_no);


 extern SCEW_API scew_bool scew_reader_end (scew_reader *reader);


 extern SCEW_API scew_bool scew_reader_error (scew_reader *reader);


 extern SCEW_API scew_bool scew_reader_close (scew_reader *reader);


 extern SCEW_API void scew_reader_free (scew_reader *reader);


 #ifdef __cplusplus

 }

 #endif /* __cplusplus */


 #endif /* READER_H_0811231336 */

scew_reader_free
SCEW_API void scew_reader_free(scew_reader *reader)
Frees the memory allocated by the given reader.

scew_reader_hooks
This is the set of functions that are implemented by all SCEW reader sources.
Definition: reader.h:75

scew_reader_data
SCEW_API void * scew_reader_data(scew_reader *reader)
Returns the reference to the internal data structure being used by the given reader.

export.h
SCEW shared library support.

scew_bool
unsigned char scew_bool
This should be defined using stdbool.h when C99 is available.
Definition: bool.h:35

scew_reader_close
SCEW_API scew_bool scew_reader_close(scew_reader *reader)
Closes the given reader.

scew_reader_create
SCEW_API scew_reader * scew_reader_create(scew_reader_hooks const *hooks, void *data)
Creates a new SCEW reader with the given scew_reader_hooks implementation.

scew_reader
struct scew_reader scew_reader
This is the type delcaration for SCEW readers.
Definition: reader.h:66

scew_reader_read
SCEW_API size_t scew_reader_read(scew_reader *reader, XML_Char *buffer, size_t char_no)
Reads data from the given reader in store it in the specified buffer.

bool.h
SCEW boolean type declaration.

scew_reader_error
SCEW_API scew_bool scew_reader_error(scew_reader *reader)
Tells whether an error was found while reading from the given reader.

scew_reader_end
SCEW_API scew_bool scew_reader_end(scew_reader *reader)
Tells whether the given reader has reached its end.