Module parser from libxml2

# ## Module parser from libxml2

API Menu
Main Menu Developer Menu Code Examples API Menu Parser API Tree API Reader API XML Guidelines ChangeLog
API Indexes
Alphabetic Constructors Functions/Types Modules Symbols
Related links
Mail archive XSLT libxslt DOM gdome2 XML-DSig xmlsec FTP Windows binaries Solaris binaries MacOsX binaries lxml Python bindings Perl bindings C++ bindings PHP bindings Pascal bindings Ruby bindings Tcl bindings Bug Tracker
Interfaces, constants and types related to the XML parser ## Table of Contents
    #define XML_COMPLETE_ATTRS
    #define XML_DEFAULT_VERSION
    #define XML_DETECT_IDS
    #define XML_SAX2_MAGIC
    #define XML_SKIP_IDS
    Enum xmlFeature
    Enum xmlParserInputState
    Enum xmlParserMode
    Structure xmlParserNodeInfo
    struct _xmlParserNodeInfo
    Typedef xmlParserNodeInfo * xmlParserNodeInfoPtr
    Structure xmlParserNodeInfoSeq
    struct _xmlParserNodeInfoSeq
    Typedef xmlParserNodeInfoSeq * xmlParserNodeInfoSeqPtr
    Enum xmlParserOption
    Structure xmlSAXHandlerV1
    struct _xmlSAXHandlerV1
    Typedef xmlSAXHandlerV1 * xmlSAXHandlerV1Ptr
    Function type: attributeDeclSAXFunc
    void	attributeDeclSAXFunc		(void * ctx,
    					 const xmlChar * elem,
    					 const xmlChar * fullname,
    					 int type,
    					 int def,
    					 const xmlChar * defaultValue,
    					 xmlEnumerationPtr tree)
    Function type: attributeSAXFunc
    void	attributeSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * value)
    Function type: cdataBlockSAXFunc
    void	cdataBlockSAXFunc		(void * ctx,
    					 const xmlChar * value,
    					 int len)
    Function type: charactersSAXFunc
    void	charactersSAXFunc		(void * ctx,
    					 const xmlChar * ch,
    					 int len)
    Function type: commentSAXFunc
    void	commentSAXFunc			(void * ctx,
    					 const xmlChar * value)
    Function type: elementDeclSAXFunc
    void	elementDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 int type,
    					 xmlElementContentPtr content)
    Function type: endDocumentSAXFunc
    void	endDocumentSAXFunc		(void * ctx)
    Function type: endElementNsSAX2Func
    void	endElementNsSAX2Func		(void * ctx,
    					 const xmlChar * localname,
    					 const xmlChar * prefix,
    					 const xmlChar * URI)
    Function type: endElementSAXFunc
    void	endElementSAXFunc		(void * ctx,
    					 const xmlChar * name)
    Function type: entityDeclSAXFunc
    void	entityDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 int type,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId,
    					 xmlChar * content)
    Function type: errorSAXFunc
    void	errorSAXFunc			(void * ctx,
    					 const char * msg,
    					 ... ...)
    Function type: externalSubsetSAXFunc
    void	externalSubsetSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
    Function type: fatalErrorSAXFunc
    void	fatalErrorSAXFunc		(void * ctx,
    					 const char * msg,
    					 ... ...)
    Function type: getEntitySAXFunc
    xmlEntityPtr	getEntitySAXFunc	(void * ctx,
    					 const xmlChar * name)
    Function type: getParameterEntitySAXFunc
    xmlEntityPtr	getParameterEntitySAXFunc	(void * ctx,
    						 const xmlChar * name)
    Function type: hasExternalSubsetSAXFunc
    int	hasExternalSubsetSAXFunc	(void * ctx)
    Function type: hasInternalSubsetSAXFunc
    int	hasInternalSubsetSAXFunc	(void * ctx)
    Function type: ignorableWhitespaceSAXFunc
    void	ignorableWhitespaceSAXFunc	(void * ctx,
    					 const xmlChar * ch,
    					 int len)
    Function type: internalSubsetSAXFunc
    void	internalSubsetSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
    Function type: isStandaloneSAXFunc
    int	isStandaloneSAXFunc		(void * ctx)
    Function type: notationDeclSAXFunc
    void	notationDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId)
    Function type: processingInstructionSAXFunc
    void	processingInstructionSAXFunc	(void * ctx,
    					 const xmlChar * target,
    					 const xmlChar * data)
    Function type: referenceSAXFunc
    void	referenceSAXFunc		(void * ctx,
    					 const xmlChar * name)
    Function type: resolveEntitySAXFunc
    xmlParserInputPtr	resolveEntitySAXFunc	(void * ctx,
    						 const xmlChar * publicId,
    						 const xmlChar * systemId)
    Function type: setDocumentLocatorSAXFunc
    void	setDocumentLocatorSAXFunc	(void * ctx,
    					 xmlSAXLocatorPtr loc)
    Function type: startDocumentSAXFunc
    void	startDocumentSAXFunc		(void * ctx)
    Function type: startElementNsSAX2Func
    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)
    Function type: startElementSAXFunc
    void	startElementSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar ** atts)
    Function type: unparsedEntityDeclSAXFunc
    void	unparsedEntityDeclSAXFunc	(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId,
    					 const xmlChar * notationName)
    Function type: warningSAXFunc
    void	warningSAXFunc			(void * ctx,
    					 const char * msg,
    					 ... ...)
    long	xmlByteConsumed			(xmlParserCtxtPtr ctxt)
    void	xmlCleanupParser		(void)
    void	xmlClearNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)
    void	xmlClearParserCtxt		(xmlParserCtxtPtr ctxt)
    xmlParserCtxtPtr	xmlCreateDocParserCtxt	(const xmlChar * cur)
    xmlParserCtxtPtr	xmlCreateIOParserCtxt	(xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 xmlInputReadCallback ioread,
    						 xmlInputCloseCallback ioclose,
    						 void * ioctx,
    						 xmlCharEncoding enc)
    xmlParserCtxtPtr	xmlCreatePushParserCtxt	(xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 const char * chunk,
    						 int size,
    						 const char * filename)
    xmlDocPtr	xmlCtxtReadDoc		(xmlParserCtxtPtr ctxt,
    					 const xmlChar * cur,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlCtxtReadFd		(xmlParserCtxtPtr ctxt,
    					 int fd,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlCtxtReadFile		(xmlParserCtxtPtr ctxt,
    					 const char * filename,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlCtxtReadIO		(xmlParserCtxtPtr ctxt,
    					 xmlInputReadCallback ioread,
    					 xmlInputCloseCallback ioclose,
    					 void * ioctx,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlCtxtReadMemory	(xmlParserCtxtPtr ctxt,
    					 const char * buffer,
    					 int size,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    void	xmlCtxtReset			(xmlParserCtxtPtr ctxt)
    int	xmlCtxtResetPush		(xmlParserCtxtPtr ctxt,
    					 const char * chunk,
    					 int size,
    					 const char * filename,
    					 const char * encoding)
    int	xmlCtxtUseOptions		(xmlParserCtxtPtr ctxt,
    					 int options)
    Function type: xmlExternalEntityLoader
    xmlParserInputPtr	xmlExternalEntityLoader	(const char * URL,
    						 const char * ID,
    						 xmlParserCtxtPtr context)
    void	xmlFreeParserCtxt		(xmlParserCtxtPtr ctxt)
    xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)
    int	xmlGetFeature			(xmlParserCtxtPtr ctxt,
    					 const char * name,
    					 void * result)
    int	xmlGetFeaturesList		(int * len,
    					 const char ** result)
    int	xmlHasFeature			(xmlFeature feature)
    xmlDtdPtr	xmlIOParseDTD		(xmlSAXHandlerPtr sax,
    					 xmlParserInputBufferPtr input,
    					 xmlCharEncoding enc)
    void	xmlInitNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)
    void	xmlInitParser			(void)
    int	xmlInitParserCtxt		(xmlParserCtxtPtr ctxt)
    int	xmlKeepBlanksDefault		(int val)
    int	xmlLineNumbersDefault		(int val)
    xmlParserInputPtr	xmlLoadExternalEntity	(const char * URL,
    						 const char * ID,
    						 xmlParserCtxtPtr ctxt)
    xmlParserInputPtr	xmlNewIOInputStream	(xmlParserCtxtPtr ctxt,
    						 xmlParserInputBufferPtr input,
    						 xmlCharEncoding enc)
    xmlParserCtxtPtr	xmlNewParserCtxt	(void)
    int	xmlParseBalancedChunkMemory	(xmlDocPtr doc,
    					 xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 int depth,
    					 const xmlChar * string,
    					 xmlNodePtr * lst)
    int	xmlParseBalancedChunkMemoryRecover	(xmlDocPtr doc,
    						 xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 int depth,
    						 const xmlChar * string,
    						 xmlNodePtr * lst,
    						 int recover)
    int	xmlParseChunk			(xmlParserCtxtPtr ctxt,
    					 const char * chunk,
    					 int size,
    					 int terminate)
    int	xmlParseCtxtExternalEntity	(xmlParserCtxtPtr ctx,
    					 const xmlChar * URL,
    					 const xmlChar * ID,
    					 xmlNodePtr * lst)
    xmlDtdPtr	xmlParseDTD		(const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
    xmlDocPtr	xmlParseDoc		(const xmlChar * cur)
    int	xmlParseDocument		(xmlParserCtxtPtr ctxt)
    xmlDocPtr	xmlParseEntity		(const char * filename)
    int	xmlParseExtParsedEnt		(xmlParserCtxtPtr ctxt)
    int	xmlParseExternalEntity		(xmlDocPtr doc,
    					 xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 int depth,
    					 const xmlChar * URL,
    					 const xmlChar * ID,
    					 xmlNodePtr * lst)
    xmlDocPtr	xmlParseFile		(const char * filename)
    xmlParserErrors	xmlParseInNodeContext	(xmlNodePtr node,
    					 const char * data,
    					 int datalen,
    					 int options,
    					 xmlNodePtr * lst)
    xmlDocPtr	xmlParseMemory		(const char * buffer,
    					 int size)
    void	xmlParserAddNodeInfo		(xmlParserCtxtPtr ctxt,
    					 const xmlParserNodeInfoPtr info)
    const xmlParserNodeInfo *	xmlParserFindNodeInfo	(const xmlParserCtxtPtr ctx,
    							 const xmlNodePtr node)
    unsigned long	xmlParserFindNodeInfoIndex	(const xmlParserNodeInfoSeqPtr seq,
    						 const xmlNodePtr node)
    Function type: xmlParserInputDeallocate
    void	xmlParserInputDeallocate	(xmlChar * str)
    int	xmlParserInputGrow		(xmlParserInputPtr in,
    					 int len)
    int	xmlParserInputRead		(xmlParserInputPtr in,
    					 int len)
    int	xmlPedanticParserDefault	(int val)
    xmlDocPtr	xmlReadDoc		(const xmlChar * cur,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlReadFd		(int fd,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlReadFile		(const char * filename,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlReadIO		(xmlInputReadCallback ioread,
    					 xmlInputCloseCallback ioclose,
    					 void * ioctx,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlReadMemory		(const char * buffer,
    					 int size,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
    xmlDocPtr	xmlRecoverDoc		(const xmlChar * cur)
    xmlDocPtr	xmlRecoverFile		(const char * filename)
    xmlDocPtr	xmlRecoverMemory	(const char * buffer,
    					 int size)
    xmlDtdPtr	xmlSAXParseDTD		(xmlSAXHandlerPtr sax,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
    xmlDocPtr	xmlSAXParseDoc		(xmlSAXHandlerPtr sax,
    					 const xmlChar * cur,
    					 int recovery)
    xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax,
    					 const char * filename)
    xmlDocPtr	xmlSAXParseFile		(xmlSAXHandlerPtr sax,
    					 const char * filename,
    					 int recovery)
    xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax,
    					 const char * filename,
    					 int recovery,
    					 void * data)
    xmlDocPtr	xmlSAXParseMemory	(xmlSAXHandlerPtr sax,
    					 const char * buffer,
    					 int size,
    					 int recovery)
    xmlDocPtr	xmlSAXParseMemoryWithData	(xmlSAXHandlerPtr sax,
    						 const char * buffer,
    						 int size,
    						 int recovery,
    						 void * data)
    int	xmlSAXUserParseFile		(xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 const char * filename)
    int	xmlSAXUserParseMemory		(xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 const char * buffer,
    					 int size)
    void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)
    int	xmlSetFeature			(xmlParserCtxtPtr ctxt,
    					 const char * name,
    					 void * value)
    void	xmlSetupParserForBuffer		(xmlParserCtxtPtr ctxt,
    					 const xmlChar * buffer,
    					 const char * filename)
    void	xmlStopParser			(xmlParserCtxtPtr ctxt)
    int	xmlSubstituteEntitiesDefault	(int val)
## Description ### Macro: XML_COMPLETE_ATTRS
    #define 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. ### Macro: XML_DEFAULT_VERSION
    #define XML_DEFAULT_VERSION
The default version of XML used: 1.0 ### Macro: XML_DETECT_IDS
    #define XML_DETECT_IDS
Bit in the loadsubset context field to tell to do ID/REFs lookups. Use it to initialize xmlLoadExtDtdDefaultValue. ### Macro: XML_SAX2_MAGIC
    #define XML_SAX2_MAGIC
Special constant found in SAX2 blocks initialized fields ### Macro: XML_SKIP_IDS
    #define 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. ### Enum xmlFeature
    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_ICU = 32
        XML_WITH_LZMA = 33
        XML_WITH_NONE = 99999 : just to be sure of allocation size
    }
### Enum xmlParserInputState
    Enum xmlParserInputState {
        XML_PARSER_EOF = -1 : nothing is to be parsed
        XML_PARSER_START = 0 : nothing has been parsed
        XML_PARSER_MISC = 1 : Misc* before int subset
        XML_PARSER_PI = 2 : Within a processing instruction
        XML_PARSER_DTD = 3 : within some DTD content
        XML_PARSER_PROLOG = 4 : Misc* after internal subset
        XML_PARSER_COMMENT = 5 : within a comment
        XML_PARSER_START_TAG = 6 : within a start tag
        XML_PARSER_CONTENT = 7 : within the content
        XML_PARSER_CDATA_SECTION = 8 : within a CDATA section
        XML_PARSER_END_TAG = 9 : within a closing tag
        XML_PARSER_ENTITY_DECL = 10 : within an entity declaration
        XML_PARSER_ENTITY_VALUE = 11 : within an entity value in a decl
        XML_PARSER_ATTRIBUTE_VALUE = 12 : within an attribute value
        XML_PARSER_SYSTEM_LITERAL = 13 : within a SYSTEM value
        XML_PARSER_EPILOG = 14 : the Misc* after the last end tag
        XML_PARSER_IGNORE = 15 : within an IGNORED section
        XML_PARSER_PUBLIC_LITERAL = 16 : within a PUBLIC value
    }
### Enum xmlParserMode
    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
    }
### Structure xmlParserNodeInfo
    Structure xmlParserNodeInfo
    struct _xmlParserNodeInfo {
        const struct _xmlNode *	node	: Position & line # that text that create
        unsigned long	begin_pos
        unsigned long	begin_line
        unsigned long	end_pos
        unsigned long	end_line
    }
### Structure xmlParserNodeInfoSeq
    Structure xmlParserNodeInfoSeq
    struct _xmlParserNodeInfoSeq {
        unsigned long	maximum
        unsigned long	length
        xmlParserNodeInfo *	buffer
    }
### Enum xmlParserOption
    Enum xmlParserOption {
        XML_PARSE_RECOVER = 1 : recover on errors
        XML_PARSE_NOENT = 2 : substitute entities
        XML_PARSE_DTDLOAD = 4 : load the external subset
        XML_PARSE_DTDATTR = 8 : default DTD attributes
        XML_PARSE_DTDVALID = 16 : validate with the DTD
        XML_PARSE_NOERROR = 32 : suppress error reports
        XML_PARSE_NOWARNING = 64 : suppress warning reports
        XML_PARSE_PEDANTIC = 128 : pedantic error reporting
        XML_PARSE_NOBLANKS = 256 : remove blank nodes
        XML_PARSE_SAX1 = 512 : use the SAX1 interface internally
        XML_PARSE_XINCLUDE = 1024 : Implement XInclude substitition
        XML_PARSE_NONET = 2048 : Forbid network access
        XML_PARSE_NODICT = 4096 : Do not reuse the context dictionary
        XML_PARSE_NSCLEAN = 8192 : remove redundant namespaces declarations
        XML_PARSE_NOCDATA = 16384 : merge CDATA as text nodes
        XML_PARSE_NOXINCNODE = 32768 : do not generate XINCLUDE START/END nodes
        XML_PARSE_COMPACT = 65536 : compact small text nodes; no modification of the tree allowed afterwards (will possibly crash if you try to modify the tree)
        XML_PARSE_OLD10 = 131072 : parse using XML-1.0 before update 5
        XML_PARSE_NOBASEFIX = 262144 : do not fixup XINCLUDE xml:base uris
        XML_PARSE_HUGE = 524288 : relax any hardcoded limit from the parser
        XML_PARSE_OLDSAX = 1048576 : parse using SAX2 interface before 2.7.0
        XML_PARSE_IGNORE_ENC = 2097152 : ignore internal document encoding hint
        XML_PARSE_BIG_LINES = 4194304 : Store big lines numbers in text PSVI field
    }
### Structure xmlSAXHandlerV1
    Structure xmlSAXHandlerV1
    struct _xmlSAXHandlerV1 {
        internalSubsetSAXFunc	internalSubset
        isStandaloneSAXFunc	isStandalone
        hasInternalSubsetSAXFunc	hasInternalSubset
        hasExternalSubsetSAXFunc	hasExternalSubset
        resolveEntitySAXFunc	resolveEntity
        getEntitySAXFunc	getEntity
        entityDeclSAXFunc	entityDecl
        notationDeclSAXFunc	notationDecl
        attributeDeclSAXFunc	attributeDecl
        elementDeclSAXFunc	elementDecl
        unparsedEntityDeclSAXFunc	unparsedEntityDecl
        setDocumentLocatorSAXFunc	setDocumentLocator
        startDocumentSAXFunc	startDocument
        endDocumentSAXFunc	endDocument
        startElementSAXFunc	startElement
        endElementSAXFunc	endElement
        referenceSAXFunc	reference
        charactersSAXFunc	characters
        ignorableWhitespaceSAXFunc	ignorableWhitespace
        processingInstructionSAXFunc	processingInstruction
        commentSAXFunc	comment
        warningSAXFunc	warning
        errorSAXFunc	error
        fatalErrorSAXFunc	fatalError	: unused error() get all the errors
        getParameterEntitySAXFunc	getParameterEntity
        cdataBlockSAXFunc	cdataBlock
        externalSubsetSAXFunc	externalSubset
        unsigned int	initialized
    }
### Function type: attributeDeclSAXFunc
    Function type: attributeDeclSAXFunc
    void	attributeDeclSAXFunc		(void * ctx,
    					 const xmlChar * elem,
    					 const xmlChar * fullname,
    					 int type,
    					 int def,
    					 const xmlChar * defaultValue,
    					 xmlEnumerationPtr tree)
An attribute definition has been parsed.
`ctx`: | the user data (XML parser context)
`elem`: | the name of the element
`fullname`: | the attribute name
`type`: | the attribute type
`def`: | the type of default value
`defaultValue`: | the attribute default value
`tree`: | the tree of enumerated value set
### Function type: attributeSAXFunc
    Function type: attributeSAXFunc
    void	attributeSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * 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.
`ctx`: | the user data (XML parser context)
`name`: | The attribute name, including namespace prefix
`value`: | The attribute value
### Function type: cdataBlockSAXFunc
    Function type: cdataBlockSAXFunc
    void	cdataBlockSAXFunc		(void * ctx,
    					 const xmlChar * value,
    					 int len)
Called when a pcdata block has been parsed.
`ctx`: | the user data (XML parser context)
`value`: | The pcdata content
`len`: | the block length
### Function type: charactersSAXFunc
    Function type: charactersSAXFunc
    void	charactersSAXFunc		(void * ctx,
    					 const xmlChar * ch,
    					 int len)
Receiving some chars from the parser.
`ctx`: | the user data (XML parser context)
`ch`: | a xmlChar string
`len`: | the number of xmlChar
### Function type: commentSAXFunc
    Function type: commentSAXFunc
    void	commentSAXFunc			(void * ctx,
    					 const xmlChar * value)
A comment has been parsed.
`ctx`: | the user data (XML parser context)
`value`: | the comment content
### Function type: elementDeclSAXFunc
    Function type: elementDeclSAXFunc
    void	elementDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 int type,
    					 xmlElementContentPtr content)
An element definition has been parsed.
`ctx`: | the user data (XML parser context)
`name`: | the element name
`type`: | the element type
`content`: | the element value tree
### Function type: endDocumentSAXFunc
    Function type: endDocumentSAXFunc
    void	endDocumentSAXFunc		(void * ctx)
Called when the document end has been detected.
`ctx`: | the user data (XML parser context)
### Function type: endElementNsSAX2Func
    Function type: endElementNsSAX2Func
    void	endElementNsSAX2Func		(void * ctx,
    					 const xmlChar * localname,
    					 const xmlChar * prefix,
    					 const xmlChar * URI)
SAX2 callback when an element end has been detected by the parser. It provides the namespace informations for the element.
`ctx`: | the user data (XML parser context)
`localname`: | the local name of the element
`prefix`: | the element namespace prefix if available
`URI`: | the element namespace name if available
### Function type: endElementSAXFunc
    Function type: endElementSAXFunc
    void	endElementSAXFunc		(void * ctx,
    					 const xmlChar * name)
Called when the end of an element has been detected.
`ctx`: | the user data (XML parser context)
`name`: | The element name
### Function type: entityDeclSAXFunc
    Function type: entityDeclSAXFunc
    void	entityDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 int type,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId,
    					 xmlChar * content)
An entity definition has been parsed.
`ctx`: | the user data (XML parser context)
`name`: | the entity name
`type`: | the entity type
`publicId`: | The public ID of the entity
`systemId`: | The system ID of the entity
`content`: | the entity value (without processing).
### Function type: errorSAXFunc
    Function type: errorSAXFunc
    void	errorSAXFunc			(void * ctx,
    					 const char * msg,
    					 ... ...)
Display and format an error messages, callback.
`ctx`: | an XML parser context
`msg`: | the message to display/transmit
`...`: | extra parameters for the message display
### Function type: externalSubsetSAXFunc
    Function type: externalSubsetSAXFunc
    void	externalSubsetSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
Callback on external subset declaration.
`ctx`: | the user data (XML parser context)
`name`: | the root element name
`ExternalID`: | the external ID
`SystemID`: | the SYSTEM ID (e.g. filename or URL)
### Function type: fatalErrorSAXFunc
    Function type: fatalErrorSAXFunc
    void	fatalErrorSAXFunc		(void * ctx,
    					 const char * msg,
    					 ... ...)
Display and format fatal error messages, callback. Note: so far fatalError() SAX callbacks are not used, error() get all the callbacks for errors.
`ctx`: | an XML parser context
`msg`: | the message to display/transmit
`...`: | extra parameters for the message display
### Function type: getEntitySAXFunc
    Function type: getEntitySAXFunc
    xmlEntityPtr	getEntitySAXFunc	(void * ctx,
    					 const xmlChar * name)
Get an entity by name.
`ctx`: | the user data (XML parser context)
`name`: | The entity name
`Returns`: | the xmlEntityPtr if found.
### Function type: getParameterEntitySAXFunc
    Function type: getParameterEntitySAXFunc
    xmlEntityPtr	getParameterEntitySAXFunc	(void * ctx,
    						 const xmlChar * name)
Get a parameter entity by name.
`ctx`: | the user data (XML parser context)
`name`: | The entity name
`Returns`: | the xmlEntityPtr if found.
### Function type: hasExternalSubsetSAXFunc
    Function type: hasExternalSubsetSAXFunc
    int	hasExternalSubsetSAXFunc	(void * ctx)
Does this document has an external subset?
`ctx`: | the user data (XML parser context)
`Returns`: | 1 if true
### Function type: hasInternalSubsetSAXFunc
    Function type: hasInternalSubsetSAXFunc
    int	hasInternalSubsetSAXFunc	(void * ctx)
Does this document has an internal subset.
`ctx`: | the user data (XML parser context)
`Returns`: | 1 if true
### Function type: ignorableWhitespaceSAXFunc
    Function type: ignorableWhitespaceSAXFunc
    void	ignorableWhitespaceSAXFunc	(void * ctx,
    					 const xmlChar * ch,
    					 int len)
Receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters.
`ctx`: | the user data (XML parser context)
`ch`: | a xmlChar string
`len`: | the number of xmlChar
### Function type: internalSubsetSAXFunc
    Function type: internalSubsetSAXFunc
    void	internalSubsetSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
Callback on internal subset declaration.
`ctx`: | the user data (XML parser context)
`name`: | the root element name
`ExternalID`: | the external ID
`SystemID`: | the SYSTEM ID (e.g. filename or URL)
### Function type: isStandaloneSAXFunc
    Function type: isStandaloneSAXFunc
    int	isStandaloneSAXFunc		(void * ctx)
Is this document tagged standalone?
`ctx`: | the user data (XML parser context)
`Returns`: | 1 if true
### Function type: notationDeclSAXFunc
    Function type: notationDeclSAXFunc
    void	notationDeclSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId)
What to do when a notation declaration has been parsed.
`ctx`: | the user data (XML parser context)
`name`: | The name of the notation
`publicId`: | The public ID of the entity
`systemId`: | The system ID of the entity
### Function type: processingInstructionSAXFunc
    Function type: processingInstructionSAXFunc
    void	processingInstructionSAXFunc	(void * ctx,
    					 const xmlChar * target,
    					 const xmlChar * data)
A processing instruction has been parsed.
`ctx`: | the user data (XML parser context)
`target`: | the target name
`data`: | the PI data's
### Function type: referenceSAXFunc
    Function type: referenceSAXFunc
    void	referenceSAXFunc		(void * ctx,
    					 const xmlChar * name)
Called when an entity reference is detected.
`ctx`: | the user data (XML parser context)
`name`: | The entity name
### Function type: resolveEntitySAXFunc
    Function type: resolveEntitySAXFunc
    xmlParserInputPtr	resolveEntitySAXFunc	(void * ctx,
    						 const xmlChar * publicId,
    						 const xmlChar * systemId)
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
`ctx`: | the user data (XML parser context)
`publicId`: | The public ID of the entity
`systemId`: | The system ID of the entity
`Returns`: | the xmlParserInputPtr if inlined or NULL for DOM behaviour.
### Function type: setDocumentLocatorSAXFunc
    Function type: setDocumentLocatorSAXFunc
    void	setDocumentLocatorSAXFunc	(void * ctx,
    					 xmlSAXLocatorPtr loc)
Receive the document locator at startup, actually xmlDefaultSAXLocator. Everything is available on the context, so this is useless in our case.
`ctx`: | the user data (XML parser context)
`loc`: | A SAX Locator
### Function type: startDocumentSAXFunc
    Function type: startDocumentSAXFunc
    void	startDocumentSAXFunc		(void * ctx)
Called when the document start being processed.
`ctx`: | the user data (XML parser context)
### Function type: startElementNsSAX2Func
    Function type: startElementNsSAX2Func
    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)
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.
`ctx`: | the user data (XML parser context)
`localname`: | the local name of the element
`prefix`: | the element namespace prefix if available
`URI`: | the element namespace name if available
`nb_namespaces`: | number of namespace definitions on that node
`namespaces`: | pointer to the array of prefix/URI pairs namespace definitions
`nb_attributes`: | the number of attributes on that node
`nb_defaulted`: | the number of defaulted attributes. The defaulted ones are at the end of the array
`attributes`: | pointer to the array of (localname/prefix/URI/value/end) attribute values.
### Function type: startElementSAXFunc
    Function type: startElementSAXFunc
    void	startElementSAXFunc		(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar ** atts)
Called when an opening tag has been processed.
`ctx`: | the user data (XML parser context)
`name`: | The element name, including namespace prefix
`atts`: | An array of name/value attributes pairs, NULL terminated
### Function type: unparsedEntityDeclSAXFunc
    Function type: unparsedEntityDeclSAXFunc
    void	unparsedEntityDeclSAXFunc	(void * ctx,
    					 const xmlChar * name,
    					 const xmlChar * publicId,
    					 const xmlChar * systemId,
    					 const xmlChar * notationName)
What to do when an unparsed entity declaration is parsed.
`ctx`: | the user data (XML parser context)
`name`: | The name of the entity
`publicId`: | The public ID of the entity
`systemId`: | The system ID of the entity
`notationName`: | the name of the notation
### Function type: warningSAXFunc
    Function type: warningSAXFunc
    void	warningSAXFunc			(void * ctx,
    					 const char * msg,
    					 ... ...)
Display and format a warning messages, callback.
`ctx`: | an XML parser context
`msg`: | the message to display/transmit
`...`: | extra parameters for the message display
### Function: xmlByteConsumed
    long	xmlByteConsumed			(xmlParserCtxtPtr ctxt)
This function provides the current index of the parser relative to the start of the current entity. This function is computed in bytes from the beginning starting at zero and finishing at the size in byte of the file if parsing a file. The function is of constant cost if the input is UTF-8 but can be costly if run on non-UTF-8 input.
`ctxt`: | an XML parser context
`Returns`: | the index in bytes from the beginning of the entity or -1 in case the index could not be computed.
### Function: xmlCleanupParser
    void	xmlCleanupParser		(void)
This function name is somewhat misleading. It does not clean up parser state, it cleans up memory allocated by the library itself. It is a cleanup function for the XML library. It tries to reclaim all related global memory allocated for the library processing. It doesn't deallocate any document related memory. One should call xmlCleanupParser() only when the process has finished using the library and all XML/HTML documents built with it. See also xmlInitParser() which has the opposite function of preparing the library for operations. WARNING: if your application is multithreaded or has plugin support calling this may crash the application if another thread or a plugin is still using libxml2. It's sometimes very hard to guess if libxml2 is in use in the application, some libraries or plugins may use it without notice. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind ! ### Function: xmlClearNodeInfoSeq
    void	xmlClearNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)
-- Clear (release memory and reinitialize) node info sequence
`seq`: | a node info sequence pointer
### Function: xmlClearParserCtxt
    void	xmlClearParserCtxt		(xmlParserCtxtPtr ctxt)
Clear (release owned resources) and reinitialize a parser context
`ctxt`: | an XML parser context
### Function: xmlCreateDocParserCtxt
    xmlParserCtxtPtr	xmlCreateDocParserCtxt	(const xmlChar * cur)
Creates a parser context for an XML in-memory document.
`cur`: | a pointer to an array of xmlChar
`Returns`: | the new parser context or NULL
### Function: xmlCreateIOParserCtxt
    xmlParserCtxtPtr	xmlCreateIOParserCtxt	(xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 xmlInputReadCallback ioread,
    						 xmlInputCloseCallback ioclose,
    						 void * ioctx,
    						 xmlCharEncoding enc)
Create a parser context for using the XML parser with an existing I/O stream
`sax`: | a SAX handler
`user_data`: | The user data returned on SAX callbacks
`ioread`: | an I/O read function
`ioclose`: | an I/O close function
`ioctx`: | an I/O handler
`enc`: | the charset encoding if known
`Returns`: | the new parser context or NULL
### Function: xmlCreatePushParserCtxt
    xmlParserCtxtPtr	xmlCreatePushParserCtxt	(xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 const char * chunk,
    						 int size,
    						 const char * filename)
Create a parser context for using the XML parser in push mode. If @buffer and @size are non-NULL, the data is used to detect the encoding. The remaining characters will be parsed so they don't need to be fed in again through xmlParseChunk. To allow content encoding detection, @size should be >= 4 The value of @filename is used for fetching external entities and error/warning reports.
`sax`: | a SAX handler
`user_data`: | The user data returned on SAX callbacks
`chunk`: | a pointer to an array of chars
`size`: | number of chars in the array
`filename`: | an optional file name or URI
`Returns`: | the new parser context or NULL
### Function: xmlCtxtReadDoc
    xmlDocPtr	xmlCtxtReadDoc		(xmlParserCtxtPtr ctxt,
    					 const xmlChar * cur,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context
`ctxt`: | an XML parser context
`cur`: | a pointer to a zero terminated string
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlCtxtReadFd
    xmlDocPtr	xmlCtxtReadFd		(xmlParserCtxtPtr ctxt,
    					 int fd,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML from a file descriptor and build a tree. This reuses the existing @ctxt parser context NOTE that the file descriptor will not be closed when the reader is closed or reset.
`ctxt`: | an XML parser context
`fd`: | an open file descriptor
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlCtxtReadFile
    xmlDocPtr	xmlCtxtReadFile		(xmlParserCtxtPtr ctxt,
    					 const char * filename,
    					 const char * encoding,
    					 int options)
parse an XML file from the filesystem or the network. This reuses the existing @ctxt parser context
`ctxt`: | an XML parser context
`filename`: | a file or URL
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlCtxtReadIO
    xmlDocPtr	xmlCtxtReadIO		(xmlParserCtxtPtr ctxt,
    					 xmlInputReadCallback ioread,
    					 xmlInputCloseCallback ioclose,
    					 void * ioctx,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML document from I/O functions and source and build a tree. This reuses the existing @ctxt parser context
`ctxt`: | an XML parser context
`ioread`: | an I/O read function
`ioclose`: | an I/O close function
`ioctx`: | an I/O handler
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlCtxtReadMemory
    xmlDocPtr	xmlCtxtReadMemory	(xmlParserCtxtPtr ctxt,
    					 const char * buffer,
    					 int size,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context
`ctxt`: | an XML parser context
`buffer`: | a pointer to a char array
`size`: | the size of the array
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlCtxtReset
    void	xmlCtxtReset			(xmlParserCtxtPtr ctxt)
Reset a parser context
`ctxt`: | an XML parser context
### Function: xmlCtxtResetPush
    int	xmlCtxtResetPush		(xmlParserCtxtPtr ctxt,
    					 const char * chunk,
    					 int size,
    					 const char * filename,
    					 const char * encoding)
Reset a push parser context
`ctxt`: | an XML parser context
`chunk`: | a pointer to an array of chars
`size`: | number of chars in the array
`filename`: | an optional file name or URI
`encoding`: | the document encoding, or NULL
`Returns`: | 0 in case of success and 1 in case of error
### Function: xmlCtxtUseOptions
    int	xmlCtxtUseOptions		(xmlParserCtxtPtr ctxt,
    					 int options)
Applies the options to the parser context
`ctxt`: | an XML parser context
`options`: | a combination of xmlParserOption
`Returns`: | 0 in case of success, the set of unknown or unimplemented options in case of error.
### Function type: xmlExternalEntityLoader
    Function type: xmlExternalEntityLoader
    xmlParserInputPtr	xmlExternalEntityLoader	(const char * URL,
    						 const char * ID,
    						 xmlParserCtxtPtr context)
External entity loaders types.
`URL`: | The System ID of the resource requested
`ID`: | The Public ID of the resource requested
`context`: | the XML parser context
`Returns`: | the entity input parser.
### Function: xmlFreeParserCtxt
    void	xmlFreeParserCtxt		(xmlParserCtxtPtr ctxt)
Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.
`ctxt`: | an XML parser context
### Function: xmlGetExternalEntityLoader
    xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)
Get the default external entity resolver function for the application
`Returns`: | the xmlExternalEntityLoader function pointer
### Function: xmlGetFeature
    int	xmlGetFeature			(xmlParserCtxtPtr ctxt,
    					 const char * name,
    					 void * result)
Read the current value of one feature of this parser instance
`ctxt`: | an XML/HTML parser context
`name`: | the feature name
`result`: | location to store the result
`Returns`: | -1 in case or error, 0 otherwise
### Function: xmlGetFeaturesList
    int	xmlGetFeaturesList		(int * len,
    					 const char ** result)
Copy at most *@len feature names into the @result array
`len`: | the length of the features name array (input/output)
`result`: | an array of string to be filled with the features name.
`Returns`: | -1 in case or error, or the total number of features, len is updated with the number of strings copied, strings must not be deallocated
### Function: xmlHasFeature
    int	xmlHasFeature			(xmlFeature feature)
Examines if the library has been compiled with a given feature.
`feature`: | the feature to be examined
`Returns`: | a non-zero value if the feature exist, otherwise zero. Returns zero (0) if the feature does not exist or an unknown unknown feature is requested, non-zero otherwise.
### Function: xmlIOParseDTD
    xmlDtdPtr	xmlIOParseDTD		(xmlSAXHandlerPtr sax,
    					 xmlParserInputBufferPtr input,
    					 xmlCharEncoding enc)
Load and parse a DTD
`sax`: | the SAX handler block or NULL
`input`: | an Input Buffer
`enc`: | the charset encoding if known
`Returns`: | the resulting xmlDtdPtr or NULL in case of error. @input will be freed by the function in any case.
### Function: xmlInitNodeInfoSeq
    void	xmlInitNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)
-- Initialize (set to initial state) node info sequence
`seq`: | a node info sequence pointer
### Function: xmlInitParser
    void	xmlInitParser			(void)
Initialization function for the XML parser. This is not reentrant. Call once before processing in case of use in multithreaded programs. ### Function: xmlInitParserCtxt
    int	xmlInitParserCtxt		(xmlParserCtxtPtr ctxt)
Initialize a parser context
`ctxt`: | an XML parser context
`Returns`: | 0 in case of success and -1 in case of error
### Function: xmlKeepBlanksDefault
    int	xmlKeepBlanksDefault		(int val)
Set and return the previous value for default blanks text nodes support. The 1.x version of the parser used an heuristic to try to detect ignorable white spaces. As a result the SAX callback was generating xmlSAX2IgnorableWhitespace() callbacks instead of characters() one, and when using the DOM output text nodes containing those blanks were not generated. The 2.x and later version will switch to the XML standard way and ignorableWhitespace() are only generated when running the parser in validating mode and when the current element doesn't allow CDATA or mixed content. This function is provided as a way to force the standard behavior on 1.X libs and to switch back to the old mode for compatibility when running 1.X client code on 2.X . Upgrade of 1.X code should be done by using xmlIsBlankNode() commodity function to detect the "empty" nodes generated. This value also affect autogeneration of indentation when saving code if blanks sections are kept, indentation is not generated.
`val`: | int 0 or 1
`Returns`: | the last value for 0 for no substitution, 1 for substitution.
### Function: xmlLineNumbersDefault
    int	xmlLineNumbersDefault		(int val)
Set and return the previous value for enabling line numbers in elements contents. This may break on old application and is turned off by default.
`val`: | int 0 or 1
`Returns`: | the last value for 0 for no substitution, 1 for substitution.
### Function: xmlLoadExternalEntity
    xmlParserInputPtr	xmlLoadExternalEntity	(const char * URL,
    						 const char * ID,
    						 xmlParserCtxtPtr ctxt)
Load an external entity, note that the use of this function for unparsed entities may generate problems
`URL`: | the URL for the entity to load
`ID`: | the Public ID for the entity to load
`ctxt`: | the context in which the entity is called or NULL
`Returns`: | the xmlParserInputPtr or NULL
### Function: xmlNewIOInputStream
    xmlParserInputPtr	xmlNewIOInputStream	(xmlParserCtxtPtr ctxt,
    						 xmlParserInputBufferPtr input,
    						 xmlCharEncoding enc)
Create a new input stream structure encapsulating the @input into a stream suitable for the parser.
`ctxt`: | an XML parser context
`input`: | an I/O Input
`enc`: | the charset encoding if known
`Returns`: | the new input stream or NULL
### Function: xmlNewParserCtxt
    xmlParserCtxtPtr	xmlNewParserCtxt	(void)
Allocate and initialize a new parser context.
`Returns`: | the xmlParserCtxtPtr or NULL
### Function: xmlParseBalancedChunkMemory
    int	xmlParseBalancedChunkMemory	(xmlDocPtr doc,
    					 xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 int depth,
    					 const xmlChar * string,
    					 xmlNodePtr * lst)
Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by the content production in the XML grammar: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
`doc`: | the document the chunk pertains to
`sax`: | the SAX handler bloc (possibly NULL)
`user_data`: | The user data returned on SAX callbacks (possibly NULL)
`depth`: | Used for loop detection, use 0
`string`: | the input string in UTF8 or ISO-Latin (zero terminated)
`lst`: | the return value for the set of parsed nodes
`Returns`: | 0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise
### Function: xmlParseBalancedChunkMemoryRecover
    int	xmlParseBalancedChunkMemoryRecover	(xmlDocPtr doc,
    						 xmlSAXHandlerPtr sax,
    						 void * user_data,
    						 int depth,
    						 const xmlChar * string,
    						 xmlNodePtr * lst,
    						 int recover)
Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by the content production in the XML grammar: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
`doc`: | the document the chunk pertains to
`sax`: | the SAX handler bloc (possibly NULL)
`user_data`: | The user data returned on SAX callbacks (possibly NULL)
`depth`: | Used for loop detection, use 0
`string`: | the input string in UTF8 or ISO-Latin (zero terminated)
`lst`: | the return value for the set of parsed nodes
`recover`: | return nodes even if the data is broken (use 0)
`Returns`: | 0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise In case recover is set to 1, the nodelist will not be empty even if the parsed chunk is not well balanced, assuming the parsing succeeded to some extent.
### Function: xmlParseChunk
    int	xmlParseChunk			(xmlParserCtxtPtr ctxt,
    					 const char * chunk,
    					 int size,
    					 int terminate)
Parse a Chunk of memory
`ctxt`: | an XML parser context
`chunk`: | an char array
`size`: | the size in byte of the chunk
`terminate`: | last chunk indicator
`Returns`: | zero if no error, the xmlParserErrors otherwise.
### Function: xmlParseCtxtExternalEntity
    int	xmlParseCtxtExternalEntity	(xmlParserCtxtPtr ctx,
    					 const xmlChar * URL,
    					 const xmlChar * ID,
    					 xmlNodePtr * lst)
Parse an external general entity within an existing parsing context An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content
`ctx`: | the existing parsing context
`URL`: | the URL for the entity to load
`ID`: | the System ID for the entity to load
`lst`: | the return value for the set of parsed nodes
`Returns`: | 0 if the entity is well formed, -1 in case of args problem and the parser error code otherwise
### Function: xmlParseDTD
    xmlDtdPtr	xmlParseDTD		(const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
Load and parse an external subset.
`ExternalID`: | a NAME* containing the External ID of the DTD
`SystemID`: | a NAME* containing the URL to the DTD
`Returns`: | the resulting xmlDtdPtr or NULL in case of error.
### Function: xmlParseDoc
    xmlDocPtr	xmlParseDoc		(const xmlChar * cur)
parse an XML in-memory document and build a tree.
`cur`: | a pointer to an array of xmlChar
`Returns`: | the resulting document tree
### Function: xmlParseDocument
    int	xmlParseDocument		(xmlParserCtxtPtr ctxt)
parse an XML document (and build a tree if using the standard SAX interface). [1] document ::= prolog element Misc* [22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?
`ctxt`: | an XML parser context
`Returns`: | 0, -1 in case of error. the parser context is augmented as a result of the parsing.
### Function: xmlParseEntity
    xmlDocPtr	xmlParseEntity		(const char * filename)
parse an XML external entity out of context and build a tree. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk
`filename`: | the filename
`Returns`: | the resulting document tree
### Function: xmlParseExtParsedEnt
    int	xmlParseExtParsedEnt		(xmlParserCtxtPtr ctxt)
parse a general parsed entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content
`ctxt`: | an XML parser context
`Returns`: | 0, -1 in case of error. the parser context is augmented as a result of the parsing.
### Function: xmlParseExternalEntity
    int	xmlParseExternalEntity		(xmlDocPtr doc,
    					 xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 int depth,
    					 const xmlChar * URL,
    					 const xmlChar * ID,
    					 xmlNodePtr * lst)
Parse an external general entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content
`doc`: | the document the chunk pertains to
`sax`: | the SAX handler bloc (possibly NULL)
`user_data`: | The user data returned on SAX callbacks (possibly NULL)
`depth`: | Used for loop detection, use 0
`URL`: | the URL for the entity to load
`ID`: | the System ID for the entity to load
`lst`: | the return value for the set of parsed nodes
`Returns`: | 0 if the entity is well formed, -1 in case of args problem and the parser error code otherwise
### Function: xmlParseFile
    xmlDocPtr	xmlParseFile		(const char * filename)
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.
`filename`: | the filename
`Returns`: | the resulting document tree if the file was wellformed, NULL otherwise.
### Function: xmlParseInNodeContext
    xmlParserErrors	xmlParseInNodeContext	(xmlNodePtr node,
    					 const char * data,
    					 int datalen,
    					 int options,
    					 xmlNodePtr * lst)
Parse a well-balanced chunk of an XML document within the context (DTD, namespaces, etc ...) of the given node. The allowed sequence for the data is a Well Balanced Chunk defined by the content production in the XML grammar: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*
`node`: | the context node
`data`: | the input string
`datalen`: | the input string length in bytes
`options`: | a combination of xmlParserOption
`lst`: | the return value for the set of parsed nodes
`Returns`: | XML_ERR_OK if the chunk is well balanced, and the parser error code otherwise
### Function: xmlParseMemory
    xmlDocPtr	xmlParseMemory		(const char * buffer,
    					 int size)
parse an XML in-memory block and build a tree.
`buffer`: | an pointer to a char array
`size`: | the size of the array
`Returns`: | the resulting document tree
### Function: xmlParserAddNodeInfo
    void	xmlParserAddNodeInfo		(xmlParserCtxtPtr ctxt,
    					 const xmlParserNodeInfoPtr info)
Insert node info record into the sorted sequence
`ctxt`: | an XML parser context
`info`: | a node info sequence pointer
### Function: xmlParserFindNodeInfo
    const xmlParserNodeInfo *	xmlParserFindNodeInfo	(const xmlParserCtxtPtr ctx,
    							 const xmlNodePtr node)
Find the parser node info struct for a given node
`ctx`: | an XML parser context
`node`: | an XML node within the tree
`Returns`: | an xmlParserNodeInfo block pointer or NULL
### Function: xmlParserFindNodeInfoIndex
    unsigned long	xmlParserFindNodeInfoIndex	(const xmlParserNodeInfoSeqPtr seq,
    						 const xmlNodePtr node)
xmlParserFindNodeInfoIndex : Find the index that the info record for the given node is or should be at in a sorted sequence
`seq`: | a node info sequence pointer
`node`: | an XML node pointer
`Returns`: | a long indicating the position of the record
### Function type: xmlParserInputDeallocate
    Function type: xmlParserInputDeallocate
    void	xmlParserInputDeallocate	(xmlChar * str)
Callback for freeing some parser input allocations.
`str`: | the string to deallocate
### Function: xmlParserInputGrow
    int	xmlParserInputGrow		(xmlParserInputPtr in,
    					 int len)
This function increase the input for the parser. It tries to preserve pointers to the input buffer, and keep already read data
`in`: | an XML parser input
`len`: | an indicative size for the lookahead
`Returns`: | the amount of char read, or -1 in case of error, 0 indicate the end of this entity
### Function: xmlParserInputRead
    int	xmlParserInputRead		(xmlParserInputPtr in,
    					 int len)
This function was internal and is deprecated.
`in`: | an XML parser input
`len`: | an indicative size for the lookahead
`Returns`: | -1 as this is an error to use it.
### Function: xmlPedanticParserDefault
    int	xmlPedanticParserDefault	(int val)
Set and return the previous value for enabling pedantic warnings.
`val`: | int 0 or 1
`Returns`: | the last value for 0 for no substitution, 1 for substitution.
### Function: xmlReadDoc
    xmlDocPtr	xmlReadDoc		(const xmlChar * cur,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML in-memory document and build a tree.
`cur`: | a pointer to a zero terminated string
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlReadFd
    xmlDocPtr	xmlReadFd		(int fd,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML from a file descriptor and build a tree. NOTE that the file descriptor will not be closed when the reader is closed or reset.
`fd`: | an open file descriptor
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlReadFile
    xmlDocPtr	xmlReadFile		(const char * filename,
    					 const char * encoding,
    					 int options)
parse an XML file from the filesystem or the network.
`filename`: | a file or URL
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlReadIO
    xmlDocPtr	xmlReadIO		(xmlInputReadCallback ioread,
    					 xmlInputCloseCallback ioclose,
    					 void * ioctx,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML document from I/O functions and source and build a tree.
`ioread`: | an I/O read function
`ioclose`: | an I/O close function
`ioctx`: | an I/O handler
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlReadMemory
    xmlDocPtr	xmlReadMemory		(const char * buffer,
    					 int size,
    					 const char * URL,
    					 const char * encoding,
    					 int options)
parse an XML in-memory document and build a tree.
`buffer`: | a pointer to a char array
`size`: | the size of the array
`URL`: | the base URL to use for the document
`encoding`: | the document encoding, or NULL
`options`: | a combination of xmlParserOption
`Returns`: | the resulting document tree
### Function: xmlRecoverDoc
    xmlDocPtr	xmlRecoverDoc		(const xmlChar * cur)
parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a attempt to build a tree is tried anyway
`cur`: | a pointer to an array of xmlChar
`Returns`: | the resulting document tree or NULL in case of failure
### Function: xmlRecoverFile
    xmlDocPtr	xmlRecoverFile		(const char * filename)
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, it attempts to build a tree anyway
`filename`: | the filename
`Returns`: | the resulting document tree or NULL in case of failure
### Function: xmlRecoverMemory
    xmlDocPtr	xmlRecoverMemory	(const char * buffer,
    					 int size)
parse an XML in-memory block and build a tree. In the case the document is not Well Formed, an attempt to build a tree is tried anyway
`buffer`: | an pointer to a char array
`size`: | the size of the array
`Returns`: | the resulting document tree or NULL in case of error
### Function: xmlSAXParseDTD
    xmlDtdPtr	xmlSAXParseDTD		(xmlSAXHandlerPtr sax,
    					 const xmlChar * ExternalID,
    					 const xmlChar * SystemID)
Load and parse an external subset.
`sax`: | the SAX handler block
`ExternalID`: | a NAME* containing the External ID of the DTD
`SystemID`: | a NAME* containing the URL to the DTD
`Returns`: | the resulting xmlDtdPtr or NULL in case of error.
### Function: xmlSAXParseDoc
    xmlDocPtr	xmlSAXParseDoc		(xmlSAXHandlerPtr sax,
    					 const xmlChar * cur,
    					 int recovery)
parse an XML in-memory document and build a tree. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.
`sax`: | the SAX handler block
`cur`: | a pointer to an array of xmlChar
`recovery`: | work in recovery mode, i.e. tries to read no Well Formed documents
`Returns`: | the resulting document tree
### Function: xmlSAXParseEntity
    xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax,
    					 const char * filename)
parse an XML external entity out of context and build a tree. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk
`sax`: | the SAX handler block
`filename`: | the filename
`Returns`: | the resulting document tree
### Function: xmlSAXParseFile
    xmlDocPtr	xmlSAXParseFile		(xmlSAXHandlerPtr sax,
    					 const char * filename,
    					 int recovery)
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.
`sax`: | the SAX handler block
`filename`: | the filename
`recovery`: | work in recovery mode, i.e. tries to read no Well Formed documents
`Returns`: | the resulting document tree
### Function: xmlSAXParseFileWithData
    xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax,
    					 const char * filename,
    					 int recovery,
    					 void * data)
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. It use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines. User data (void *) is stored within the parser context in the context's _private member, so it is available nearly everywhere in libxml
`sax`: | the SAX handler block
`filename`: | the filename
`recovery`: | work in recovery mode, i.e. tries to read no Well Formed documents
`data`: | the userdata
`Returns`: | the resulting document tree
### Function: xmlSAXParseMemory
    xmlDocPtr	xmlSAXParseMemory	(xmlSAXHandlerPtr sax,
    					 const char * buffer,
    					 int size,
    					 int recovery)
parse an XML in-memory block and use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.
`sax`: | the SAX handler block
`buffer`: | an pointer to a char array
`size`: | the size of the array
`recovery`: | work in recovery mode, i.e. tries to read not Well Formed documents
`Returns`: | the resulting document tree
### Function: xmlSAXParseMemoryWithData
    xmlDocPtr	xmlSAXParseMemoryWithData	(xmlSAXHandlerPtr sax,
    						 const char * buffer,
    						 int size,
    						 int recovery,
    						 void * data)
parse an XML in-memory block and use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines. User data (void *) is stored within the parser context in the context's _private member, so it is available nearly everywhere in libxml
`sax`: | the SAX handler block
`buffer`: | an pointer to a char array
`size`: | the size of the array
`recovery`: | work in recovery mode, i.e. tries to read no Well Formed documents
`data`: | the userdata
`Returns`: | the resulting document tree
### Function: xmlSAXUserParseFile
    int	xmlSAXUserParseFile		(xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 const char * filename)
parse an XML file and call the given SAX handler routines. Automatic support for ZLIB/Compress compressed document is provided
`sax`: | a SAX handler
`user_data`: | The user data returned on SAX callbacks
`filename`: | a file name
`Returns`: | 0 in case of success or a error number otherwise
### Function: xmlSAXUserParseMemory
    int	xmlSAXUserParseMemory		(xmlSAXHandlerPtr sax,
    					 void * user_data,
    					 const char * buffer,
    					 int size)
A better SAX parsing routine. parse an XML in-memory buffer and call the given SAX handler routines.
`sax`: | a SAX handler
`user_data`: | The user data returned on SAX callbacks
`buffer`: | an in-memory XML document input
`size`: | the length of the XML document in bytes
`Returns`: | 0 in case of success or a error number otherwise
### Function: xmlSetExternalEntityLoader
    void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)
Changes the defaultexternal entity resolver function for the application
`f`: | the new entity resolver function
### Function: xmlSetFeature
    int	xmlSetFeature			(xmlParserCtxtPtr ctxt,
    					 const char * name,
    					 void * value)
Change the current value of one feature of this parser instance
`ctxt`: | an XML/HTML parser context
`name`: | the feature name
`value`: | pointer to the location of the new value
`Returns`: | -1 in case or error, 0 otherwise
### Function: xmlSetupParserForBuffer
    void	xmlSetupParserForBuffer		(xmlParserCtxtPtr ctxt,
    					 const xmlChar * buffer,
    					 const char * filename)
Setup the parser context to parse a new buffer; Clears any prior contents from the parser context. The buffer parameter must not be NULL, but the filename parameter can be
`ctxt`: | an XML parser context
`buffer`: | a xmlChar * buffer
`filename`: | a file name
### Function: xmlStopParser
    void	xmlStopParser			(xmlParserCtxtPtr ctxt)
Blocks further parser processing
`ctxt`: | an XML parser context
### Function: xmlSubstituteEntitiesDefault
    int	xmlSubstituteEntitiesDefault	(int val)
Set and return the previous value for default entity support. Initially the parser always keep entity references instead of substituting entity values in the output. This function has to be used to change the default parser behavior SAX::substituteEntities() has to be used for changing that on a file by file basis.
`val`: | int 0 or 1
`Returns`: | the last value for 0 for no substitution, 1 for substitution.
Daniel Veillard