--- embedaddon/libxml2/doc/html/libxml-tree.html 2012/02/21 23:37:59 1.1.1.1 +++ embedaddon/libxml2/doc/html/libxml-tree.html 2013/07/22 01:22:26 1.1.1.2 @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underli Module tree from libxml2
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 + Module tree from libxml2
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
@@ -75,6 +75,7 @@ A:link, A:visited, A:active { text-decoration: underli
 
xmlBufferPtr	xmlBufferCreate		(void)
xmlBufferPtr	xmlBufferCreateSize	(size_t size)
xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
size_t size)
+
xmlChar *	xmlBufferDetach		(xmlBufferPtr buf)
int	xmlBufferDump			(FILE * file, 
xmlBufferPtr buf)
void	xmlBufferEmpty			(xmlBufferPtr buf)
void	xmlBufferFree			(xmlBufferPtr buf)
@@ -289,6 +290,7 @@ A:link, A:visited, A:active { text-decoration: underli XML_BUFFER_ALLOC_EXACT = 2 : grow only to the minimal size XML_BUFFER_ALLOC_IMMUTABLE = 3 : immutable buffer XML_BUFFER_ALLOC_IO = 4 : special allocation scheme used for I/O + XML_BUFFER_ALLOC_HYBRID = 5 : exact up to a threshold, and doubleit thereafter }

Structure xmlDOMWrapCtxt

Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt { void * _private : * The type of this context, just in case @@ -568,6 +570,7 @@ A:link, A:visited, A:active { text-decoration: underli int nodeInfoNr : Depth of the parsing stack int nodeInfoMax : Max depth of the parsing stack xmlParserNodeInfo * nodeInfoTab : array of nodeInfos + int input_id : we need to label inputs }

Structure xmlParserInput

Structure xmlParserInput
struct _xmlParserInput { xmlParserInputBufferPtr buf : UTF-8 encoded buffer const char * filename : The file analyzed, if any @@ -666,7 +669,9 @@ A:link, A:visited, A:active { text-decoration: underli

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)
+
mem:the memory area
size:the size in byte
Returns:the new structure.

Function: xmlBufferDetach

xmlChar *	xmlBufferDetach		(xmlBufferPtr buf)
+

Remove the string contained in a buffer and gie it back to the caller. The buffer is reset to an empty content. This doesn't work with immutable buffers as they can't be reset.

+
buf:the buffer
Returns:the previous string contained by the buffer.

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.

@@ -766,7 +771,7 @@ A:link, A:visited, A:active { text-decoration: underli
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

+

Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance XML_BUFFER_ALLOC_HYBRID - use exact sizes on small strings to keep memory usage tight in normal usage, and doubleit on large strings to avoid pathological 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)
@@ -942,7 +947,7 @@ A:link, A:visited, A:active { text-decoration: underli
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

+

Unlink a node from it's current context, the node is not freed If one need to free the node, use xmlFreeNode() routine after the unlink to discard it.

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)