parser.h File Reference

#include <libxml/xmlversion.h>
#include <libxml/tree.h>
#include <libxml/dict.h>
#include <libxml/hash.h>
#include <libxml/valid.h>
#include <libxml/entities.h>
#include <libxml/xmlerror.h>
#include <libxml/xmlstring.h>
#include <libxml/xmlmemory.h>
#include <libxml/encoding.h>
#include <libxml/xmlIO.h>
#include <libxml/SAX2.h>
#include <libxml/threads.h>

Include dependency graph for parser.h:

Go to the source code of this file.

Classes
struct	_xmlParserInput
struct	_xmlParserNodeInfo
struct	_xmlParserNodeInfoSeq
struct	_xmlParserCtxt
struct	_xmlSAXLocator
struct	_xmlSAXHandler
struct	_xmlSAXHandlerV1

Macros
#define	XML_TREE_INTERNALS
#define	XML_DEFAULT_VERSION   "1.0"
#define	XML_DETECT_IDS   2
#define	XML_COMPLETE_ATTRS   4
#define	XML_SKIP_IDS   8

Typedefs
typedef void(*	xmlParserInputDeallocate) (xmlChar *str)
typedef struct _xmlParserNodeInfo	xmlParserNodeInfo
typedef xmlParserNodeInfo *	xmlParserNodeInfoPtr
typedef struct _xmlParserNodeInfoSeq	xmlParserNodeInfoSeq
typedef xmlParserNodeInfoSeq *	xmlParserNodeInfoSeqPtr
typedef struct _xmlStartTag	xmlStartTag
typedef struct _xmlParserNsData	xmlParserNsData
typedef struct _xmlAttrHashBucket	xmlAttrHashBucket
typedef xmlParserInputPtr(*	resolveEntitySAXFunc) (void *ctx, const xmlChar *publicId, const xmlChar *systemId)
: the root element name
externalSubsetSAXFunc: @ctx: the user data (XML parser context) @ExternalID: the external ID @SystemID: the SYSTEM ID (e.g. filename or URL) Callback on external subset declaration.
typedef void(*	internalSubsetSAXFunc) (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
typedef void(*	externalSubsetSAXFunc) (void *ctx, const xmlChar *name, const xmlChar *ExternalID, const xmlChar *SystemID)
: The entity name
getParameterEntitySAXFunc: @ctx: the user data (XML parser context) Get a parameter entity by name. Returns the xmlEntityPtr if found.
typedef xmlEntityPtr(*	getEntitySAXFunc) (void *ctx, const xmlChar *name)
typedef xmlEntityPtr(*	getParameterEntitySAXFunc) (void *ctx, const xmlChar *name)
: The name of the notation
notationDeclSAXFunc: @ctx: the user data (XML parser context) @publicId: The public ID of the entity @systemId: The system ID of the entity What to do when a notation declaration has been parsed.
typedef void(*	notationDeclSAXFunc) (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId)
typedef void(*	attributeDeclSAXFunc) (void *ctx, const xmlChar *elem, const xmlChar *fullname, int type, int def, const xmlChar *defaultValue, xmlEnumerationPtr tree)
: the element name
endElementSAXFunc: @ctx: the user data (XML parser context) Called when the end of an element has been detected.
typedef void(*	elementDeclSAXFunc) (void *ctx, const xmlChar *name, int type, xmlElementContentPtr content)
typedef void(*	endElementSAXFunc) (void *ctx, const xmlChar *name)
: The name of the entity
unparsedEntityDeclSAXFunc: @ctx: the user data (XML parser context) @publicId: The public ID of the entity @systemId: The system ID of the entity @notationName: the name of the notation What to do when an unparsed entity declaration is parsed.
typedef void(*	unparsedEntityDeclSAXFunc) (void *ctx, const xmlChar *name, const xmlChar *publicId, const xmlChar *systemId, const xmlChar *notationName)
typedef void(*	setDocumentLocatorSAXFunc) (void *ctx, xmlSAXLocatorPtr loc)
typedef void(*	startDocumentSAXFunc) (void *ctx)
typedef void(*	endDocumentSAXFunc) (void *ctx)
: The element name, including namespace prefix
startElementSAXFunc: @ctx: the user data (XML parser context) @atts: An array of name/value attributes pairs, NULL terminated Called when an opening tag has been processed.
typedef void(*	startElementSAXFunc) (void *ctx, const xmlChar *name, const xmlChar **atts)
: The attribute name, including namespace prefix
attributeSAXFunc: @ctx: the user data (XML parser context) @value: The attribute value Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element.
typedef void(*	attributeSAXFunc) (void *ctx, const xmlChar *name, const xmlChar *value)

Enumerations
enum	xmlParserInputState {   XML_PARSER_EOF = -1 , XML_PARSER_START = 0 , XML_PARSER_MISC , XML_PARSER_PI ,   XML_PARSER_DTD , XML_PARSER_PROLOG , XML_PARSER_COMMENT , XML_PARSER_START_TAG ,   XML_PARSER_CONTENT , XML_PARSER_CDATA_SECTION , XML_PARSER_END_TAG , XML_PARSER_ENTITY_DECL ,   XML_PARSER_ENTITY_VALUE , XML_PARSER_ATTRIBUTE_VALUE , XML_PARSER_SYSTEM_LITERAL , XML_PARSER_EPILOG ,   XML_PARSER_IGNORE , XML_PARSER_PUBLIC_LITERAL , XML_PARSER_XML_DECL }
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 }

: the entity name
referenceSAXFunc: @ctx: the user data (XML parser context) Called when an entity reference is detected.
#define	XML_SAX2_MAGIC   0xDEEDBEAF
#define	XML_GLOBALS_PARSER_CORE
#define	XML_GLOBALS_PARSER_OUTPUT
#define	XML_GLOBALS_PARSER_SAX1
#define	XML_GLOBALS_PARSER
#define	XML_OP   XML_DECLARE_GLOBAL
enum	xmlParserOption {   XML_PARSE_RECOVER = 1<<0 , XML_PARSE_NOENT = 1<<1 , XML_PARSE_DTDLOAD = 1<<2 , XML_PARSE_DTDATTR = 1<<3 ,   XML_PARSE_DTDVALID = 1<<4 , XML_PARSE_NOERROR = 1<<5 , XML_PARSE_NOWARNING = 1<<6 , XML_PARSE_PEDANTIC = 1<<7 ,   XML_PARSE_NOBLANKS = 1<<8 , XML_PARSE_SAX1 = 1<<9 , XML_PARSE_XINCLUDE = 1<<10 , XML_PARSE_NONET = 1<<11 ,   XML_PARSE_NODICT = 1<<12 , XML_PARSE_NSCLEAN = 1<<13 , XML_PARSE_NOCDATA = 1<<14 , XML_PARSE_NOXINCNODE = 1<<15 ,   XML_PARSE_COMPACT = 1<<16 , XML_PARSE_OLD10 = 1<<17 , XML_PARSE_NOBASEFIX = 1<<18 , XML_PARSE_HUGE = 1<<19 ,   XML_PARSE_OLDSAX = 1<<20 , XML_PARSE_IGNORE_ENC = 1<<21 , XML_PARSE_BIG_LINES = 1<<22 }
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 }
typedef void(*	entityDeclSAXFunc) (void *ctx, const xmlChar *name, int type, const xmlChar *publicId, const xmlChar *systemId, xmlChar *content)
typedef void(*	referenceSAXFunc) (void *ctx, const xmlChar *name)
typedef void(*	charactersSAXFunc) (void *ctx, const xmlChar *ch, int len)
typedef void(*	ignorableWhitespaceSAXFunc) (void *ctx, const xmlChar *ch, int len)
typedef void(*	processingInstructionSAXFunc) (void *ctx, const xmlChar *target, const xmlChar *data)
typedef void(*	commentSAXFunc) (void *ctx, const xmlChar *value)
typedef void(*	cdataBlockSAXFunc) (void *ctx, const xmlChar *value, int len)
typedef void(*	warningSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2
typedef void(*) typedef void(*	errorSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2
typedef void(*) typedef void(*) typedef void(*	fatalErrorSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2
typedef void(*) typedef void(*) typedef void(*) typedef int(*	isStandaloneSAXFunc) (void *ctx)
typedef int(*	hasInternalSubsetSAXFunc) (void *ctx)
typedef int(*	hasExternalSubsetSAXFunc) (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(*	endElementNsSAX2Func) (void *ctx, const xmlChar *localname, const xmlChar *prefix, const xmlChar *URI)
typedef struct _xmlSAXHandlerV1	xmlSAXHandlerV1
typedef xmlSAXHandlerV1 *	xmlSAXHandlerV1Ptr
typedef xmlParserInputPtr(*	xmlExternalEntityLoader) (const char *URL, const char *ID, xmlParserCtxtPtr context)
XMLPUBVAR const char *const	xmlParserVersion
XML_GLOBALS_PARSER XMLPUBFUN void	xmlInitParser (void)
XMLPUBFUN void	xmlCleanupParser (void)
XML_DEPRECATED XMLPUBFUN void	xmlInitGlobals (void)
XML_DEPRECATED XMLPUBFUN void	xmlCleanupGlobals (void)
XML_DEPRECATED XMLPUBFUN int	xmlParserInputRead (xmlParserInputPtr in, int len)
XML_DEPRECATED XMLPUBFUN int	xmlParserInputGrow (xmlParserInputPtr in, int len)
XML_DEPRECATED XMLPUBFUN int	xmlSubstituteEntitiesDefault (int val)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefSubstituteEntitiesDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlKeepBlanksDefault (int val)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefKeepBlanksDefaultValue (int v)
XMLPUBFUN void	xmlStopParser (xmlParserCtxtPtr ctxt)
XML_DEPRECATED XMLPUBFUN int	xmlPedanticParserDefault (int val)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefPedanticParserDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlLineNumbersDefault (int val)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefLineNumbersDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefDoValidityCheckingDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefGetWarningsDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefLoadExtDtdDefaultValue (int v)
XML_DEPRECATED XMLPUBFUN int	xmlThrDefParserDebugEntities (int v)
XMLPUBFUN int	xmlParseDocument (xmlParserCtxtPtr ctxt)
XMLPUBFUN int	xmlParseExtParsedEnt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlParserErrors	xmlParseInNodeContext (xmlNodePtr node, const char *data, int datalen, int options, xmlNodePtr *lst)
XMLPUBFUN int	xmlParseCtxtExternalEntity (xmlParserCtxtPtr ctx, const xmlChar *URL, const xmlChar *ID, xmlNodePtr *lst)
XMLPUBFUN xmlParserCtxtPtr	xmlNewParserCtxt (void)
XMLPUBFUN xmlParserCtxtPtr	xmlNewSAXParserCtxt (const xmlSAXHandler *sax, void *userData)
XMLPUBFUN int	xmlInitParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN void	xmlClearParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN void	xmlFreeParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlParserCtxtPtr	xmlCreateDocParserCtxt (const xmlChar *cur)
XMLPUBFUN xmlParserCtxtPtr	xmlCreateIOParserCtxt (xmlSAXHandlerPtr sax, void *user_data, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, xmlCharEncoding enc)
XMLPUBFUN xmlParserInputPtr	xmlNewIOInputStream (xmlParserCtxtPtr ctxt, xmlParserInputBufferPtr input, xmlCharEncoding enc)
XMLPUBFUN const xmlParserNodeInfo *	xmlParserFindNodeInfo (const xmlParserCtxtPtr ctxt, const xmlNodePtr node)
XMLPUBFUN void	xmlInitNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN void	xmlClearNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN unsigned long	xmlParserFindNodeInfoIndex (const xmlParserNodeInfoSeqPtr seq, const xmlNodePtr node)
XMLPUBFUN void	xmlParserAddNodeInfo (xmlParserCtxtPtr ctxt, const xmlParserNodeInfoPtr info)
XMLPUBFUN void	xmlSetExternalEntityLoader (xmlExternalEntityLoader f)
XMLPUBFUN xmlExternalEntityLoader	xmlGetExternalEntityLoader (void)
XMLPUBFUN xmlParserInputPtr	xmlLoadExternalEntity (const char *URL, const char *ID, xmlParserCtxtPtr ctxt)
XMLPUBFUN long	xmlByteConsumed (xmlParserCtxtPtr ctxt)
XMLPUBFUN void	xmlCtxtReset (xmlParserCtxtPtr ctxt)
XMLPUBFUN int	xmlCtxtResetPush (xmlParserCtxtPtr ctxt, const char *chunk, int size, const char *filename, const char *encoding)
XMLPUBFUN int	xmlCtxtUseOptions (xmlParserCtxtPtr ctxt, int options)
XMLPUBFUN void	xmlCtxtSetMaxAmplification (xmlParserCtxtPtr ctxt, unsigned maxAmpl)
XMLPUBFUN xmlDocPtr	xmlReadDoc (const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlReadFile (const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlReadMemory (const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlReadFd (int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlReadIO (xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlCtxtReadDoc (xmlParserCtxtPtr ctxt, const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlCtxtReadFile (xmlParserCtxtPtr ctxt, const char *filename, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlCtxtReadMemory (xmlParserCtxtPtr ctxt, const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlCtxtReadFd (xmlParserCtxtPtr ctxt, int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr	xmlCtxtReadIO (xmlParserCtxtPtr ctxt, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)
XMLPUBFUN int	xmlHasFeature (xmlFeature feature)

Macro Definition Documentation

XML_COMPLETE_ATTRS

#define XML_COMPLETE_ATTRS   4

XML_COMPLETE_ATTRS:

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

Definition at line 152 of file parser.h.

XML_DEFAULT_VERSION

#define XML_DEFAULT_VERSION   "1.0"

XML_DEFAULT_VERSION:

The default version of XML used: 1.0

Definition at line 39 of file parser.h.

XML_DETECT_IDS

#define XML_DETECT_IDS   2

XML_DETECT_IDS:

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

Definition at line 143 of file parser.h.

XML_GLOBALS_PARSER

#define XML_GLOBALS_PARSER

Value:

  XML_GLOBALS_PARSER_CORE \
  XML_GLOBALS_PARSER_OUTPUT \
  XML_GLOBALS_PARSER_SAX1

Definition at line 880 of file parser.h.

XML_GLOBALS_PARSER_CORE

#define XML_GLOBALS_PARSER_CORE

Value:

  XML_OP(oldXMLWDcompatibility, int, XML_DEPRECATED) \
  XML_OP(xmlDefaultSAXLocator, xmlSAXLocator, XML_DEPRECATED) \
  XML_OP(xmlDoValidityCheckingDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlGetWarningsDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlKeepBlanksDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlLineNumbersDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlLoadExtDtdDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlParserDebugEntities, int, XML_DEPRECATED) \
  XML_OP(xmlPedanticParserDefaultValue, int, XML_DEPRECATED) \
  XML_OP(xmlSubstituteEntitiesDefaultValue, int, XML_DEPRECATED)

DOC_DISABLE

Definition at line 852 of file parser.h.

XML_GLOBALS_PARSER_OUTPUT

#define XML_GLOBALS_PARSER_OUTPUT

Definition at line 870 of file parser.h.

XML_GLOBALS_PARSER_SAX1

#define XML_GLOBALS_PARSER_SAX1

Definition at line 877 of file parser.h.

XML_OP

#define XML_OP   XML_DECLARE_GLOBAL

Definition at line 885 of file parser.h.

XML_SAX2_MAGIC

#define XML_SAX2_MAGIC   0xDEEDBEAF

XML_SAX2_MAGIC:

Special constant found in SAX2 blocks initialized fields

Definition at line 687 of file parser.h.

XML_SKIP_IDS

#define XML_SKIP_IDS   8

XML_SKIP_IDS:

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

Definition at line 160 of file parser.h.

XML_TREE_INTERNALS

#define XML_TREE_INTERNALS

Definition at line 14 of file parser.h.

Typedef Documentation

attributeDeclSAXFunc

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

Definition at line 459 of file parser.h.

attributeSAXFunc

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

Definition at line 549 of file parser.h.

cdataBlockSAXFunc

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

cdataBlockSAXFunc: @ctx: the user data (XML parser context) @value: The pcdata content @len: the block length

Called when a pcdata block has been parsed.

Definition at line 612 of file parser.h.

charactersSAXFunc

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

charactersSAXFunc: @ctx: the user data (XML parser context) @ch: a xmlChar string @len: the number of xmlChar

Receiving some chars from the parser.

Definition at line 569 of file parser.h.

commentSAXFunc

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

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

A comment has been parsed.

Definition at line 602 of file parser.h.

elementDeclSAXFunc

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

Definition at line 475 of file parser.h.

endDocumentSAXFunc

typedef void(* endDocumentSAXFunc) (void *ctx)

endDocumentSAXFunc: @ctx: the user data (XML parser context)

Called when the document end has been detected.

Definition at line 517 of file parser.h.

endElementNsSAX2Func

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

endElementNsSAX2Func: @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

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

Definition at line 729 of file parser.h.

endElementSAXFunc

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

Definition at line 536 of file parser.h.

entityDeclSAXFunc

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

Definition at line 428 of file parser.h.

errorSAXFunc

typedef void(*) typedef void(* errorSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2

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

Display and format an error messages, callback.

Definition at line 634 of file parser.h.

externalSubsetSAXFunc

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

Definition at line 391 of file parser.h.

fatalErrorSAXFunc

typedef void(*) typedef void(*) typedef void(* fatalErrorSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2

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

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

Definition at line 646 of file parser.h.

getEntitySAXFunc

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

Definition at line 404 of file parser.h.

getParameterEntitySAXFunc

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

Definition at line 415 of file parser.h.

hasExternalSubsetSAXFunc

typedef int(* hasExternalSubsetSAXFunc) (void *ctx)

hasExternalSubsetSAXFunc: @ctx: the user data (XML parser context)

Does this document has an external subset?

Returns 1 if true

Definition at line 675 of file parser.h.

hasInternalSubsetSAXFunc

typedef int(* hasInternalSubsetSAXFunc) (void *ctx)

hasInternalSubsetSAXFunc: @ctx: the user data (XML parser context)

Does this document has an internal subset.

Returns 1 if true

Definition at line 665 of file parser.h.

ignorableWhitespaceSAXFunc

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

ignorableWhitespaceSAXFunc: @ctx: the user data (XML parser context) @ch: a xmlChar string @len: the number of xmlChar

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

Definition at line 581 of file parser.h.

internalSubsetSAXFunc

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

Definition at line 378 of file parser.h.

isStandaloneSAXFunc

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

isStandaloneSAXFunc: @ctx: the user data (XML parser context)

Is this document tagged standalone?

Returns 1 if true

Definition at line 656 of file parser.h.

notationDeclSAXFunc

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

Definition at line 443 of file parser.h.

processingInstructionSAXFunc

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

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

A processing instruction has been parsed.

Definition at line 592 of file parser.h.

referenceSAXFunc

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

Definition at line 559 of file parser.h.

resolveEntitySAXFunc

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

xmlSAXHandler:

A SAX handler is bunch of callbacks called by the parser when processing of the input generate data or structure information. resolveEntitySAXFunc: @ctx: the user data (XML parser context) @publicId: The public ID of the entity @systemId: The system ID of the entity

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

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

Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.

Definition at line 366 of file parser.h.

setDocumentLocatorSAXFunc

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

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

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

Definition at line 502 of file parser.h.

startDocumentSAXFunc

typedef void(* startDocumentSAXFunc) (void *ctx)

startDocumentSAXFunc: @ctx: the user data (XML parser context)

Called when the document start being processed.

Definition at line 510 of file parser.h.

startElementNsSAX2Func

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

startElementNsSAX2Func: @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.

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.

Definition at line 708 of file parser.h.

startElementSAXFunc

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

Definition at line 526 of file parser.h.

unparsedEntityDeclSAXFunc

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

Definition at line 489 of file parser.h.

warningSAXFunc

typedef void(* warningSAXFunc) (void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2

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

Display and format a warning messages, callback.

Definition at line 624 of file parser.h.

xmlAttrHashBucket

typedef struct _xmlAttrHashBucket xmlAttrHashBucket

Definition at line 178 of file parser.h.

xmlExternalEntityLoader

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

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

External entity loaders types.

Returns the entity input parser.

Definition at line 837 of file parser.h.

xmlParserInputDeallocate

typedef void(* xmlParserInputDeallocate) (xmlChar *str)

xmlParserInput:

An xmlParserInput is an input flow for the XML processor. Each entity parsed is associated an xmlParserInput (except the few predefined ones). This is the case both for internal entities

• in which case the flow is already completely in memory - or external entities - in which case we use the buf structure for progressive reading and I18N conversions to the internal UTF-8 format. xmlParserInputDeallocate: @str: the string to deallocate

Callback for freeing some parser input allocations.

Definition at line 58 of file parser.h.

xmlParserNodeInfo

typedef struct _xmlParserNodeInfo xmlParserNodeInfo

xmlParserNodeInfo:

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

Definition at line 89 of file parser.h.

xmlParserNodeInfoPtr

typedef xmlParserNodeInfo* xmlParserNodeInfoPtr

Definition at line 90 of file parser.h.

xmlParserNodeInfoSeq

typedef struct _xmlParserNodeInfoSeq xmlParserNodeInfoSeq

Definition at line 101 of file parser.h.

xmlParserNodeInfoSeqPtr

typedef xmlParserNodeInfoSeq* xmlParserNodeInfoSeqPtr

Definition at line 102 of file parser.h.

xmlParserNsData

typedef struct _xmlParserNsData xmlParserNsData

Definition at line 177 of file parser.h.

xmlSAXHandlerV1

typedef struct _xmlSAXHandlerV1 xmlSAXHandlerV1

Definition at line 793 of file parser.h.

xmlSAXHandlerV1Ptr

typedef xmlSAXHandlerV1* xmlSAXHandlerV1Ptr

Definition at line 794 of file parser.h.

xmlStartTag

typedef struct _xmlStartTag xmlStartTag

Definition at line 176 of file parser.h.

Enumeration Type Documentation

xmlFeature

enum xmlFeature

xmlFeature:

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

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

Definition at line 1341 of file parser.h.

             {
    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 */
} xmlFeature;

xmlParserInputState

enum xmlParserInputState

xmlParserInputState:

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

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

Definition at line 115 of file parser.h.

             {
    XML_PARSER_EOF = -1,    /* nothing is to be parsed */
    XML_PARSER_START = 0,   /* nothing has been parsed */
    XML_PARSER_MISC,        /* Misc* before int subset */
    XML_PARSER_PI,      /* Within a processing instruction */
    XML_PARSER_DTD,     /* within some DTD content */
    XML_PARSER_PROLOG,      /* Misc* after internal subset */
    XML_PARSER_COMMENT,     /* within a comment */
    XML_PARSER_START_TAG,   /* within a start tag */
    XML_PARSER_CONTENT,     /* within the content */
    XML_PARSER_CDATA_SECTION,   /* within a CDATA section */
    XML_PARSER_END_TAG,     /* within a closing tag */
    XML_PARSER_ENTITY_DECL, /* within an entity declaration */
    XML_PARSER_ENTITY_VALUE,    /* within an entity value in a decl */
    XML_PARSER_ATTRIBUTE_VALUE, /* within an attribute value */
    XML_PARSER_SYSTEM_LITERAL,  /* within a SYSTEM value */
    XML_PARSER_EPILOG,      /* the Misc* after the last end tag */
    XML_PARSER_IGNORE,      /* within an IGNORED section */
    XML_PARSER_PUBLIC_LITERAL,  /* within a PUBLIC value */
    XML_PARSER_XML_DECL         /* before XML decl (but after BOM) */
} xmlParserInputState;

xmlParserMode

enum xmlParserMode

xmlParserMode:

A parser can operate in various modes

Enumerator
XML_PARSE_UNKNOWN
XML_PARSE_DOM
XML_PARSE_SAX
XML_PARSE_PUSH_DOM
XML_PARSE_PUSH_SAX
XML_PARSE_READER

Definition at line 167 of file parser.h.

             {
    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
} xmlParserMode;

xmlParserOption

enum xmlParserOption

xmlParserOption:

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

Enumerator
XML_PARSE_RECOVER
XML_PARSE_NOENT
XML_PARSE_DTDLOAD
XML_PARSE_DTDATTR
XML_PARSE_DTDVALID
XML_PARSE_NOERROR
XML_PARSE_NOWARNING
XML_PARSE_PEDANTIC
XML_PARSE_NOBLANKS
XML_PARSE_SAX1
XML_PARSE_XINCLUDE
XML_PARSE_NONET
XML_PARSE_NODICT
XML_PARSE_NSCLEAN
XML_PARSE_NOCDATA
XML_PARSE_NOXINCNODE
XML_PARSE_COMPACT
XML_PARSE_OLD10
XML_PARSE_NOBASEFIX
XML_PARSE_HUGE
XML_PARSE_OLDSAX
XML_PARSE_IGNORE_ENC
XML_PARSE_BIG_LINES

Definition at line 1229 of file parser.h.

             {
    XML_PARSE_RECOVER   = 1<<0, /* recover on errors */
    XML_PARSE_NOENT = 1<<1, /* substitute entities */
    XML_PARSE_DTDLOAD   = 1<<2, /* load the external subset */
    XML_PARSE_DTDATTR   = 1<<3, /* default DTD attributes */
    XML_PARSE_DTDVALID  = 1<<4, /* validate with the DTD */
    XML_PARSE_NOERROR   = 1<<5, /* suppress error reports */
    XML_PARSE_NOWARNING = 1<<6, /* suppress warning reports */
    XML_PARSE_PEDANTIC  = 1<<7, /* pedantic error reporting */
    XML_PARSE_NOBLANKS  = 1<<8, /* remove blank nodes */
    XML_PARSE_SAX1  = 1<<9, /* use the SAX1 interface internally */
    XML_PARSE_XINCLUDE  = 1<<10,/* Implement XInclude substitution  */
    XML_PARSE_NONET = 1<<11,/* Forbid network access */
    XML_PARSE_NODICT    = 1<<12,/* Do not reuse the context dictionary */
    XML_PARSE_NSCLEAN   = 1<<13,/* remove redundant namespaces declarations */
    XML_PARSE_NOCDATA   = 1<<14,/* merge CDATA as text nodes */
    XML_PARSE_NOXINCNODE= 1<<15,/* do not generate XINCLUDE START/END nodes */
    XML_PARSE_COMPACT   = 1<<16,/* compact small text nodes; no modification of
                                   the tree allowed afterwards (will possibly
                   crash if you try to modify the tree) */
    XML_PARSE_OLD10 = 1<<17,/* parse using XML-1.0 before update 5 */
    XML_PARSE_NOBASEFIX = 1<<18,/* do not fixup XINCLUDE xml:base uris */
    XML_PARSE_HUGE      = 1<<19,/* relax any hardcoded limit from the parser */
    XML_PARSE_OLDSAX    = 1<<20,/* parse using SAX2 interface before 2.7.0 */
    XML_PARSE_IGNORE_ENC= 1<<21,/* ignore internal document encoding hint */
    XML_PARSE_BIG_LINES = 1<<22 /* Store big lines numbers in text PSVI field */
} xmlParserOption;

Function Documentation

xmlByteConsumed()

XMLPUBFUN long xmlByteConsumed

(

xmlParserCtxtPtr

ctxt

)

xmlCleanupGlobals()

XML_DEPRECATED XMLPUBFUN void xmlCleanupGlobals

(

void

)

xmlCleanupGlobals:

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.

Definition at line 609 of file globals.c.

                             {
}

xmlCleanupParser()

XMLPUBFUN void xmlCleanupParser

(

void

)

xmlCleanupParser:

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 !

Definition at line 630 of file threads.c.

                       {
    if (!xmlParserInitialized)
        return;
 
    /* These functions can call xmlFree. */
 
    xmlCleanupCharEncodingHandlers();
#ifdef LIBXML_CATALOG_ENABLED
    xmlCatalogCleanup();
#endif
#ifdef LIBXML_SCHEMAS_ENABLED
    xmlSchemaCleanupTypes();
    xmlRelaxNGCleanupTypes();
#endif
 
    /* These functions should never call xmlFree. */
 
    xmlCleanupInputCallbacks();
#ifdef LIBXML_OUTPUT_ENABLED
    xmlCleanupOutputCallbacks();
#endif
 
    xmlCleanupDictInternal();
    xmlCleanupRandom();
    xmlCleanupGlobalsInternal();
    /*
     * Must come last. On Windows, xmlCleanupGlobalsInternal can call
     * xmlFree which uses xmlMemMutex in debug mode.
     */
    xmlCleanupMemoryInternal();
 
    xmlGlobalInitMutexDestroy();
 
    xmlParserInitialized = 0;
    xmlParserInnerInitialized = 0;
}

Referenced by DllMain(), and xmlInitParser().

xmlClearNodeInfoSeq()

XMLPUBFUN void xmlClearNodeInfoSeq

(

xmlParserNodeInfoSeqPtr

seq

)

xmlClearNodeInfoSeq: @seq: a node info sequence pointer

DEPRECATED: Don't use.

– Clear (release memory and reinitialize) node info sequence

Definition at line 2210 of file parserInternals.c.

{
    if (seq == NULL)
        return;
    if (seq->buffer != NULL)
        xmlFree(seq->buffer);
    xmlInitNodeInfoSeq(seq);
}

Referenced by xmlClearParserCtxt().

xmlClearParserCtxt()

XMLPUBFUN void xmlClearParserCtxt

(

xmlParserCtxtPtr

ctxt

)

xmlClearParserCtxt: @ctxt: an XML parser context

Clear (release owned resources) and reinitialize a parser context

Definition at line 2145 of file parserInternals.c.

{
  if (ctxt==NULL)
    return;
  xmlClearNodeInfoSeq(&ctxt->node_seq);
  xmlCtxtReset(ctxt);
}

xmlCreateDocParserCtxt()

XMLPUBFUN xmlParserCtxtPtr xmlCreateDocParserCtxt

(

const xmlChar *

str

)

xmlCreateDocParserCtxt: @str: a pointer to an array of xmlChar

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

Returns the new parser context or NULL

Definition at line 14207 of file parser.c.

                                           {
    xmlParserCtxtPtr ctxt;
    xmlParserInputPtr input;
    xmlParserInputBufferPtr buf;
 
    if (str == NULL)
    return(NULL);
 
    ctxt = xmlNewParserCtxt();
    if (ctxt == NULL)
    return(NULL);
 
    buf = xmlParserInputBufferCreateString(str);
    if (buf == NULL) {
    xmlFreeParserCtxt(ctxt);
    return(NULL);
    }
 
    input = xmlNewInputStream(ctxt);
    if (input == NULL) {
    xmlFreeParserInputBuffer(buf);
    xmlFreeParserCtxt(ctxt);
    return(NULL);
    }
 
    input->filename = NULL;
    input->buf = buf;
    xmlBufResetInput(input->buf->buffer, input);
 
    inputPush(ctxt, input);
    return(ctxt);
}

Referenced by xmlParseBalancedChunkMemoryInternal(), and xmlReadDoc().

xmlCreateIOParserCtxt()

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

xmlCreateIOParserCtxt: @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

Create a parser context for using the XML parser with an existing I/O stream

Returns the new parser context or NULL

Definition at line 12333 of file parser.c.

                                      {
    xmlParserCtxtPtr ctxt;
    xmlParserInputPtr inputStream;
    xmlParserInputBufferPtr buf;
 
    if (ioread == NULL) return(NULL);
 
    buf = xmlParserInputBufferCreateIO(ioread, ioclose, ioctx, enc);
    if (buf == NULL) {
        if (ioclose != NULL)
            ioclose(ioctx);
        return (NULL);
    }
 
    ctxt = xmlNewSAXParserCtxt(sax, user_data);
    if (ctxt == NULL) {
    xmlFreeParserInputBuffer(buf);
    return(NULL);
    }
 
    inputStream = xmlNewIOInputStream(ctxt, buf, enc);
    if (inputStream == NULL) {
    xmlFreeParserCtxt(ctxt);
    return(NULL);
    }
    inputPush(ctxt, inputStream);
 
    return(ctxt);
}

xmlCtxtReadDoc()

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

xmlCtxtReadDoc: @ctxt: an XML parser context @str: 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

parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

Returns the resulting document tree

Definition at line 14950 of file parser.c.

{
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (ctxt == NULL)
        return (NULL);
    if (str == NULL)
        return (NULL);
    xmlInitParser();
 
    xmlCtxtReset(ctxt);
 
    input = xmlParserInputBufferCreateString(str);
    if (input == NULL) {
    return(NULL);
    }
 
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
    xmlFreeParserInputBuffer(input);
    return(NULL);
    }
 
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 1));
}

xmlCtxtReadFd()

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

xmlCtxtReadFd: @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

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.

Returns the resulting document tree

Definition at line 15074 of file parser.c.

{
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (fd < 0)
        return (NULL);
    if (ctxt == NULL)
        return (NULL);
    xmlInitParser();
 
    xmlCtxtReset(ctxt);
 
 
    input = xmlParserInputBufferCreateFd(fd, XML_CHAR_ENCODING_NONE);
    if (input == NULL)
        return (NULL);
    input->closecallback = NULL;
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
        xmlFreeParserInputBuffer(input);
        return (NULL);
    }
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 1));
}

xmlCtxtReadFile()

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

xmlCtxtReadFile: @ctxt: an XML parser context @filename: a file or URL @encoding: the document encoding, or NULL @options: a combination of xmlParserOption

parse an XML file from the filesystem or the network. This reuses the existing @ctxt parser context

Returns the resulting document tree

Definition at line 14992 of file parser.c.

{
    xmlParserInputPtr stream;
 
    if (filename == NULL)
        return (NULL);
    if (ctxt == NULL)
        return (NULL);
    xmlInitParser();
 
    xmlCtxtReset(ctxt);
 
    stream = xmlLoadExternalEntity(filename, NULL, ctxt);
    if (stream == NULL) {
        return (NULL);
    }
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, NULL, encoding, options, 1));
}

xmlCtxtReadIO()

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

xmlCtxtReadIO: @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

parse an XML document from I/O functions and source and build a tree. This reuses the existing @ctxt parser context

Returns the resulting document tree

Definition at line 15118 of file parser.c.

{
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (ioread == NULL)
        return (NULL);
    if (ctxt == NULL)
        return (NULL);
    xmlInitParser();
 
    xmlCtxtReset(ctxt);
 
    input = xmlParserInputBufferCreateIO(ioread, ioclose, ioctx,
                                         XML_CHAR_ENCODING_NONE);
    if (input == NULL) {
        if (ioclose != NULL)
            ioclose(ioctx);
        return (NULL);
    }
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
        xmlFreeParserInputBuffer(input);
        return (NULL);
    }
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 1));
}

xmlCtxtReadMemory()

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

xmlCtxtReadMemory: @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

parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

Returns the resulting document tree

Definition at line 15028 of file parser.c.

{
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (ctxt == NULL)
        return (NULL);
    if (buffer == NULL)
        return (NULL);
    xmlInitParser();
 
    xmlCtxtReset(ctxt);
 
    input = xmlParserInputBufferCreateStatic(buffer, size,
                                             XML_CHAR_ENCODING_NONE);
    if (input == NULL) {
    return(NULL);
    }
 
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
    xmlFreeParserInputBuffer(input);
    return(NULL);
    }
 
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 1));
}

xmlCtxtReset()

XMLPUBFUN void xmlCtxtReset

(

xmlParserCtxtPtr

ctxt

)

xmlCtxtReset: @ctxt: an XML parser context

Reset a parser context

Definition at line 14372 of file parser.c.

{
    xmlParserInputPtr input;
    xmlDictPtr dict;
 
    if (ctxt == NULL)
        return;
 
    dict = ctxt->dict;
 
    while ((input = inputPop(ctxt)) != NULL) { /* Non consuming */
        xmlFreeInputStream(input);
    }
    ctxt->inputNr = 0;
    ctxt->input = NULL;
 
    ctxt->spaceNr = 0;
    if (ctxt->spaceTab != NULL) {
    ctxt->spaceTab[0] = -1;
    ctxt->space = &ctxt->spaceTab[0];
    } else {
        ctxt->space = NULL;
    }
 
 
    ctxt->nodeNr = 0;
    ctxt->node = NULL;
 
    ctxt->nameNr = 0;
    ctxt->name = NULL;
 
    ctxt->nsNr = 0;
    xmlParserNsReset(ctxt->nsdb);
 
    DICT_FREE(ctxt->version);
    ctxt->version = NULL;
    DICT_FREE(ctxt->encoding);
    ctxt->encoding = NULL;
    DICT_FREE(ctxt->directory);
    ctxt->directory = NULL;
    DICT_FREE(ctxt->extSubURI);
    ctxt->extSubURI = NULL;
    DICT_FREE(ctxt->extSubSystem);
    ctxt->extSubSystem = NULL;
    if (ctxt->myDoc != NULL)
        xmlFreeDoc(ctxt->myDoc);
    ctxt->myDoc = NULL;
 
    ctxt->standalone = -1;
    ctxt->hasExternalSubset = 0;
    ctxt->hasPErefs = 0;
    ctxt->html = 0;
    ctxt->external = 0;
    ctxt->instate = XML_PARSER_START;
    ctxt->token = 0;
 
    ctxt->wellFormed = 1;
    ctxt->nsWellFormed = 1;
    ctxt->disableSAX = 0;
    ctxt->valid = 1;
#if 0
    ctxt->vctxt.userData = ctxt;
    ctxt->vctxt.error = xmlParserValidityError;
    ctxt->vctxt.warning = xmlParserValidityWarning;
#endif
    ctxt->record_info = 0;
    ctxt->checkIndex = 0;
    ctxt->endCheckState = 0;
    ctxt->inSubset = 0;
    ctxt->errNo = XML_ERR_OK;
    ctxt->depth = 0;
    ctxt->catalogs = NULL;
    ctxt->sizeentities = 0;
    ctxt->sizeentcopy = 0;
    xmlInitNodeInfoSeq(&ctxt->node_seq);
 
    if (ctxt->attsDefault != NULL) {
        xmlHashFree(ctxt->attsDefault, xmlHashDefaultDeallocator);
        ctxt->attsDefault = NULL;
    }
    if (ctxt->attsSpecial != NULL) {
        xmlHashFree(ctxt->attsSpecial, NULL);
        ctxt->attsSpecial = NULL;
    }
 
#ifdef LIBXML_CATALOG_ENABLED
    if (ctxt->catalogs != NULL)
    xmlCatalogFreeLocal(ctxt->catalogs);
#endif
    ctxt->nbErrors = 0;
    ctxt->nbWarnings = 0;
    if (ctxt->lastError.code != XML_ERR_OK)
        xmlResetError(&ctxt->lastError);
}

Referenced by xmlClearParserCtxt(), xmlCtxtReadDoc(), xmlCtxtReadFd(), xmlCtxtReadFile(), xmlCtxtReadIO(), xmlCtxtReadMemory(), and xmlCtxtResetPush().

xmlCtxtResetPush()

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

xmlCtxtResetPush: @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

Reset a push parser context

Returns 0 in case of success and 1 in case of error

Definition at line 14480 of file parser.c.

{
    xmlParserInputPtr inputStream;
    xmlParserInputBufferPtr buf;
 
    if (ctxt == NULL)
        return(1);
 
    buf = xmlAllocParserInputBuffer(XML_CHAR_ENCODING_NONE);
    if (buf == NULL)
        return(1);
 
    if (ctxt == NULL) {
        xmlFreeParserInputBuffer(buf);
        return(1);
    }
 
    xmlCtxtReset(ctxt);
 
    if (filename == NULL) {
        ctxt->directory = NULL;
    } else {
        ctxt->directory = xmlParserGetDirectory(filename);
    }
 
    inputStream = xmlNewInputStream(ctxt);
    if (inputStream == NULL) {
        xmlFreeParserInputBuffer(buf);
        return(1);
    }
 
    if (filename == NULL)
        inputStream->filename = NULL;
    else
        inputStream->filename = (char *)
            xmlCanonicPath((const xmlChar *) filename);
    inputStream->buf = buf;
    xmlBufResetInput(buf->buffer, inputStream);
 
    inputPush(ctxt, inputStream);
 
    if ((size > 0) && (chunk != NULL) && (ctxt->input != NULL) &&
        (ctxt->input->buf != NULL)) {
        size_t pos = ctxt->input->cur - ctxt->input->base;
        int res;
 
        res = xmlParserInputBufferPush(ctxt->input->buf, size, chunk);
        xmlBufUpdateInput(ctxt->input->buf->buffer, ctxt->input, pos);
        if (res < 0) {
            xmlFatalErr(ctxt, ctxt->input->buf->error, NULL);
            xmlHaltParser(ctxt);
            return(1);
        }
    }
 
    if (encoding != NULL) {
        xmlCharEncodingHandlerPtr hdlr;
 
        hdlr = xmlFindCharEncodingHandler(encoding);
        if (hdlr != NULL) {
            xmlSwitchToEncoding(ctxt, hdlr);
    } else {
        xmlFatalErrMsgStr(ctxt, XML_ERR_UNSUPPORTED_ENCODING,
                  "Unsupported encoding %s\n", BAD_CAST encoding);
        }
    }
 
    return(0);
}

xmlCtxtSetMaxAmplification()

XMLPUBFUN void xmlCtxtSetMaxAmplification	(	xmlParserCtxtPtr	ctxt,
		unsigned	maxAmpl
	)

xmlCtxtSetMaxAmplification: @ctxt: an XML parser context @maxAmpl: maximum amplification factor

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.

Definition at line 14717 of file parser.c.

{
    ctxt->maxAmpl = maxAmpl;
}

xmlCtxtUseOptions()

XMLPUBFUN int xmlCtxtUseOptions	(	xmlParserCtxtPtr	ctxt,
		int	options
	)

xmlCtxtUseOptions: @ctxt: an XML parser context @options: a combination of xmlParserOption

Applies the options to the parser context

Returns 0 in case of success, the set of unknown or unimplemented options in case of error.

Definition at line 14698 of file parser.c.

{
   return(xmlCtxtUseOptionsInternal(ctxt, options));
}

Referenced by xslt_doc_default_loader(), and xsltDocDefaultLoaderFunc().

xmlFreeParserCtxt()

XMLPUBFUN void xmlFreeParserCtxt

(

xmlParserCtxtPtr

ctxt

)

xmlFreeParserCtxt: @ctxt: an XML parser context

Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.

Definition at line 2009 of file parserInternals.c.

{
    xmlParserInputPtr input;
 
    if (ctxt == NULL) return;
 
    while ((input = inputPop(ctxt)) != NULL) { /* Non consuming */
        xmlFreeInputStream(input);
    }
    if (ctxt->spaceTab != NULL) xmlFree(ctxt->spaceTab);
    if (ctxt->nameTab != NULL) xmlFree((xmlChar * *)ctxt->nameTab);
    if (ctxt->nodeTab != NULL) xmlFree(ctxt->nodeTab);
    if (ctxt->nodeInfoTab != NULL) xmlFree(ctxt->nodeInfoTab);
    if (ctxt->inputTab != NULL) xmlFree(ctxt->inputTab);
    if (ctxt->version != NULL) xmlFree((char *) ctxt->version);
    if (ctxt->encoding != NULL) xmlFree((char *) ctxt->encoding);
    if (ctxt->extSubURI != NULL) xmlFree((char *) ctxt->extSubURI);
    if (ctxt->extSubSystem != NULL) xmlFree((char *) ctxt->extSubSystem);
#ifdef LIBXML_SAX1_ENABLED
    if ((ctxt->sax != NULL) &&
        (ctxt->sax != (xmlSAXHandlerPtr) &xmlDefaultSAXHandler))
#else
    if (ctxt->sax != NULL)
#endif /* LIBXML_SAX1_ENABLED */
        xmlFree(ctxt->sax);
    if (ctxt->directory != NULL) xmlFree((char *) ctxt->directory);
    if (ctxt->vctxt.nodeTab != NULL) xmlFree(ctxt->vctxt.nodeTab);
    if (ctxt->atts != NULL) xmlFree((xmlChar * *)ctxt->atts);
    if (ctxt->dict != NULL) xmlDictFree(ctxt->dict);
    if (ctxt->nsTab != NULL) xmlFree(ctxt->nsTab);
    if (ctxt->nsdb != NULL) xmlParserNsFree(ctxt->nsdb);
    if (ctxt->attrHash != NULL) xmlFree(ctxt->attrHash);
    if (ctxt->pushTab != NULL) xmlFree(ctxt->pushTab);
    if (ctxt->attallocs != NULL) xmlFree(ctxt->attallocs);
    if (ctxt->attsDefault != NULL)
        xmlHashFree(ctxt->attsDefault, xmlHashDefaultDeallocator);
    if (ctxt->attsSpecial != NULL)
        xmlHashFree(ctxt->attsSpecial, NULL);
    if (ctxt->freeElems != NULL) {
        xmlNodePtr cur, next;
 
    cur = ctxt->freeElems;
    while (cur != NULL) {
        next = cur->next;
        xmlFree(cur);
        cur = next;
    }
    }
    if (ctxt->freeAttrs != NULL) {
        xmlAttrPtr cur, next;
 
    cur = ctxt->freeAttrs;
    while (cur != NULL) {
        next = cur->next;
        xmlFree(cur);
        cur = next;
    }
    }
    /*
     * cleanup the error strings
     */
    if (ctxt->lastError.message != NULL)
        xmlFree(ctxt->lastError.message);
    if (ctxt->lastError.file != NULL)
        xmlFree(ctxt->lastError.file);
    if (ctxt->lastError.str1 != NULL)
        xmlFree(ctxt->lastError.str1);
    if (ctxt->lastError.str2 != NULL)
        xmlFree(ctxt->lastError.str2);
    if (ctxt->lastError.str3 != NULL)
        xmlFree(ctxt->lastError.str3);
 
#ifdef LIBXML_CATALOG_ENABLED
    if (ctxt->catalogs != NULL)
    xmlCatalogFreeLocal(ctxt->catalogs);
#endif
    xmlFree(ctxt);
}

Referenced by doparse(), internal_parseBuffer(), internal_parseStream(), xmlCreateDocParserCtxt(), xmlCreateEntityParserCtxtInternal(), xmlCreateIOParserCtxt(), xmlCreateMemoryParserCtxt(), xmlCreateURLParserCtxt(), xmlDoRead(), xmlNewSAXParserCtxt(), xmlParseBalancedChunkMemoryInternal(), xmlParseExternalEntityPrivate(), xmlParseInNodeContext(), xmlReadFd(), xmlReadIO(), xslt_doc_default_loader(), and xsltDocDefaultLoaderFunc().

xmlGetExternalEntityLoader()

XMLPUBFUN xmlExternalEntityLoader xmlGetExternalEntityLoader

(

void

)

Referenced by link_datatypes(), and schemasInit().

xmlHasFeature()

XMLPUBFUN int xmlHasFeature

(

xmlFeature

feature

)

xmlHasFeature: @feature: the feature to be examined

Examines if the library has been compiled with a given feature.

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.

Definition at line 640 of file parser.c.

{
    switch (feature) {
    case XML_WITH_THREAD:
#ifdef LIBXML_THREAD_ENABLED
        return(1);
#else
        return(0);
#endif
        case XML_WITH_TREE:
#ifdef LIBXML_TREE_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_OUTPUT:
#ifdef LIBXML_OUTPUT_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_PUSH:
#ifdef LIBXML_PUSH_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_READER:
#ifdef LIBXML_READER_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_PATTERN:
#ifdef LIBXML_PATTERN_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_WRITER:
#ifdef LIBXML_WRITER_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_SAX1:
#ifdef LIBXML_SAX1_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_FTP:
#ifdef LIBXML_FTP_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_HTTP:
#ifdef LIBXML_HTTP_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_VALID:
#ifdef LIBXML_VALID_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_HTML:
#ifdef LIBXML_HTML_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_LEGACY:
#ifdef LIBXML_LEGACY_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_C14N:
#ifdef LIBXML_C14N_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_CATALOG:
#ifdef LIBXML_CATALOG_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_XPATH:
#ifdef LIBXML_XPATH_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_XPTR:
#ifdef LIBXML_XPTR_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_XINCLUDE:
#ifdef LIBXML_XINCLUDE_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_ICONV:
#ifdef LIBXML_ICONV_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_ISO8859X:
#ifdef LIBXML_ISO8859X_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_UNICODE:
#ifdef LIBXML_UNICODE_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_REGEXP:
#ifdef LIBXML_REGEXP_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_AUTOMATA:
#ifdef LIBXML_AUTOMATA_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_EXPR:
#ifdef LIBXML_EXPR_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_SCHEMAS:
#ifdef LIBXML_SCHEMAS_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_SCHEMATRON:
#ifdef LIBXML_SCHEMATRON_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_MODULES:
#ifdef LIBXML_MODULES_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_DEBUG:
#ifdef LIBXML_DEBUG_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_DEBUG_MEM:
#ifdef DEBUG_MEMORY_LOCATION
            return(1);
#else
            return(0);
#endif
        case XML_WITH_DEBUG_RUN:
            return(0);
        case XML_WITH_ZLIB:
#ifdef LIBXML_ZLIB_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_LZMA:
#ifdef LIBXML_LZMA_ENABLED
            return(1);
#else
            return(0);
#endif
        case XML_WITH_ICU:
#ifdef LIBXML_ICU_ENABLED
            return(1);
#else
            return(0);
#endif
        default:
        break;
     }
     return(0);
}

xmlInitGlobals()

XML_DEPRECATED XMLPUBFUN void xmlInitGlobals

(

void

)

xmlInitGlobals:

DEPRECATED: Alias for xmlInitParser.

Definition at line 562 of file globals.c.

                          {
    xmlInitParser();
}

xmlInitNodeInfoSeq()

XMLPUBFUN void xmlInitNodeInfoSeq

(

xmlParserNodeInfoSeqPtr

seq

)

xmlInitNodeInfoSeq: @seq: a node info sequence pointer

DEPRECATED: Don't use.

– Initialize (set to initial state) node info sequence

Definition at line 2191 of file parserInternals.c.

{
    if (seq == NULL)
        return;
    seq->length = 0;
    seq->maximum = 0;
    seq->buffer = NULL;
}

Referenced by xmlClearNodeInfoSeq(), xmlCtxtReset(), and xmlInitSAXParserCtxt().

xmlInitParser()

XML_GLOBALS_PARSER XMLPUBFUN void xmlInitParser

(

void

)

DOC_ENABLE

xmlInitParser:

Initialization function for the XML parser.

Call once from the main thread before using the library in multithreaded programs.

Definition at line 569 of file threads.c.

                    {
    /*
     * Note that the initialization code must not make memory allocations.
     */
    if (xmlParserInitialized != 0)
        return;
 
    xmlGlobalInitMutexLock();
 
    if (xmlParserInnerInitialized == 0) {
#if defined(_WIN32) && \
    !defined(LIBXML_THREAD_ALLOC_ENABLED) && \
    (!defined(LIBXML_STATIC) || defined(LIBXML_STATIC_FOR_DLL))
        if (xmlFree == free)
            atexit(xmlCleanupParser);
#endif
 
        xmlInitMemoryInternal(); /* Should come second */
        xmlInitGlobalsInternal();
        xmlInitRandom();
        xmlInitDictInternal();
        xmlInitEncodingInternal();
#if defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)
        xmlInitXPathInternal();
#endif
 
        xmlRegisterDefaultInputCallbacks();
#ifdef LIBXML_OUTPUT_ENABLED
        xmlRegisterDefaultOutputCallbacks();
#endif /* LIBXML_OUTPUT_ENABLED */
 
        xmlParserInnerInitialized = 1;
    }
 
    xmlGlobalInitMutexUnlock();
 
    xmlParserInitialized = 1;
}

Referenced by DllMain(), xmlCheckVersion(), xmlCtxtReadDoc(), xmlCtxtReadFd(), xmlCtxtReadFile(), xmlCtxtReadIO(), xmlCtxtReadMemory(), xmlDictCreate(), xmlHashCreate(), xmlInitCharEncodingHandlers(), xmlInitGlobals(), xmlInitializeDict(), xmlInitMemory(), xmlInitSAXParserCtxt(), xmlInitThreads(), xmlIsMainThreadInternal(), xmlMallocAtomicLoc(), xmlMallocLoc(), xmlMemStrdupLoc(), xmlParseDocument(), xmlReadDoc(), xmlReadFd(), xmlReadFile(), xmlReadIO(), xmlReadMemory(), and xmlReallocLoc().

xmlInitParserCtxt()

XMLPUBFUN int xmlInitParserCtxt

(

xmlParserCtxtPtr

ctxt

)

xmlInitParserCtxt: @ctxt: an XML parser context

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

Initialize a parser context

Returns 0 in case of success and -1 in case of error

Definition at line 1995 of file parserInternals.c.

{
    return(xmlInitSAXParserCtxt(ctxt, NULL, NULL));
}

xmlKeepBlanksDefault()

XML_DEPRECATED XMLPUBFUN int xmlKeepBlanksDefault

(

int

val

)

xmlKeepBlanksDefault: @val: int 0 or 1

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.

Returns the last value for 0 for no substitution, 1 for substitution.

Definition at line 2426 of file parserInternals.c.

                              {
    int old = xmlKeepBlanksDefaultValue;
 
    xmlKeepBlanksDefaultValue = val;
#ifdef LIBXML_OUTPUT_ENABLED
    if (!val)
        xmlIndentTreeOutput = 1;
#endif
    return(old);
}

xmlLineNumbersDefault()

XML_DEPRECATED XMLPUBFUN int xmlLineNumbersDefault

(

int

val

)

xmlLineNumbersDefault: @val: int 0 or 1

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.

Returns the last value for 0 for no substitution, 1 for substitution.

Definition at line 2368 of file parserInternals.c.

                               {
    int old = xmlLineNumbersDefaultValue;
 
    xmlLineNumbersDefaultValue = val;
    return(old);
}

xmlLoadExternalEntity()

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

Referenced by xmlCreateEntityParserCtxtInternal(), xmlCreateURLParserCtxt(), xmlCtxtReadFile(), xmlLoadEntityContent(), xmlNewEntityInputStream(), xmlSAX2ResolveEntity(), and xsltDocDefaultLoaderFunc().

xmlNewIOInputStream()

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

xmlNewIOInputStream: @ctxt: an XML parser context @input: an I/O Input @enc: the charset encoding if known

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

Returns the new input stream or NULL

Definition at line 1581 of file parserInternals.c.

                                     {
    xmlParserInputPtr inputStream;
 
    if (input == NULL) return(NULL);
    if (xmlParserDebugEntities)
    xmlGenericError(xmlGenericErrorContext, "new input from I/O\n");
    inputStream = xmlNewInputStream(ctxt);
    if (inputStream == NULL) {
    return(NULL);
    }
    inputStream->filename = NULL;
    inputStream->buf = input;
    xmlBufResetInput(inputStream->buf->buffer, inputStream);
 
    if (enc != XML_CHAR_ENCODING_NONE) {
        xmlSwitchEncoding(ctxt, enc);
    }
 
    return(inputStream);
}

Referenced by import_loader_onDataAvailable(), xmlCreateIOParserCtxt(), xmlCtxtReadDoc(), xmlCtxtReadFd(), xmlCtxtReadIO(), xmlCtxtReadMemory(), xmlReadFd(), and xmlReadIO().

xmlNewParserCtxt()

XMLPUBFUN xmlParserCtxtPtr xmlNewParserCtxt

(

void

)

xmlNewParserCtxt:

Allocate and initialize a new parser context.

Returns the xmlParserCtxtPtr or NULL

Definition at line 2097 of file parserInternals.c.

{
    return(xmlNewSAXParserCtxt(NULL, NULL));
}

Referenced by xmlCreateDocParserCtxt(), xmlCreateMemoryParserCtxt(), xmlCreateURLParserCtxt(), xmlReadFd(), xmlReadIO(), xslt_doc_default_loader(), and xsltDocDefaultLoaderFunc().

xmlNewSAXParserCtxt()

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

xmlNewSAXParserCtxt: @sax: SAX handler @userData: user data

Allocate and initialize a new SAX parser context. If userData is NULL, the parser context will be passed as user data.

Returns the xmlParserCtxtPtr or NULL if memory allocation failed.

Definition at line 2114 of file parserInternals.c.

{
    xmlParserCtxtPtr ctxt;
 
    ctxt = (xmlParserCtxtPtr) xmlMalloc(sizeof(xmlParserCtxt));
    if (ctxt == NULL) {
    xmlErrMemory(NULL, "cannot allocate parser context\n");
    return(NULL);
    }
    memset(ctxt, 0, sizeof(xmlParserCtxt));
    if (xmlInitSAXParserCtxt(ctxt, sax, userData) < 0) {
        xmlFreeParserCtxt(ctxt);
    return(NULL);
    }
    return(ctxt);
}

Referenced by xmlCreateEntityParserCtxtInternal(), xmlCreateIOParserCtxt(), and xmlNewParserCtxt().

xmlParseCtxtExternalEntity()

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

xmlParseCtxtExternalEntity: @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

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

Returns 0 if the entity is well formed, -1 in case of args problem and the parser error code otherwise

Definition at line 12621 of file parser.c.

                                                       {
    void *userData;
 
    if (ctx == NULL) return(-1);
    /*
     * If the user provided their own SAX callbacks, then reuse the
     * userData callback field, otherwise the expected setup in a
     * DOM builder is to have userData == ctxt
     */
    if (ctx->userData == ctx)
        userData = NULL;
    else
        userData = ctx->userData;
    return xmlParseExternalEntityPrivate(ctx->myDoc, ctx, ctx->sax,
                                         userData, ctx->depth + 1,
                                         URL, ID, lst);
}

xmlParseDocument()

XMLPUBFUN int xmlParseDocument

(

xmlParserCtxtPtr

ctxt

)

xmlParseDocument: @ctxt: an XML parser context

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*)?

Returns 0, -1 in case of error. the parser context is augmented as a result of the parsing.

Definition at line 11009 of file parser.c.

                                        {
    xmlInitParser();
 
    if ((ctxt == NULL) || (ctxt->input == NULL))
        return(-1);
 
    GROW;
 
    /*
     * SAX: detecting the level.
     */
    xmlDetectSAX2(ctxt);
 
    /*
     * SAX: beginning of the document processing.
     */
    if ((ctxt->sax) && (ctxt->sax->setDocumentLocator))
        ctxt->sax->setDocumentLocator(ctxt->userData, &xmlDefaultSAXLocator);
    if (ctxt->instate == XML_PARSER_EOF)
    return(-1);
 
    xmlDetectEncoding(ctxt);
 
    if (CUR == 0) {
    xmlFatalErr(ctxt, XML_ERR_DOCUMENT_EMPTY, NULL);
    return(-1);
    }
 
    GROW;
    if ((CMP5(CUR_PTR, '<', '?', 'x', 'm', 'l')) && (IS_BLANK_CH(NXT(5)))) {
 
    /*
     * Note that we will switch encoding on the fly.
     */
    xmlParseXMLDecl(ctxt);
    if ((ctxt->errNo == XML_ERR_UNSUPPORTED_ENCODING) ||
        (ctxt->instate == XML_PARSER_EOF)) {
        /*
         * The XML REC instructs us to stop parsing right here
         */
        return(-1);
    }
    SKIP_BLANKS;
    } else {
    ctxt->version = xmlCharStrdup(XML_DEFAULT_VERSION);
    }
    if ((ctxt->sax) && (ctxt->sax->startDocument) && (!ctxt->disableSAX))
        ctxt->sax->startDocument(ctxt->userData);
    if (ctxt->instate == XML_PARSER_EOF)
    return(-1);
    if ((ctxt->myDoc != NULL) && (ctxt->input != NULL) &&
        (ctxt->input->buf != NULL) && (ctxt->input->buf->compressed >= 0)) {
    ctxt->myDoc->compression = ctxt->input->buf->compressed;
    }
 
    /*
     * The Misc part of the Prolog
     */
    xmlParseMisc(ctxt);
 
    /*
     * Then possibly doc type declaration(s) and more Misc
     * (doctypedecl Misc*)?
     */
    GROW;
    if (CMP9(CUR_PTR, '<', '!', 'D', 'O', 'C', 'T', 'Y', 'P', 'E')) {
 
    ctxt->inSubset = 1;
    xmlParseDocTypeDecl(ctxt);
    if (RAW == '[') {
        ctxt->instate = XML_PARSER_DTD;
        xmlParseInternalSubset(ctxt);
        if (ctxt->instate == XML_PARSER_EOF)
        return(-1);
    }
 
    /*
     * Create and update the external subset.
     */
    ctxt->inSubset = 2;
    if ((ctxt->sax != NULL) && (ctxt->sax->externalSubset != NULL) &&
        (!ctxt->disableSAX))
        ctxt->sax->externalSubset(ctxt->userData, ctxt->intSubName,
                                  ctxt->extSubSystem, ctxt->extSubURI);
    if (ctxt->instate == XML_PARSER_EOF)
        return(-1);
    ctxt->inSubset = 0;
 
        xmlCleanSpecialAttr(ctxt);
 
    ctxt->instate = XML_PARSER_PROLOG;
    xmlParseMisc(ctxt);
    }
 
    /*
     * Time to start parsing the tree itself
     */
    GROW;
    if (RAW != '<') {
    xmlFatalErrMsg(ctxt, XML_ERR_DOCUMENT_EMPTY,
               "Start tag expected, '<' not found\n");
    } else {
    ctxt->instate = XML_PARSER_CONTENT;
    xmlParseElement(ctxt);
    ctxt->instate = XML_PARSER_EPILOG;
 
 
    /*
     * The Misc part at the end
     */
    xmlParseMisc(ctxt);
 
        if (ctxt->input->cur < ctxt->input->end) {
            if (ctxt->errNo == XML_ERR_OK)
            xmlFatalErr(ctxt, XML_ERR_DOCUMENT_END, NULL);
        } else if ((ctxt->input->buf != NULL) &&
                   (ctxt->input->buf->encoder != NULL) &&
                   (!xmlBufIsEmpty(ctxt->input->buf->raw))) {
            xmlFatalErrMsg(ctxt, XML_ERR_INVALID_CHAR,
                           "Truncated multi-byte sequence at EOF\n");
        }
    ctxt->instate = XML_PARSER_EOF;
    }
 
    /*
     * SAX: end of the document processing.
     */
    if ((ctxt->sax) && (ctxt->sax->endDocument != NULL))
        ctxt->sax->endDocument(ctxt->userData);
 
    /*
     * Remove locally kept entity definitions if the tree was not built
     */
    if ((ctxt->myDoc != NULL) &&
    (xmlStrEqual(ctxt->myDoc->version, SAX_COMPAT_MODE))) {
    xmlFreeDoc(ctxt->myDoc);
    ctxt->myDoc = NULL;
    }
 
    if ((ctxt->wellFormed) && (ctxt->myDoc != NULL)) {
        ctxt->myDoc->properties |= XML_DOC_WELLFORMED;
    if (ctxt->valid)
        ctxt->myDoc->properties |= XML_DOC_DTDVALID;
    if (ctxt->nsWellFormed)
        ctxt->myDoc->properties |= XML_DOC_NSVALID;
    if (ctxt->options & XML_PARSE_OLD10)
        ctxt->myDoc->properties |= XML_DOC_OLD10;
    }
    if (! ctxt->wellFormed) {
    ctxt->valid = 0;
    return(-1);
    }
    return(0);
}

Referenced by doparse(), internal_parseBuffer(), xmlDoRead(), xslt_doc_default_loader(), and xsltDocDefaultLoaderFunc().

xmlParseExtParsedEnt()

XMLPUBFUN int xmlParseExtParsedEnt

(

xmlParserCtxtPtr

ctxt

)

xmlParseExtParsedEnt: @ctxt: an XML parser context

parse a general parsed entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt.

[78] extParsedEnt ::= TextDecl? content

Returns 0, -1 in case of error. the parser context is augmented as a result of the parsing.

Definition at line 11179 of file parser.c.

                                            {
    if ((ctxt == NULL) || (ctxt->input == NULL))
        return(-1);
 
    xmlDetectSAX2(ctxt);
 
    /*
     * SAX: beginning of the document processing.
     */
    if ((ctxt->sax) && (ctxt->sax->setDocumentLocator))
        ctxt->sax->setDocumentLocator(ctxt->userData, &xmlDefaultSAXLocator);
 
    xmlDetectEncoding(ctxt);
 
    if (CUR == 0) {
    xmlFatalErr(ctxt, XML_ERR_DOCUMENT_EMPTY, NULL);
    }
 
    /*
     * Check for the XMLDecl in the Prolog.
     */
    GROW;
    if ((CMP5(CUR_PTR, '<', '?', 'x', 'm', 'l')) && (IS_BLANK_CH(NXT(5)))) {
 
    /*
     * Note that we will switch encoding on the fly.
     */
    xmlParseXMLDecl(ctxt);
    if (ctxt->errNo == XML_ERR_UNSUPPORTED_ENCODING) {
        /*
         * The XML REC instructs us to stop parsing right here
         */
        return(-1);
    }
    SKIP_BLANKS;
    } else {
    ctxt->version = xmlCharStrdup(XML_DEFAULT_VERSION);
    }
    if ((ctxt->sax) && (ctxt->sax->startDocument) && (!ctxt->disableSAX))
        ctxt->sax->startDocument(ctxt->userData);
    if (ctxt->instate == XML_PARSER_EOF)
    return(-1);
 
    /*
     * Doing validity checking on chunk doesn't make sense
     */
    ctxt->instate = XML_PARSER_CONTENT;
    ctxt->validate = 0;
    ctxt->loadsubset = 0;
    ctxt->depth = 0;
 
    xmlParseContent(ctxt);
    if (ctxt->instate == XML_PARSER_EOF)
    return(-1);
 
    if ((RAW == '<') && (NXT(1) == '/')) {
    xmlFatalErr(ctxt, XML_ERR_NOT_WELL_BALANCED, NULL);
    } else if (RAW != 0) {
    xmlFatalErr(ctxt, XML_ERR_EXTRA_CONTENT, NULL);
    }
 
    /*
     * SAX: end of the document processing.
     */
    if ((ctxt->sax) && (ctxt->sax->endDocument != NULL))
        ctxt->sax->endDocument(ctxt->userData);
 
    if (! ctxt->wellFormed) return(-1);
    return(0);
}

xmlParseInNodeContext()

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

xmlParseInNodeContext: @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

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)*

Returns XML_ERR_OK if the chunk is well balanced, and the parser error code otherwise

Definition at line 13156 of file parser.c.

                                                    {
    xmlParserCtxtPtr ctxt;
    xmlDocPtr doc = NULL;
    xmlNodePtr fake, cur;
    int nsnr = 0;
 
    xmlParserErrors ret = XML_ERR_OK;
 
    /*
     * check all input parameters, grab the document
     */
    if ((lst == NULL) || (node == NULL) || (data == NULL) || (datalen < 0))
        return(XML_ERR_INTERNAL_ERROR);
    switch (node->type) {
        case XML_ELEMENT_NODE:
        case XML_ATTRIBUTE_NODE:
        case XML_TEXT_NODE:
        case XML_CDATA_SECTION_NODE:
        case XML_ENTITY_REF_NODE:
        case XML_PI_NODE:
        case XML_COMMENT_NODE:
        case XML_DOCUMENT_NODE:
        case XML_HTML_DOCUMENT_NODE:
        break;
    default:
        return(XML_ERR_INTERNAL_ERROR);
 
    }
    while ((node != NULL) && (node->type != XML_ELEMENT_NODE) &&
           (node->type != XML_DOCUMENT_NODE) &&
       (node->type != XML_HTML_DOCUMENT_NODE))
    node = node->parent;
    if (node == NULL)
    return(XML_ERR_INTERNAL_ERROR);
    if (node->type == XML_ELEMENT_NODE)
    doc = node->doc;
    else
        doc = (xmlDocPtr) node;
    if (doc == NULL)
    return(XML_ERR_INTERNAL_ERROR);
 
    /*
     * allocate a context and set-up everything not related to the
     * node position in the tree
     */
    if (doc->type == XML_DOCUMENT_NODE)
    ctxt = xmlCreateMemoryParserCtxt((char *) data, datalen);
#ifdef LIBXML_HTML_ENABLED
    else if (doc->type == XML_HTML_DOCUMENT_NODE) {
    ctxt = htmlCreateMemoryParserCtxt((char *) data, datalen);
        /*
         * When parsing in context, it makes no sense to add implied
         * elements like html/body/etc...
         */
        options |= HTML_PARSE_NOIMPLIED;
    }
#endif
    else
        return(XML_ERR_INTERNAL_ERROR);
 
    if (ctxt == NULL)
        return(XML_ERR_NO_MEMORY);
 
    /*
     * Use input doc's dict if present, else assure XML_PARSE_NODICT is set.
     * We need a dictionary for xmlDetectSAX2, so if there's no doc dict
     * we must wait until the last moment to free the original one.
     */
    if (doc->dict != NULL) {
        if (ctxt->dict != NULL)
        xmlDictFree(ctxt->dict);
    ctxt->dict = doc->dict;
    } else
        options |= XML_PARSE_NODICT;
 
    if (doc->encoding != NULL) {
        xmlCharEncodingHandlerPtr hdlr;
 
        hdlr = xmlFindCharEncodingHandler((const char *) doc->encoding);
        if (hdlr != NULL) {
            xmlSwitchToEncoding(ctxt, hdlr);
    } else {
            return(XML_ERR_UNSUPPORTED_ENCODING);
        }
    }
 
    xmlCtxtUseOptionsInternal(ctxt, options);
    xmlDetectSAX2(ctxt);
    ctxt->myDoc = doc;
    /* parsing in context, i.e. as within existing content */
    ctxt->input_id = 2;
    ctxt->instate = XML_PARSER_CONTENT;
 
    fake = xmlNewDocComment(node->doc, NULL);
    if (fake == NULL) {
        xmlFreeParserCtxt(ctxt);
    return(XML_ERR_NO_MEMORY);
    }
    xmlAddChild(node, fake);
 
    if (node->type == XML_ELEMENT_NODE)
    nodePush(ctxt, node);
 
    if ((ctxt->html == 0) && (node->type == XML_ELEMENT_NODE)) {
    /*
     * initialize the SAX2 namespaces stack
     */
    cur = node;
    while ((cur != NULL) && (cur->type == XML_ELEMENT_NODE)) {
        xmlNsPtr ns = cur->nsDef;
            xmlHashedString hprefix, huri;
 
        while (ns != NULL) {
                hprefix = xmlDictLookupHashed(ctxt->dict, ns->prefix, -1);
                huri = xmlDictLookupHashed(ctxt->dict, ns->href, -1);
                if (xmlParserNsPush(ctxt, &hprefix, &huri, ns, 1) > 0)
                    nsnr++;
        ns = ns->next;
        }
        cur = cur->parent;
    }
    }
 
    if ((ctxt->validate) || (ctxt->replaceEntities != 0)) {
    /*
     * ID/IDREF registration will be done in xmlValidateElement below
     */
    ctxt->loadsubset |= XML_SKIP_IDS;
    }
 
#ifdef LIBXML_HTML_ENABLED
    if (doc->type == XML_HTML_DOCUMENT_NODE)
        __htmlParseContent(ctxt);
    else
#endif
    xmlParseContent(ctxt);
 
    xmlParserNsPop(ctxt, nsnr);
    if ((RAW == '<') && (NXT(1) == '/')) {
    xmlFatalErr(ctxt, XML_ERR_NOT_WELL_BALANCED, NULL);
    } else if (RAW != 0) {
    xmlFatalErr(ctxt, XML_ERR_EXTRA_CONTENT, NULL);
    }
    if ((ctxt->node != NULL) && (ctxt->node != node)) {
    xmlFatalErr(ctxt, XML_ERR_NOT_WELL_BALANCED, NULL);
    ctxt->wellFormed = 0;
    }
 
    if (!ctxt->wellFormed) {
        if (ctxt->errNo == 0)
        ret = XML_ERR_INTERNAL_ERROR;
    else
        ret = (xmlParserErrors)ctxt->errNo;
    } else {
        ret = XML_ERR_OK;
    }
 
    /*
     * Return the newly created nodeset after unlinking it from
     * the pseudo sibling.
     */
 
    cur = fake->next;
    fake->next = NULL;
    node->last = fake;
 
    if (cur != NULL) {
    cur->prev = NULL;
    }
 
    *lst = cur;
 
    while (cur != NULL) {
    cur->parent = NULL;
    cur = cur->next;
    }
 
    xmlUnlinkNode(fake);
    xmlFreeNode(fake);
 
 
    if (ret != XML_ERR_OK) {
        xmlFreeNodeList(*lst);
    *lst = NULL;
    }
 
    if (doc->dict != NULL)
        ctxt->dict = NULL;
    xmlFreeParserCtxt(ctxt);
 
    return(ret);
}

xmlParserAddNodeInfo()

XMLPUBFUN void xmlParserAddNodeInfo	(	xmlParserCtxtPtr	ctxt,
		const xmlParserNodeInfoPtr	info
	)

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

DEPRECATED: Don't use.

Insert node info record into the sorted sequence

Definition at line 2273 of file parserInternals.c.

{
    unsigned long pos;
 
    if ((ctxt == NULL) || (info == NULL)) return;
 
    /* Find pos and check to see if node is already in the sequence */
    pos = xmlParserFindNodeInfoIndex(&ctxt->node_seq, (xmlNodePtr)
                                     info->node);
 
    if ((pos < ctxt->node_seq.length) &&
        (ctxt->node_seq.buffer != NULL) &&
        (ctxt->node_seq.buffer[pos].node == info->node)) {
        ctxt->node_seq.buffer[pos] = *info;
    }
 
    /* Otherwise, we need to add new node to buffer */
    else {
        if ((ctxt->node_seq.length + 1 > ctxt->node_seq.maximum) ||
        (ctxt->node_seq.buffer == NULL)) {
            xmlParserNodeInfo *tmp_buffer;
            unsigned int byte_size;
 
            if (ctxt->node_seq.maximum == 0)
                ctxt->node_seq.maximum = 2;
            byte_size = (sizeof(*ctxt->node_seq.buffer) *
            (2 * ctxt->node_seq.maximum));
 
            if (ctxt->node_seq.buffer == NULL)
                tmp_buffer = (xmlParserNodeInfo *) xmlMalloc(byte_size);
            else
                tmp_buffer =
                    (xmlParserNodeInfo *) xmlRealloc(ctxt->node_seq.buffer,
                                                     byte_size);
 
            if (tmp_buffer == NULL) {
        xmlErrMemory(ctxt, "failed to allocate buffer\n");
                return;
            }
            ctxt->node_seq.buffer = tmp_buffer;
            ctxt->node_seq.maximum *= 2;
        }
 
        /* If position is not at end, move elements out of the way */
        if (pos != ctxt->node_seq.length) {
            unsigned long i;
 
            for (i = ctxt->node_seq.length; i > pos; i--)
                ctxt->node_seq.buffer[i] = ctxt->node_seq.buffer[i - 1];
        }
 
        /* Copy element and increase length */
        ctxt->node_seq.buffer[pos] = *info;
        ctxt->node_seq.length++;
    }
}

Referenced by xmlParseElementStart().

xmlParserFindNodeInfo()

XMLPUBFUN const xmlParserNodeInfo * xmlParserFindNodeInfo	(	const xmlParserCtxtPtr	ctx,
		const xmlNodePtr	node
	)

xmlParserFindNodeInfo: @ctx: an XML parser context @node: an XML node within the tree

DEPRECATED: Don't use.

Find the parser node info struct for a given node

Returns an xmlParserNodeInfo block pointer or NULL

Definition at line 2166 of file parserInternals.c.

{
    unsigned long pos;
 
    if ((ctx == NULL) || (node == NULL))
        return (NULL);
    /* Find position where node should be at */
    pos = xmlParserFindNodeInfoIndex(&ctx->node_seq, node);
    if (pos < ctx->node_seq.length
        && ctx->node_seq.buffer[pos].node == node)
        return &ctx->node_seq.buffer[pos];
    else
        return NULL;
}

Referenced by xmlParseElementEnd().

xmlParserFindNodeInfoIndex()

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

xmlParserFindNodeInfoIndex: @seq: a node info sequence pointer @node: an XML node pointer

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

Returns a long indicating the position of the record

Definition at line 2232 of file parserInternals.c.

{
    unsigned long upper, lower, middle;
    int found = 0;
 
    if ((seq == NULL) || (node == NULL))
        return ((unsigned long) -1);
 
    /* Do a binary search for the key */
    lower = 1;
    upper = seq->length;
    middle = 0;
    while (lower <= upper && !found) {
        middle = lower + (upper - lower) / 2;
        if (node == seq->buffer[middle - 1].node)
            found = 1;
        else if (node < seq->buffer[middle - 1].node)
            upper = middle - 1;
        else
            lower = middle + 1;
    }
 
    /* Return position */
    if (middle == 0 || seq->buffer[middle - 1].node < node)
        return middle;
    else
        return middle - 1;
}

Referenced by xmlParserAddNodeInfo(), and xmlParserFindNodeInfo().

xmlParserInputGrow()

XML_DEPRECATED XMLPUBFUN int xmlParserInputGrow	(	xmlParserInputPtr	in,
		int	len
	)

xmlParserInputGrow: @in: an XML parser input @len: an indicative size for the lookahead

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

Returns the amount of char read, or -1 in case of error, 0 indicate the end of this entity

Definition at line 567 of file parserInternals.c.

                                                  {
    int ret;
    size_t indx;
 
    if ((in == NULL) || (len < 0)) return(-1);
    if (in->buf == NULL) return(-1);
    if (in->base == NULL) return(-1);
    if (in->cur == NULL) return(-1);
    if (in->buf->buffer == NULL) return(-1);
 
    /* Don't grow memory buffers. */
    if ((in->buf->encoder == NULL) && (in->buf->readcallback == NULL))
        return(0);
 
    indx = in->cur - in->base;
    if (xmlBufUse(in->buf->buffer) > (unsigned int) indx + INPUT_CHUNK) {
        return(0);
    }
    ret = xmlParserInputBufferGrow(in->buf, len);
 
    in->base = xmlBufContent(in->buf->buffer);
    if (in->base == NULL) {
        in->base = BAD_CAST "";
        in->cur = in->base;
        in->end = in->base;
        return(-1);
    }
    in->cur = in->base + indx;
    in->end = xmlBufEnd(in->buf->buffer);
 
    return(ret);
}

xmlParserInputRead()

XML_DEPRECATED XMLPUBFUN int xmlParserInputRead	(	xmlParserInputPtr in	ATTRIBUTE_UNUSED,
		int len	ATTRIBUTE_UNUSED
	)

xmlParserInputRead: @in: an XML parser input @len: an indicative size for the lookahead

DEPRECATED: This function was internal and is deprecated.

Returns -1 as this is an error to use it.

Definition at line 498 of file parserInternals.c.

                                                                                    {
    return(-1);
}

xmlPedanticParserDefault()

XML_DEPRECATED XMLPUBFUN int xmlPedanticParserDefault

(

int

val

)

xmlPedanticParserDefault: @val: int 0 or 1

DEPRECATED: Use the modern options API with XML_PARSE_PEDANTIC.

Set and return the previous value for enabling pedantic warnings.

Returns the last value for 0 for no substitution, 1 for substitution.

Definition at line 2348 of file parserInternals.c.

                                  {
    int old = xmlPedanticParserDefaultValue;
 
    xmlPedanticParserDefaultValue = val;
    return(old);
}

xmlReadDoc()

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

xmlReadDoc: @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

parse an XML in-memory document and build a tree.

Returns the resulting document tree

Definition at line 14786 of file parser.c.

{
    xmlParserCtxtPtr ctxt;
 
    if (cur == NULL)
        return (NULL);
    xmlInitParser();
 
    ctxt = xmlCreateDocParserCtxt(cur);
    if (ctxt == NULL)
        return (NULL);
    return (xmlDoRead(ctxt, URL, encoding, options, 0));
}

xmlReadFd()

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

xmlReadFd: @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

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.

Returns the resulting document tree

Definition at line 14860 of file parser.c.

{
    xmlParserCtxtPtr ctxt;
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (fd < 0)
        return (NULL);
    xmlInitParser();
 
    input = xmlParserInputBufferCreateFd(fd, XML_CHAR_ENCODING_NONE);
    if (input == NULL)
        return (NULL);
    input->closecallback = NULL;
    ctxt = xmlNewParserCtxt();
    if (ctxt == NULL) {
        xmlFreeParserInputBuffer(input);
        return (NULL);
    }
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
        xmlFreeParserInputBuffer(input);
    xmlFreeParserCtxt(ctxt);
        return (NULL);
    }
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 0));
}

xmlReadFile()

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

xmlReadFile: @filename: a file or URL @encoding: the document encoding, or NULL @options: a combination of xmlParserOption

parse an XML file from the filesystem or the network.

Returns the resulting document tree

Definition at line 14811 of file parser.c.

{
    xmlParserCtxtPtr ctxt;
 
    xmlInitParser();
    ctxt = xmlCreateURLParserCtxt(filename, options);
    if (ctxt == NULL)
        return (NULL);
    return (xmlDoRead(ctxt, NULL, encoding, options, 0));
}

xmlReadIO()

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

xmlReadIO: @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

parse an XML document from I/O functions and source and build a tree.

Returns the resulting document tree

Definition at line 14903 of file parser.c.

{
    xmlParserCtxtPtr ctxt;
    xmlParserInputBufferPtr input;
    xmlParserInputPtr stream;
 
    if (ioread == NULL)
        return (NULL);
    xmlInitParser();
 
    input = xmlParserInputBufferCreateIO(ioread, ioclose, ioctx,
                                         XML_CHAR_ENCODING_NONE);
    if (input == NULL) {
        if (ioclose != NULL)
            ioclose(ioctx);
        return (NULL);
    }
    ctxt = xmlNewParserCtxt();
    if (ctxt == NULL) {
        xmlFreeParserInputBuffer(input);
        return (NULL);
    }
    stream = xmlNewIOInputStream(ctxt, input, XML_CHAR_ENCODING_NONE);
    if (stream == NULL) {
        xmlFreeParserInputBuffer(input);
    xmlFreeParserCtxt(ctxt);
        return (NULL);
    }
    inputPush(ctxt, stream);
    return (xmlDoRead(ctxt, URL, encoding, options, 0));
}

xmlReadMemory()

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

xmlReadMemory: @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

parse an XML in-memory document and build a tree.

Returns the resulting document tree

Definition at line 14835 of file parser.c.

{
    xmlParserCtxtPtr ctxt;
 
    xmlInitParser();
    ctxt = xmlCreateMemoryParserCtxt(buffer, size);
    if (ctxt == NULL)
        return (NULL);
    return (xmlDoRead(ctxt, URL, encoding, options, 0));
}

Referenced by parse_xml().

xmlSetExternalEntityLoader()

XMLPUBFUN void xmlSetExternalEntityLoader

(

xmlExternalEntityLoader

f

)

Referenced by schemasCleanup(), and schemasInit().

xmlStopParser()

XMLPUBFUN void xmlStopParser

(

xmlParserCtxtPtr

ctxt

)

xmlStopParser: @ctxt: an XML parser context

Blocks further parser processing

Definition at line 12311 of file parser.c.

                                     {
    if (ctxt == NULL)
        return;
    xmlHaltParser(ctxt);
    ctxt->errNo = XML_ERR_USER_STOP;
}

Referenced by format_error_message_from_id(), libxmlFatalError(), and xmlSwitchEncoding().

xmlSubstituteEntitiesDefault()

XML_DEPRECATED XMLPUBFUN int xmlSubstituteEntitiesDefault

(

int

val

)

xmlSubstituteEntitiesDefault: @val: int 0 or 1

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.

Returns the last value for 0 for no substitution, 1 for substitution.

Definition at line 2392 of file parserInternals.c.

                                      {
    int old = xmlSubstituteEntitiesDefaultValue;
 
    xmlSubstituteEntitiesDefaultValue = val;
    return(old);
}

xmlThrDefDoValidityCheckingDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefDoValidityCheckingDefaultValue

(

int

v

)

Definition at line 1044 of file globals.c.

                                                   {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlDoValidityCheckingDefaultValueThrDef;
    xmlDoValidityCheckingDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefGetWarningsDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefGetWarningsDefaultValue

(

int

v

)

Definition at line 1053 of file globals.c.

                                            {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlGetWarningsDefaultValueThrDef;
    xmlGetWarningsDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefKeepBlanksDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefKeepBlanksDefaultValue

(

int

v

)

Definition at line 1091 of file globals.c.

                                           {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlKeepBlanksDefaultValueThrDef;
    xmlKeepBlanksDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefLineNumbersDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefLineNumbersDefaultValue

(

int

v

)

Definition at line 1100 of file globals.c.

                                            {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlLineNumbersDefaultValueThrDef;
    xmlLineNumbersDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefLoadExtDtdDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefLoadExtDtdDefaultValue

(

int

v

)

Definition at line 1109 of file globals.c.

                                           {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlLoadExtDtdDefaultValueThrDef;
    xmlLoadExtDtdDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefParserDebugEntities()

XML_DEPRECATED XMLPUBFUN int xmlThrDefParserDebugEntities

(

int

v

)

Definition at line 1118 of file globals.c.

                                        {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlParserDebugEntitiesThrDef;
    xmlParserDebugEntitiesThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefPedanticParserDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefPedanticParserDefaultValue

(

int

v

)

Definition at line 1127 of file globals.c.

                                               {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlPedanticParserDefaultValueThrDef;
    xmlPedanticParserDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

xmlThrDefSubstituteEntitiesDefaultValue()

XML_DEPRECATED XMLPUBFUN int xmlThrDefSubstituteEntitiesDefaultValue

(

int

v

)

Definition at line 1136 of file globals.c.

                                                   {
    int ret;
    xmlMutexLock(&xmlThrDefMutex);
    ret = xmlSubstituteEntitiesDefaultValueThrDef;
    xmlSubstituteEntitiesDefaultValueThrDef = v;
    xmlMutexUnlock(&xmlThrDefMutex);
    return ret;
}

Variable Documentation

xmlParserVersion

XMLPUBVAR const char* const xmlParserVersion

Definition at line 845 of file parser.h.