parser

parser - the core parser module

Interfaces, constants and types related to the XML parser

Author(s): Daniel Veillard

Synopsis

#define XML_DEFAULT_VERSION;
#define XML_SAX2_MAGIC;
typedef struct _xmlAttrHashBucket xmlAttrHashBucket;
typedef enum xmlFeature;
typedef enum xmlParserInputState;
typedef enum xmlParserMode;
typedef struct _xmlParserNodeInfo xmlParserNodeInfo;
typedef xmlParserNodeInfo * xmlParserNodeInfoPtr;
typedef struct _xmlParserNodeInfoSeq xmlParserNodeInfoSeq;
typedef xmlParserNodeInfoSeq * xmlParserNodeInfoSeqPtr;
typedef struct _xmlParserNsData xmlParserNsData;
typedef enum xmlParserOption;
typedef struct _xmlSAXHandlerV1 xmlSAXHandlerV1;
typedef xmlSAXHandlerV1 * xmlSAXHandlerV1Ptr;
typedef struct _xmlStartTag xmlStartTag;
typedef void attributeDeclSAXFunc		(void * ctx, 
const xmlChar * elem,
const xmlChar * fullname,
int type,
int def,
const xmlChar * defaultValue,
xmlEnumerationPtr tree); typedef void attributeSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar * value); 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 elementDeclSAXFunc (void * ctx,
const xmlChar * name,
int type,
xmlElementContentPtr content); typedef void endDocumentSAXFunc (void * ctx); typedef void endElementNsSAX2Func (void * ctx,
const xmlChar * localname,
const xmlChar * prefix,
const xmlChar * URI); typedef void endElementSAXFunc (void * ctx,
const xmlChar * name); typedef void entityDeclSAXFunc (void * ctx,
const xmlChar * name,
int type,
const xmlChar * publicId,
const xmlChar * systemId,
xmlChar * content); typedef void errorSAXFunc (void * ctx,
const char * msg,
... ...); typedef void externalSubsetSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID); typedef void fatalErrorSAXFunc (void * ctx,
const char * msg,
... ...); typedef xmlEntityPtr getEntitySAXFunc (void * ctx,
const xmlChar * name); typedef xmlEntityPtr getParameterEntitySAXFunc (void * ctx,
const xmlChar * name); typedef int hasExternalSubsetSAXFunc (void * ctx); typedef int hasInternalSubsetSAXFunc (void * ctx); typedef void ignorableWhitespaceSAXFunc (void * ctx,
const xmlChar * ch,
int len); typedef void internalSubsetSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID); typedef int isStandaloneSAXFunc (void * ctx); typedef void notationDeclSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId); typedef void processingInstructionSAXFunc (void * ctx,
const xmlChar * target,
const xmlChar * data); typedef void referenceSAXFunc (void * ctx,
const xmlChar * name); typedef xmlParserInputPtr resolveEntitySAXFunc (void * ctx,
const xmlChar * publicId,
const xmlChar * systemId); typedef void setDocumentLocatorSAXFunc (void * ctx,
xmlSAXLocatorPtr loc); typedef void startDocumentSAXFunc (void * ctx); 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 void startElementSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar ** atts); typedef void unparsedEntityDeclSAXFunc (void * ctx,
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId,
const xmlChar * notationName); typedef void warningSAXFunc (void * ctx,
const char * msg,
... ...); long xmlByteConsumed (xmlParserCtxtPtr ctxt); void xmlCleanupGlobals (void); void xmlCleanupParser (void); void xmlClearNodeInfoSeq (xmlParserNodeInfoSeqPtr seq); void xmlClearParserCtxt (xmlParserCtxtPtr ctxt); xmlParserCtxtPtr xmlCreateDocParserCtxt (const xmlChar * str); 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 xmlCtxtParseDocument (xmlParserCtxtPtr ctxt,
xmlParserInputPtr input); xmlDocPtr xmlCtxtReadDoc (xmlParserCtxtPtr ctxt,
const xmlChar * str,
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); void xmlCtxtSetErrorHandler (xmlParserCtxtPtr ctxt,
xmlStructuredErrorFunc handler,
void * data); void xmlCtxtSetMaxAmplification (xmlParserCtxtPtr ctxt,
unsigned maxAmpl); int xmlCtxtSetOptions (xmlParserCtxtPtr ctxt,
int options); int xmlCtxtUseOptions (xmlParserCtxtPtr ctxt,
int options); typedef 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 xmlInitGlobals (void); 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 buf,
xmlCharEncoding enc); xmlParserCtxtPtr xmlNewParserCtxt (void); xmlParserCtxtPtr xmlNewSAXParserCtxt (const xmlSAXHandler * sax,
void * userData); 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 * listOut,
int recover); int xmlParseChunk (xmlParserCtxtPtr ctxt,
const char * chunk,
int size,
int terminate); int xmlParseCtxtExternalEntity (xmlParserCtxtPtr ctxt,
const xmlChar * URL,
const xmlChar * ID,
xmlNodePtr * listOut); 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 * list); 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,
xmlParserNodeInfoPtr info); const xmlParserNodeInfo * xmlParserFindNodeInfo (xmlParserCtxtPtr ctx,
xmlNodePtr node); unsigned long xmlParserFindNodeInfoIndex (xmlParserNodeInfoSeqPtr seq,
xmlNodePtr node); typedef 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); int xmlThrDefDoValidityCheckingDefaultValue (int v); int xmlThrDefGetWarningsDefaultValue (int v); int xmlThrDefKeepBlanksDefaultValue (int v); int xmlThrDefLineNumbersDefaultValue (int v); int xmlThrDefLoadExtDtdDefaultValue (int v); int xmlThrDefParserDebugEntities (int v); int xmlThrDefPedanticParserDefaultValue (int v); int xmlThrDefSubstituteEntitiesDefaultValue (int v);

Description

Details

Macro XML_DEFAULT_VERSION

#define XML_DEFAULT_VERSION;

The default version of XML used: 1.0


Macro XML_SAX2_MAGIC

#define XML_SAX2_MAGIC;

Special constant found in SAX2 blocks initialized fields


Structure xmlAttrHashBucket

struct _xmlAttrHashBucket {
The content of this structure is not made public by the API.
} xmlAttrHashBucket;



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 */
    XML_PARSER_XML_DECL = 17 /*  before XML decl (but after BOM) */
};



Structure xmlParserNodeInfo

struct _xmlParserNodeInfo {
    const struct _xmlNode *	node	: Position & line # that text that created the node begins & ends on
    unsigned long	begin_pos
    unsigned long	begin_line
    unsigned long	end_pos
    unsigned long	end_line
} xmlParserNodeInfo;


Typedef xmlParserNodeInfoPtr

xmlParserNodeInfo * xmlParserNodeInfoPtr;


Structure xmlParserNodeInfoSeq

struct _xmlParserNodeInfoSeq {
    unsigned long	maximum
    unsigned long	length
    xmlParserNodeInfo *	buffer
} xmlParserNodeInfoSeq;


Typedef xmlParserNodeInfoSeqPtr

xmlParserNodeInfoSeq * xmlParserNodeInfoSeqPtr;


Structure xmlParserNsData

struct _xmlParserNsData {
The content of this structure is not made public by the API.
} xmlParserNsData;


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 substitution */
    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 */
    XML_PARSE_NO_XXE = 8388608 /*  disable loading of external content */
};


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
} xmlSAXHandlerV1;


Typedef xmlSAXHandlerV1Ptr

xmlSAXHandlerV1 * xmlSAXHandlerV1Ptr;


Structure xmlStartTag

struct _xmlStartTag {
The content of this structure is not made public by the API.
} xmlStartTag;


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

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

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

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

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

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

void	endDocumentSAXFunc		(void * ctx)

Called when the document end has been detected.

ctx: the user data (XML parser context)

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 information 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

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

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

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

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

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

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

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

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

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

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

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

int	isStandaloneSAXFunc		(void * ctx)

Is this document tagged standalone?

ctx: the user data (XML parser context)
Returns: 1 if true

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

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

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

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

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

void	startDocumentSAXFunc		(void * ctx)

Called when the document start being processed.

ctx: the user data (XML parser context)

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 information 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

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

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

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 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 type xmlParserInputDeallocate

void	xmlParserInputDeallocate	(xmlChar * str)

Callback for freeing some parser input allocations.

str: the string to deallocate

Variable oldXMLWDcompatibility

const int oldXMLWDcompatibility;

Global setting, DEPRECATED.


Variable xmlDefaultSAXHandler

const xmlSAXHandlerV1 xmlDefaultSAXHandler;

DEPRECATED: This handler is unused and will be removed from future versions. Default SAX version1 handler for XML, builds the DOM tree


Variable xmlDefaultSAXLocator

const xmlSAXLocator xmlDefaultSAXLocator;

DEPRECATED: Don't use The default SAX Locator { getPublicId, getSystemId, getLineNumber, getColumnNumber}


Variable xmlParserDebugEntities

const int xmlParserDebugEntities;

DEPRECATED: Don't use Global setting, asking the parser to print out debugging information. while handling entities. Disabled by default


Variable xmlParserVersion

const char * const xmlParserVersion;

Constant string describing the internal version of the library


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.

xmlCleanupGlobals ()

void	xmlCleanupGlobals		(void)

DEPRECATED: This function is a no-op. Call xmlCleanupParser to free global state but see the warnings there. xmlCleanupParser should be only called once at program exit. In most cases, you don't have call cleanup functions at all.


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 !


xmlClearNodeInfoSeq ()

void	xmlClearNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)

DEPRECATED: Don't use. -- Clear (release memory and reinitialize) node info sequence

seq: a node info sequence pointer

xmlClearParserCtxt ()

void	xmlClearParserCtxt		(xmlParserCtxtPtr ctxt)

Clear (release owned resources) and reinitialize a parser context

ctxt: an XML parser context

xmlCreateDocParserCtxt ()

xmlParserCtxtPtr	xmlCreateDocParserCtxt	(const xmlChar * str)

Creates a parser context for an XML in-memory document.

str: a pointer to an array of xmlChar
Returns: the new parser context or NULL

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 (optional)
user_data: user data for SAX callbacks (optional)
ioread: an I/O read function
ioclose: an I/O close function (optional)
ioctx: an I/O handler
enc: the charset encoding if known (deprecated)
Returns: the new parser context or NULL

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. See xmlParseChunk. Passing an initial chunk is useless and deprecated. @filename is used as base URI to fetch external entities and for error reports.

sax: a SAX handler (optional)
user_data: user data for SAX callbacks (optional)
chunk: initial chunk (optional, deprecated)
size: size of initial chunk in bytes
filename: file name or URI (optional)
Returns: the new parser context or NULL in case of error.

xmlCtxtParseDocument ()

xmlDocPtr	xmlCtxtParseDocument	(xmlParserCtxtPtr ctxt, 
xmlParserInputPtr input)

Parse an XML document and return the resulting document tree. Takes ownership of the input object. Available since 2.13.0.

ctxt: an XML parser context
input: parser input
Returns: the resulting document tree or NULL

xmlCtxtReadDoc ()

xmlDocPtr	xmlCtxtReadDoc		(xmlParserCtxtPtr ctxt, 
const xmlChar * str,
const char * URL,
const char * encoding,
int options)

Parse an XML in-memory document and build a tree. @URL is used as base to resolve external entities and for error reporting. See xmlCtxtUseOptions for details.

ctxt: an XML parser context
str: a pointer to a zero terminated string
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlCtxtReadFd ()

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

Parse an XML document from a file descriptor and build a tree. NOTE that the file descriptor will not be closed when the context is freed or reset. @URL is used as base to resolve external entities and for error reporting. See xmlCtxtUseOptions for details.

ctxt: an XML parser context
fd: an open file descriptor
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlCtxtReadFile ()

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

Parse an XML file from the filesystem, the network or a user-defined resource loader.

ctxt: an XML parser context
filename: a file or URL
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

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 @URL is used as base to resolve external entities and for error reporting. See xmlCtxtUseOptions for details.

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

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. The input buffer must not contain a terminating null byte. @URL is used as base to resolve external entities and for error reporting. See xmlCtxtUseOptions for details.

ctxt: an XML parser context
buffer: a pointer to a char array
size: the size of the array
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlCtxtReset ()

void	xmlCtxtReset			(xmlParserCtxtPtr ctxt)

Reset a parser context

ctxt: an XML parser context

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

xmlCtxtSetErrorHandler ()

void	xmlCtxtSetErrorHandler		(xmlParserCtxtPtr ctxt, 
xmlStructuredErrorFunc handler,
void * data)

Register a callback function that will be called on errors and warnings. If handler is NULL, the error handler will be deactivated. This is the recommended way to collect errors from the parser and takes precedence over all other error reporting mechanisms. These are (in order of precedence): - per-context structured handler (xmlCtxtSetErrorHandler) - per-context structured "serror" SAX handler - global structured handler (xmlSetStructuredErrorFunc) - per-context generic "error" and "warning" SAX handlers - global generic handler (xmlSetGenericErrorFunc) - print to stderr Available since 2.13.0.

ctxt: an XML parser context
handler: error handler
data: data for error handler

xmlCtxtSetMaxAmplification ()

void	xmlCtxtSetMaxAmplification	(xmlParserCtxtPtr ctxt, 
unsigned maxAmpl)

To protect against exponential entity expansion ("billion laughs"), the size of serialized output is (roughly) limited to the input size multiplied by this factor. The default value is 5. When working with documents making heavy use of entity expansion, it can be necessary to increase the value. For security reasons, this should only be considered when processing trusted input.

ctxt: an XML parser context
maxAmpl: maximum amplification factor

xmlCtxtSetOptions ()

int	xmlCtxtSetOptions		(xmlParserCtxtPtr ctxt, 
int options)

Applies the options to the parser context. Unset options are cleared. Available since 2.13.0. With older versions, you can use xmlCtxtUseOptions. XML_PARSE_RECOVER Enable "recovery" mode which allows non-wellformed documents. How this mode behaves exactly is unspecified and may change without further notice. Use of this feature is DISCOURAGED. XML_PARSE_NOENT Despite the confusing name, this option enables substitution of entities. The resulting tree won't contain any entity reference nodes. This option also enables loading of external entities (both general and parameter entities) which is dangerous. If you process untrusted data, it's recommended to set the XML_PARSE_NO_XXE option to disable loading of external entities. XML_PARSE_DTDLOAD Enables loading of an external DTD and the loading and substitution of external parameter entities. Has no effect if XML_PARSE_NO_XXE is set. XML_PARSE_DTDATTR Adds default attributes from the DTD to the result document. Implies XML_PARSE_DTDLOAD, but loading of external content can be disabled with XML_PARSE_NO_XXE. XML_PARSE_DTDVALID This option enables DTD validation which requires to load external DTDs and external entities (both general and parameter entities) unless XML_PARSE_NO_XXE was set. XML_PARSE_NO_XXE Disables loading of external DTDs or entities. XML_PARSE_NOERROR Disable error and warning reports to the error handlers. Errors are still accessible with xmlCtxtGetLastError. XML_PARSE_NOWARNING Disable warning reports. XML_PARSE_PEDANTIC Enable some pedantic warnings. XML_PARSE_NOBLANKS Remove some text nodes containing only whitespace from the result document. Which nodes are removed depends on DTD element declarations or a conservative heuristic. The reindenting feature of the serialization code relies on this option to be set when parsing. Use of this option is DISCOURAGED. XML_PARSE_SAX1 Always invoke the deprecated SAX1 startElement and endElement handlers. This option is DEPRECATED. XML_PARSE_NONET Disable network access with the builtin HTTP and FTP clients. XML_PARSE_NODICT Create a document without interned strings, making all strings separate memory allocations. XML_PARSE_NSCLEAN Remove redundant namespace declarations from the result document. XML_PARSE_NOCDATA Output normal text nodes instead of CDATA nodes. XML_PARSE_COMPACT Store small strings directly in the node struct to save memory. XML_PARSE_OLD10 Use old Name productions from before XML 1.0 Fifth Edition. This options is DEPRECATED. XML_PARSE_HUGE Relax some internal limits. Maximum size of text nodes, tags, comments, processing instructions, CDATA sections, entity values normal: 10M huge: 1B Maximum size of names, system literals, pubid literals normal: 50K huge: 10M Maximum nesting depth of elements normal: 256 huge: 2048 Maximum nesting depth of entities normal: 20 huge: 40 XML_PARSE_OLDSAX Enable an unspecified legacy mode for SAX parsers. This option is DEPRECATED. XML_PARSE_IGNORE_ENC Ignore the encoding in the XML declaration. This option is mostly unneeded these days. The only effect is to enforce UTF-8 decoding of ASCII-like data. XML_PARSE_BIG_LINES Enable reporting of line numbers larger than 65535.

ctxt: an XML parser context
options: a bitmask of xmlParserOption values
Returns: 0 in case of success, the set of unknown or unimplemented options in case of error.

xmlCtxtUseOptions ()

int	xmlCtxtUseOptions		(xmlParserCtxtPtr ctxt, 
int options)

DEPRECATED: Use xmlCtxtSetOptions. Applies the options to the parser context. The following options are never cleared and can only be enabled: XML_PARSE_NOERROR XML_PARSE_NOWARNING XML_PARSE_NONET XML_PARSE_NSCLEAN XML_PARSE_NOCDATA XML_PARSE_COMPACT XML_PARSE_OLD10 XML_PARSE_HUGE XML_PARSE_OLDSAX XML_PARSE_IGNORE_ENC XML_PARSE_BIG_LINES

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.

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

xmlGetExternalEntityLoader ()

xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)

Get the default external entity resolver function for the application

Returns: the xmlExternalEntityLoader function pointer

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

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

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.

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.

xmlInitGlobals ()

void	xmlInitGlobals			(void)

DEPRECATED: Alias for xmlInitParser.


xmlInitNodeInfoSeq ()

void	xmlInitNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)

DEPRECATED: Don't use. -- Initialize (set to initial state) node info sequence

seq: a node info sequence pointer

xmlInitParser ()

void	xmlInitParser			(void)

Initialization function for the XML parser. Call once from the main thread before using the library in multithreaded programs.


xmlInitParserCtxt ()

int	xmlInitParserCtxt		(xmlParserCtxtPtr ctxt)

DEPRECATED: Internal function which will be made private in a future version. Initialize a parser context

ctxt: an XML parser context
Returns: 0 in case of success and -1 in case of error

xmlKeepBlanksDefault ()

int	xmlKeepBlanksDefault		(int val)

DEPRECATED: Use the modern options API with XML_PARSE_NOBLANKS. 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.

xmlLineNumbersDefault ()

int	xmlLineNumbersDefault		(int val)

DEPRECATED: The modern options API always enables line numbers. 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.

xmlLoadExternalEntity ()

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

@URL is a filename or URL. If if contains the substring "://", it is assumed to be a Legacy Extended IRI. Otherwise, it is treated as a filesystem path. @ID is an optional XML public ID, typically from a doctype declaration. It is used for catalog lookups. The following resource loaders will be called if they were registered (in order of precedence): - the global external entity loader set with xmlSetExternalEntityLoader - the per-thread xmlParserInputBufferCreateFilenameFunc set with xmlParserInputBufferCreateFilenameDefault - the default loader which will return - the result from a matching global input callback set with xmlRegisterInputCallbacks - a HTTP resource if support is compiled in. - a file opened from the filesystem, with automatic detection of compressed files if support is compiled in.

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

xmlNewIOInputStream ()

xmlParserInputPtr	xmlNewIOInputStream	(xmlParserCtxtPtr ctxt, 
xmlParserInputBufferPtr buf,
xmlCharEncoding enc)

Create a new input stream structure encapsulating the @input into a stream suitable for the parser.

ctxt: an XML parser context
buf: an input buffer
enc: the charset encoding if known
Returns: the new input stream or NULL

xmlNewParserCtxt ()

xmlParserCtxtPtr	xmlNewParserCtxt	(void)

Allocate and initialize a new parser context.

Returns: the xmlParserCtxtPtr or NULL

xmlNewSAXParserCtxt ()

xmlParserCtxtPtr	xmlNewSAXParserCtxt	(const xmlSAXHandler * sax, 
void * userData)

Allocate and initialize a new SAX parser context. If userData is NULL, the parser context will be passed as user data. Available since 2.11.0. If you want support older versions, it's best to invoke xmlNewParserCtxt and set ctxt->sax with struct assignment.

sax: SAX handler
userData: user data
Returns: the xmlParserCtxtPtr or NULL if memory allocation failed.

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 (must not be NULL)
sax: the SAX handler block (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

xmlParseBalancedChunkMemoryRecover ()

int	xmlParseBalancedChunkMemoryRecover	(xmlDocPtr doc, 
xmlSAXHandlerPtr sax,
void * user_data,
int depth,
const xmlChar * string,
xmlNodePtr * listOut,
int recover)

Parse a well-balanced chunk of an XML document 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 (must not be NULL)
sax: the SAX handler block (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)
listOut: 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, or thehe 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.

xmlParseChunk ()

int	xmlParseChunk			(xmlParserCtxtPtr ctxt, 
const char * chunk,
int size,
int terminate)

Parse a chunk of memory in push parser mode. Assumes that the parser context was initialized with xmlCreatePushParserCtxt. The last chunk, which will often be empty, must be marked with the @terminate flag. With the default SAX callbacks, the resulting document will be available in ctxt->myDoc. This pointer will not be freed by the library. If the document isn't well-formed, ctxt->myDoc is set to NULL. The push parser doesn't support recovery mode.

ctxt: an XML parser context
chunk: chunk of memory
size: size of chunk in bytes
terminate: last chunk indicator
Returns: an xmlParserErrors code (0 on success).

xmlParseCtxtExternalEntity ()

int	xmlParseCtxtExternalEntity	(xmlParserCtxtPtr ctxt, 
const xmlChar * URL,
const xmlChar * ID,
xmlNodePtr * listOut)

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

ctxt: the existing parsing context
URL: the URL for the entity to load
ID: the System ID for the entity to load
listOut: 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

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.

xmlParseDoc ()

xmlDocPtr	xmlParseDoc		(const xmlChar * cur)

DEPRECATED: Use xmlReadDoc. parse an XML in-memory document and build a tree.

cur: a pointer to an array of xmlChar
Returns: the resulting document tree

xmlParseDocument ()

int	xmlParseDocument		(xmlParserCtxtPtr ctxt)

Parse an XML document and invoke the SAX handlers. This is useful if you're only interested in custom SAX callbacks. If you want a document tree, use xmlCtxtParseDocument.

ctxt: an XML parser context
Returns: 0, -1 in case of error.

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

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.

xmlParseExternalEntity ()

int	xmlParseExternalEntity		(xmlDocPtr doc, 
xmlSAXHandlerPtr sax,
void * user_data,
int depth,
const xmlChar * URL,
const xmlChar * ID,
xmlNodePtr * list)

DEPRECATED: Use xmlParseCtxtExternalEntity. 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 block (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
list: 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

xmlParseFile ()

xmlDocPtr	xmlParseFile		(const char * filename)

DEPRECATED: Use xmlReadFile. 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.

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

xmlParseMemory ()

xmlDocPtr	xmlParseMemory		(const char * buffer, 
int size)

DEPRECATED: Use xmlReadMemory. 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

xmlParserAddNodeInfo ()

void	xmlParserAddNodeInfo		(xmlParserCtxtPtr ctxt, 
xmlParserNodeInfoPtr info)

DEPRECATED: Don't use. Insert node info record into the sorted sequence

ctxt: an XML parser context
info: a node info sequence pointer

xmlParserFindNodeInfo ()

const xmlParserNodeInfo *	xmlParserFindNodeInfo	(xmlParserCtxtPtr ctx, 
xmlNodePtr node)

DEPRECATED: Don't use. 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

xmlParserFindNodeInfoIndex ()

unsigned long	xmlParserFindNodeInfoIndex	(xmlParserNodeInfoSeqPtr seq, 
xmlNodePtr node)

DEPRECATED: Don't use. 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

xmlParserInputGrow ()

int	xmlParserInputGrow		(xmlParserInputPtr in, 
int len)

DEPRECATED: Don't use. 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

xmlParserInputRead ()

int	xmlParserInputRead		(xmlParserInputPtr in, 
int len)

DEPRECATED: 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.

xmlPedanticParserDefault ()

int	xmlPedanticParserDefault	(int val)

DEPRECATED: Use the modern options API with XML_PARSE_PEDANTIC. 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.

xmlReadDoc ()

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

Convenience function to parse an XML document from a zero-terminated string. See xmlCtxtReadDoc for details.

cur: a pointer to a zero terminated string
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlReadFd ()

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

Parse an XML from a file descriptor and build a tree. See xmlCtxtReadFd for details. NOTE that the file descriptor will not be closed when the context is freed or reset.

fd: an open file descriptor
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlReadFile ()

xmlDocPtr	xmlReadFile		(const char * filename, 
const char * encoding,
int options)

Convenience function to parse an XML file from the filesystem, the network or a global user-define resource loader. See xmlCtxtReadFile for details.

filename: a file or URL
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

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 context and build a tree. See xmlCtxtReadIO for details.

ioread: an I/O read function
ioclose: an I/O close function (optional)
ioctx: an I/O handler
URL: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

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. The input buffer must not contain a terminating null byte. See xmlCtxtReadMemory for details.

buffer: a pointer to a char array
size: the size of the array
url: base URL (optional)
encoding: the document encoding (optional)
options: a combination of xmlParserOption
Returns: the resulting document tree

xmlRecoverDoc ()

xmlDocPtr	xmlRecoverDoc		(const xmlChar * cur)

DEPRECATED: Use xmlReadDoc with XML_PARSE_RECOVER. 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

xmlRecoverFile ()

xmlDocPtr	xmlRecoverFile		(const char * filename)

DEPRECATED: Use xmlReadFile with XML_PARSE_RECOVER. 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

xmlRecoverMemory ()

xmlDocPtr	xmlRecoverMemory	(const char * buffer, 
int size)

DEPRECATED: Use xmlReadMemory with XML_PARSE_RECOVER. 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

xmlSAXParseDTD ()

xmlDtdPtr	xmlSAXParseDTD		(xmlSAXHandlerPtr sax, 
const xmlChar * ExternalID,
const xmlChar * SystemID)

DEPRECATED: Don't use. 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.

xmlSAXParseDoc ()

xmlDocPtr	xmlSAXParseDoc		(xmlSAXHandlerPtr sax, 
const xmlChar * cur,
int recovery)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadDoc. 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

xmlSAXParseEntity ()

xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax, 
const char * filename)

DEPRECATED: Don't use. 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

xmlSAXParseFile ()

xmlDocPtr	xmlSAXParseFile		(xmlSAXHandlerPtr sax, 
const char * filename,
int recovery)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile. 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

xmlSAXParseFileWithData ()

xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax, 
const char * filename,
int recovery,
void * data)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile. 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

xmlSAXParseMemory ()

xmlDocPtr	xmlSAXParseMemory	(xmlSAXHandlerPtr sax, 
const char * buffer,
int size,
int recovery)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory. 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

xmlSAXParseMemoryWithData ()

xmlDocPtr	xmlSAXParseMemoryWithData	(xmlSAXHandlerPtr sax, 
const char * buffer,
int size,
int recovery,
void * data)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory. 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

xmlSAXUserParseFile ()

int	xmlSAXUserParseFile		(xmlSAXHandlerPtr sax, 
void * user_data,
const char * filename)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadFile. 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

xmlSAXUserParseMemory ()

int	xmlSAXUserParseMemory		(xmlSAXHandlerPtr sax, 
void * user_data,
const char * buffer,
int size)

DEPRECATED: Use xmlNewSAXParserCtxt and xmlCtxtReadMemory. 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

xmlSetExternalEntityLoader ()

void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)

Changes the defaultexternal entity resolver function for the application

f: the new entity resolver 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

xmlSetupParserForBuffer ()

void	xmlSetupParserForBuffer		(xmlParserCtxtPtr ctxt, 
const xmlChar * buffer,
const char * filename)

DEPRECATED: Don't use. 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

xmlStopParser ()

void	xmlStopParser			(xmlParserCtxtPtr ctxt)

Blocks further parser processing

ctxt: an XML parser context

xmlSubstituteEntitiesDefault ()

int	xmlSubstituteEntitiesDefault	(int val)

DEPRECATED: Use the modern options API with XML_PARSE_NOENT. 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.

xmlThrDefDoValidityCheckingDefaultValue ()

int	xmlThrDefDoValidityCheckingDefaultValue	(int v)

v:
Returns:

xmlThrDefGetWarningsDefaultValue ()

int	xmlThrDefGetWarningsDefaultValue	(int v)

v:
Returns:

xmlThrDefKeepBlanksDefaultValue ()

int	xmlThrDefKeepBlanksDefaultValue	(int v)

v:
Returns:

xmlThrDefLineNumbersDefaultValue ()

int	xmlThrDefLineNumbersDefaultValue	(int v)

v:
Returns:

xmlThrDefLoadExtDtdDefaultValue ()

int	xmlThrDefLoadExtDtdDefaultValue	(int v)

v:
Returns:

xmlThrDefParserDebugEntities ()

int	xmlThrDefParserDebugEntities	(int v)

v:
Returns:

xmlThrDefPedanticParserDefaultValue ()

int	xmlThrDefPedanticParserDefaultValue	(int v)

v:
Returns:

xmlThrDefSubstituteEntitiesDefaultValue ()

int	xmlThrDefSubstituteEntitiesDefaultValue	(int v)

v:
Returns: