parser.h File Reference

#include <stdarg.h>
#include <libxml/xmlversion.h>
#include <libxml/tree.h>
#include <libxml/dict.h>
#include <libxml/hash.h>
#include <libxml/valid.h>
#include <libxml/entities.h>
#include <libxml/xmlerror.h>
#include <libxml/xmlstring.h>
#include <libxml/encoding.h>
#include <libxml/xmlIO.h>
#include <libxml/globals.h>

Go to the source code of this file.

Data Structures
struct	_xmlParserCtxt
struct	_xmlParserInput
struct	_xmlParserNodeInfo
struct	_xmlParserNodeInfoSeq
struct	_xmlSAXHandler
struct	_xmlSAXHandlerV1
struct	_xmlSAXLocator
: The entity name
referenceSAXFunc: : the user data (XML parser context) Called when an entity reference is detected.
#define	XML_SAX2_MAGIC   0xDEEDBEAF
enum	xmlFeature {   XML_WITH_THREAD = 1, XML_WITH_TREE = 2, XML_WITH_OUTPUT = 3, XML_WITH_PUSH = 4,   XML_WITH_READER = 5, XML_WITH_PATTERN = 6, XML_WITH_WRITER = 7, XML_WITH_SAX1 = 8,   XML_WITH_FTP = 9, XML_WITH_HTTP = 10, XML_WITH_VALID = 11, XML_WITH_HTML = 12,   XML_WITH_LEGACY = 13, XML_WITH_C14N = 14, XML_WITH_CATALOG = 15, XML_WITH_XPATH = 16,   XML_WITH_XPTR = 17, XML_WITH_XINCLUDE = 18, XML_WITH_ICONV = 19, XML_WITH_ISO8859X = 20,   XML_WITH_UNICODE = 21, XML_WITH_REGEXP = 22, XML_WITH_AUTOMATA = 23, XML_WITH_EXPR = 24,   XML_WITH_SCHEMAS = 25, XML_WITH_SCHEMATRON = 26, XML_WITH_MODULES = 27, XML_WITH_DEBUG = 28,   XML_WITH_DEBUG_MEM = 29, XML_WITH_DEBUG_RUN = 30, XML_WITH_ZLIB = 31, XML_WITH_NONE = 99999 }
enum	xmlParserOption {   XML_PARSE_RECOVER = 1<<0, XML_PARSE_NOENT = 1<<1, XML_PARSE_DTDLOAD = 1<<2, XML_PARSE_DTDATTR = 1<<3,   XML_PARSE_DTDVALID = 1<<4, XML_PARSE_NOERROR = 1<<5, XML_PARSE_NOWARNING = 1<<6, XML_PARSE_PEDANTIC = 1<<7,   XML_PARSE_NOBLANKS = 1<<8, XML_PARSE_SAX1 = 1<<9, XML_PARSE_XINCLUDE = 1<<10, XML_PARSE_NONET = 1<<11,   XML_PARSE_NODICT = 1<<12, XML_PARSE_NSCLEAN = 1<<13, XML_PARSE_NOCDATA = 1<<14, XML_PARSE_NOXINCNODE = 1<<15,   XML_PARSE_COMPACT = 1<<16 }
typedef void(*)	cdataBlockSAXFunc (void *ctx, const xmlChar *value, int len)
typedef void(*)	charactersSAXFunc (void *ctx, const xmlChar *ch, int len)
typedef void(*)	commentSAXFunc (void *ctx, const xmlChar *value)
typedef void(*)	endElementNsSAX2Func (void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI)
typedef int(*)	hasExternalSubsetSAXFunc (void *ctx)
typedef int(*)	hasInternalSubsetSAXFunc (void *ctx)
typedef void(*)	ignorableWhitespaceSAXFunc (void *ctx, const xmlChar *ch, int len)
typedef const char typedef const char typedef const char typedef int(*)	isStandaloneSAXFunc (void *ctx)
typedef const char typedef const char typedef const char *	msg
typedef const char typedef const char *	msg
typedef const char *	msg
typedef void(*)	processingInstructionSAXFunc (void *ctx, const xmlChar *target, const xmlChar *data)
typedef void(*)	referenceSAXFunc (void *ctx, const xmlChar *name)
typedef void(*)	startElementNsSAX2Func (void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI, int nb_namespaces, const xmlChar **namespaces, int nb_attributes, int nb_defaulted, const xmlChar **attributes)
typedef const char typedef const char typedef	void (XMLCDECL *fatalErrorSAXFunc)(void *ctx
typedef const char typedef	void (XMLCDECL *errorSAXFunc)(void *ctx
typedef xmlParserInputPtr(*)	xmlExternalEntityLoader (const char *URL, const char *ID, xmlParserCtxtPtr context)
typedef _xmlSAXHandlerV1	xmlSAXHandlerV1
typedef xmlSAXHandlerV1 *	xmlSAXHandlerV1Ptr
typedef	void (XMLCDECL *warningSAXFunc)(void *ctx
XMLPUBFUN long XMLCALL	xmlByteConsumed (xmlParserCtxtPtr ctxt)
XMLPUBFUN void XMLCALL	xmlCleanupParser (void)
XMLPUBFUN void XMLCALL	xmlClearNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN void XMLCALL	xmlClearParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlParserCtxtPtr XMLCALL	xmlCreateDocParserCtxt (const xmlChar *cur)
XMLPUBFUN xmlParserCtxtPtr XMLCALL	xmlCreateIOParserCtxt (xmlSAXHandlerPtr sax, void *user_data, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, xmlCharEncoding enc)
XMLPUBFUN xmlDocPtr XMLCALL	xmlCtxtReadDoc (xmlParserCtxtPtr ctxt, const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlCtxtReadFd (xmlParserCtxtPtr ctxt, int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlCtxtReadFile (xmlParserCtxtPtr ctxt, const char *filename, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlCtxtReadIO (xmlParserCtxtPtr ctxt, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlCtxtReadMemory (xmlParserCtxtPtr ctxt, const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN void XMLCALL	xmlCtxtReset (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL	xmlCtxtResetPush (xmlParserCtxtPtr ctxt, const char *chunk, int size, const char *filename, const char *encoding)
XMLPUBFUN int XMLCALL	xmlCtxtUseOptions (xmlParserCtxtPtr ctxt, int options)
XMLPUBFUN void XMLCALL	xmlFreeParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlExternalEntityLoader XMLCALL	xmlGetExternalEntityLoader (void)
XMLPUBFUN int XMLCALL	xmlHasFeature (xmlFeature feature)
XMLPUBFUN void XMLCALL	xmlInitNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN void XMLCALL	xmlInitParser (void)
XMLPUBFUN int XMLCALL	xmlInitParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL	xmlKeepBlanksDefault (int val)
XMLPUBFUN int XMLCALL	xmlLineNumbersDefault (int val)
XMLPUBFUN xmlParserInputPtr XMLCALL	xmlLoadExternalEntity (const char *URL, const char *ID, xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlParserInputPtr XMLCALL	xmlNewIOInputStream (xmlParserCtxtPtr ctxt, xmlParserInputBufferPtr input, xmlCharEncoding enc)
XMLPUBFUN xmlParserCtxtPtr XMLCALL	xmlNewParserCtxt (void)
XMLPUBFUN int XMLCALL	xmlParseCtxtExternalEntity (xmlParserCtxtPtr ctx, const xmlChar *URL, const xmlChar *ID, xmlNodePtr *lst)
XMLPUBFUN int XMLCALL	xmlParseDocument (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL	xmlParseExtParsedEnt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlParserErrors XMLCALL	xmlParseInNodeContext (xmlNodePtr node, const char *data, int datalen, int options, xmlNodePtr *lst)
XMLPUBFUN void XMLCALL	xmlParserAddNodeInfo (xmlParserCtxtPtr ctxt, const xmlParserNodeInfoPtr info)
XMLPUBFUN const xmlParserNodeInfo *XMLCALL	xmlParserFindNodeInfo (const xmlParserCtxtPtr ctxt, const xmlNodePtr node)
XMLPUBFUN unsigned long XMLCALL	xmlParserFindNodeInfoIndex (const xmlParserNodeInfoSeqPtr seq, const xmlNodePtr node)
XMLPUBFUN int XMLCALL	xmlParserInputGrow (xmlParserInputPtr in, int len)
XMLPUBFUN int XMLCALL	xmlParserInputRead (xmlParserInputPtr in, int len)
XMLPUBFUN int XMLCALL	xmlPedanticParserDefault (int val)
XMLPUBFUN xmlDocPtr XMLCALL	xmlReadDoc (const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlReadFd (int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlReadFile (const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlReadIO (xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL	xmlReadMemory (const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN void XMLCALL	xmlSetExternalEntityLoader (xmlExternalEntityLoader f)
XMLPUBFUN void XMLCALL	xmlStopParser (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL	xmlSubstituteEntitiesDefault (int val)
: The name of the notation
notationDeclSAXFunc: : the user data (XML parser context) : The public ID of the entity : The system ID of the entity What to do when a notation declaration has been parsed.
typedef void(*)	attributeDeclSAXFunc (void *ctx, const xmlChar *elem, const xmlChar *fullname, int type, int def, const xmlChar *defaultValue, xmlEnumerationPtr tree)
typedef void(*)	notationDeclSAXFunc (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId)
: The attribute name, including namespace prefix
attributeSAXFunc: : the user data (XML parser context) : The attribute value Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element.
typedef void(*)	attributeSAXFunc (void *ctx, const xmlChar *name, const xmlChar *value)
: the element name
elementDeclSAXFunc: : the user data (XML parser context) : the element type : the element value tree An element definition has been parsed.
typedef void(*)	elementDeclSAXFunc (void *ctx, const xmlChar *name, int type, xmlElementContentPtr content)
: The name of the entity
unparsedEntityDeclSAXFunc: : the user data (XML parser context) : The public ID of the entity : The system ID of the entity : the name of the notation What to do when an unparsed entity declaration is parsed.
typedef void(*)	endDocumentSAXFunc (void *ctx)
typedef void(*)	setDocumentLocatorSAXFunc (void *ctx, xmlSAXLocatorPtr loc)
typedef void(*)	startDocumentSAXFunc (void *ctx)
typedef void(*)	unparsedEntityDeclSAXFunc (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId, const xmlChar *notationName)
: The element name
endElementSAXFunc: : the user data (XML parser context) Called when the end of an element has been detected.
typedef void(*)	endElementSAXFunc (void *ctx, const xmlChar *name)
: the entity name
entityDeclSAXFunc: : the user data (XML parser context) : the entity type : The public ID of the entity : The system ID of the entity : the entity value (without processing). An entity definition has been parsed.
typedef void(*)	entityDeclSAXFunc (void *ctx, const xmlChar *name, int type, const xmlChar *publicId, const xmlChar *systemId, xmlChar *content)
: the root element name
externalSubsetSAXFunc: : the user data (XML parser context) : the external ID : the SYSTEM ID (e.g. filename or URL) Callback on external subset declaration.
typedef void(*)	externalSubsetSAXFunc (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
: The entity name
getEntitySAXFunc: : the user data (XML parser context) Get an entity by name. Returns the xmlEntityPtr if found.
typedef xmlEntityPtr(*)	getEntitySAXFunc (void *ctx, const xmlChar *name)
: The entity name
getParameterEntitySAXFunc: : the user data (XML parser context) Get a parameter entity by name. Returns the xmlEntityPtr if found.
typedef xmlEntityPtr(*)	getParameterEntitySAXFunc (void *ctx, const xmlChar *name)
: the root element name
internalSubsetSAXFunc: : the user data (XML parser context) : the external ID : the SYSTEM ID (e.g. filename or URL) Callback on internal subset declaration.
typedef void(*)	internalSubsetSAXFunc (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
: The element name, including namespace prefix
startElementSAXFunc: : the user data (XML parser context) : An array of name/value attributes pairs, NULL terminated Called when an opening tag has been processed.
typedef void(*)	startElementSAXFunc (void *ctx, const xmlChar *name, const xmlChar **atts)
Defines
#define	XML_COMPLETE_ATTRS   4
#define	XML_DEFAULT_VERSION   "1.0"
#define	XML_DETECT_IDS   2
#define	XML_SKIP_IDS   8
Typedefs
typedef xmlParserInputPtr(*)	resolveEntitySAXFunc (void *ctx, const xmlChar *publicId, const xmlChar *systemId)
typedef void(*)	xmlParserInputDeallocate (xmlChar *str)
typedef _xmlParserNodeInfo	xmlParserNodeInfo
typedef xmlParserNodeInfo *	xmlParserNodeInfoPtr
typedef _xmlParserNodeInfoSeq	xmlParserNodeInfoSeq
typedef xmlParserNodeInfoSeq *	xmlParserNodeInfoSeqPtr
Enumerations
enum	xmlParserInputState {   XML_PARSER_EOF = -1, XML_PARSER_START = 0, XML_PARSER_MISC, XML_PARSER_PI,   XML_PARSER_DTD, XML_PARSER_PROLOG, XML_PARSER_COMMENT, XML_PARSER_START_TAG,   XML_PARSER_CONTENT, XML_PARSER_CDATA_SECTION, XML_PARSER_END_TAG, XML_PARSER_ENTITY_DECL,   XML_PARSER_ENTITY_VALUE, XML_PARSER_ATTRIBUTE_VALUE, XML_PARSER_SYSTEM_LITERAL, XML_PARSER_EPILOG,   XML_PARSER_IGNORE, XML_PARSER_PUBLIC_LITERAL }
enum	xmlParserMode {   XML_PARSE_UNKNOWN = 0, XML_PARSE_DOM = 1, XML_PARSE_SAX = 2, XML_PARSE_PUSH_DOM = 3,   XML_PARSE_PUSH_SAX = 4, XML_PARSE_READER = 5 }

---

Define Documentation

#define XML_COMPLETE_ATTRS   4

XML_COMPLETE_ATTRS:

Bit in the loadsubset context field to tell to do complete the elements attributes lists with the ones defaulted from the DTDs. Use it to initialize xmlLoadExtDtdDefaultValue.

Definition at line 148 of file parser.h.

#define XML_DEFAULT_VERSION   "1.0"

XML_DEFAULT_VERSION:

The default version of XML used: 1.0

Definition at line 33 of file parser.h.

#define XML_DETECT_IDS   2

XML_DETECT_IDS:

Bit in the loadsubset context field to tell to do ID/REFs lookups. Use it to initialize xmlLoadExtDtdDefaultValue.

Definition at line 139 of file parser.h.

#define XML_SAX2_MAGIC   0xDEEDBEAF

XML_SAX2_MAGIC:

Special constant found in SAX2 blocks initialized fields

Definition at line 657 of file parser.h.

#define XML_SKIP_IDS   8

XML_SKIP_IDS:

Bit in the loadsubset context field to tell to not do ID/REFs registration. Used to initialize xmlLoadExtDtdDefaultValue in some special cases.

Definition at line 156 of file parser.h.

---

Typedef Documentation

typedef void(*) attributeDeclSAXFunc(void *ctx, const xmlChar *elem, const xmlChar *fullname, int type, int def, const xmlChar *defaultValue, xmlEnumerationPtr tree)

Definition at line 429 of file parser.h.

typedef void(*) attributeSAXFunc(void *ctx, const xmlChar *name, const xmlChar *value)

Definition at line 519 of file parser.h.

typedef void(*) cdataBlockSAXFunc(void *ctx, const xmlChar *value, int len)

cdataBlockSAXFunc: : the user data (XML parser context) : The pcdata content : the block length

Called when a pcdata block has been parsed.

Definition at line 582 of file parser.h.

typedef void(*) charactersSAXFunc(void *ctx, const xmlChar *ch, int len)

charactersSAXFunc: : the user data (XML parser context) : a xmlChar string : the number of xmlChar

Receiving some chars from the parser.

Definition at line 539 of file parser.h.

typedef void(*) commentSAXFunc(void *ctx, const xmlChar *value)

commentSAXFunc: : the user data (XML parser context) : the comment content

A comment has been parsed.

Definition at line 572 of file parser.h.

typedef void(*) elementDeclSAXFunc(void *ctx, const xmlChar *name, int type, xmlElementContentPtr content)

Definition at line 445 of file parser.h.

typedef void(*) endDocumentSAXFunc(void *ctx)

endDocumentSAXFunc: : the user data (XML parser context)

Called when the document end has been detected.

Definition at line 487 of file parser.h.

typedef void(*) endElementNsSAX2Func(void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI)

endElementNsSAX2Func: : the user data (XML parser context) : the local name of the element : the element namespace prefix if available : the element namespace name if available

SAX2 callback when an element end has been detected by the parser. It provides the namespace informations for the element.

Definition at line 699 of file parser.h.

typedef void(*) endElementSAXFunc(void *ctx, const xmlChar *name)

Definition at line 506 of file parser.h.

typedef void(*) entityDeclSAXFunc(void *ctx, const xmlChar *name, int type, const xmlChar *publicId, const xmlChar *systemId, xmlChar *content)

Definition at line 398 of file parser.h.

typedef void(*) externalSubsetSAXFunc(void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)

Definition at line 361 of file parser.h.

typedef xmlEntityPtr(*) getEntitySAXFunc(void *ctx, const xmlChar *name)

Definition at line 374 of file parser.h.

typedef xmlEntityPtr(*) getParameterEntitySAXFunc(void *ctx, const xmlChar *name)

Definition at line 385 of file parser.h.

typedef int(*) hasExternalSubsetSAXFunc(void *ctx)

hasExternalSubsetSAXFunc: : the user data (XML parser context)

Does this document has an external subset?

Returns 1 if true

Definition at line 645 of file parser.h.

typedef int(*) hasInternalSubsetSAXFunc(void *ctx)

hasInternalSubsetSAXFunc: : the user data (XML parser context)

Does this document has an internal subset.

Returns 1 if true

Definition at line 635 of file parser.h.

typedef void(*) ignorableWhitespaceSAXFunc(void *ctx, const xmlChar *ch, int len)

ignorableWhitespaceSAXFunc: : the user data (XML parser context) : a xmlChar string : the number of xmlChar

Receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters.

Definition at line 551 of file parser.h.

typedef void(*) internalSubsetSAXFunc(void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)

Definition at line 348 of file parser.h.

typedef const char typedef const char typedef const char typedef int(*) isStandaloneSAXFunc(void *ctx)

isStandaloneSAXFunc: : the user data (XML parser context)

Is this document tagged standalone?

Returns 1 if true

Definition at line 626 of file parser.h.

typedef const char typedef const char typedef const char* msg

Definition at line 617 of file parser.h.

typedef const char typedef const char* msg

Definition at line 605 of file parser.h.

typedef const char* msg

Definition at line 595 of file parser.h.

typedef void(*) notationDeclSAXFunc(void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId)

Definition at line 413 of file parser.h.

typedef void(*) processingInstructionSAXFunc(void *ctx, const xmlChar *target, const xmlChar *data)

processingInstructionSAXFunc: : the user data (XML parser context) : the target name : the PI data's

A processing instruction has been parsed.

Definition at line 562 of file parser.h.

typedef void(*) referenceSAXFunc(void *ctx, const xmlChar *name)

Definition at line 529 of file parser.h.

typedef xmlParserInputPtr(*) resolveEntitySAXFunc(void *ctx, const xmlChar *publicId, const xmlChar *systemId)

resolveEntitySAXFunc: : the user data (XML parser context) : The public ID of the entity : The system ID of the entity

Callback: The entity loader, to control the loading of external entities, the application can either:

• override this resolveEntity() callback in the SAX block
• or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine

Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.

Definition at line 336 of file parser.h.

typedef void(*) setDocumentLocatorSAXFunc(void *ctx, xmlSAXLocatorPtr loc)

setDocumentLocatorSAXFunc: : the user data (XML parser context) : A SAX Locator

Receive the document locator at startup, actually xmlDefaultSAXLocator. Everything is available on the context, so this is useless in our case.

Definition at line 472 of file parser.h.

typedef void(*) startDocumentSAXFunc(void *ctx)

startDocumentSAXFunc: : the user data (XML parser context)

Called when the document start being processed.

Definition at line 480 of file parser.h.

typedef void(*) startElementNsSAX2Func(void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI, int nb_namespaces, const xmlChar **namespaces, int nb_attributes, int nb_defaulted, const xmlChar **attributes)

startElementNsSAX2Func: : the user data (XML parser context) : the local name of the element : the element namespace prefix if available : the element namespace name if available : number of namespace definitions on that node : pointer to the array of prefix/URI pairs namespace definitions : the number of attributes on that node : the number of defaulted attributes. The defaulted ones are at the end of the array : pointer to the array of (localname/prefix/URI/value/end) attribute values.

SAX2 callback when an element start has been detected by the parser. It provides the namespace informations for the element, as well as the new namespace declarations on the element.

Definition at line 678 of file parser.h.

typedef void(*) startElementSAXFunc(void *ctx, const xmlChar *name, const xmlChar **atts)

Definition at line 496 of file parser.h.

typedef void(*) unparsedEntityDeclSAXFunc(void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId, const xmlChar *notationName)

Definition at line 459 of file parser.h.

typedef const char typedef const char typedef void(XMLCDECL *fatalErrorSAXFunc)(void *ctx

fatalErrorSAXFunc: : an XML parser context : the message to display/transmit @...: extra parameters for the message display

Display and format fatal error messages, callback. Note: so far fatalError() SAX callbacks are not used, error() get all the callbacks for errors.

Definition at line 616 of file parser.h.

typedef const char typedef void(XMLCDECL *errorSAXFunc)(void *ctx

errorSAXFunc: : an XML parser context : the message to display/transmit @...: extra parameters for the message display

Display and format an error messages, callback.

Definition at line 604 of file parser.h.

typedef xmlParserInputPtr(*) xmlExternalEntityLoader(const char *URL, const char *ID, xmlParserCtxtPtr context)

xmlExternalEntityLoader: : The System ID of the resource requested : The Public ID of the resource requested : the XML parser context

External entity loaders types.

Returns the entity input parser.

Definition at line 788 of file parser.h.

typedef void(* ) xmlParserInputDeallocate(xmlChar *str)

xmlParserInputDeallocate: : the string to deallocate

Callback for freeing some parser input allocations.

Definition at line 52 of file parser.h.

typedef struct _xmlParserNodeInfo xmlParserNodeInfo

xmlParserNodeInfo:

The parser can be asked to collect Node informations, i.e. at what place in the file they were detected. NOTE: This is off by default and not very well tested.

Definition at line 86 of file parser.h.

typedef xmlParserNodeInfo* xmlParserNodeInfoPtr

Definition at line 87 of file parser.h.

typedef struct _xmlParserNodeInfoSeq xmlParserNodeInfoSeq

Definition at line 98 of file parser.h.

typedef xmlParserNodeInfoSeq* xmlParserNodeInfoSeqPtr

Definition at line 99 of file parser.h.

typedef struct _xmlSAXHandlerV1 xmlSAXHandlerV1

Definition at line 744 of file parser.h.

typedef xmlSAXHandlerV1* xmlSAXHandlerV1Ptr

Definition at line 745 of file parser.h.

---

Enumeration Type Documentation

enum xmlFeature

xmlFeature:

Used to examine the existance of features that can be enabled or disabled at compile-time. They used to be called XML_FEATURE_xxx but this clashed with Expat

Enumerator:

XML_WITH_THREAD
XML_WITH_TREE
XML_WITH_OUTPUT
XML_WITH_PUSH
XML_WITH_READER
XML_WITH_PATTERN
XML_WITH_WRITER
XML_WITH_SAX1
XML_WITH_FTP
XML_WITH_HTTP
XML_WITH_VALID
XML_WITH_HTML
XML_WITH_LEGACY
XML_WITH_C14N
XML_WITH_CATALOG
XML_WITH_XPATH
XML_WITH_XPTR
XML_WITH_XINCLUDE
XML_WITH_ICONV
XML_WITH_ISO8859X
XML_WITH_UNICODE
XML_WITH_REGEXP
XML_WITH_AUTOMATA
XML_WITH_EXPR
XML_WITH_SCHEMAS
XML_WITH_SCHEMATRON
XML_WITH_MODULES
XML_WITH_DEBUG
XML_WITH_DEBUG_MEM
XML_WITH_DEBUG_RUN
XML_WITH_ZLIB
XML_WITH_NONE

Definition at line 1178 of file parser.h.

enum xmlParserInputState

xmlParserInputState:

The parser is now working also as a state based parser. The recursive one use the state info for entities processing.

Enumerator:

XML_PARSER_EOF
XML_PARSER_START
XML_PARSER_MISC
XML_PARSER_PI
XML_PARSER_DTD
XML_PARSER_PROLOG
XML_PARSER_COMMENT
XML_PARSER_START_TAG
XML_PARSER_CONTENT
XML_PARSER_CDATA_SECTION
XML_PARSER_END_TAG
XML_PARSER_ENTITY_DECL
XML_PARSER_ENTITY_VALUE
XML_PARSER_ATTRIBUTE_VALUE
XML_PARSER_SYSTEM_LITERAL
XML_PARSER_EPILOG
XML_PARSER_IGNORE
XML_PARSER_PUBLIC_LITERAL

Definition at line 112 of file parser.h.

enum xmlParserMode

xmlParserMode:

A parser can operate in various modes

Enumerator:

XML_PARSE_UNKNOWN
XML_PARSE_DOM
XML_PARSE_SAX
XML_PARSE_PUSH_DOM
XML_PARSE_PUSH_SAX
XML_PARSE_READER

Definition at line 163 of file parser.h.

enum xmlParserOption

xmlParserOption:

This is the set of XML parser options that can be passed down to the xmlReadDoc() and similar calls.

Enumerator:

XML_PARSE_RECOVER
XML_PARSE_NOENT
XML_PARSE_DTDLOAD
XML_PARSE_DTDATTR
XML_PARSE_DTDVALID
XML_PARSE_NOERROR
XML_PARSE_NOWARNING
XML_PARSE_PEDANTIC
XML_PARSE_NOBLANKS
XML_PARSE_SAX1
XML_PARSE_XINCLUDE
XML_PARSE_NONET
XML_PARSE_NODICT
XML_PARSE_NSCLEAN
XML_PARSE_NOCDATA
XML_PARSE_NOXINCNODE
XML_PARSE_COMPACT

Definition at line 1075 of file parser.h.

---

Function Documentation

typedef void

(

XMLCDECL *

warningSAXFunc

)

warningSAXFunc: : an XML parser context : the message to display/transmit @...: extra parameters for the message display

Display and format a warning messages, callback.

XMLPUBFUN long XMLCALL xmlByteConsumed

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN void XMLCALL xmlCleanupParser

(

void

)

XMLPUBFUN void XMLCALL xmlClearNodeInfoSeq

(

xmlParserNodeInfoSeqPtr

seq

)

XMLPUBFUN void XMLCALL xmlClearParserCtxt

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN xmlParserCtxtPtr XMLCALL xmlCreateDocParserCtxt

(

const xmlChar *

cur

)

XMLPUBFUN xmlParserCtxtPtr XMLCALL xmlCreateIOParserCtxt	(	xmlSAXHandlerPtr	sax,
		void *	user_data,
		xmlInputReadCallback	ioread,
		xmlInputCloseCallback	ioclose,
		void *	ioctx,
		xmlCharEncoding	enc
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadDoc	(	xmlParserCtxtPtr	ctxt,
		const xmlChar *	cur,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadFd	(	xmlParserCtxtPtr	ctxt,
		int	fd,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadFile	(	xmlParserCtxtPtr	ctxt,
		const char *	filename,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadIO	(	xmlParserCtxtPtr	ctxt,
		xmlInputReadCallback	ioread,
		xmlInputCloseCallback	ioclose,
		void *	ioctx,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadMemory	(	xmlParserCtxtPtr	ctxt,
		const char *	buffer,
		int	size,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN void XMLCALL xmlCtxtReset

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN int XMLCALL xmlCtxtResetPush	(	xmlParserCtxtPtr	ctxt,
		const char *	chunk,
		int	size,
		const char *	filename,
		const char *	encoding
	)

XMLPUBFUN int XMLCALL xmlCtxtUseOptions	(	xmlParserCtxtPtr	ctxt,
		int	options
	)

XMLPUBFUN void XMLCALL xmlFreeParserCtxt

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN xmlExternalEntityLoader XMLCALL xmlGetExternalEntityLoader

(

void

)

XMLPUBFUN int XMLCALL xmlHasFeature

(

xmlFeature

feature

)

XMLPUBFUN void XMLCALL xmlInitNodeInfoSeq

(

xmlParserNodeInfoSeqPtr

seq

)

XMLPUBFUN void XMLCALL xmlInitParser

(

void

)

XMLPUBFUN int XMLCALL xmlInitParserCtxt

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN int XMLCALL xmlKeepBlanksDefault

(

int

val

)

XMLPUBFUN int XMLCALL xmlLineNumbersDefault

(

int

val

)

XMLPUBFUN xmlParserInputPtr XMLCALL xmlLoadExternalEntity	(	const char *	URL,
		const char *	ID,
		xmlParserCtxtPtr	ctxt
	)

XMLPUBFUN xmlParserInputPtr XMLCALL xmlNewIOInputStream	(	xmlParserCtxtPtr	ctxt,
		xmlParserInputBufferPtr	input,
		xmlCharEncoding	enc
	)

XMLPUBFUN xmlParserCtxtPtr XMLCALL xmlNewParserCtxt

(

void

)

XMLPUBFUN int XMLCALL xmlParseCtxtExternalEntity	(	xmlParserCtxtPtr	ctx,
		const xmlChar *	URL,
		const xmlChar *	ID,
		xmlNodePtr *	lst
	)

XMLPUBFUN int XMLCALL xmlParseDocument

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN int XMLCALL xmlParseExtParsedEnt

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN xmlParserErrors XMLCALL xmlParseInNodeContext	(	xmlNodePtr	node,
		const char *	data,
		int	datalen,
		int	options,
		xmlNodePtr *	lst
	)

XMLPUBFUN void XMLCALL xmlParserAddNodeInfo	(	xmlParserCtxtPtr	ctxt,
		const xmlParserNodeInfoPtr	info
	)

XMLPUBFUN const xmlParserNodeInfo* XMLCALL xmlParserFindNodeInfo	(	const xmlParserCtxtPtr	ctxt,
		const xmlNodePtr	node
	)

XMLPUBFUN unsigned long XMLCALL xmlParserFindNodeInfoIndex	(	const xmlParserNodeInfoSeqPtr	seq,
		const xmlNodePtr	node
	)

XMLPUBFUN int XMLCALL xmlParserInputGrow	(	xmlParserInputPtr	in,
		int	len
	)

XMLPUBFUN int XMLCALL xmlParserInputRead	(	xmlParserInputPtr	in,
		int	len
	)

XMLPUBFUN int XMLCALL xmlPedanticParserDefault

(

int

val

)

XMLPUBFUN xmlDocPtr XMLCALL xmlReadDoc	(	const xmlChar *	cur,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlReadFd	(	int	fd,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlReadFile	(	const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlReadIO	(	xmlInputReadCallback	ioread,
		xmlInputCloseCallback	ioclose,
		void *	ioctx,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN xmlDocPtr XMLCALL xmlReadMemory	(	const char *	buffer,
		int	size,
		const char *	URL,
		const char *	encoding,
		int	options
	)

XMLPUBFUN void XMLCALL xmlSetExternalEntityLoader

(

xmlExternalEntityLoader

f

)

XMLPUBFUN void XMLCALL xmlStopParser

(

xmlParserCtxtPtr

ctxt

)

XMLPUBFUN int XMLCALL xmlSubstituteEntitiesDefault

(

int

val

)

---