Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

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

Table of Contents

#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
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)
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)
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)
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	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)
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)
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 }

Enum xmlBufferAllocationScheme

Enum xmlBufferAllocationScheme {
    XML_BUFFER_ALLOC_DOUBLEIT = 1
    XML_BUFFER_ALLOC_EXACT = 2
    XML_BUFFER_ALLOC_IMMUTABLE = 3
}

Structure xmlDOMWrapCtxt

Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt { void * _private }

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 }

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 }

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 }

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 }

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: 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: 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. WARNING: This function is in a experimental state.

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 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. TODO: 1) Support dicts Optimize string adoption for equal or none dicts. 2) XInclude WARNING: This function is in a experimental state and should only be currently only be used to test it.

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. WARNING: This function is in a experimental state.

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. WARNING: This function is in a experimental state.

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().

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

Function: xmlDocFormatDump

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

Dump an XML document to an open FILE.

f:the FILE*
cur:the document
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Function: xmlDocGetRootElement

xmlNodePtr	xmlDocGetRootElement	(xmlDocPtr doc)

Get the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

doc:the document
Returns:the #xmlNodePtr for the root or NULL

Function: xmlDocSetRootElement

xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
xmlNodePtr root)

Set the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

doc:the document
root:the new document root element
Returns:the old root element if any was found

Function: xmlElemDump

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

Dump an XML/HTML node, recursive behaviour, children are printed too.

f:the FILE * for the output
doc:the document
cur:the current node

Function: xmlFreeDoc

void	xmlFreeDoc			(xmlDocPtr cur)

Free up all the structures used by a document, tree included.

cur:pointer to the document

Function: xmlFreeDtd

void	xmlFreeDtd			(xmlDtdPtr cur)

Free a DTD structure.

cur:the DTD structure to free up

Function: xmlFreeNode

void	xmlFreeNode			(xmlNodePtr cur)

Free a node, this is a recursive behaviour, all the children are freed too. This doesn't unlink the child from the list, use xmlUnlinkNode() first.

cur:the node

Function: xmlFreeNodeList

void	xmlFreeNodeList			(xmlNodePtr cur)

Free a node and all its siblings, this is a recursive behaviour, all the children are freed too.

cur:the first node in the list

Function: xmlFreeNs

void	xmlFreeNs			(xmlNsPtr cur)

Free up the structures associated to a namespace

cur:the namespace pointer

Function: xmlFreeNsList

void	xmlFreeNsList			(xmlNsPtr cur)

Free up all the structures associated to the chained namespaces.

cur:the first namespace pointer

Function: xmlFreeProp

void	xmlFreeProp			(xmlAttrPtr cur)

Free one attribute, all the content is freed too

cur:an attribute

Function: xmlFreePropList

void	xmlFreePropList			(xmlAttrPtr cur)

Free a property and all its siblings, all the children are freed too.

cur:the first property in the list

Function: xmlGetBufferAllocationScheme

xmlBufferAllocationScheme	xmlGetBufferAllocationScheme	(void)

Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance

Returns:the current allocation scheme

Function: xmlGetCompressMode

int	xmlGetCompressMode		(void)

get the default compression mode used, ZLIB based.

Returns:0 (uncompressed) to 9 (max compression)

Function: xmlGetDocCompressMode

int	xmlGetDocCompressMode		(xmlDocPtr doc)

get the compression ratio for a document, ZLIB based

doc:the document
Returns:0 (uncompressed) to 9 (max compression)

Function: xmlGetIntSubset

xmlDtdPtr	xmlGetIntSubset		(xmlDocPtr doc)

Get the internal subset of a document

doc:the document pointer
Returns:a pointer to the DTD structure or NULL if not found

Function: xmlGetLastChild

xmlNodePtr	xmlGetLastChild		(xmlNodePtr parent)

Search the last child of a node.

parent:the parent node
Returns:the last child or NULL if none.

Function: xmlGetLineNo

long	xmlGetLineNo			(xmlNodePtr node)

Get line number of @node. This requires activation of this option before invoking the parser by calling xmlLineNumbersDefault(1)

node:valid node
Returns:the line number if successful, -1 otherwise

Function: xmlGetNoNsProp

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

Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. This function is similar to xmlGetProp except it will accept only an attribute in no namespace.

node:the node
name:the attribute name
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().

Function: xmlGetNodePath

xmlChar *	xmlGetNodePath		(xmlNodePtr node)

Build a structure based Path for the given node

node:a node
Returns:the new path or NULL in case of error. The caller must free the returned string

Function: xmlGetNsList

xmlNsPtr *	xmlGetNsList		(xmlDocPtr doc, 
xmlNodePtr node)

Search all the namespace applying to a given element.

doc:the document
node:the current node
Returns:an NULL terminated array of all the #xmlNsPtr found that need to be freed by the caller or NULL if no namespace if defined

Function: xmlGetNsProp

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

Search and get the value of an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

node:the node
name:the attribute name
nameSpace:the URI of the namespace
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().

Function: xmlGetProp

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

Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. NOTE: this function acts independently of namespaces associated to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp() for namespace aware processing.

node:the node
name:the attribute name
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().

Function: xmlHasNsProp

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

Search for an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. Note that a namespace of NULL indicates to use the default namespace.

node:the node
name:the attribute name
nameSpace:the URI of the namespace
Returns:the attribute or the attribute declaration or NULL if neither was found.

Function: xmlHasProp

xmlAttrPtr	xmlHasProp		(xmlNodePtr node, 
const xmlChar * name)

Search an attribute associated to a node This function also looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

node:the node
name:the attribute name
Returns:the attribute or the attribute declaration or NULL if neither was found.

Function: xmlIsBlankNode

int	xmlIsBlankNode			(xmlNodePtr node)

Checks whether this node is an empty or whitespace only (and possibly ignorable) text-node.

node:the node
Returns:1 yes, 0 no

Function: xmlIsXHTML

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

Try to find if the document correspond to an XHTML DTD

systemID:the system identifier
publicID:the public identifier
Returns:1 if true, 0 if not and -1 in case of error

Function: xmlNewCDataBlock

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

Creation of a new node containing a CDATA block.

doc:the document
content:the CDATA block content content
len:the length of the block
Returns:a pointer to the new node object.

Function: xmlNewCharRef

xmlNodePtr	xmlNewCharRef		(xmlDocPtr doc, 
const xmlChar * name)

Creation of a new character reference node.

doc:the document
name:the char ref string, starting with # or "&# ... ;"
Returns:a pointer to the new node object.

Function: xmlNewChild

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

Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @ns is NULL, the newly created element inherits the namespace of @parent. If @content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created. NOTE: @content is supposed to be a piece of XML CDATA, so it allows entity references. XML special chars must be escaped first by using xmlEncodeEntitiesReentrant(), or xmlNewTextChild() should be used.

parent:the parent node
ns:a namespace if any
name:the name of the child
content:the XML content of the child if any.
Returns:a pointer to the new node object.

Function: xmlNewComment

xmlNodePtr	xmlNewComment		(const xmlChar * content)

Creation of a new node containing a comment.

content:the comment content
Returns:a pointer to the new node object.

Function: xmlNewDoc

xmlDocPtr	xmlNewDoc		(const xmlChar * version)

Creates a new XML document

version:xmlChar string giving the version of XML "1.0"
Returns:a new document

Function: xmlNewDocComment

xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
const xmlChar * content)

Creation of a new node containing a comment within a document.

doc:the document
content:the comment content
Returns:a pointer to the new node object.

Function: xmlNewDocFragment

xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc)

Creation of a new Fragment node.

doc:the document owning the fragment
Returns:a pointer to the new node object.

Function: xmlNewDocNode

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

Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

doc:the document
ns:namespace if any
name:the node name
content:the XML text content if any
Returns:a pointer to the new node object.

Function: xmlNewDocNodeEatName

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

Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

doc:the document
ns:namespace if any
name:the node name
content:the XML text content if any
Returns:a pointer to the new node object.

Function: xmlNewDocPI

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

Creation of a processing instruction element.

doc:the target document
name:the processing instruction name
content:the PI content
Returns:a pointer to the new node object.

Function: xmlNewDocProp

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

Create a new property carried by a document.

doc:the document
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute

Function: xmlNewDocRawNode

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

Creation of a new node element within a document. @ns and @content are optional (NULL).

doc:the document
ns:namespace if any
name:the node name
content:the text content if any
Returns:a pointer to the new node object.

Function: xmlNewDocText

xmlNodePtr	xmlNewDocText		(xmlDocPtr doc, 
const xmlChar * content)

Creation of a new text node within a document.

doc:the document
content:the text content
Returns:a pointer to the new node object.

Function: xmlNewDocTextLen

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

Creation of a new text node with an extra content length parameter. The text node pertain to a given document.

doc:the document
content:the text content
len:the text len.
Returns:a pointer to the new node object.

Function: xmlNewDtd

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

Creation of a new DTD for the external subset. To create an internal subset, use xmlCreateIntSubset().

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

Function: xmlNewGlobalNs

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

Creation of a Namespace, the old way using PI and without scoping DEPRECATED !!!

doc:the document carrying the namespace
href:the URI associated
prefix:the prefix for the namespace
Returns:NULL this functionality had been removed

Function: xmlNewNode

xmlNodePtr	xmlNewNode		(xmlNsPtr ns, 
const xmlChar * name)

Creation of a new node element. @ns is optional (NULL).

ns:namespace if any
name:the node name
Returns:a pointer to the new node object. Uses xmlStrdup() to make copy of @name.

Function: xmlNewNodeEatName

xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
xmlChar * name)

Creation of a new node element. @ns is optional (NULL).

ns:namespace if any
name:the node name
Returns:a pointer to the new node object, with pointer @name as new node's name. Use xmlNewNode() if a copy of @name string is is needed as new node's name.

Function: xmlNewNs

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

Creation of a new Namespace. This function will refuse to create a namespace with a similar prefix than an existing one present on this node. We use href==NULL in the case of an element creation where the namespace was not defined.

node:the element carrying the namespace
href:the URI associated
prefix:the prefix for the namespace
Returns:a new namespace pointer or NULL

Function: xmlNewNsProp

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

Create a new property tagged with a namespace and carried by a node.

node:the holding node
ns:the namespace
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute

Function: xmlNewNsPropEatName

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

Create a new property tagged with a namespace and carried by a node.

node:the holding node
ns:the namespace
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute

Function: xmlNewPI

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

Creation of a processing instruction element. Use xmlDocNewPI preferably to get string interning

name:the processing instruction name
content:the PI content
Returns:a pointer to the new node object.

Function: xmlNewProp

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

Create a new property carried by a node.

node:the holding node
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute

Function: xmlNewReference

xmlNodePtr	xmlNewReference		(xmlDocPtr doc, 
const xmlChar * name)

Creation of a new reference node.

doc:the document
name:the reference name, or the reference string with & and ;
Returns:a pointer to the new node object.

Function: xmlNewText

xmlNodePtr	xmlNewText		(const xmlChar * content)

Creation of a new text node.

content:the text content
Returns:a pointer to the new node object.

Function: xmlNewTextChild

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

Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @ns is NULL, the newly created element inherits the namespace of @parent. If @content is non NULL, a child TEXT node will be created containing the string @content. NOTE: Use xmlNewChild() if @content will contain entities that need to be preserved. Use this function, xmlNewTextChild(), if you need to ensure that reserved XML chars that might appear in @content, such as the ampersand, greater-than or less-than signs, are automatically replaced by their XML escaped entity representations.

parent:the parent node
ns:a namespace if any
name:the name of the child
content:the text content of the child if any.
Returns:a pointer to the new node object.

Function: xmlNewTextLen

xmlNodePtr	xmlNewTextLen		(const xmlChar * content, 
int len)

Creation of a new text node with an extra parameter for the content's length

content:the text content
len:the text len.
Returns:a pointer to the new node object.

Function: xmlNodeAddContent

void	xmlNodeAddContent		(xmlNodePtr cur, 
const xmlChar * content)

Append the extra substring to the node content.

cur:the node being modified
content:extra content

Function: xmlNodeAddContentLen

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

Append the extra substring to the node content.

cur:the node being modified
content:extra content
len:the size of @content

Function: xmlNodeBufGetContent

int	xmlNodeBufGetContent		(xmlBufferPtr buffer, 
xmlNodePtr cur)

Read the value of a node @cur, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted. Fills up the buffer @buffer with this value

buffer:a buffer
cur:the node being read
Returns:0 in case of success and -1 in case of error.

Function: xmlNodeDump

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

Dump an XML node, recursive behaviour,children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

buf:the XML buffer output
doc:the document
cur:the current node
level:the imbrication level for indenting
format:is formatting allowed
Returns:the number of bytes written to the buffer or -1 in case of error

Function: xmlNodeDumpOutput

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

Dump an XML node, recursive behaviour, children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

buf:the XML buffer output
doc:the document
cur:the current node
level:the imbrication level for indenting
format:is formatting allowed
encoding:an optional encoding string

Function: xmlNodeGetBase

xmlChar *	xmlNodeGetBase		(xmlDocPtr doc, 
xmlNodePtr cur)

Searches for the BASE URL. The code should work on both XML and HTML document even if base mechanisms are completely different. It returns the base as defined in RFC 2396 sections 5.1.1. Base URI within Document Content and 5.1.2. Base URI from the Encapsulating Entity However it does not return the document base (5.1.3), use xmlDocumentGetBase() for this

doc:the document the node pertains to
cur:the node being checked
Returns:a pointer to the base URL, or NULL if not found It's up to the caller to free the memory with xmlFree().

Function: xmlNodeGetContent

xmlChar *	xmlNodeGetContent	(xmlNodePtr cur)

Read the value of a node, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted.

cur:the node being read
Returns:a new #xmlChar * or NULL if no content is available. It's up to the caller to free the memory with xmlFree().

Function: xmlNodeGetLang

xmlChar *	xmlNodeGetLang		(xmlNodePtr cur)

Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.

cur:the node being checked
Returns:a pointer to the lang value, or NULL if not found It's up to the caller to free the memory with xmlFree().

Function: xmlNodeGetSpacePreserve

int	xmlNodeGetSpacePreserve		(xmlNodePtr cur)

Searches the space preserving behaviour of a node, i.e. the values of the xml:space attribute or the one carried by the nearest ancestor.

cur:the node being checked
Returns:-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"

Function: xmlNodeIsText

int	xmlNodeIsText			(xmlNodePtr node)

Is this node a Text node ?

node:the node
Returns:1 yes, 0 no

Function: xmlNodeListGetRawString

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

Builds the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString() this function doesn't do any character encoding handling.

doc:the document
list:a Node list
inLine:should we replace entity contents or show their external form
Returns:a pointer to the string copy, the caller must free it with xmlFree().

Function: xmlNodeListGetString

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

Build the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs

doc:the document
list:a Node list
inLine:should we replace entity contents or show their external form
Returns:a pointer to the string copy, the caller must free it with xmlFree().

Function: xmlNodeSetBase

void	xmlNodeSetBase			(xmlNodePtr cur, 
const xmlChar * uri)

Set (or reset) the base URI of a node, i.e. the value of the xml:base attribute.

cur:the node being changed
uri:the new base URI

Function: xmlNodeSetContent

void	xmlNodeSetContent		(xmlNodePtr cur, 
const xmlChar * content)

Replace the content of a node.

cur:the node being modified
content:the new value of the content

Function: xmlNodeSetContentLen

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

Replace the content of a node.

cur:the node being modified
content:the new value of the content
len:the size of @content

Function: xmlNodeSetLang

void	xmlNodeSetLang			(xmlNodePtr cur, 
const xmlChar * lang)

Set the language of a node, i.e. the values of the xml:lang attribute.

cur:the node being changed
lang:the language description

Function: xmlNodeSetName

void	xmlNodeSetName			(xmlNodePtr cur, 
const xmlChar * name)

Set (or reset) the name of a node.

cur:the node being changed
name:the new tag name

Function: xmlNodeSetSpacePreserve

void	xmlNodeSetSpacePreserve		(xmlNodePtr cur, 
int val)

Set (or reset) the space preserving behaviour of a node, i.e. the value of the xml:space attribute.

cur:the node being changed
val:the xml:space value ("0": default, 1: "preserve")

Function: xmlReconciliateNs

int	xmlReconciliateNs		(xmlDocPtr doc, 
xmlNodePtr tree)

This function checks that all the namespaces declared within the given tree are properly declared. This is needed for example after Copy or Cut and then paste operations. The subtree may still hold pointers to namespace declarations outside the subtree or invalid/masked. As much as possible the function try to reuse the existing namespaces found in the new environment. If not possible the new namespaces are redeclared on @tree at the top of the given subtree.

doc:the document
tree:a node defining the subtree to reconciliate
Returns:the number of namespace declarations created or -1 in case of error.

Function: xmlRemoveProp

int	xmlRemoveProp			(xmlAttrPtr cur)

Unlink and free one attribute, all the content is freed too Note this doesn't work for namespace definition attributes

cur:an attribute
Returns:0 if success and -1 in case of error.

Function: xmlReplaceNode

xmlNodePtr	xmlReplaceNode		(xmlNodePtr old, 
xmlNodePtr cur)

Unlink the old node from its current context, prune the new one at the same place. If @cur was already inserted in a document it is first unlinked from its existing context.

old:the old node
cur:the node
Returns:the @old node

Function: xmlSaveFile

int	xmlSaveFile			(const char * filename, 
xmlDocPtr cur)

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used.

filename:the filename (or URL)
cur:the document
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFileEnc

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

Dump an XML document, converting it to the given encoding

filename:the filename (or URL)
cur:the document
encoding:the name of an encoding (or NULL)
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFileTo

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

Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.

buf:an output I/O buffer
cur:the document
encoding:the encoding if any assuming the I/O layer handles the trancoding
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFormatFile

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

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used. If @format is set then the document will be indented on output. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

filename:the filename (or URL)
cur:the document
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSaveFormatFileEnc

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

Dump an XML document to a file or an URL.

filename:the filename or URL to output
cur:the document being saved
encoding:the name of the encoding to use or NULL.
format:should formatting spaces be added.
Returns:the number of bytes written or -1 in case of error. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Function: xmlSaveFormatFileTo

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

Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.

buf:an output I/O buffer
cur:the document
encoding:the encoding if any assuming the I/O layer handles the trancoding
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure.

Function: xmlSearchNs

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

Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. @nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning is generated to cover this case.

doc:the document
node:the current node
nameSpace:the namespace prefix
Returns:the namespace pointer or NULL.

Function: xmlSearchNsByHref

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

Search a Ns aliasing a given URI. Recurse on the parents until it finds the defined namespace or return NULL otherwise.

doc:the document
node:the current node
href:the namespace value
Returns:the namespace pointer or NULL.

Function: xmlSetBufferAllocationScheme

void	xmlSetBufferAllocationScheme	(xmlBufferAllocationScheme scheme)

Set the buffer allocation method. Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance

scheme:allocation method to use

Function: xmlSetCompressMode

void	xmlSetCompressMode		(int mode)

set the default compression mode used, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

mode:the compression ratio

Function: xmlSetDocCompressMode

void	xmlSetDocCompressMode		(xmlDocPtr doc, 
int mode)

set the compression ratio for a document, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

doc:the document
mode:the compression ratio

Function: xmlSetListDoc

void	xmlSetListDoc			(xmlNodePtr list, 
xmlDocPtr doc)

update all nodes in the list to point to the right document

list:the first element
doc:the document

Function: xmlSetNs

void	xmlSetNs			(xmlNodePtr node, 
xmlNsPtr ns)

Associate a namespace to a node, a posteriori.

node:a node in the document
ns:a namespace pointer

Function: xmlSetNsProp

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

Set (or reset) an attribute carried by a node. The ns structure must be in scope, this is not checked

node:the node
ns:the namespace definition
name:the attribute name
value:the attribute value
Returns:the attribute pointer.

Function: xmlSetProp

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

Set (or reset) an attribute carried by a node. If @name has a prefix, then the corresponding namespace-binding will be used, if in scope; it is an error it there's no such ns-binding for the prefix in scope.

node:the node
name:the attribute name (a QName)
value:the attribute value
Returns:the attribute pointer.

Function: xmlSetTreeDoc

void	xmlSetTreeDoc			(xmlNodePtr tree, 
xmlDocPtr doc)

update all nodes under the tree to point to the right document

tree:the top element
doc:the document

Function: xmlSplitQName2

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

parse an XML qualified name string [NS 5] QName ::= (Prefix ':')? LocalPart [NS 6] Prefix ::= NCName [NS 7] LocalPart ::= NCName

name:the full QName
prefix:a xmlChar **
Returns:NULL if not a QName, otherwise the local part, and prefix is updated to get the Prefix if any.

Function: xmlSplitQName3

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

parse an XML qualified name string,i

name:the full QName
len:an int *
Returns:NULL if it is not a Qualified Name, otherwise, update len with the lenght in byte of the prefix and return a pointer to the start of the name without the prefix

Function: xmlStringGetNodeList

xmlNodePtr	xmlStringGetNodeList	(xmlDocPtr doc, 
const xmlChar * value)

Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

doc:the document
value:the value of the attribute
Returns:a pointer to the first child

Function: xmlStringLenGetNodeList

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

Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

doc:the document
value:the value of the text
len:the length of the string value
Returns:a pointer to the first child

Function: xmlTextConcat

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

Concat the given string at the end of the existing node content

node:the node
content:the content
len:@content length
Returns:-1 in case of error, 0 otherwise

Function: xmlTextMerge

xmlNodePtr	xmlTextMerge		(xmlNodePtr first, 
xmlNodePtr second)

Merge two text nodes into one

first:the first text node
second:the second text node being merged
Returns:the first text node augmented

Function: xmlUnlinkNode

void	xmlUnlinkNode			(xmlNodePtr cur)

Unlink a node from it's current context, the node is not freed

cur:the node

Function: xmlUnsetNsProp

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

Remove an attribute carried by a node.

node:the node
ns:the namespace definition
name:the attribute name
Returns:0 if successful, -1 if not found

Function: xmlUnsetProp

int	xmlUnsetProp			(xmlNodePtr node, 
const xmlChar * name)

Remove an attribute carried by a node. This handles only attributes in no namespace.

node:the node
name:the attribute name
Returns:0 if successful, -1 if not found

Function: xmlValidateNCName

int	xmlValidateNCName		(const xmlChar * value, 
int space)

Check that a value conforms to the lexical space of NCName

value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlValidateNMToken

int	xmlValidateNMToken		(const xmlChar * value, 
int space)

Check that a value conforms to the lexical space of NMToken

value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlValidateName

int	xmlValidateName			(const xmlChar * value, 
int space)

Check that a value conforms to the lexical space of Name

value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.

Function: xmlValidateQName

int	xmlValidateQName		(const xmlChar * value, 
int space)

Check that a value conforms to the lexical space of QName

value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.

Daniel Veillard