From 07a67fa4bcc1b8bf2651ab41e5fc54a05059cf7e Mon Sep 17 00:00:00 2001 From: Mike Hommey Date: Sat, 29 Apr 2006 21:57:40 +0200 Subject: Load /tmp/libxml2-2.6.24 into libxml2/branches/upstream/current. --- doc/html/libxml-tree.html | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) (limited to 'doc/html/libxml-tree.html') diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html index af8fefc..9e45be1 100644 --- a/doc/html/libxml-tree.html +++ b/doc/html/libxml-tree.html @@ -10,7 +10,7 @@ A:link, A:visited, A:active { text-decoration: underline } 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
@@ -96,6 +96,7 @@ A:link, A:visited, A:active { text-decoration: underline }
 
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)
@@ -674,8 +675,10 @@ A:link, A:visited, A:active { text-decoration: underline }
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)
-

Ensures that ns-references point to @destDoc: either to elements->nsDef entries if @destParent is given, or to @destDoc->oldNs otherwise. 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 succeeded, -1 otherwise and on API/internal errors.

Function: xmlDOMWrapFreeCtxt

void	xmlDOMWrapFreeCtxt		(xmlDOMWrapCtxtPtr ctxt)
+

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.

@@ -874,10 +877,10 @@ A:link, A:visited, A:active { text-decoration: underline }
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.

+

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.

-
node:the node
name:the attribute name
value:the attribute value
Returns:the attribute pointer.

Function: xmlSetTreeDoc

void	xmlSetTreeDoc			(xmlNodePtr tree, 
xmlDocPtr doc)
+

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

@@ -896,7 +899,7 @@ A:link, A:visited, A:active { text-decoration: underline }
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.

+

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)
-- cgit v1.2.3