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

Syntax checking functions. More...

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

Functions

int SyntaxChecker_hasExpectedXHTMLSyntax (XMLNode_t *node, SBMLNamespaces_t *sbmlns)
 _tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tXMLNode_t_t _tstructure_t _trepresents_t _tXHTML_t _tthat_t _tconforms_t _tto_t _tthe_t _trequirements_t _tof_t _tthe_t _tSBML_t _tspecification_t.
 
int SyntaxChecker_isValidSBMLSId (const char *sid)
 _tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tSBML_t _ttype_t _tSId_t.
 
int SyntaxChecker_isValidUnitSId (const char *units)
 _tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tSBML_t _ttype_t _tUnitSId_t.
 
int SyntaxChecker_isValidXMLID (const char *id)
 _tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tXML_t _t1_t._t0_t _ttype_t _tID_t.
 

Detailed Description

Syntax checking functions.

Author
Sarah Keating

Function Documentation

◆ SyntaxChecker_hasExpectedXHTMLSyntax()

int SyntaxChecker_hasExpectedXHTMLSyntax ( XMLNode_t node,
SBMLNamespaces_t sbmlns 
)

_tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tXMLNode_t_t _tstructure_t _trepresents_t _tXHTML_t _tthat_t _tconforms_t _tto_t _tthe_t _trequirements_t _tof_t _tthe_t _tSBML_t _tspecification_t.

@_tparam_t _tnode_t _tthe_t _tXMLNode_t_t _tstructure_t _tto_t _tbe_t _tchecked_t _tfor_t _tconformance_t. @_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthe_t @_tp_t _tnode_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tXMLNode_t_t _tstructure_t _tconforms_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tthe_t _toptional_t _tSBMLNamespaces_t_t _targument_t _tcan_t _tbe_t _tused_t _tto_t _tcheck_t _tfor_t _tthe_t _tdeclaration_t _tof_t _tthe_t _tXHTML_t _tnamespace_t _tat_t _tthe_t _ttop_t-_tlevel_t _twithin_t _tan_t _tSBMLDocument_t_t.

@_tmemberof_t _tSyntaxChecker_t_t

◆ SyntaxChecker_isValidSBMLSId()

int SyntaxChecker_isValidSBMLSId ( const char *  sid)

_tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tSBML_t _ttype_t _tSId_t.

@_tparam_t _tsid_t _tstring_t _tto_t _tbe_t _tchecked_t _tfor_t _tconformance_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tconforms_t _tto_t _ttype_t _tSId_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

_tThe_t _tidentifier_t _tgiven_t _tby_t _tan_t _tobject_t'_ts_t "_tid_t" _tattribute_t _tvalue_t _tis_t _tused_t _tto_t _tidentify_t _tthe_t _tobject_t _twithin_t _tthe_t _tSBML_t _tmodel_t _tdefinition_t. _tOther_t _tobjects_t _tcan_t _trefer_t _tto_t _tthe_t _tcomponent_t _tusing_t _tthis_t _tidentifier_t. _tThe_t _tdata_t _ttype_t _tof_t "_tid_t" _tis_t _talways_t <_tcode_t>_tSId_t</_tcode_t> _tor_t _ta_t _ttype_t _tderived_t _tfrom_t _tthat_t, _tsuch_t _tas_t <_tcode_t>_tUnitSId_t</_tcode_t>, _tdepending_t _ton_t _tthe_t _tobject_t _tin_t _tquestion_t. _tAll_t _tdata_t _ttypes_t _tare_t _tdefined_t _tas_t _tfollows_t: <_tpre_t _tstyle_t="_tmargin_t-_tleft_t: _t2em_t; _tborder_t: _tnone_t; _tfont_t-_tweight_t: _tbold_t; _tcolor_t: _tblack_t"> _tletter_t ::= '_ta_t'..'_tz_t','_tA_t'..'_tZ_t' _tdigit_t ::= '_t0_t'..'_t9_t' _tidChar_t ::= _tletter_t | _tdigit_t | '__t' _tSId_t ::= ( _tletter_t | '__t' ) _tidChar_t* </_tpre_t>

@_tmemberof_t _tSyntaxChecker_t_t

_tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tSBML_t _ttype_t _tSId_t.

@_tcond_t _tdoxygenIgnored_t

◆ SyntaxChecker_isValidUnitSId()

int SyntaxChecker_isValidUnitSId ( const char *  units)

_tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tSBML_t _ttype_t _tUnitSId_t.

@_tparam_t _tunits_t _tstring_t _tto_t _tbe_t _tchecked_t _tfor_t _tconformance_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tconforms_t _tto_t _ttype_t _tUnitSId_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t @_thtmlinclude_t _tunitid_t-_tsyntax._thtml_t

@_tmemberof_t _tSyntaxChecker_t_t

◆ SyntaxChecker_isValidXMLID()

int SyntaxChecker_isValidXMLID ( const char *  id)

_tPredicate_t _tindicating_t _twhether_t _tthe_t _targument_t _tstring_t _tconforms_t _tto_t _tthe_t _tXML_t _t1_t._t0_t _ttype_t _tID_t.

@_tparam_t _tid_t _tstring_t _tto_t _tbe_t _tchecked_t _tfor_t _tconformance_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tconforms_t _tto_t _ttype_t _tID_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t @_thtmlinclude_t _txmlid_t-_tsyntax._thtml_t

@_tmemberof_t _tSyntaxChecker_t_t