From 7300193becde71a344c8ac0973dc290fa24d800d Mon Sep 17 00:00:00 2001 From: Raphaël Hertzog Date: Tue, 25 Aug 2015 21:55:54 +0200 Subject: Imported Upstream version 2.9.1+dfsg1 --- doc/devhelp/libxml2-tree.html | 146 +++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 73 deletions(-) (limited to 'doc/devhelp/libxml2-tree.html') diff --git a/doc/devhelp/libxml2-tree.html b/doc/devhelp/libxml2-tree.html index 3cc28c7..90c3903 100644 --- a/doc/devhelp/libxml2-tree.html +++ b/doc/devhelp/libxml2-tree.html @@ -105,14 +105,14 @@ typedef struct _xmlDtd xmlDtd; typedef struct _xmlAttribute xmlAttribute; typedef xmlOutputBuffer * xmlOutputBufferPtr; typedef xmlSAXHandler * xmlSAXHandlerPtr; -xmlNodePtr xmlDocCopyNode (xmlNodePtr node,
xmlDocPtr doc,
int extended); +xmlNodePtr xmlDocCopyNode (const xmlNodePtr node,
xmlDocPtr doc,
int extended); xmlNodePtr xmlNewDocRawNode (xmlDocPtr doc,
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content); -xmlChar * xmlBufContent (const xmlBuf * buf); +xmlChar * xmlBufContent (const xmlBufPtr buf); xmlAttrPtr xmlNewNsPropEatName (xmlNodePtr node,
xmlNsPtr ns,
xmlChar * name,
const xmlChar * value); -xmlNodePtr xmlStringGetNodeList (const xmlDoc * doc,
const xmlChar * value); +xmlNodePtr xmlStringGetNodeList (xmlDocPtr doc,
const xmlChar * value); xmlNodePtr xmlNewCDataBlock (xmlDocPtr doc,
const xmlChar * content,
int len); void xmlBufferWriteCHAR (xmlBufferPtr buf,
const xmlChar * string); -xmlChar * xmlNodeGetBase (const xmlDoc * doc,
const xmlNode * cur); +xmlChar * xmlNodeGetBase (xmlDocPtr doc,
xmlNodePtr cur); void xmlBufferEmpty (xmlBufferPtr buf); xmlChar * xmlBuildQName (const xmlChar * ncname,
const xmlChar * prefix,
xmlChar * memory,
int len); int xmlValidateNMToken (const xmlChar * value,
int space); @@ -120,12 +120,12 @@ int xmlSaveFormatFileEnc (const char * file xmlNodePtr xmlAddSibling (xmlNodePtr cur,
xmlNodePtr elem); xmlBufferPtr xmlBufferCreate (void); xmlNodePtr xmlNewDocFragment (xmlDocPtr doc); -xmlNodePtr xmlDocGetRootElement (const xmlDoc * doc); -xmlChar * xmlGetProp (const xmlNode * node,
const xmlChar * name); +xmlNodePtr xmlDocGetRootElement (xmlDocPtr doc); +xmlChar * xmlGetProp (xmlNodePtr node,
const xmlChar * name); int xmlValidateName (const xmlChar * value,
int space); -xmlChar * xmlBufEnd (xmlBufPtr buf); +xmlChar * xmlBufEnd (const xmlBufPtr buf); int xmlValidateQName (const xmlChar * value,
int space); -xmlAttrPtr xmlHasNsProp (const xmlNode * node,
const xmlChar * name,
const xmlChar * nameSpace); +xmlAttrPtr xmlHasNsProp (xmlNodePtr node,
const xmlChar * name,
const xmlChar * nameSpace); xmlNodePtr xmlAddPrevSibling (xmlNodePtr cur,
xmlNodePtr elem); int xmlBufferAddHead (xmlBufferPtr buf,
const xmlChar * str,
int len); xmlNodePtr xmlNewPI (const xmlChar * name,
const xmlChar * content); @@ -134,8 +134,8 @@ void xmlDocDumpFormatMemoryEnc (xmlChildElementCount (xmlNodePtr parent); void xmlElemDump (FILE * f,
xmlDocPtr doc,
xmlNodePtr cur); int xmlSaveFormatFileTo (xmlOutputBufferPtr buf,
xmlDocPtr cur,
const char * encoding,
int format); -xmlDtdPtr xmlGetIntSubset (const xmlDoc * doc); -int xmlNodeBufGetContent (xmlBufferPtr buffer,
const xmlNode * cur); +xmlDtdPtr xmlGetIntSubset (xmlDocPtr doc); +int xmlNodeBufGetContent (xmlBufferPtr buffer,
xmlNodePtr cur); xmlNodePtr xmlNextElementSibling (xmlNodePtr node); void xmlBufferWriteChar (xmlBufferPtr buf,
const char * string); void xmlBufferFree (xmlBufferPtr buf); @@ -156,38 +156,38 @@ int xmlValidateNCName (const xmlGetCompressMode (void); int xmlNodeDump (xmlBufferPtr buf,
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format); xmlBufferPtr xmlBufferCreateSize (size_t size); -xmlChar * xmlNodeListGetString (xmlDocPtr doc,
const xmlNode * list,
int inLine); +xmlChar * xmlNodeListGetString (xmlDocPtr doc,
xmlNodePtr list,
int inLine); void xmlSetCompressMode (int mode); void xmlSetTreeDoc (xmlNodePtr tree,
xmlDocPtr doc); int xmlDOMWrapAdoptNode (xmlDOMWrapCtxtPtr ctxt,
xmlDocPtr sourceDoc,
xmlNodePtr node,
xmlDocPtr destDoc,
xmlNodePtr destParent,
int options); -xmlNodePtr xmlCopyNodeList (xmlNodePtr node); +xmlNodePtr xmlCopyNodeList (const xmlNodePtr node); xmlNodePtr xmlNewDocNodeEatName (xmlDocPtr doc,
xmlNsPtr ns,
xmlChar * name,
const xmlChar * content); xmlNodePtr xmlAddChildList (xmlNodePtr parent,
xmlNodePtr cur); -xmlChar * xmlGetNodePath (const xmlNode * node); +xmlChar * xmlGetNodePath (xmlNodePtr node); void xmlFreePropList (xmlAttrPtr cur); void xmlNodeAddContent (xmlNodePtr cur,
const xmlChar * content); int xmlUnsetNsProp (xmlNodePtr node,
xmlNsPtr ns,
const xmlChar * name); xmlNodePtr xmlFirstElementChild (xmlNodePtr parent); xmlNodePtr xmlAddNextSibling (xmlNodePtr cur,
xmlNodePtr elem); -int xmlIsBlankNode (const xmlNode * node); +int xmlIsBlankNode (xmlNodePtr node); xmlNsPtr xmlNewGlobalNs (xmlDocPtr doc,
const xmlChar * href,
const xmlChar * prefix); int xmlBufferDump (FILE * file,
xmlBufferPtr buf); -xmlChar * xmlNodeGetContent (const xmlNode * cur); +xmlChar * xmlNodeGetContent (xmlNodePtr cur); xmlDocPtr xmlCopyDoc (xmlDocPtr doc,
int recursive); xmlDOMWrapCtxtPtr xmlDOMWrapNewCtxt (void); void xmlDocDumpMemoryEnc (xmlDocPtr out_doc,
xmlChar ** doc_txt_ptr,
int * doc_txt_len,
const char * txt_encoding); -int xmlBufGetNodeContent (xmlBufPtr buf,
const xmlNode * cur); +int xmlBufGetNodeContent (xmlBufPtr buf,
xmlNodePtr cur); xmlNodePtr xmlTextMerge (xmlNodePtr first,
xmlNodePtr second); void xmlDocDumpMemory (xmlDocPtr cur,
xmlChar ** mem,
int * size); xmlNodePtr xmlNewDocPI (xmlDocPtr doc,
const xmlChar * name,
const xmlChar * content); void xmlFreeNs (xmlNsPtr cur); int xmlDocDump (FILE * f,
xmlDocPtr cur); void xmlFreeProp (xmlAttrPtr cur); -xmlChar * xmlGetNoNsProp (const xmlNode * node,
const xmlChar * name); +xmlChar * xmlGetNoNsProp (xmlNodePtr node,
const xmlChar * name); xmlChar * xmlSplitQName2 (const xmlChar * name,
xmlChar ** prefix); xmlAttrPtr xmlNewProp (xmlNodePtr node,
const xmlChar * name,
const xmlChar * value); int xmlTextConcat (xmlNodePtr node,
const xmlChar * content,
int len); -int xmlNodeGetSpacePreserve (const xmlNode * cur); +int xmlNodeGetSpacePreserve (xmlNodePtr cur); int xmlBufferShrink (xmlBufferPtr buf,
unsigned int len); xmlNodePtr xmlPreviousElementSibling (xmlNodePtr node); void xmlNodeSetContentLen (xmlNodePtr cur,
const xmlChar * content,
int len); @@ -196,20 +196,20 @@ void xmlBufferWriteQuotedString (xmlAttrPtr xmlCopyProp (xmlNodePtr target,
xmlAttrPtr cur); xmlNodePtr xmlReplaceNode (xmlNodePtr old,
xmlNodePtr cur); void xmlSetDocCompressMode (xmlDocPtr doc,
int mode); -xmlNodePtr xmlCopyNode (xmlNodePtr node,
int extended); +xmlNodePtr xmlCopyNode (const xmlNodePtr node,
int extended); void xmlUnlinkNode (xmlNodePtr cur); const xmlChar * xmlSplitQName3 (const xmlChar * name,
int * len); typedef xmlNsPtr xmlDOMWrapAcquireNsFunction (xmlDOMWrapCtxtPtr ctxt,
xmlNodePtr node,
const xmlChar * nsName,
const xmlChar * nsPrefix); size_t xmlBufUse (const xmlBufPtr buf); xmlNodePtr xmlDocSetRootElement (xmlDocPtr doc,
xmlNodePtr root); -long xmlGetLineNo (const xmlNode * node); -const xmlChar * xmlBufferContent (const xmlBuffer * buf); +long xmlGetLineNo (xmlNodePtr node); +const xmlChar * xmlBufferContent (const xmlBufferPtr buf); int xmlRemoveProp (xmlAttrPtr cur); xmlNodePtr xmlLastElementChild (xmlNodePtr parent); -xmlChar * xmlNodeGetLang (const xmlNode * cur); -int xmlGetDocCompressMode (const xmlDoc * doc); +xmlChar * xmlNodeGetLang (xmlNodePtr cur); +int xmlGetDocCompressMode (xmlDocPtr doc); size_t xmlBufNodeDump (xmlBufPtr buf,
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format); -xmlChar * xmlGetNsProp (const xmlNode * node,
const xmlChar * name,
const xmlChar * nameSpace); +xmlChar * xmlGetNsProp (xmlNodePtr node,
const xmlChar * name,
const xmlChar * nameSpace); xmlAttrPtr xmlNewDocProp (xmlDocPtr doc,
const xmlChar * name,
const xmlChar * value); void xmlFreeNode (xmlNodePtr cur); xmlAttrPtr xmlNewNsProp (xmlNodePtr node,
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * value); @@ -218,12 +218,12 @@ void xmlDOMWrapFreeCtxt (xmlBufferSetAllocationScheme (xmlBufferPtr buf,
xmlBufferAllocationScheme scheme); xmlNodePtr xmlNewChild (xmlNodePtr parent,
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content); xmlNsPtr xmlSearchNs (xmlDocPtr doc,
xmlNodePtr node,
const xmlChar * nameSpace); -xmlNodePtr xmlStringLenGetNodeList (const xmlDoc * doc,
const xmlChar * value,
int len); +xmlNodePtr xmlStringLenGetNodeList (xmlDocPtr doc,
const xmlChar * value,
int len); int xmlSaveFormatFile (const char * filename,
xmlDocPtr cur,
int format); xmlAttrPtr xmlCopyPropList (xmlNodePtr target,
xmlAttrPtr cur); int xmlDocFormatDump (FILE * f,
xmlDocPtr cur,
int format); void xmlNodeSetSpacePreserve (xmlNodePtr cur,
int val); -xmlAttrPtr xmlHasProp (const xmlNode * node,
const xmlChar * name); +xmlAttrPtr xmlHasProp (xmlNodePtr node,
const xmlChar * name); int xmlBufferCat (xmlBufferPtr buf,
const xmlChar * str); xmlDtdPtr xmlCreateIntSubset (xmlDocPtr doc,
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID); xmlDocPtr xmlNewDoc (const xmlChar * version); @@ -233,26 +233,26 @@ int xmlBufferCat (xmlBufferResize (xmlBufferPtr buf,
unsigned int size); void xmlNodeSetBase (xmlNodePtr cur,
const xmlChar * uri); xmlNodePtr xmlNewComment (const xmlChar * content); -int xmlBufferLength (const xmlBuffer * buf); +int xmlBufferLength (const xmlBufferPtr buf); xmlNodePtr xmlNewText (const xmlChar * content); int xmlUnsetProp (xmlNodePtr node,
const xmlChar * name); xmlBufferAllocationScheme xmlGetBufferAllocationScheme (void); int xmlSaveFile (const char * filename,
xmlDocPtr cur); -xmlNodePtr xmlDocCopyNodeList (xmlDocPtr doc,
xmlNodePtr node); +xmlNodePtr xmlDocCopyNodeList (xmlDocPtr doc,
const xmlNodePtr node); void xmlSetNs (xmlNodePtr node,
xmlNsPtr ns); xmlNsPtr xmlNewNs (xmlNodePtr node,
const xmlChar * href,
const xmlChar * prefix); int xmlDOMWrapRemoveNode (xmlDOMWrapCtxtPtr ctxt,
xmlDocPtr doc,
xmlNodePtr node,
int options); void xmlAttrSerializeTxtContent (xmlBufferPtr buf,
xmlDocPtr doc,
xmlAttrPtr attr,
const xmlChar * string); xmlDtdPtr xmlCopyDtd (xmlDtdPtr dtd); -xmlNodePtr xmlNewDocText (const xmlDoc * doc,
const xmlChar * content); -xmlChar * xmlNodeListGetRawString (const xmlDoc * doc,
const xmlNode * list,
int inLine); +xmlNodePtr xmlNewDocText (xmlDocPtr doc,
const xmlChar * content); +xmlChar * xmlNodeListGetRawString (xmlDocPtr doc,
xmlNodePtr list,
int inLine); xmlBufferPtr xmlBufferCreateStatic (void * mem,
size_t size); -xmlNodePtr xmlNewReference (const xmlDoc * doc,
const xmlChar * name); +xmlNodePtr xmlNewReference (xmlDocPtr doc,
const xmlChar * name); int xmlDOMWrapReconcileNamespaces (xmlDOMWrapCtxtPtr ctxt,
xmlNodePtr elem,
int options); int xmlBufferCCat (xmlBufferPtr buf,
const char * str); -xmlNsPtr * xmlGetNsList (const xmlDoc * doc,
const xmlNode * node); +xmlNsPtr * xmlGetNsList (xmlDocPtr doc,
xmlNodePtr node); int xmlBufferGrow (xmlBufferPtr buf,
unsigned int len); -int xmlNodeIsText (const xmlNode * node); +int xmlNodeIsText (xmlNodePtr node); void xmlSetBufferAllocationScheme (xmlBufferAllocationScheme scheme); int xmlIsXHTML (const xmlChar * systemID,
const xmlChar * publicID); void xmlNodeSetLang (xmlNodePtr cur,
const xmlChar * lang); @@ -269,7 +269,7 @@ void xmlNodeSetName (xmlNodePtr xmlNewDocTextLen (xmlDocPtr doc,
const xmlChar * content,
int len); xmlDtdPtr xmlNewDtd (xmlDocPtr doc,
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID); void xmlFreeNsList (xmlNsPtr cur); -xmlNodePtr xmlGetLastChild (const xmlNode * parent); +xmlNodePtr xmlGetLastChild (xmlNodePtr parent);
@@ -615,7 +615,7 @@ The content of this structure is not made public by the API. 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 also used to count entities * + int checked : was the entity content checked this is also used to count entites * r } xmlEntity;

@@ -959,16 +959,16 @@ The content of this structure is not made public by the API.

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
-

xmlBufContent ()

xmlChar *	xmlBufContent		(const xmlBuf * buf)

+        
xmlBufContent ()
xmlChar *	xmlBufContent		(const xmlBufPtr buf)

 
Function to extract the content of a buffer

 
buf:the buffer
Returns:the internal content

         

-        
xmlBufEnd ()
xmlChar *	xmlBufEnd		(xmlBufPtr buf)

+        
xmlBufEnd ()
xmlChar *	xmlBufEnd		(const xmlBufPtr buf)

 
Function to extract the end of the content of a buffer

 
buf:the buffer
Returns:the end of the internal content or NULL in case of error

         

-        
xmlBufGetNodeContent ()
int	xmlBufGetNodeContent		(xmlBufPtr buf, 
					 const xmlNode * 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 @buf with this value

+        
xmlBufGetNodeContent ()
int	xmlBufGetNodeContent		(xmlBufPtr buf, 
					 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

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

         

         
xmlBufNodeDump ()
size_t	xmlBufNodeDump			(xmlBufPtr buf, 
					 xmlDocPtr doc, 
					 xmlNodePtr cur, 
					 int level, 
					 int format)

@@ -999,7 +999,7 @@ The content of this structure is not made public by the API.
 
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.

         

-        
xmlBufferContent ()
const xmlChar *	xmlBufferContent	(const xmlBuffer * buf)

+        
xmlBufferContent ()
const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

 
Function to extract the content of a buffer

 
buf:the buffer
Returns:the internal content

         

@@ -1035,7 +1035,7 @@ The content of this structure is not made public by the API.
 
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

         

-        
xmlBufferLength ()
int	xmlBufferLength			(const xmlBuffer * buf)

+        
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

         

@@ -1087,11 +1087,11 @@ The content of this structure is not made public by the API.
 
Do a copy of an namespace list.

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

         

-        
xmlCopyNode ()
xmlNodePtr	xmlCopyNode		(xmlNodePtr node, 
					 int extended)

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

         

-        
xmlCopyNodeList ()
xmlNodePtr	xmlCopyNodeList		(xmlNodePtr node)

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

         

@@ -1108,7 +1108,7 @@ The content of this structure is not made public by the API.
 
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

         

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

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

         

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

@@ -1121,7 +1121,7 @@ The content of this structure is not made public by the API.
         

         
xmlDOMWrapNewCtxt ()
xmlDOMWrapCtxtPtr	xmlDOMWrapNewCtxt	(void)

 
Allocates and initializes a new DOM-wrapper context.

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

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

         

         
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.

@@ -1131,11 +1131,11 @@ The content of this structure is not made public by the API.
 
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.

         

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

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

         

-        
xmlDocCopyNodeList ()
xmlNodePtr	xmlDocCopyNodeList	(xmlDocPtr doc, 
					 xmlNodePtr node)

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

         

@@ -1163,7 +1163,7 @@ The content of this structure is not made public by the API.
 
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

         

-        
xmlDocGetRootElement ()
xmlNodePtr	xmlDocGetRootElement	(const xmlDoc * doc)

+        
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

         

@@ -1219,51 +1219,51 @@ The content of this structure is not made public by the API.
 
get the default compression mode used, ZLIB based.

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

         

-        
xmlGetDocCompressMode ()
int	xmlGetDocCompressMode		(const xmlDoc * doc)

+        
xmlGetDocCompressMode ()
int	xmlGetDocCompressMode		(xmlDocPtr doc)

 
get the compression ratio for a document, ZLIB based

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

         

-        
xmlGetIntSubset ()
xmlDtdPtr	xmlGetIntSubset		(const xmlDoc * doc)

+        
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

         

-        
xmlGetLastChild ()
xmlNodePtr	xmlGetLastChild		(const xmlNode * parent)

+        
xmlGetLastChild ()
xmlNodePtr	xmlGetLastChild		(xmlNodePtr parent)

 
Search the last child of a node.

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

         

-        
xmlGetLineNo ()
long	xmlGetLineNo			(const xmlNode * node)

+        
xmlGetLineNo ()
long	xmlGetLineNo			(xmlNodePtr node)

 
Get line number of @node. Try to override the limitation of lines being store in 16 bits ints if XML_PARSE_BIG_LINES parser option was used

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

         

-        
xmlGetNoNsProp ()
xmlChar *	xmlGetNoNsProp		(const xmlNode * node, 
					 const xmlChar * name)

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

         

-        
xmlGetNodePath ()
xmlChar *	xmlGetNodePath		(const xmlNode * node)

+        
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

         

-        
xmlGetNsList ()
xmlNsPtr *	xmlGetNsList		(const xmlDoc * doc, 
					 const xmlNode * node)

+        
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

         

-        
xmlGetNsProp ()
xmlChar *	xmlGetNsProp		(const xmlNode * node, 
					 const xmlChar * name, 
					 const xmlChar * nameSpace)

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

         

-        
xmlGetProp ()
xmlChar *	xmlGetProp		(const xmlNode * node, 
					 const xmlChar * name)

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

         

-        
xmlHasNsProp ()
xmlAttrPtr	xmlHasNsProp		(const xmlNode * node, 
					 const xmlChar * name, 
					 const xmlChar * nameSpace)

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

         

-        
xmlHasProp ()
xmlAttrPtr	xmlHasProp		(const xmlNode * node, 
					 const xmlChar * name)

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

         

-        
xmlIsBlankNode ()
int	xmlIsBlankNode			(const xmlNode * node)

+        
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

         

@@ -1323,7 +1323,7 @@ The content of this structure is not made public by the API.
 
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.

         

-        
xmlNewDocText ()
xmlNodePtr	xmlNewDocText		(const xmlDoc * doc, 
					 const xmlChar * content)

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

         

@@ -1348,7 +1348,7 @@ The content of this structure is not made public by the API.
 
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.

         

         
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. Note that for a default namespace, @prefix should be NULL. We use href==NULL in the case of an element creation where the namespace was not defined.

+
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

         

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

@@ -1367,7 +1367,7 @@ The content of this structure is not made public by the API.
 
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

         

-        
xmlNewReference ()
xmlNodePtr	xmlNewReference		(const xmlDoc * doc, 
					 const xmlChar * name)

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

         

@@ -1395,7 +1395,7 @@ The content of this structure is not made public by the API.
 
Append the extra substring to the node content. NOTE: In contrast to xmlNodeSetContentLen(), @content is supposed to be raw text, so unescaped XML special chars are allowed, entity references are not supported.

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

         

-        
xmlNodeBufGetContent ()
int	xmlNodeBufGetContent		(xmlBufferPtr buffer, 
					 const xmlNode * cur)

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

         

@@ -1407,31 +1407,31 @@ The content of this structure is not made public by the API.
 
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

         

-        
xmlNodeGetBase ()
xmlChar *	xmlNodeGetBase		(const xmlDoc * doc, 
					 const xmlNode * cur)

+        
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 doc->URL in this case

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

         

-        
xmlNodeGetContent ()
xmlChar *	xmlNodeGetContent	(const xmlNode * cur)

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

         

-        
xmlNodeGetLang ()
xmlChar *	xmlNodeGetLang		(const xmlNode * cur)

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

         

-        
xmlNodeGetSpacePreserve ()
int	xmlNodeGetSpacePreserve		(const xmlNode * cur)

+        
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"

         

-        
xmlNodeIsText ()
int	xmlNodeIsText			(const xmlNode * node)

+        
xmlNodeIsText ()
int	xmlNodeIsText			(xmlNodePtr node)

 
Is this node a Text node ?

 
node:the node
Returns:1 yes, 0 no

         

-        
xmlNodeListGetRawString ()
xmlChar *	xmlNodeListGetRawString	(const xmlDoc * doc, 
					 const xmlNode * list, 
					 int inLine)

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

         

-        
xmlNodeListGetString ()
xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
					 const xmlNode * list, 
					 int inLine)

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

         

@@ -1547,11 +1547,11 @@ The content of this structure is not made public by the API.
 
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 length in byte of the prefix and return a pointer to the start of the name without the prefix

         

-        
xmlStringGetNodeList ()
xmlNodePtr	xmlStringGetNodeList	(const xmlDoc * doc, 
					 const xmlChar * value)

+        
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

         

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

+        
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

         

-- 
cgit v1.2.3