Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

parser.h File Reference

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

Go to the source code of this file.

Classes

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

Defines

#define XML_DEFAULT_VERSION   "1.0"
#define XML_DETECT_IDS   2
#define XML_COMPLETE_ATTRS   4
#define XML_SKIP_IDS   8
#define XML_SAX2_MAGIC   0xDEEDBEAF

Typedefs

typedef void(* xmlParserInputDeallocate )(xmlChar *str)
typedef _xmlParserNodeInfo xmlParserNodeInfo
typedef xmlParserNodeInfoxmlParserNodeInfoPtr
typedef _xmlParserNodeInfoSeq xmlParserNodeInfoSeq
typedef xmlParserNodeInfoSeqxmlParserNodeInfoSeqPtr
typedef xmlParserInputPtr(* resolveEntitySAXFunc )(void *ctx, const xmlChar *publicId, const xmlChar *systemId)
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)
typedef xmlEntityPtr(* getEntitySAXFunc )(void *ctx, const xmlChar *name)
typedef xmlEntityPtr(* getParameterEntitySAXFunc )(void *ctx, const xmlChar *name)
typedef void(* entityDeclSAXFunc )(void *ctx, const xmlChar *name, int type, const xmlChar *publicId, const xmlChar *systemId, xmlChar *content)
typedef void(* 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)
typedef void(* elementDeclSAXFunc )(void *ctx, const xmlChar *name, int type, xmlElementContentPtr content)
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)
typedef void(* startElementSAXFunc )(void *ctx, const xmlChar *name, const xmlChar **atts)
typedef void(* endElementSAXFunc )(void *ctx, const xmlChar *name)
typedef void(* attributeSAXFunc )(void *ctx, const xmlChar *name, const xmlChar *value)
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,...)
typedef void(* errorSAXFunc )(void *ctx, const char *msg,...)
typedef void(* fatalErrorSAXFunc )(void *ctx, const char *msg,...)
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 _xmlSAXHandlerV1 xmlSAXHandlerV1
typedef xmlSAXHandlerV1xmlSAXHandlerV1Ptr
typedef xmlParserInputPtr(* xmlExternalEntityLoader )(const char *URL, const char *ID, xmlParserCtxtPtr context)

Enumerations

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

Functions

XMLPUBFUN void XMLCALL xmlInitParser (void)
XMLPUBFUN void XMLCALL xmlCleanupParser (void)
XMLPUBFUN int XMLCALL xmlParserInputRead (xmlParserInputPtr in, int len)
XMLPUBFUN int XMLCALL xmlParserInputGrow (xmlParserInputPtr in, int len)
XMLPUBFUN xmlChar *XMLCALL xmlStrdup (const xmlChar *cur)
XMLPUBFUN xmlChar *XMLCALL xmlStrndup (const xmlChar *cur, int len)
XMLPUBFUN xmlChar *XMLCALL xmlCharStrndup (const char *cur, int len)
XMLPUBFUN xmlChar *XMLCALL xmlCharStrdup (const char *cur)
XMLPUBFUN xmlChar *XMLCALL xmlStrsub (const xmlChar *str, int start, int len)
XMLPUBFUN const xmlChar *XMLCALL xmlStrchr (const xmlChar *str, xmlChar val)
XMLPUBFUN const xmlChar *XMLCALL xmlStrstr (const xmlChar *str, const xmlChar *val)
XMLPUBFUN const xmlChar *XMLCALL xmlStrcasestr (const xmlChar *str, xmlChar *val)
XMLPUBFUN int XMLCALL xmlStrcmp (const xmlChar *str1, const xmlChar *str2)
XMLPUBFUN int XMLCALL xmlStrncmp (const xmlChar *str1, const xmlChar *str2, int len)
XMLPUBFUN int XMLCALL xmlStrcasecmp (const xmlChar *str1, const xmlChar *str2)
XMLPUBFUN int XMLCALL xmlStrncasecmp (const xmlChar *str1, const xmlChar *str2, int len)
XMLPUBFUN int XMLCALL xmlStrEqual (const xmlChar *str1, const xmlChar *str2)
XMLPUBFUN int XMLCALL xmlStrQEqual (const xmlChar *pref, const xmlChar *name, const xmlChar *str)
XMLPUBFUN int XMLCALL xmlStrlen (const xmlChar *str)
XMLPUBFUN xmlChar *XMLCALL xmlStrcat (xmlChar *cur, const xmlChar *add)
XMLPUBFUN xmlChar *XMLCALL xmlStrncat (xmlChar *cur, const xmlChar *add, int len)
XMLPUBFUN int XMLCALL xmlStrPrintf (xmlChar *buf, int len, const xmlChar *msg,...)
XMLPUBFUN int XMLCALL xmlStrVPrintf (xmlChar *buf, int len, const xmlChar *msg, va_list ap)
XMLPUBFUN xmlDocPtr XMLCALL xmlParseDoc (xmlChar *cur)
XMLPUBFUN xmlDocPtr XMLCALL xmlParseMemory (const char *buffer, int size)
XMLPUBFUN xmlDocPtr XMLCALL xmlParseFile (const char *filename)
XMLPUBFUN int XMLCALL xmlSubstituteEntitiesDefault (int val)
XMLPUBFUN int XMLCALL xmlKeepBlanksDefault (int val)
XMLPUBFUN void XMLCALL xmlStopParser (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL xmlPedanticParserDefault (int val)
XMLPUBFUN int XMLCALL xmlLineNumbersDefault (int val)
XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverDoc (xmlChar *cur)
XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverMemory (const char *buffer, int size)
XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverFile (const char *filename)
XMLPUBFUN int XMLCALL xmlParseDocument (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL xmlParseExtParsedEnt (xmlParserCtxtPtr ctxt)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseDoc (xmlSAXHandlerPtr sax, xmlChar *cur, int recovery)
XMLPUBFUN int XMLCALL xmlSAXUserParseFile (xmlSAXHandlerPtr sax, void *user_data, const char *filename)
XMLPUBFUN int XMLCALL xmlSAXUserParseMemory (xmlSAXHandlerPtr sax, void *user_data, const char *buffer, int size)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseMemory (xmlSAXHandlerPtr sax, const char *buffer, int size, int recovery)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseMemoryWithData (xmlSAXHandlerPtr sax, const char *buffer, int size, int recovery, void *data)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseFile (xmlSAXHandlerPtr sax, const char *filename, int recovery)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseFileWithData (xmlSAXHandlerPtr sax, const char *filename, int recovery, void *data)
XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseEntity (xmlSAXHandlerPtr sax, const char *filename)
XMLPUBFUN xmlDocPtr XMLCALL xmlParseEntity (const char *filename)
XMLPUBFUN xmlDtdPtr XMLCALL xmlParseDTD (const xmlChar *ExternalID, const xmlChar *SystemID)
XMLPUBFUN xmlDtdPtr XMLCALL xmlSAXParseDTD (xmlSAXHandlerPtr sax, const xmlChar *ExternalID, const xmlChar *SystemID)
XMLPUBFUN xmlDtdPtr XMLCALL xmlIOParseDTD (xmlSAXHandlerPtr sax, xmlParserInputBufferPtr input, xmlCharEncoding enc)
XMLPUBFUN int XMLCALL xmlParseBalancedChunkMemory (xmlDocPtr doc, xmlSAXHandlerPtr sax, void *user_data, int depth, const xmlChar *string, xmlNodePtr *lst)
XMLPUBFUN int XMLCALL xmlParseBalancedChunkMemoryRecover (xmlDocPtr doc, xmlSAXHandlerPtr sax, void *user_data, int depth, const xmlChar *string, xmlNodePtr *lst, int recover)
XMLPUBFUN int XMLCALL xmlParseExternalEntity (xmlDocPtr doc, xmlSAXHandlerPtr sax, void *user_data, int depth, const xmlChar *URL, const xmlChar *ID, xmlNodePtr *lst)
XMLPUBFUN int XMLCALL xmlParseCtxtExternalEntity (xmlParserCtxtPtr ctx, const xmlChar *URL, const xmlChar *ID, xmlNodePtr *lst)
XMLPUBFUN xmlParserCtxtPtr
XMLCALL 
xmlNewParserCtxt (void)
XMLPUBFUN int XMLCALL xmlInitParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN void XMLCALL xmlClearParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN void XMLCALL xmlFreeParserCtxt (xmlParserCtxtPtr ctxt)
XMLPUBFUN void XMLCALL xmlSetupParserForBuffer (xmlParserCtxtPtr ctxt, const xmlChar *buffer, const char *filename)
XMLPUBFUN xmlParserCtxtPtr
XMLCALL 
xmlCreateDocParserCtxt (const xmlChar *cur)
XMLPUBFUN int XMLCALL xmlGetFeaturesList (int *len, const char **result)
XMLPUBFUN int XMLCALL xmlGetFeature (xmlParserCtxtPtr ctxt, const char *name, void *result)
XMLPUBFUN int XMLCALL xmlSetFeature (xmlParserCtxtPtr ctxt, const char *name, void *value)
XMLPUBFUN xmlParserCtxtPtr
XMLCALL 
xmlCreateIOParserCtxt (xmlSAXHandlerPtr sax, void *user_data, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, xmlCharEncoding enc)
XMLPUBFUN xmlParserInputPtr
XMLCALL 
xmlNewIOInputStream (xmlParserCtxtPtr ctxt, xmlParserInputBufferPtr input, xmlCharEncoding enc)
XMLPUBFUN const xmlParserNodeInfo
*XMLCALL 
xmlParserFindNodeInfo (const xmlParserCtxtPtr ctxt, const xmlNodePtr node)
XMLPUBFUN void XMLCALL xmlInitNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN void XMLCALL xmlClearNodeInfoSeq (xmlParserNodeInfoSeqPtr seq)
XMLPUBFUN unsigned long XMLCALL xmlParserFindNodeInfoIndex (const xmlParserNodeInfoSeqPtr seq, const xmlNodePtr node)
XMLPUBFUN void XMLCALL xmlParserAddNodeInfo (xmlParserCtxtPtr ctxt, const xmlParserNodeInfoPtr info)
XMLPUBFUN void XMLCALL xmlSetExternalEntityLoader (xmlExternalEntityLoader f)
XMLPUBFUN xmlExternalEntityLoader
XMLCALL 
xmlGetExternalEntityLoader (void)
XMLPUBFUN xmlParserInputPtr
XMLCALL 
xmlLoadExternalEntity (const char *URL, const char *ID, xmlParserCtxtPtr ctxt)
XMLPUBFUN void XMLCALL xmlCtxtReset (xmlParserCtxtPtr ctxt)
XMLPUBFUN int XMLCALL xmlCtxtResetPush (xmlParserCtxtPtr ctxt, const char *chunk, int size, const char *filename, const char *encoding)
XMLPUBFUN int XMLCALL xmlCtxtUseOptions (xmlParserCtxtPtr ctxt, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlReadDoc (const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlReadFile (const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlReadMemory (const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlReadFd (int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlReadIO (xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadDoc (xmlParserCtxtPtr ctxt, const xmlChar *cur, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadFile (xmlParserCtxtPtr ctxt, const char *filename, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadMemory (xmlParserCtxtPtr ctxt, const char *buffer, int size, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadFd (xmlParserCtxtPtr ctxt, int fd, const char *URL, const char *encoding, int options)
XMLPUBFUN xmlDocPtr XMLCALL xmlCtxtReadIO (xmlParserCtxtPtr ctxt, xmlInputReadCallback ioread, xmlInputCloseCallback ioclose, void *ioctx, const char *URL, const char *encoding, int options)


Define Documentation

#define XML_COMPLETE_ATTRS   4
 

XML_COMPLETE_ATTRS:

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

#define XML_DEFAULT_VERSION   "1.0"
 

XML_DEFAULT_VERSION:

The default version of XML used: 1.0

#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.

#define XML_SAX2_MAGIC   0xDEEDBEAF
 

XML_SAX2_MAGIC:

Special constant found in SAX2 blocks initialized fields

#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.


Typedef Documentation

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

attributeDeclSAXFunc: : the user data (XML parser context) : the name of the element : the attribute name : the attribute type : the type of default value : the attribute default value : the tree of enumerated value set

An attribute definition has been parsed.

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

attributeSAXFunc: : the user data (XML parser context) : The attribute name, including namespace prefix : 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(* cdataBlockSAXFunc)(void *ctx, const xmlChar *value, int len)
 

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

Called when a pcdata block has been parsed.

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

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

Receiving some chars from the parser.

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

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

A comment has been parsed.

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

elementDeclSAXFunc: : the user data (XML parser context) : the element name : the element type : the element value tree

An element definition has been parsed.

typedef void(* endDocumentSAXFunc)(void *ctx)
 

endDocumentSAXFunc: : the user data (XML parser context)

Called when the document end has been detected.

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

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

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

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

endElementSAXFunc: : the user data (XML parser context) : The element name

Called when the end of an element has been detected.

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

entityDeclSAXFunc: : the user data (XML parser context) : the entity name : the entity type : The public ID of the entity : The system ID of the entity : the entity value (without processing).

An entity definition has been parsed.

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

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

Display and format an error messages, callback.

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

externalSubsetSAXFunc: : the user data (XML parser context) : the root element name : the external ID : the SYSTEM ID (e.g. filename or URL)

Callback on external subset declaration.

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

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

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

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

getEntitySAXFunc: : the user data (XML parser context) : The entity name

Get an entity by name.

Returns the xmlEntityPtr if found.

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

getParameterEntitySAXFunc: : the user data (XML parser context) : The entity name

Get a parameter entity by name.

Returns the xmlEntityPtr if found.

typedef int(* hasExternalSubsetSAXFunc)(void *ctx)
 

hasExternalSubsetSAXFunc: : the user data (XML parser context)

Does this document has an external subset?

Returns 1 if true

typedef int(* hasInternalSubsetSAXFunc)(void *ctx)
 

hasInternalSubsetSAXFunc: : the user data (XML parser context)

Does this document has an internal subset.

Returns 1 if true

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

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

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

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

internalSubsetSAXFunc: : the user data (XML parser context) : the root element name : the external ID : the SYSTEM ID (e.g. filename or URL)

Callback on internal subset declaration.

typedef int(* isStandaloneSAXFunc)(void *ctx)
 

isStandaloneSAXFunc: : the user data (XML parser context)

Is this document tagged standalone?

Returns 1 if true

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

notationDeclSAXFunc: : the user data (XML parser context) : The name of the notation : The public ID of the entity : The system ID of the entity

What to do when a notation declaration has been parsed.

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

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

A processing instruction has been parsed.

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

referenceSAXFunc: : the user data (XML parser context) : The entity name

Called when an entity reference is detected.

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

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

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

Returns the xmlParserInputPtr if inlined or NULL for DOM behaviour.

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

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

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

typedef void(* startDocumentSAXFunc)(void *ctx)
 

startDocumentSAXFunc: : the user data (XML parser context)

Called when the document start being processed.

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

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

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

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

startElementSAXFunc: : the user data (XML parser context) : The element name, including namespace prefix : An array of name/value attributes pairs, NULL terminated

Called when an opening tag has been processed.

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

unparsedEntityDeclSAXFunc: : the user data (XML parser context) : The name of the entity : The public ID of the entity : The system ID of the entity : the name of the notation

What to do when an unparsed entity declaration is parsed.

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

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

Display and format a warning messages, callback.

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

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

External entity loaders types.

Returns the entity input parser.

typedef void(* xmlParserInputDeallocate)(xmlChar *str)
 

xmlParserInputDeallocate: : the string to deallocate

Callback for freeing some parser input allocations.

typedef struct _xmlParserNodeInfo xmlParserNodeInfo
 

xmlParserNodeInfo:

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

typedef xmlParserNodeInfo* xmlParserNodeInfoPtr
 

typedef struct _xmlParserNodeInfoSeq xmlParserNodeInfoSeq
 

typedef xmlParserNodeInfoSeq* xmlParserNodeInfoSeqPtr
 

typedef struct _xmlSAXHandlerV1 xmlSAXHandlerV1
 

typedef xmlSAXHandlerV1* xmlSAXHandlerV1Ptr
 


Enumeration Type Documentation

enum xmlParserInputState
 

xmlParserInputState:

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

Enumeration values:
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 

enum xmlParserOption
 

xmlParserOption:

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

Enumeration values:
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 


Function Documentation

XMLPUBFUN xmlChar* XMLCALL xmlCharStrdup const char *  cur  ) 
 

XMLPUBFUN xmlChar* XMLCALL xmlCharStrndup const char *  cur,
int  len
 

XMLPUBFUN void XMLCALL xmlCleanupParser void   ) 
 

XMLPUBFUN void XMLCALL xmlClearNodeInfoSeq xmlParserNodeInfoSeqPtr  seq  ) 
 

XMLPUBFUN void XMLCALL xmlClearParserCtxt xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN xmlParserCtxtPtr XMLCALL xmlCreateDocParserCtxt const xmlChar cur  ) 
 

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

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

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

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

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

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

XMLPUBFUN void XMLCALL xmlCtxtReset xmlParserCtxtPtr  ctxt  ) 
 

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

XMLPUBFUN int XMLCALL xmlCtxtUseOptions xmlParserCtxtPtr  ctxt,
int  options
 

XMLPUBFUN void XMLCALL xmlFreeParserCtxt xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN xmlExternalEntityLoader XMLCALL xmlGetExternalEntityLoader void   ) 
 

XMLPUBFUN int XMLCALL xmlGetFeature xmlParserCtxtPtr  ctxt,
const char *  name,
void *  result
 

XMLPUBFUN int XMLCALL xmlGetFeaturesList int *  len,
const char **  result
 

XMLPUBFUN void XMLCALL xmlInitNodeInfoSeq xmlParserNodeInfoSeqPtr  seq  ) 
 

XMLPUBFUN void XMLCALL xmlInitParser void   ) 
 

XMLPUBFUN int XMLCALL xmlInitParserCtxt xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN xmlDtdPtr XMLCALL xmlIOParseDTD xmlSAXHandlerPtr  sax,
xmlParserInputBufferPtr  input,
xmlCharEncoding  enc
 

XMLPUBFUN int XMLCALL xmlKeepBlanksDefault int  val  ) 
 

XMLPUBFUN int XMLCALL xmlLineNumbersDefault int  val  ) 
 

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

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

XMLPUBFUN xmlParserCtxtPtr XMLCALL xmlNewParserCtxt void   ) 
 

XMLPUBFUN int XMLCALL xmlParseBalancedChunkMemory xmlDocPtr  doc,
xmlSAXHandlerPtr  sax,
void *  user_data,
int  depth,
const xmlChar string,
xmlNodePtr lst
 

XMLPUBFUN int XMLCALL xmlParseBalancedChunkMemoryRecover xmlDocPtr  doc,
xmlSAXHandlerPtr  sax,
void *  user_data,
int  depth,
const xmlChar string,
xmlNodePtr lst,
int  recover
 

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

XMLPUBFUN xmlDocPtr XMLCALL xmlParseDoc xmlChar cur  ) 
 

XMLPUBFUN int XMLCALL xmlParseDocument xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN xmlDtdPtr XMLCALL xmlParseDTD const xmlChar ExternalID,
const xmlChar SystemID
 

XMLPUBFUN xmlDocPtr XMLCALL xmlParseEntity const char *  filename  ) 
 

XMLPUBFUN int XMLCALL xmlParseExternalEntity xmlDocPtr  doc,
xmlSAXHandlerPtr  sax,
void *  user_data,
int  depth,
const xmlChar URL,
const xmlChar ID,
xmlNodePtr lst
 

XMLPUBFUN int XMLCALL xmlParseExtParsedEnt xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN xmlDocPtr XMLCALL xmlParseFile const char *  filename  ) 
 

XMLPUBFUN xmlDocPtr XMLCALL xmlParseMemory const char *  buffer,
int  size
 

XMLPUBFUN void XMLCALL xmlParserAddNodeInfo xmlParserCtxtPtr  ctxt,
const xmlParserNodeInfoPtr  info
 

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

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

XMLPUBFUN int XMLCALL xmlParserInputGrow xmlParserInputPtr  in,
int  len
 

XMLPUBFUN int XMLCALL xmlParserInputRead xmlParserInputPtr  in,
int  len
 

XMLPUBFUN int XMLCALL xmlPedanticParserDefault int  val  ) 
 

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

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

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

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

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

XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverDoc xmlChar cur  ) 
 

XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverFile const char *  filename  ) 
 

XMLPUBFUN xmlDocPtr XMLCALL xmlRecoverMemory const char *  buffer,
int  size
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseDoc xmlSAXHandlerPtr  sax,
xmlChar cur,
int  recovery
 

XMLPUBFUN xmlDtdPtr XMLCALL xmlSAXParseDTD xmlSAXHandlerPtr  sax,
const xmlChar ExternalID,
const xmlChar SystemID
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseEntity xmlSAXHandlerPtr  sax,
const char *  filename
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseFile xmlSAXHandlerPtr  sax,
const char *  filename,
int  recovery
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseFileWithData xmlSAXHandlerPtr  sax,
const char *  filename,
int  recovery,
void *  data
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseMemory xmlSAXHandlerPtr  sax,
const char *  buffer,
int  size,
int  recovery
 

XMLPUBFUN xmlDocPtr XMLCALL xmlSAXParseMemoryWithData xmlSAXHandlerPtr  sax,
const char *  buffer,
int  size,
int  recovery,
void *  data
 

XMLPUBFUN int XMLCALL xmlSAXUserParseFile xmlSAXHandlerPtr  sax,
void *  user_data,
const char *  filename
 

XMLPUBFUN int XMLCALL xmlSAXUserParseMemory xmlSAXHandlerPtr  sax,
void *  user_data,
const char *  buffer,
int  size
 

XMLPUBFUN void XMLCALL xmlSetExternalEntityLoader xmlExternalEntityLoader  f  ) 
 

XMLPUBFUN int XMLCALL xmlSetFeature xmlParserCtxtPtr  ctxt,
const char *  name,
void *  value
 

XMLPUBFUN void XMLCALL xmlSetupParserForBuffer xmlParserCtxtPtr  ctxt,
const xmlChar buffer,
const char *  filename
 

XMLPUBFUN void XMLCALL xmlStopParser xmlParserCtxtPtr  ctxt  ) 
 

XMLPUBFUN int XMLCALL xmlStrcasecmp const xmlChar str1,
const xmlChar str2
 

XMLPUBFUN const xmlChar* XMLCALL xmlStrcasestr const xmlChar str,
xmlChar val
 

XMLPUBFUN xmlChar* XMLCALL xmlStrcat xmlChar cur,
const xmlChar add
 

XMLPUBFUN const xmlChar* XMLCALL xmlStrchr const xmlChar str,
xmlChar  val
 

XMLPUBFUN int XMLCALL xmlStrcmp const xmlChar str1,
const xmlChar str2
 

XMLPUBFUN xmlChar* XMLCALL xmlStrdup const xmlChar cur  ) 
 

XMLPUBFUN int XMLCALL xmlStrEqual const xmlChar str1,
const xmlChar str2
 

XMLPUBFUN int XMLCALL xmlStrlen const xmlChar str  ) 
 

XMLPUBFUN int XMLCALL xmlStrncasecmp const xmlChar str1,
const xmlChar str2,
int  len
 

XMLPUBFUN xmlChar* XMLCALL xmlStrncat xmlChar cur,
const xmlChar add,
int  len
 

XMLPUBFUN int XMLCALL xmlStrncmp const xmlChar str1,
const xmlChar str2,
int  len
 

XMLPUBFUN xmlChar* XMLCALL xmlStrndup const xmlChar cur,
int  len
 

XMLPUBFUN int XMLCALL xmlStrPrintf xmlChar buf,
int  len,
const xmlChar msg,
  ...
 

XMLPUBFUN int XMLCALL xmlStrQEqual const xmlChar pref,
const xmlChar name,
const xmlChar str
 

XMLPUBFUN const xmlChar* XMLCALL xmlStrstr const xmlChar str,
const xmlChar val
 

XMLPUBFUN xmlChar* XMLCALL xmlStrsub const xmlChar str,
int  start,
int  len
 

XMLPUBFUN int XMLCALL xmlStrVPrintf xmlChar buf,
int  len,
const xmlChar msg,
va_list  ap
 

XMLPUBFUN int XMLCALL xmlSubstituteEntitiesDefault int  val  ) 
 


Generated on Wed Mar 16 00:10:30 2005 for Dibbler - a portable DHCPv6 by  doxygen 1.3.9.1