Module tree from libxml2

Module tree from libxml2

API Menu

API Indexes

Related links

this module describes the structures found in an tree resulting from an XML or HTML parsing, as well as the API provided for various processing on that tree

#define BASE_BUFFER_SIZE

#define XML_GET_CONTENT

#define XML_GET_LINE

#define XML_LOCAL_NAMESPACE

#define XML_XML_ID

#define XML_XML_NAMESPACE

#define xmlChildrenNode

#define xmlRootNode

Structure xmlAttr
struct _xmlAttr

Typedef xmlAttr * xmlAttrPtr

Structure xmlAttribute
struct _xmlAttribute

Enum xmlAttributeDefault

Typedef xmlAttribute * xmlAttributePtr

Enum xmlAttributeType

Structure xmlBuffer
struct _xmlBuffer

Enum xmlBufferAllocationScheme

Typedef xmlBuffer * xmlBufferPtr

Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt

Typedef xmlDOMWrapCtxt * xmlDOMWrapCtxtPtr

Structure xmlDoc
struct _xmlDoc

Enum xmlDocProperties

Typedef xmlDoc * xmlDocPtr

Structure xmlDtd
struct _xmlDtd

Typedef xmlDtd * xmlDtdPtr

Structure xmlElement
struct _xmlElement

Structure xmlElementContent
struct _xmlElementContent

Enum xmlElementContentOccur

Typedef xmlElementContent * xmlElementContentPtr

Enum xmlElementContentType

Typedef xmlElement * xmlElementPtr

Enum xmlElementType

Enum xmlElementTypeVal

Structure xmlEntity
struct _xmlEntity

Typedef xmlEntity * xmlEntityPtr

Structure xmlEnumeration
struct _xmlEnumeration

Typedef xmlEnumeration * xmlEnumerationPtr

Structure xmlID
struct _xmlID

Typedef xmlID * xmlIDPtr

Structure xmlNode
struct _xmlNode

Typedef xmlNode * xmlNodePtr

Structure xmlNotation
struct _xmlNotation

Typedef xmlNotation * xmlNotationPtr

Structure xmlNs
struct _xmlNs

Typedef xmlNs * xmlNsPtr

Typedef xmlElementType xmlNsType

Structure xmlOutputBuffer
struct _xmlOutputBuffer

Typedef xmlOutputBuffer * xmlOutputBufferPtr

Structure xmlParserCtxt
struct _xmlParserCtxt

Typedef xmlParserCtxt * xmlParserCtxtPtr

Structure xmlParserInput
struct _xmlParserInput

Structure xmlParserInputBuffer
struct _xmlParserInputBuffer

Typedef xmlParserInputBuffer * xmlParserInputBufferPtr

Typedef xmlParserInput * xmlParserInputPtr

Structure xmlRef
struct _xmlRef

Typedef xmlRef * xmlRefPtr

Structure xmlSAXHandler
struct _xmlSAXHandler

Typedef xmlSAXHandler * xmlSAXHandlerPtr

Structure xmlSAXLocator
struct _xmlSAXLocator

Typedef xmlSAXLocator * xmlSAXLocatorPtr

xmlNodePtr	xmlAddChild		(xmlNodePtr parent, 
					 xmlNodePtr cur)

xmlNodePtr	xmlAddChildList		(xmlNodePtr parent, 
					 xmlNodePtr cur)

xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
					 xmlNodePtr elem)

xmlNodePtr	xmlAddPrevSibling	(xmlNodePtr cur, 
					 xmlNodePtr elem)

xmlNodePtr	xmlAddSibling		(xmlNodePtr cur, 
					 xmlNodePtr elem)

void	xmlAttrSerializeTxtContent	(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlAttrPtr attr, 
					 const xmlChar * string)

int	xmlBufferAdd			(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

int	xmlBufferAddHead		(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

int	xmlBufferCCat			(xmlBufferPtr buf, 
					 const char * str)

int	xmlBufferCat			(xmlBufferPtr buf, 
					 const xmlChar * str)

const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

xmlBufferPtr	xmlBufferCreate		(void)

xmlBufferPtr	xmlBufferCreateSize	(size_t size)

xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
					 size_t size)

int	xmlBufferDump			(FILE * file, 
					 xmlBufferPtr buf)

void	xmlBufferEmpty			(xmlBufferPtr buf)

void	xmlBufferFree			(xmlBufferPtr buf)

int	xmlBufferGrow			(xmlBufferPtr buf, 
					 unsigned int len)

int	xmlBufferLength			(const xmlBufferPtr buf)

int	xmlBufferResize			(xmlBufferPtr buf, 
					 unsigned int size)

void	xmlBufferSetAllocationScheme	(xmlBufferPtr buf, 
					 xmlBufferAllocationScheme scheme)

int	xmlBufferShrink			(xmlBufferPtr buf, 
					 unsigned int len)

void	xmlBufferWriteCHAR		(xmlBufferPtr buf, 
					 const xmlChar * string)

void	xmlBufferWriteChar		(xmlBufferPtr buf, 
					 const char * string)

void	xmlBufferWriteQuotedString	(xmlBufferPtr buf, 
					 const xmlChar * string)

xmlChar *	xmlBuildQName		(const xmlChar * ncname, 
					 const xmlChar * prefix, 
					 xmlChar * memory, 
					 int len)

unsigned long	xmlChildElementCount	(xmlNodePtr parent)

xmlDocPtr	xmlCopyDoc		(xmlDocPtr doc, 
					 int recursive)

xmlDtdPtr	xmlCopyDtd		(xmlDtdPtr dtd)

xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur)

xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur)

xmlNodePtr	xmlCopyNode		(const xmlNodePtr node, 
					 int extended)

xmlNodePtr	xmlCopyNodeList		(const xmlNodePtr node)

xmlAttrPtr	xmlCopyProp		(xmlNodePtr target, 
					 xmlAttrPtr cur)

xmlAttrPtr	xmlCopyPropList		(xmlNodePtr target, 
					 xmlAttrPtr cur)

xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
					 const xmlChar * name, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID)

Function type: xmlDOMWrapAcquireNsFunction
xmlNsPtr	xmlDOMWrapAcquireNsFunction	(xmlDOMWrapCtxtPtr ctxt, 
						 xmlNodePtr node, 
						 const xmlChar * nsName, 
						 const xmlChar * nsPrefix)

int	xmlDOMWrapAdoptNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr sourceDoc, 
					 xmlNodePtr node, 
					 xmlDocPtr destDoc, 
					 xmlNodePtr destParent, 
					 int options)

int	xmlDOMWrapCloneNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr sourceDoc, 
					 xmlNodePtr node, 
					 xmlNodePtr * resNode, 
					 xmlDocPtr destDoc, 
					 xmlNodePtr destParent, 
					 int deep, 
					 int options)

void	xmlDOMWrapFreeCtxt		(xmlDOMWrapCtxtPtr ctxt)

xmlDOMWrapCtxtPtr	xmlDOMWrapNewCtxt	(void)

int	xmlDOMWrapReconcileNamespaces	(xmlDOMWrapCtxtPtr ctxt, 
					 xmlNodePtr elem, 
					 int options)

int	xmlDOMWrapRemoveNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr doc, 
					 xmlNodePtr node, 
					 int options)

xmlNodePtr	xmlDocCopyNode		(const xmlNodePtr node, 
					 xmlDocPtr doc, 
					 int extended)

xmlNodePtr	xmlDocCopyNodeList	(xmlDocPtr doc, 
					 const xmlNodePtr node)

int	xmlDocDump			(FILE * f, 
					 xmlDocPtr cur)

void	xmlDocDumpFormatMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size, 
					 int format)

void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
					 xmlChar ** doc_txt_ptr, 
					 int * doc_txt_len, 
					 const char * txt_encoding, 
					 int format)

void	xmlDocDumpMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size)

void	xmlDocDumpMemoryEnc		(xmlDocPtr out_doc, 
					 xmlChar ** doc_txt_ptr, 
					 int * doc_txt_len, 
					 const char * txt_encoding)

int	xmlDocFormatDump		(FILE * f, 
					 xmlDocPtr cur, 
					 int format)

xmlNodePtr	xmlDocGetRootElement	(xmlDocPtr doc)

xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
					 xmlNodePtr root)

void	xmlElemDump			(FILE * f, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur)

xmlNodePtr	xmlFirstElementChild	(xmlNodePtr parent)

void	xmlFreeDoc			(xmlDocPtr cur)

void	xmlFreeDtd			(xmlDtdPtr cur)

void	xmlFreeNode			(xmlNodePtr cur)

void	xmlFreeNodeList			(xmlNodePtr cur)

void	xmlFreeNs			(xmlNsPtr cur)

void	xmlFreeNsList			(xmlNsPtr cur)

void	xmlFreeProp			(xmlAttrPtr cur)

void	xmlFreePropList			(xmlAttrPtr cur)

xmlBufferAllocationScheme	xmlGetBufferAllocationScheme	(void)

int	xmlGetCompressMode		(void)

int	xmlGetDocCompressMode		(xmlDocPtr doc)

xmlDtdPtr	xmlGetIntSubset		(xmlDocPtr doc)

xmlNodePtr	xmlGetLastChild		(xmlNodePtr parent)

long	xmlGetLineNo			(xmlNodePtr node)

xmlChar *	xmlGetNoNsProp		(xmlNodePtr node, 
					 const xmlChar * name)

xmlChar *	xmlGetNodePath		(xmlNodePtr node)

xmlNsPtr *	xmlGetNsList		(xmlDocPtr doc, 
					 xmlNodePtr node)

xmlChar *	xmlGetNsProp		(xmlNodePtr node, 
					 const xmlChar * name, 
					 const xmlChar * nameSpace)

xmlChar *	xmlGetProp		(xmlNodePtr node, 
					 const xmlChar * name)

xmlAttrPtr	xmlHasNsProp		(xmlNodePtr node, 
					 const xmlChar * name, 
					 const xmlChar * nameSpace)

xmlAttrPtr	xmlHasProp		(xmlNodePtr node, 
					 const xmlChar * name)

int	xmlIsBlankNode			(xmlNodePtr node)

int	xmlIsXHTML			(const xmlChar * systemID, 
					 const xmlChar * publicID)

xmlNodePtr	xmlLastElementChild	(xmlNodePtr parent)

xmlNodePtr	xmlNewCDataBlock	(xmlDocPtr doc, 
					 const xmlChar * content, 
					 int len)

xmlNodePtr	xmlNewCharRef		(xmlDocPtr doc, 
					 const xmlChar * name)

xmlNodePtr	xmlNewChild		(xmlNodePtr parent, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * content)

xmlNodePtr	xmlNewComment		(const xmlChar * content)

xmlDocPtr	xmlNewDoc		(const xmlChar * version)

xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
					 const xmlChar * content)

xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc)

xmlNodePtr	xmlNewDocNode		(xmlDocPtr doc, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * content)

xmlNodePtr	xmlNewDocNodeEatName	(xmlDocPtr doc, 
					 xmlNsPtr ns, 
					 xmlChar * name, 
					 const xmlChar * content)

xmlNodePtr	xmlNewDocPI		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 const xmlChar * content)

xmlAttrPtr	xmlNewDocProp		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 const xmlChar * value)

xmlNodePtr	xmlNewDocRawNode	(xmlDocPtr doc, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * content)

xmlNodePtr	xmlNewDocText		(xmlDocPtr doc, 
					 const xmlChar * content)

xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
					 const xmlChar * content, 
					 int len)

xmlDtdPtr	xmlNewDtd		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID)

xmlNsPtr	xmlNewGlobalNs		(xmlDocPtr doc, 
					 const xmlChar * href, 
					 const xmlChar * prefix)

xmlNodePtr	xmlNewNode		(xmlNsPtr ns, 
					 const xmlChar * name)

xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
					 xmlChar * name)

xmlNsPtr	xmlNewNs		(xmlNodePtr node, 
					 const xmlChar * href, 
					 const xmlChar * prefix)

xmlAttrPtr	xmlNewNsProp		(xmlNodePtr node, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * value)

xmlAttrPtr	xmlNewNsPropEatName	(xmlNodePtr node, 
					 xmlNsPtr ns, 
					 xmlChar * name, 
					 const xmlChar * value)

xmlNodePtr	xmlNewPI		(const xmlChar * name, 
					 const xmlChar * content)

xmlAttrPtr	xmlNewProp		(xmlNodePtr node, 
					 const xmlChar * name, 
					 const xmlChar * value)

xmlNodePtr	xmlNewReference		(xmlDocPtr doc, 
					 const xmlChar * name)

xmlNodePtr	xmlNewText		(const xmlChar * content)

xmlNodePtr	xmlNewTextChild		(xmlNodePtr parent, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * content)

xmlNodePtr	xmlNewTextLen		(const xmlChar * content, 
					 int len)

xmlNodePtr	xmlNextElementSibling	(xmlNodePtr node)

void	xmlNodeAddContent		(xmlNodePtr cur, 
					 const xmlChar * content)

void	xmlNodeAddContentLen		(xmlNodePtr cur, 
					 const xmlChar * content, 
					 int len)

int	xmlNodeBufGetContent		(xmlBufferPtr buffer, 
					 xmlNodePtr cur)

int	xmlNodeDump			(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 int level, 
					 int format)

void	xmlNodeDumpOutput		(xmlOutputBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 int level, 
					 int format, 
					 const char * encoding)

xmlChar *	xmlNodeGetBase		(xmlDocPtr doc, 
					 xmlNodePtr cur)

xmlChar *	xmlNodeGetContent	(xmlNodePtr cur)

xmlChar *	xmlNodeGetLang		(xmlNodePtr cur)

int	xmlNodeGetSpacePreserve		(xmlNodePtr cur)

int	xmlNodeIsText			(xmlNodePtr node)

xmlChar *	xmlNodeListGetRawString	(xmlDocPtr doc, 
					 xmlNodePtr list, 
					 int inLine)

xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
					 xmlNodePtr list, 
					 int inLine)

void	xmlNodeSetBase			(xmlNodePtr cur, 
					 const xmlChar * uri)

void	xmlNodeSetContent		(xmlNodePtr cur, 
					 const xmlChar * content)

void	xmlNodeSetContentLen		(xmlNodePtr cur, 
					 const xmlChar * content, 
					 int len)

void	xmlNodeSetLang			(xmlNodePtr cur, 
					 const xmlChar * lang)

void	xmlNodeSetName			(xmlNodePtr cur, 
					 const xmlChar * name)

void	xmlNodeSetSpacePreserve		(xmlNodePtr cur, 
					 int val)

xmlNodePtr	xmlPreviousElementSibling	(xmlNodePtr node)

int	xmlReconciliateNs		(xmlDocPtr doc, 
					 xmlNodePtr tree)

int	xmlRemoveProp			(xmlAttrPtr cur)

xmlNodePtr	xmlReplaceNode		(xmlNodePtr old, 
					 xmlNodePtr cur)

int	xmlSaveFile			(const char * filename, 
					 xmlDocPtr cur)

int	xmlSaveFileEnc			(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding)

int	xmlSaveFileTo			(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding)

int	xmlSaveFormatFile		(const char * filename, 
					 xmlDocPtr cur, 
					 int format)

int	xmlSaveFormatFileEnc		(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

int	xmlSaveFormatFileTo		(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

xmlNsPtr	xmlSearchNs		(xmlDocPtr doc, 
					 xmlNodePtr node, 
					 const xmlChar * nameSpace)

xmlNsPtr	xmlSearchNsByHref	(xmlDocPtr doc, 
					 xmlNodePtr node, 
					 const xmlChar * href)

void	xmlSetBufferAllocationScheme	(xmlBufferAllocationScheme scheme)

void	xmlSetCompressMode		(int mode)

void	xmlSetDocCompressMode		(xmlDocPtr doc, 
					 int mode)

void	xmlSetListDoc			(xmlNodePtr list, 
					 xmlDocPtr doc)

void	xmlSetNs			(xmlNodePtr node, 
					 xmlNsPtr ns)

xmlAttrPtr	xmlSetNsProp		(xmlNodePtr node, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * value)

xmlAttrPtr	xmlSetProp		(xmlNodePtr node, 
					 const xmlChar * name, 
					 const xmlChar * value)

void	xmlSetTreeDoc			(xmlNodePtr tree, 
					 xmlDocPtr doc)

xmlChar *	xmlSplitQName2		(const xmlChar * name, 
					 xmlChar ** prefix)

const xmlChar *	xmlSplitQName3		(const xmlChar * name, 
					 int * len)

xmlNodePtr	xmlStringGetNodeList	(xmlDocPtr doc, 
					 const xmlChar * value)

xmlNodePtr	xmlStringLenGetNodeList	(xmlDocPtr doc, 
					 const xmlChar * value, 
					 int len)

int	xmlTextConcat			(xmlNodePtr node, 
					 const xmlChar * content, 
					 int len)

xmlNodePtr	xmlTextMerge		(xmlNodePtr first, 
					 xmlNodePtr second)

void	xmlUnlinkNode			(xmlNodePtr cur)

int	xmlUnsetNsProp			(xmlNodePtr node, 
					 xmlNsPtr ns, 
					 const xmlChar * name)

int	xmlUnsetProp			(xmlNodePtr node, 
					 const xmlChar * name)

int	xmlValidateNCName		(const xmlChar * value, 
					 int space)

int	xmlValidateNMToken		(const xmlChar * value, 
					 int space)

int	xmlValidateName			(const xmlChar * value, 
					 int space)

int	xmlValidateQName		(const xmlChar * value, 
					 int space)

Description

Macro: BASE_BUFFER_SIZE

#define BASE_BUFFER_SIZE

default buffer size 4000.

Macro: XML_GET_CONTENT

#define XML_GET_CONTENT

Macro to extract the content pointer of a node.

Macro: XML_GET_LINE

#define XML_GET_LINE

Macro to extract the line number of an element node.

Macro: XML_LOCAL_NAMESPACE

#define XML_LOCAL_NAMESPACE

A namespace declaration node.

Macro: XML_XML_ID

#define XML_XML_ID

This is the name for the special xml:id attribute

Macro: XML_XML_NAMESPACE

#define XML_XML_NAMESPACE

This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

Macro: xmlChildrenNode

#define xmlChildrenNode

Macro for compatibility naming layer with libxml1. Maps to "children."

Macro: xmlRootNode

#define xmlRootNode

Macro for compatibility naming layer with libxml1. Maps to "children".

Structure xmlAttr

Structure xmlAttr
struct _xmlAttr {
    void *	_private	: application data
    xmlElementType	type	: XML_ATTRIBUTE_NODE, must be second !
    const xmlChar *	name	: the name of the property
    struct _xmlNode *	children	: the value of the property
    struct _xmlNode *	last	: NULL
    struct _xmlNode *	parent	: child->parent link
    struct _xmlAttr *	next	: next sibling link
    struct _xmlAttr *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document
    xmlNs *	ns	: pointer to the associated namespace
    xmlAttributeType	atype	: the attribute type if validating
    void *	psvi	: for type/PSVI informations
}

Structure xmlAttribute

Structure xmlAttribute
struct _xmlAttribute {
    void *	_private	: application data
    xmlElementType	type	: XML_ATTRIBUTE_DECL, must be second !
    const xmlChar *	name	: Attribute name
    struct _xmlNode *	children	: NULL
    struct _xmlNode *	last	: NULL
    struct _xmlDtd *	parent	: -> DTD
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document
    struct _xmlAttribute *	nexth	: next in hash table
    xmlAttributeType	atype	: The attribute type
    xmlAttributeDefault	def	: the default
    const xmlChar *	defaultValue	: or the default value
    xmlEnumerationPtr	tree	: or the enumeration tree if any
    const xmlChar *	prefix	: the namespace prefix if any
    const xmlChar *	elem	: Element holding the attribute
}

Enum xmlAttributeDefault

Enum xmlAttributeDefault {
    XML_ATTRIBUTE_NONE = 1
    XML_ATTRIBUTE_REQUIRED = 2
    XML_ATTRIBUTE_IMPLIED = 3
    XML_ATTRIBUTE_FIXED = 4
}

Enum xmlAttributeType

Enum xmlAttributeType {
    XML_ATTRIBUTE_CDATA = 1
    XML_ATTRIBUTE_ID = 2
    XML_ATTRIBUTE_IDREF = 3
    XML_ATTRIBUTE_IDREFS = 4
    XML_ATTRIBUTE_ENTITY = 5
    XML_ATTRIBUTE_ENTITIES = 6
    XML_ATTRIBUTE_NMTOKEN = 7
    XML_ATTRIBUTE_NMTOKENS = 8
    XML_ATTRIBUTE_ENUMERATION = 9
    XML_ATTRIBUTE_NOTATION = 10
}

Structure xmlBuffer

Structure xmlBuffer
struct _xmlBuffer {
    xmlChar *	content	: The buffer content UTF8
    unsigned int	use	: The buffer size used
    unsigned int	size	: The buffer size
    xmlBufferAllocationScheme	alloc	: The realloc method
    xmlChar *	contentIO	: in IO mode we may have a different base
}

Enum xmlBufferAllocationScheme

Enum xmlBufferAllocationScheme {
    XML_BUFFER_ALLOC_DOUBLEIT = 1 : double each time one need to grow
    XML_BUFFER_ALLOC_EXACT = 2 : grow only to the minimal size
    XML_BUFFER_ALLOC_IMMUTABLE = 3 : immutable buffer
    XML_BUFFER_ALLOC_IO = 4 : special allocation scheme used for I/O
}

Structure xmlDOMWrapCtxt

Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt {
    void *	_private	: * The type of this context, just in case
    int	type	: * Internal namespace map used for variou
    void *	namespaceMap	: * Use this one to acquire an xmlNsPtr in
    xmlDOMWrapAcquireNsFunction	getNsForNodeFunc
}

Structure xmlDoc

Structure xmlDoc
struct _xmlDoc {
    void *	_private	: application data
    xmlElementType	type	: XML_DOCUMENT_NODE, must be second !
    char *	name	: name/filename/URI of the document
    struct _xmlNode *	children	: the document tree
    struct _xmlNode *	last	: last child link
    struct _xmlNode *	parent	: child->parent link
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: autoreference to itself End of common p
    int	compression	: level of zlib compression
    int	standalone	: standalone document (no external refs)
    struct _xmlDtd *	intSubset	: the document internal subset
    struct _xmlDtd *	extSubset	: the document external subset
    struct _xmlNs *	oldNs	: Global namespace, the old way
    const xmlChar *	version	: the XML version string
    const xmlChar *	encoding	: external initial encoding, if any
    void *	ids	: Hash table for ID attributes if any
    void *	refs	: Hash table for IDREFs attributes if any
    const xmlChar *	URL	: The URI for that document
    int	charset	: encoding of the in-memory content actua
    struct _xmlDict *	dict	: dict used to allocate names or NULL
    void *	psvi	: for type/PSVI informations
    int	parseFlags	: set of xmlParserOption used to parse th
    int	properties	: set of xmlDocProperties for this docume
}

Enum xmlDocProperties

Enum xmlDocProperties {
    XML_DOC_WELLFORMED = 1 : document is XML well formed
    XML_DOC_NSVALID = 2 : document is Namespace valid
    XML_DOC_OLD10 = 4 : parsed with old XML-1.0 parser
    XML_DOC_DTDVALID = 8 : DTD validation was successful
    XML_DOC_XINCLUDE = 16 : XInclude substitution was done
    XML_DOC_USERBUILT = 32 : Document was built using the API and not by parsing an instance
    XML_DOC_INTERNAL = 64 : built for internal processing
    XML_DOC_HTML = 128 : parsed or built HTML document
}

Structure xmlDtd

Structure xmlDtd
struct _xmlDtd {
    void *	_private	: application data
    xmlElementType	type	: XML_DTD_NODE, must be second !
    const xmlChar *	name	: Name of the DTD
    struct _xmlNode *	children	: the value of the property link
    struct _xmlNode *	last	: last child link
    struct _xmlDoc *	parent	: child->parent link
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document End of common p
    void *	notations	: Hash table for notations if any
    void *	elements	: Hash table for elements if any
    void *	attributes	: Hash table for attributes if any
    void *	entities	: Hash table for entities if any
    const xmlChar *	ExternalID	: External identifier for PUBLIC DTD
    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC DTD
    void *	pentities	: Hash table for param entities if any
}

Structure xmlElement

Structure xmlElement
struct _xmlElement {
    void *	_private	: application data
    xmlElementType	type	: XML_ELEMENT_DECL, must be second !
    const xmlChar *	name	: Element name
    struct _xmlNode *	children	: NULL
    struct _xmlNode *	last	: NULL
    struct _xmlDtd *	parent	: -> DTD
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document
    xmlElementTypeVal	etype	: The type
    xmlElementContentPtr	content	: the allowed element content
    xmlAttributePtr	attributes	: List of the declared attributes
    const xmlChar *	prefix	: the namespace prefix if any
    xmlRegexpPtr	contModel	: the validating regexp
    void *	contModel
}

Structure xmlElementContent

Structure xmlElementContent
struct _xmlElementContent {
    xmlElementContentType	type	: PCDATA, ELEMENT, SEQ or OR
    xmlElementContentOccur	ocur	: ONCE, OPT, MULT or PLUS
    const xmlChar *	name	: Element name
    struct _xmlElementContent *	c1	: first child
    struct _xmlElementContent *	c2	: second child
    struct _xmlElementContent *	parent	: parent
    const xmlChar *	prefix	: Namespace prefix
}

Enum xmlElementContentOccur

Enum xmlElementContentOccur {
    XML_ELEMENT_CONTENT_ONCE = 1
    XML_ELEMENT_CONTENT_OPT = 2
    XML_ELEMENT_CONTENT_MULT = 3
    XML_ELEMENT_CONTENT_PLUS = 4
}

Enum xmlElementContentType

Enum xmlElementContentType {
    XML_ELEMENT_CONTENT_PCDATA = 1
    XML_ELEMENT_CONTENT_ELEMENT = 2
    XML_ELEMENT_CONTENT_SEQ = 3
    XML_ELEMENT_CONTENT_OR = 4
}

Enum xmlElementType

Enum xmlElementType {
    XML_ELEMENT_NODE = 1
    XML_ATTRIBUTE_NODE = 2
    XML_TEXT_NODE = 3
    XML_CDATA_SECTION_NODE = 4
    XML_ENTITY_REF_NODE = 5
    XML_ENTITY_NODE = 6
    XML_PI_NODE = 7
    XML_COMMENT_NODE = 8
    XML_DOCUMENT_NODE = 9
    XML_DOCUMENT_TYPE_NODE = 10
    XML_DOCUMENT_FRAG_NODE = 11
    XML_NOTATION_NODE = 12
    XML_HTML_DOCUMENT_NODE = 13
    XML_DTD_NODE = 14
    XML_ELEMENT_DECL = 15
    XML_ATTRIBUTE_DECL = 16
    XML_ENTITY_DECL = 17
    XML_NAMESPACE_DECL = 18
    XML_XINCLUDE_START = 19
    XML_XINCLUDE_END = 20
    XML_DOCB_DOCUMENT_NODE = 21
}

Enum xmlElementTypeVal

Enum xmlElementTypeVal {
    XML_ELEMENT_TYPE_UNDEFINED = 0
    XML_ELEMENT_TYPE_EMPTY = 1
    XML_ELEMENT_TYPE_ANY = 2
    XML_ELEMENT_TYPE_MIXED = 3
    XML_ELEMENT_TYPE_ELEMENT = 4
}

Structure xmlEntity

Structure xmlEntity
struct _xmlEntity {
    void *	_private	: application data
    xmlElementType	type	: XML_ENTITY_DECL, must be second !
    const xmlChar *	name	: Entity name
    struct _xmlNode *	children	: First child link
    struct _xmlNode *	last	: Last child link
    struct _xmlDtd *	parent	: -> DTD
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document
    xmlChar *	orig	: content without ref substitution
    xmlChar *	content	: content or ndata if unparsed
    int	length	: the content length
    xmlEntityType	etype	: The entity type
    const xmlChar *	ExternalID	: External identifier for PUBLIC
    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC Entity
    struct _xmlEntity *	nexte	: unused
    const xmlChar *	URI	: the full URI as computed
    int	owner	: does the entity own the childrens
    int	checked	: was the entity content checked this is
}

Structure xmlEnumeration

Structure xmlEnumeration
struct _xmlEnumeration {
    struct _xmlEnumeration *	next	: next one
    const xmlChar *	name	: Enumeration name
}

Structure xmlID

Structure xmlID
struct _xmlID {
    struct _xmlID *	next	: next ID
    const xmlChar *	value	: The ID name
    xmlAttrPtr	attr	: The attribute holding it
    const xmlChar *	name	: The attribute if attr is not available
    int	lineno	: The line number if attr is not availabl
    struct _xmlDoc *	doc	: The document holding the ID
}

Structure xmlNode

Structure xmlNode
struct _xmlNode {
    void *	_private	: application data
    xmlElementType	type	: type number, must be second !
    const xmlChar *	name	: the name of the node, or the entity
    struct _xmlNode *	children	: parent->childs link
    struct _xmlNode *	last	: last child link
    struct _xmlNode *	parent	: child->parent link
    struct _xmlNode *	next	: next sibling link
    struct _xmlNode *	prev	: previous sibling link
    struct _xmlDoc *	doc	: the containing document End of common p
    xmlNs *	ns	: pointer to the associated namespace
    xmlChar *	content	: the content
    struct _xmlAttr *	properties	: properties list
    xmlNs *	nsDef	: namespace definitions on this node
    void *	psvi	: for type/PSVI informations
    unsigned short	line	: line number
    unsigned short	extra	: extra data for XPath/XSLT
}

Structure xmlNotation

Structure xmlNotation
struct _xmlNotation {
    const xmlChar *	name	: Notation name
    const xmlChar *	PublicID	: Public identifier, if any
    const xmlChar *	SystemID	: System identifier, if any
}

Structure xmlNs

Structure xmlNs
struct _xmlNs {
    struct _xmlNs *	next	: next Ns link for this node
    xmlNsType	type	: global or local
    const xmlChar *	href	: URL for the namespace
    const xmlChar *	prefix	: prefix for the namespace
    void *	_private	: application data
    struct _xmlDoc *	context	: normally an xmlDoc
}

Structure xmlOutputBuffer

Structure xmlOutputBuffer
struct _xmlOutputBuffer {
    void *	context
    xmlOutputWriteCallback	writecallback
    xmlOutputCloseCallback	closecallback
    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
    xmlBufferPtr	buffer	: Local buffer encoded in UTF-8 or ISOLat
    xmlBufferPtr	conv	: if encoder != NULL buffer for output
    int	written	: total number of byte written
    int	error
}

Structure xmlParserCtxt

Structure xmlParserCtxt
struct _xmlParserCtxt {
    struct _xmlSAXHandler *	sax	: The SAX handler
    void *	userData	: For SAX interface only, used by DOM bui
    xmlDocPtr	myDoc	: the document being built
    int	wellFormed	: is the document well formed
    int	replaceEntities	: shall we replace entities ?
    const xmlChar *	version	: the XML version string
    const xmlChar *	encoding	: the declared encoding, if any
    int	standalone	: standalone document
    int	html	: an HTML(1)/Docbook(2) document Input st
    xmlParserInputPtr	input	: Current input stream
    int	inputNr	: Number of current input streams
    int	inputMax	: Max number of input streams
    xmlParserInputPtr *	inputTab	: stack of inputs Node analysis stack onl
    xmlNodePtr	node	: Current parsed Node
    int	nodeNr	: Depth of the parsing stack
    int	nodeMax	: Max depth of the parsing stack
    xmlNodePtr *	nodeTab	: array of nodes
    int	record_info	: Whether node info should be kept
    xmlParserNodeInfoSeq	node_seq	: info about each node parsed
    int	errNo	: error code
    int	hasExternalSubset	: reference and external subset
    int	hasPErefs	: the internal subset has PE refs
    int	external	: are we parsing an external entity
    int	valid	: is the document valid
    int	validate	: shall we try to validate ?
    xmlValidCtxt	vctxt	: The validity context
    xmlParserInputState	instate	: current type of input
    int	token	: next char look-ahead
    char *	directory	: the data directory Node name stack
    const xmlChar *	name	: Current parsed Node
    int	nameNr	: Depth of the parsing stack
    int	nameMax	: Max depth of the parsing stack
    const xmlChar * *	nameTab	: array of nodes
    long	nbChars	: number of xmlChar processed
    long	checkIndex	: used by progressive parsing lookup
    int	keepBlanks	: ugly but ...
    int	disableSAX	: SAX callbacks are disabled
    int	inSubset	: Parsing is in int 1/ext 2 subset
    const xmlChar *	intSubName	: name of subset
    xmlChar *	extSubURI	: URI of external subset
    xmlChar *	extSubSystem	: SYSTEM ID of external subset xml:space
    int *	space	: Should the parser preserve spaces
    int	spaceNr	: Depth of the parsing stack
    int	spaceMax	: Max depth of the parsing stack
    int *	spaceTab	: array of space infos
    int	depth	: to prevent entity substitution loops
    xmlParserInputPtr	entity	: used to check entities boundaries
    int	charset	: encoding of the in-memory content actua
    int	nodelen	: Those two fields are there to
    int	nodemem	: Speed up large node parsing
    int	pedantic	: signal pedantic warnings
    void *	_private	: For user data, libxml won't touch it
    int	loadsubset	: should the external subset be loaded
    int	linenumbers	: set line number in element content
    void *	catalogs	: document's own catalog
    int	recovery	: run in recovery mode
    int	progressive	: is this a progressive parsing
    xmlDictPtr	dict	: dictionnary for the parser
    const xmlChar * *	atts	: array for the attributes callbacks
    int	maxatts	: the size of the array
    int	docdict	: * pre-interned strings *
    const xmlChar *	str_xml
    const xmlChar *	str_xmlns
    const xmlChar *	str_xml_ns	: * Everything below is used only by the n
    int	sax2	: operating in the new SAX mode
    int	nsNr	: the number of inherited namespaces
    int	nsMax	: the size of the arrays
    const xmlChar * *	nsTab	: the array of prefix/namespace name
    int *	attallocs	: which attribute were allocated
    void * *	pushTab	: array of data for push
    xmlHashTablePtr	attsDefault	: defaulted attributes if any
    xmlHashTablePtr	attsSpecial	: non-CDATA attributes if any
    int	nsWellFormed	: is the document XML Nanespace okay
    int	options	: * Those fields are needed only for tream
    int	dictNames	: Use dictionary names for the tree
    int	freeElemsNr	: number of freed element nodes
    xmlNodePtr	freeElems	: List of freed element nodes
    int	freeAttrsNr	: number of freed attributes nodes
    xmlAttrPtr	freeAttrs	: * the complete error informations for th
    xmlError	lastError
    xmlParserMode	parseMode	: the parser mode
    unsigned long	nbentities	: number of entities references
    unsigned long	sizeentities	: size of parsed entities
}

Structure xmlParserInput

Structure xmlParserInput
struct _xmlParserInput {
    xmlParserInputBufferPtr	buf	: UTF-8 encoded buffer
    const char *	filename	: The file analyzed, if any
    const char *	directory	: the directory/base of the file
    const xmlChar *	base	: Base of the array to parse
    const xmlChar *	cur	: Current char being parsed
    const xmlChar *	end	: end of the array to parse
    int	length	: length if known
    int	line	: Current line
    int	col	: * NOTE: consumed is only tested for equa
    unsigned long	consumed	: How many xmlChars already consumed
    xmlParserInputDeallocate	free	: function to deallocate the base
    const xmlChar *	encoding	: the encoding string for entity
    const xmlChar *	version	: the version string for entity
    int	standalone	: Was that entity marked standalone
    int	id	: an unique identifier for the entity
}

Structure xmlParserInputBuffer

Structure xmlParserInputBuffer
struct _xmlParserInputBuffer {
    void *	context
    xmlInputReadCallback	readcallback
    xmlInputCloseCallback	closecallback
    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
    xmlBufferPtr	buffer	: Local buffer encoded in UTF-8
    xmlBufferPtr	raw	: if encoder != NULL buffer for raw input
    int	compressed	: -1=unknown, 0=not compressed, 1=compres
    int	error
    unsigned long	rawconsumed	: amount consumed from raw
}

Structure xmlRef

Structure xmlRef
struct _xmlRef {
    struct _xmlRef *	next	: next Ref
    const xmlChar *	value	: The Ref name
    xmlAttrPtr	attr	: The attribute holding it
    const xmlChar *	name	: The attribute if attr is not available
    int	lineno	: The line number if attr is not availabl
}

Structure xmlSAXHandler

Structure xmlSAXHandler
struct _xmlSAXHandler {
    internalSubsetSAXFunc	internalSubset
    isStandaloneSAXFunc	isStandalone
    hasInternalSubsetSAXFunc	hasInternalSubset
    hasExternalSubsetSAXFunc	hasExternalSubset
    resolveEntitySAXFunc	resolveEntity
    getEntitySAXFunc	getEntity
    entityDeclSAXFunc	entityDecl
    notationDeclSAXFunc	notationDecl
    attributeDeclSAXFunc	attributeDecl
    elementDeclSAXFunc	elementDecl
    unparsedEntityDeclSAXFunc	unparsedEntityDecl
    setDocumentLocatorSAXFunc	setDocumentLocator
    startDocumentSAXFunc	startDocument
    endDocumentSAXFunc	endDocument
    startElementSAXFunc	startElement
    endElementSAXFunc	endElement
    referenceSAXFunc	reference
    charactersSAXFunc	characters
    ignorableWhitespaceSAXFunc	ignorableWhitespace
    processingInstructionSAXFunc	processingInstruction
    commentSAXFunc	comment
    warningSAXFunc	warning
    errorSAXFunc	error
    fatalErrorSAXFunc	fatalError	: unused error() get all the errors
    getParameterEntitySAXFunc	getParameterEntity
    cdataBlockSAXFunc	cdataBlock
    externalSubsetSAXFunc	externalSubset
    unsigned int	initialized	: The following fields are extensions ava
    void *	_private
    startElementNsSAX2Func	startElementNs
    endElementNsSAX2Func	endElementNs
    xmlStructuredErrorFunc	serror
}

Structure xmlSAXLocator

Structure xmlSAXLocator
struct _xmlSAXLocator {
    const xmlChar *(*getPublicId)	getPublicId
    const xmlChar *(*getSystemId)	getSystemId
    int(*getLineNumber)	getLineNumber
    int(*getColumnNumber)	getColumnNumber
}

Function: xmlAddChild

xmlNodePtr	xmlAddChild		(xmlNodePtr parent, 
					 xmlNodePtr cur)

Add a new node to @parent, at the end of the child (or property) list merging adjacent TEXT nodes (in which case @cur is freed) If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

`parent`:	the parent node
`cur`:	the child node
`Returns`:	the child or NULL in case of error.

Function: xmlAddChildList

xmlNodePtr	xmlAddChildList		(xmlNodePtr parent, 
					 xmlNodePtr cur)

Add a list of node at the end of the child list of the parent merging adjacent TEXT nodes (@cur may be freed)

`parent`:	the parent node
`cur`:	the first node in the list
`Returns`:	the last child or NULL in case of error.

Function: xmlAddNextSibling

xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
					 xmlNodePtr elem)

Add a new node @elem as the next sibling of @cur If the new node was already inserted in a document it is first unlinked from its existing context. As a result of text merging @elem may be freed. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

`cur`:	the child node
`elem`:	the new node
`Returns`:	the new node or NULL in case of error.

Function: xmlAddPrevSibling

xmlNodePtr	xmlAddPrevSibling	(xmlNodePtr cur, 
					 xmlNodePtr elem)

Add a new node @elem as the previous sibling of @cur merging adjacent TEXT nodes (@elem may be freed) If the new node was already inserted in a document it is first unlinked from its existing context. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

`cur`:	the child node
`elem`:	the new node
`Returns`:	the new node or NULL in case of error.

Function: xmlAddSibling

xmlNodePtr	xmlAddSibling		(xmlNodePtr cur, 
					 xmlNodePtr elem)

Add a new element @elem to the list of siblings of @cur merging adjacent TEXT nodes (@elem may be freed) If the new element was already inserted in a document it is first unlinked from its existing context.

`cur`:	the child node
`elem`:	the new node
`Returns`:	the new element or NULL in case of error.

Function: xmlAttrSerializeTxtContent

void	xmlAttrSerializeTxtContent	(xmlBufferPtr buf, 
					 xmlDocPtr doc, 
					 xmlAttrPtr attr, 
					 const xmlChar * string)

Serialize text attribute values to an xml simple buffer

`buf`:	the XML buffer output
`doc`:	the document
`attr`:	the attribute node
`string`:	the text content

Function: xmlBufferAdd

int	xmlBufferAdd			(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

Add a string range to an XML buffer. if len == -1, the length of str is recomputed.

`buf`:	the buffer to dump
`str`:	the #xmlChar string
`len`:	the number of #xmlChar to add
`Returns`:	0 successful, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlBufferAddHead

int	xmlBufferAddHead		(xmlBufferPtr buf, 
					 const xmlChar * str, 
					 int len)

Add a string range to the beginning of an XML buffer. if len == -1, the length of @str is recomputed.

`buf`:	the buffer
`str`:	the #xmlChar string
`len`:	the number of #xmlChar to add
`Returns`:	0 successful, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlBufferCCat

int	xmlBufferCCat			(xmlBufferPtr buf, 
					 const char * str)

Append a zero terminated C string to an XML buffer.

`buf`:	the buffer to dump
`str`:	the C char string
`Returns`:	0 successful, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlBufferCat

int	xmlBufferCat			(xmlBufferPtr buf, 
					 const xmlChar * str)

Append a zero terminated string to an XML buffer.

`buf`:	the buffer to add to
`str`:	the #xmlChar string
`Returns`:	0 successful, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlBufferContent

const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

Function to extract the content of a buffer

`buf`:	the buffer
`Returns`:	the internal content

Function: xmlBufferCreate

xmlBufferPtr	xmlBufferCreate		(void)

routine to create an XML buffer.

Returns: the new structure.

Function: xmlBufferCreateSize

xmlBufferPtr	xmlBufferCreateSize	(size_t size)

routine to create an XML buffer.

`size`:	initial size of buffer
`Returns`:	the new structure.

Function: xmlBufferCreateStatic

xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
					 size_t size)

routine to create an XML buffer from an immutable memory area. The area won't be modified nor copied, and is expected to be present until the end of the buffer lifetime.

`mem`:	the memory area
`size`:	the size in byte
`Returns`:	the new structure.

Function: xmlBufferDump

int	xmlBufferDump			(FILE * file, 
					 xmlBufferPtr buf)

Dumps an XML buffer to a FILE *.

`file`:	the file output
`buf`:	the buffer to dump
`Returns`:	the number of #xmlChar written

Function: xmlBufferEmpty

void	xmlBufferEmpty			(xmlBufferPtr buf)

empty a buffer.

buf: the buffer

Function: xmlBufferFree

void	xmlBufferFree			(xmlBufferPtr buf)

Frees an XML buffer. It frees both the content and the structure which encapsulate it.

buf: the buffer to free

Function: xmlBufferGrow

int	xmlBufferGrow			(xmlBufferPtr buf, 
					 unsigned int len)

Grow the available space of an XML buffer.

`buf`:	the buffer
`len`:	the minimum free size to allocate
`Returns`:	the new available space or -1 in case of error

Function: xmlBufferLength

int	xmlBufferLength			(const xmlBufferPtr buf)

Function to get the length of a buffer

`buf`:	the buffer
`Returns`:	the length of data in the internal content

Function: xmlBufferResize

int	xmlBufferResize			(xmlBufferPtr buf, 
					 unsigned int size)

Resize a buffer to accommodate minimum size of @size.

`buf`:	the buffer to resize
`size`:	the desired size
`Returns`:	0 in case of problems, 1 otherwise

Function: xmlBufferSetAllocationScheme

void	xmlBufferSetAllocationScheme	(xmlBufferPtr buf, 
					 xmlBufferAllocationScheme scheme)

Sets the allocation scheme for this buffer

`buf`:	the buffer to tune
`scheme`:	allocation scheme to use

Function: xmlBufferShrink

int	xmlBufferShrink			(xmlBufferPtr buf, 
					 unsigned int len)

Remove the beginning of an XML buffer.

`buf`:	the buffer to dump
`len`:	the number of xmlChar to remove
`Returns`:	the number of #xmlChar removed, or -1 in case of failure.

Function: xmlBufferWriteCHAR

void	xmlBufferWriteCHAR		(xmlBufferPtr buf, 
					 const xmlChar * string)

routine which manages and grows an output buffer. This one adds xmlChars at the end of the buffer.

`buf`:	the XML buffer
`string`:	the string to add

Function: xmlBufferWriteChar

void	xmlBufferWriteChar		(xmlBufferPtr buf, 
					 const char * string)

routine which manage and grows an output buffer. This one add C chars at the end of the array.

`buf`:	the XML buffer output
`string`:	the string to add

Function: xmlBufferWriteQuotedString

void	xmlBufferWriteQuotedString	(xmlBufferPtr buf, 
					 const xmlChar * string)

routine which manage and grows an output buffer. This one writes a quoted or double quoted #xmlChar string, checking first if it holds quote or double-quotes internally

`buf`:	the XML buffer output
`string`:	the string to add

Function: xmlBuildQName

xmlChar *	xmlBuildQName		(const xmlChar * ncname, 
					 const xmlChar * prefix, 
					 xmlChar * memory, 
					 int len)

Builds the QName @prefix:@ncname in @memory if there is enough space and prefix is not NULL nor empty, otherwise allocate a new string. If prefix is NULL or empty it returns ncname.

`ncname`:	the Name
`prefix`:	the prefix
`memory`:	preallocated memory
`len`:	preallocated memory length
`Returns`:	the new string which must be freed by the caller if different from @memory and @ncname or NULL in case of error

Function: xmlChildElementCount

unsigned long	xmlChildElementCount	(xmlNodePtr parent)

Finds the current number of child nodes of that element which are element nodes. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

`parent`:	the parent node
`Returns`:	the count of element child or 0 if not available

Function: xmlCopyDoc

xmlDocPtr	xmlCopyDoc		(xmlDocPtr doc, 
					 int recursive)

Do a copy of the document info. If recursive, the content tree will be copied too as well as DTD, namespaces and entities.

`doc`:	the document
`recursive`:	if not zero do a recursive copy.
`Returns`:	a new #xmlDocPtr, or NULL in case of error.

Function: xmlCopyDtd

xmlDtdPtr	xmlCopyDtd		(xmlDtdPtr dtd)

Do a copy of the dtd.

`dtd`:	the dtd
`Returns`:	a new #xmlDtdPtr, or NULL in case of error.

Function: xmlCopyNamespace

xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur)

Do a copy of the namespace.

`cur`:	the namespace
`Returns`:	a new #xmlNsPtr, or NULL in case of error.

Function: xmlCopyNamespaceList

xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur)

Do a copy of an namespace list.

`cur`:	the first namespace
`Returns`:	a new #xmlNsPtr, or NULL in case of error.

Function: xmlCopyNode

xmlNodePtr	xmlCopyNode		(const xmlNodePtr node, 
					 int extended)

Do a copy of the node.

`node`:	the node
`extended`:	if 1 do a recursive copy (properties, namespaces and children when applicable) if 2 copy properties and namespaces (when applicable)
`Returns`:	a new #xmlNodePtr, or NULL in case of error.

Function: xmlCopyNodeList

xmlNodePtr	xmlCopyNodeList		(const xmlNodePtr node)

Do a recursive copy of the node list. Use xmlDocCopyNodeList() if possible to ensure string interning.

`node`:	the first node in the list.
`Returns`:	a new #xmlNodePtr, or NULL in case of error.

Function: xmlCopyProp

xmlAttrPtr	xmlCopyProp		(xmlNodePtr target, 
					 xmlAttrPtr cur)

Do a copy of the attribute.

`target`:	the element where the attribute will be grafted
`cur`:	the attribute
`Returns`:	a new #xmlAttrPtr, or NULL in case of error.

Function: xmlCopyPropList

xmlAttrPtr	xmlCopyPropList		(xmlNodePtr target, 
					 xmlAttrPtr cur)

Do a copy of an attribute list.

`target`:	the element where the attributes will be grafted
`cur`:	the first attribute
`Returns`:	a new #xmlAttrPtr, or NULL in case of error.

Function: xmlCreateIntSubset

xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
					 const xmlChar * name, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID)

Create the internal subset of a document

`doc`:	the document pointer
`name`:	the DTD name
`ExternalID`:	the external (PUBLIC) ID
`SystemID`:	the system ID
`Returns`:	a pointer to the new DTD structure

Function type: xmlDOMWrapAcquireNsFunction

Function type: xmlDOMWrapAcquireNsFunction
xmlNsPtr	xmlDOMWrapAcquireNsFunction	(xmlDOMWrapCtxtPtr ctxt, 
						 xmlNodePtr node, 
						 const xmlChar * nsName, 
						 const xmlChar * nsPrefix)

A function called to acquire namespaces (xmlNs) from the wrapper.

`ctxt`:	a DOM wrapper context
`node`:	the context node (element or attribute)
`nsName`:	the requested namespace name
`nsPrefix`:	the requested namespace prefix
`Returns`:	an xmlNsPtr or NULL in case of an error.

Function: xmlDOMWrapAdoptNode

int	xmlDOMWrapAdoptNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr sourceDoc, 
					 xmlNodePtr node, 
					 xmlDocPtr destDoc, 
					 xmlNodePtr destParent, 
					 int options)

References of out-of scope ns-decls are remapped to point to @destDoc: 1) If @destParent is given, then nsDef entries on element-nodes are used 2) If *no* @destParent is given, then @destDoc->oldNs entries are used This is the case when you have an unliked node and just want to move it to the context of If @destParent is given, it ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. NOTE: This function was not intensively tested.

`ctxt`:	the optional context for custom processing
`sourceDoc`:	the optional sourceDoc
`node`:	the node to start with
`destDoc`:	the destination doc
`destParent`:	the optional new parent of @node in @destDoc
`options`:	option flags
`Returns`:	0 if the operation succeeded, 1 if a node of unsupported type was given, 2 if a node of not yet supported type was given and -1 on API/internal errors.

Function: xmlDOMWrapCloneNode

int	xmlDOMWrapCloneNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr sourceDoc, 
					 xmlNodePtr node, 
					 xmlNodePtr * resNode, 
					 xmlDocPtr destDoc, 
					 xmlNodePtr destParent, 
					 int deep, 
					 int options)

References of out-of scope ns-decls are remapped to point to @destDoc: 1) If @destParent is given, then nsDef entries on element-nodes are used 2) If *no* @destParent is given, then @destDoc->oldNs entries are used. This is the case when you don't know already where the cloned branch will be added to. If @destParent is given, it ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. TODO: 1) What to do with XInclude? Currently this returns an error for XInclude.

`ctxt`:	the optional context for custom processing
`sourceDoc`:	the optional sourceDoc
`node`:	the node to start with
`resNode`:	the clone of the given @node
`destDoc`:	the destination doc
`destParent`:	the optional new parent of @node in @destDoc
`deep`:	descend into child if set
`options`:	option flags
`Returns`:	0 if the operation succeeded, 1 if a node of unsupported (or not yet supported) type was given, -1 on API/internal errors.

Function: xmlDOMWrapFreeCtxt

void	xmlDOMWrapFreeCtxt		(xmlDOMWrapCtxtPtr ctxt)

Frees the DOM-wrapper context.

ctxt: the DOM-wrapper context

Function: xmlDOMWrapNewCtxt

xmlDOMWrapCtxtPtr	xmlDOMWrapNewCtxt	(void)

Allocates and initializes a new DOM-wrapper context.

Returns: the xmlDOMWrapCtxtPtr or NULL in case of an internal errror.

Function: xmlDOMWrapReconcileNamespaces

int	xmlDOMWrapReconcileNamespaces	(xmlDOMWrapCtxtPtr ctxt, 
					 xmlNodePtr elem, 
					 int options)

Ensures that ns-references point to ns-decls hold on element-nodes. Ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. NOTE: This function was not intensively tested.

`ctxt`:	DOM wrapper context, unused at the moment
`elem`:	the element-node
`options`:	option flags
`Returns`:	0 if succeeded, -1 otherwise and on API/internal errors.

Function: xmlDOMWrapRemoveNode

int	xmlDOMWrapRemoveNode		(xmlDOMWrapCtxtPtr ctxt, 
					 xmlDocPtr doc, 
					 xmlNodePtr node, 
					 int options)

Unlinks the given node from its owner. This will substitute ns-references to node->nsDef for ns-references to doc->oldNs, thus ensuring the removed branch to be autark wrt ns-references. NOTE: This function was not intensively tested.

`ctxt`:	a DOM wrapper context
`doc`:	the doc
`node`:	the node to be removed.
`options`:	set of options, unused at the moment
`Returns`:	0 on success, 1 if the node is not supported, -1 on API and internal errors.

Function: xmlDocCopyNode

xmlNodePtr	xmlDocCopyNode		(const xmlNodePtr node, 
					 xmlDocPtr doc, 
					 int extended)

Do a copy of the node to a given document.

`node`:	the node
`doc`:	the document
`extended`:	if 1 do a recursive copy (properties, namespaces and children when applicable) if 2 copy properties and namespaces (when applicable)
`Returns`:	a new #xmlNodePtr, or NULL in case of error.

Function: xmlDocCopyNodeList

xmlNodePtr	xmlDocCopyNodeList	(xmlDocPtr doc, 
					 const xmlNodePtr node)

Do a recursive copy of the node list.

`doc`:	the target document
`node`:	the first node in the list.
`Returns`:	a new #xmlNodePtr, or NULL in case of error.

Function: xmlDocDump

int	xmlDocDump			(FILE * f, 
					 xmlDocPtr cur)

Dump an XML document to an open FILE.

`f`:	the FILE*
`cur`:	the document
`Returns`:	the number of bytes written or -1 in case of failure.

Function: xmlDocDumpFormatMemory

void	xmlDocDumpFormatMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size, 
					 int format)

Dump an XML document in memory and return the #xmlChar * and it's size. It's up to the caller to free the memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

`cur`:	the document
`mem`:	OUT: the memory pointer
`size`:	OUT: the memory length
`format`:	should formatting spaces been added

Function: xmlDocDumpFormatMemoryEnc

void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
					 xmlChar ** doc_txt_ptr, 
					 int * doc_txt_len, 
					 const char * txt_encoding, 
					 int format)

Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

`out_doc`:	Document to generate XML text from
`doc_txt_ptr`:	Memory pointer for allocated XML text
`doc_txt_len`:	Length of the generated XML text
`txt_encoding`:	Character encoding to use when generating XML text
`format`:	should formatting spaces been added

Function: xmlDocDumpMemory

void	xmlDocDumpMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size)

Dump an XML document in memory and return the #xmlChar * and it's size in bytes. It's up to the caller to free the memory with xmlFree(). The resulting byte array is zero terminated, though the last 0 is not included in the returned size.

`cur`:	the document
`mem`:	OUT: the memory pointer
`size`:	OUT: the memory length

Function: xmlDocDumpMemoryEnc

void	xmlDocDumpMemoryEnc		(xmlDocPtr out_doc, 
					 xmlChar ** doc_txt_ptr, 
					 int * doc_txt_len, 
					 const char * txt_encoding)

Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree().

Module tree from libxml2

Table of Contents

Description

Macro: BASE_BUFFER_SIZE

Macro: XML_GET_CONTENT

Macro: XML_GET_LINE

Macro: XML_LOCAL_NAMESPACE

Macro: XML_XML_ID

Macro: XML_XML_NAMESPACE

Macro: xmlChildrenNode

Macro: xmlRootNode

Enum xmlAttributeDefault

Enum xmlAttributeType

Enum xmlBufferAllocationScheme

Enum xmlDocProperties

Enum xmlElementContentOccur

Enum xmlElementContentType

Enum xmlElementType

Enum xmlElementTypeVal

Function: xmlAddChild

Function: xmlAddChildList

Function: xmlAddNextSibling

Function: xmlAddPrevSibling

Function: xmlAddSibling

Function: xmlAttrSerializeTxtContent

Function: xmlBufferAdd

Function: xmlBufferAddHead

Function: xmlBufferCCat

Function: xmlBufferCat

Function: xmlBufferContent

Function: xmlBufferCreate

Function: xmlBufferCreateSize

Function: xmlBufferCreateStatic

Function: xmlBufferDump

Function: xmlBufferEmpty

Function: xmlBufferFree

Function: xmlBufferGrow

Function: xmlBufferLength

Function: xmlBufferResize

Function: xmlBufferSetAllocationScheme

Function: xmlBufferShrink

Function: xmlBufferWriteCHAR

Function: xmlBufferWriteChar

Function: xmlBufferWriteQuotedString

Function: xmlBuildQName

Function: xmlChildElementCount

Function: xmlCopyDoc

Function: xmlCopyDtd

Function: xmlCopyNamespace

Function: xmlCopyNamespaceList

Function: xmlCopyNode

Function: xmlCopyNodeList

Function: xmlCopyProp

Function: xmlCopyPropList

Function: xmlCreateIntSubset

Function type: xmlDOMWrapAcquireNsFunction

Function: xmlDOMWrapAdoptNode

Function: xmlDOMWrapCloneNode

Function: xmlDOMWrapFreeCtxt

Function: xmlDOMWrapNewCtxt

Function: xmlDOMWrapReconcileNamespaces

Function: xmlDOMWrapRemoveNode

Function: xmlDocCopyNode

Function: xmlDocCopyNodeList

Function: xmlDocDump

Function: xmlDocDumpFormatMemory

Function: xmlDocDumpFormatMemoryEnc

Function: xmlDocDumpMemory

Function: xmlDocDumpMemoryEnc