libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
XMLInputStream.h File Reference

XMLInputStream_t. More...

Include dependency graph for XMLInputStream.h:
This graph shows which files directly or indirectly include this file:

Functions

LIBLAX_EXTERN XMLInputStream_tXMLInputStream_create (const char *content, int isFile, const char *library)
 @_tclass_t _tdoc_xml_encoding_t
 
LIBLAX_EXTERN void XMLInputStream_free (XMLInputStream_t *stream)
 _tDestroys_t _tthis_t _tXMLInputStream_t_t _tstructure_t.
 
LIBLAX_EXTERN const char * XMLInputStream_getEncoding (XMLInputStream_t *stream)
 _tReturns_t _tthe_t _tencoding_t _tof_t _tthe_t _tXML_t _tstream_t.
 
LIBLAX_EXTERN XMLErrorLog_tXMLInputStream_getErrorLog (XMLInputStream_t *stream)
 _tReturns_t _tthe_t _terror_t _tlog_t _tassociated_t _twith_t _tthe_t _tgiven_t _tstream_t.
 
LIBLAX_EXTERN int XMLInputStream_isEOF (XMLInputStream_t *stream)
 _tReturns_t _tnonzero_t _tif_t _tthe_t _tgiven_t _tstream_t _thas_t _treached_t _tEOF_t.
 
LIBLAX_EXTERN int XMLInputStream_isError (XMLInputStream_t *stream)
 _tReturns_t _tnonzero_t _tif_t _tthe_t _tstream_t _thas_t _texperienced_t _ta_t _tfatal_t _terror_t.
 
LIBLAX_EXTERN int XMLInputStream_isGood (XMLInputStream_t *stream)
 _tReturns_t _tnonzero_t _tif_t _tthe_t _tgiven_t _tstream_t _tis_t _tin_t _ta_t _tgood_t _tstate_t.
 
LIBLAX_EXTERN XMLToken_tXMLInputStream_next (XMLInputStream_t *stream)
 _tReturns_t _tthe_t _tnext_t _ttoken_t _tin_t _tthe_t _tgiven_t _tstream_t.
 
LIBLAX_EXTERN const XMLToken_tXMLInputStream_peek (XMLInputStream_t *stream)
 _tReturns_t _tthe_t _tnext_t _ttoken_t @_tem_t _twithout_t _tconsuming_t _tit_t.
 
LIBLAX_EXTERN int XMLInputStream_setErrorLog (XMLInputStream_t *stream, XMLErrorLog_t *log)
 _tSets_t _tthe_t _tXMLErrorLog_t _tthis_t _tstream_t _twill_t _tuse_t _tto_t _tlog_t _terrors_t.
 
LIBLAX_EXTERN void XMLInputStream_skipPastEnd (XMLInputStream_t *stream, const XMLToken_t *element)
 _tConsume_t _tzero_t _tor_t _tmore_t _ttokens_t _tup_t _tto_t _tand_t _tincluding_t _tthe_t _tcorresponding_t _tend_t _telement_t _tor_t _tEOF_t.
 
LIBLAX_EXTERN void XMLInputStream_skipText (XMLInputStream_t *stream)
 _tConsume_t _tzero_t _tor_t _tmore_t _ttokens_t _tup_t _tto_t _tbut_t _tnot_t _tincluding_t _tthe_t _tnext_t _tXML_t _telement_t _tor_t _tEOF_t.
 

Detailed Description

XMLInputStream_t.

Author
Ben Bornstein

Function Documentation

◆ XMLInputStream_create()

LIBLAX_EXTERN XMLInputStream_t * XMLInputStream_create ( const char *  content,
int  isFile,
const char *  library 
)

@_tclass_t _tdoc_xml_encoding_t

@_tpar_t _tThe_t @_tem_t _tencoding_t _tis_t _tindicated_t _tby_t _tthe_t <_tcode_t>_txml_t</_tcode_t> _tdeclaration_t _tat_t _tthe_t _tbeginning_t _tof_t _tan_t _tXML_t _tdocument_t _tor_t _tdata_t _tstream_t. _tThe_t _tform_t _tof_t _tthis_t _tdeclaration_t _tis_t @_tverbatim_t <?_txml_t _tversion_t="_t1_t._t0_t" _tencoding_t="_tUTF_t-_t8_t"?> @_tendverbatim_t _tNote_t _tthat_t _tthe_t _tSBML_t _tspecifications_t _trequire_t _tthe_t _tuse_t _tof_t _tUTF_t-_t8_t _tencoding_t, _tso_t _tfor_t _tSBML_t _tdocuments_t, _tthe_t _tvalue_t _treturned_t _tby_t _tthis_t _tmethod_t _twill_t _talways_t _tbe_t _tthe_t _tstring_t <_tcode_t>"_tUTF_t-_t8_t"</_tcode_t>.

@_tclass_t _tdoc_xml_version_t

@_tpar_t _tThe_t @_tem_t _tversion_t _tis_t _tindicated_t _tby_t _tthe_t <_tcode_t>_txml_t</_tcode_t> _tdeclaration_t _tat_t _tthe_t _tbeginning_t _tof_t _tan_t _tXML_t _tdocument_t _tor_t _tdata_t _tstream_t. _tThe_t _tform_t _tof_t _tthis_t _tdeclaration_t _tis_t @_tverbatim_t <?_txml_t _tversion_t="_t1_t._t0_t" _tencoding_t="_tUTF_t-_t8_t"?> @_tendverbatim_t _tNote_t _tthat_t _tthe_t _tSBML_t _tspecifications_t _trequire_t _tthe_t _tuse_t _tof_t _tversion_t _t1_t._t0_t, _tso_t _tfor_t _tSBML_t _tdocuments_t, _tthe_t _tvalue_t _treturned_t _tby_t _tthis_t _tmethod_t _twill_t _talways_t _tbe_t _tthe_t _tstring_t <_tcode_t>"_t1_t._t0_t"</_tcode_t>.

_tCreates_t _ta_t _tnew_t _tempty_t _tXMLInputStream_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcontent_t _tthe_t _tsource_t _tof_t _tthe_t _tstream_t.

@_tparam_t _tisFile_t _ta_t _tBoolean_t _tflag_t _tto_t _tindicate_t _twhether_t @_tp_t _tcontent_t _tis_t _ta_t _tfile_t _tname_t. _tIf_t @_tc_t _tnonzero_t (_ttrue_t), @_tp_t _tcontent_t _tis_t _tassumed_t _tto_t _tbe_t _tthe_t _tfile_t _tfrom_t _twhich_t _tthe_t _tXML_t _tcontent_t _tis_t _tto_t _tbe_t _tread_t. _tIf_t @_tc_t _tzero_t (_tfalse_t), @_tp_t _tcontent_t _tis_t _ttaken_t _tto_t _tbe_t _ta_t _tstring_t _tthat_t @_tem_t _tis_t _tthe_t _tcontent_t _tto_t _tbe_t _tread_t.

@_tparam_t _tlibrary_t _tthe_t _tname_t _tof_t _tthe_t _tparser_t _tlibrary_t _tto_t _tuse_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tcreated_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_free()

LIBLAX_EXTERN void XMLInputStream_free ( XMLInputStream_t stream)

_tDestroys_t _tthis_t _tXMLInputStream_t_t _tstructure_t.

@_tparam_t _tstream_t _tXMLInputStream_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_getEncoding()

LIBLAX_EXTERN const char * XMLInputStream_getEncoding ( XMLInputStream_t stream)

_tReturns_t _tthe_t _tencoding_t _tof_t _tthe_t _tXML_t _tstream_t.

@_tcopydetails_t _tdoc_xml_encoding_t

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t _tthe_t _tencoding_t _tof_t _tthis_t _tXMLInputStream_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_getErrorLog()

LIBLAX_EXTERN XMLErrorLog_t * XMLInputStream_getErrorLog ( XMLInputStream_t stream)

_tReturns_t _tthe_t _terror_t _tlog_t _tassociated_t _twith_t _tthe_t _tgiven_t _tstream_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t _tthe_t _tXMLErrorLog_t _tobject_t _tfor_t _tthe_t @_tp_t _tstream_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_isEOF()

LIBLAX_EXTERN int XMLInputStream_isEOF ( XMLInputStream_t stream)

_tReturns_t _tnonzero_t _tif_t _tthe_t _tgiven_t _tstream_t _thas_t _treached_t _tEOF_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tstream_t _tis_t _tat_t _tits_t _tend_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_isError()

LIBLAX_EXTERN int XMLInputStream_isError ( XMLInputStream_t stream)

_tReturns_t _tnonzero_t _tif_t _tthe_t _tstream_t _thas_t _texperienced_t _ta_t _tfatal_t _terror_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tfatal_t _terror_t _toccurred_t _twhile_t _treading_t _tfrom_t _tthis_t _tstream_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_isGood()

LIBLAX_EXTERN int XMLInputStream_isGood ( XMLInputStream_t stream)

_tReturns_t _tnonzero_t _tif_t _tthe_t _tgiven_t _tstream_t _tis_t _tin_t _ta_t _tgood_t _tstate_t.

_tThe_t _tdefinition_t _tof_t "_tgood_t _tstate_t" _tis_t _tthat_t _tXMLInputStream_isEOF_t() _tand_t _tXMLInputStream_isError_t() _tboth_t _treturn_t @_tc_t _t0_t (_tfalse_t).

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstream_t _tis_t _thappy_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_next()

LIBLAX_EXTERN XMLToken_t * XMLInputStream_next ( XMLInputStream_t stream)

_tReturns_t _tthe_t _tnext_t _ttoken_t _tin_t _tthe_t _tgiven_t _tstream_t.

_tThe_t _ttoken_t _tis_t _tconsumed_t _tin_t _tthe_t _tprocess_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t _tthe_t _ttoken_t, _tas_t _tan_t _tXMLToken_t_t _tstructure_t.

@_tsee_t _tXMLInputStream_peek_t()

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_peek()

LIBLAX_EXTERN const XMLToken_t * XMLInputStream_peek ( XMLInputStream_t stream)

_tReturns_t _tthe_t _tnext_t _ttoken_t @_tem_t _twithout_t _tconsuming_t _tit_t.

_tA_t _tsubsequent_t _tcall_t _tto_t _teither_t _tXMLInputStream_peek_t() _tor_t _tXMLInputStream_next_t() _twill_t _treturn_t _tthe_t _tsame_t _ttoken_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _texamine_t.

@_treturn_t _tthe_t _ttoken_t, _tas_t _tan_t _tXMLToken_t_t _tstructure_t.

@_tsee_t _tXMLInputStream_get_t()

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_setErrorLog()

LIBLAX_EXTERN int XMLInputStream_setErrorLog ( XMLInputStream_t stream,
XMLErrorLog_t log 
)

_tSets_t _tthe_t _tXMLErrorLog_t _tthis_t _tstream_t _twill_t _tuse_t _tto_t _tlog_t _terrors_t.

@_tparam_t _tstream_t _tXMLInputStream_t_t _tstructure_t _tto_t _tact_t _ton_t.

@_tparam_t _tlog_t _tthe_t _tXMLErrorLog_t_t _tstructure_t _tto_t _tattach_t _tto_t _tthe_t @_tp_t _tstream_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_skipPastEnd()

LIBLAX_EXTERN void XMLInputStream_skipPastEnd ( XMLInputStream_t stream,
const XMLToken_t element 
)

_tConsume_t _tzero_t _tor_t _tmore_t _ttokens_t _tup_t _tto_t _tand_t _tincluding_t _tthe_t _tcorresponding_t _tend_t _telement_t _tor_t _tEOF_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tto_t _tact_t _ton_t.

@_tparam_t _telement_t _tthe_t _telement_t _twhose_t _tend_t _twill_t _tbe_t _tsought_t _tin_t _tthe_t _tinput_t _tstream_t.

@_tmemberof_t _tXMLInputStream_t_t

◆ XMLInputStream_skipText()

LIBLAX_EXTERN void XMLInputStream_skipText ( XMLInputStream_t stream)

_tConsume_t _tzero_t _tor_t _tmore_t _ttokens_t _tup_t _tto_t _tbut_t _tnot_t _tincluding_t _tthe_t _tnext_t _tXML_t _telement_t _tor_t _tEOF_t.

@_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _tact_t _ton_t.

@_tmemberof_t _tXMLInputStream_t_t