summaryrefslogtreecommitdiff
path: root/doc/libxml2-api.xml
diff options
context:
space:
mode:
authorMike Hommey <glandium@debian.org>2006-04-29 21:57:40 +0200
committerMike Hommey <glandium@debian.org>2006-04-29 21:57:40 +0200
commit07a67fa4bcc1b8bf2651ab41e5fc54a05059cf7e (patch)
tree7b377fd8e804a983cb2c57a43be1093ef179c5fd /doc/libxml2-api.xml
parentc5d565931c4823dc8f62fffcb65aecfec516f7b9 (diff)
downloadlibxml2-07a67fa4bcc1b8bf2651ab41e5fc54a05059cf7e.tar.gz
Load /tmp/libxml2-2.6.24 intoupstream/2.6.24.dfsg
libxml2/branches/upstream/current.
Diffstat (limited to 'doc/libxml2-api.xml')
-rw-r--r--doc/libxml2-api.xml55
1 files changed, 38 insertions, 17 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml
index 088d0ae..1affb28 100644
--- a/doc/libxml2-api.xml
+++ b/doc/libxml2-api.xml
@@ -1079,6 +1079,7 @@
<exports symbol='xmlRelaxNGDump' type='function'/>
<exports symbol='xmlRelaxNGSetParserErrors' type='function'/>
<exports symbol='xmlRelaxNGParse' type='function'/>
+ <exports symbol='xmlRelaxNGSetParserStructuredErrors' type='function'/>
<exports symbol='xmlRelaxNGValidateFullElement' type='function'/>
<exports symbol='xmlRelaxNGValidityErrorFunc' type='function'/>
<exports symbol='xmlRelaxNGValidatePushElement' type='function'/>
@@ -1530,6 +1531,7 @@
<exports symbol='xmlNodeBufGetContent' type='function'/>
<exports symbol='xmlBufferWriteChar' type='function'/>
<exports symbol='xmlBufferFree' type='function'/>
+ <exports symbol='xmlDOMWrapCloneNode' type='function'/>
<exports symbol='xmlNewNode' type='function'/>
<exports symbol='xmlSaveFileTo' type='function'/>
<exports symbol='xmlNewTextLen' type='function'/>
@@ -5845,8 +5847,8 @@ if necessary or NULL'/>
<struct name='xmlChRangeGroup' file='chvalid' type='struct _xmlChRangeGroup'>
<field name='nbShortRange' type='int' info=''/>
<field name='nbLongRange' type='int' info=''/>
- <field name='shortRange' type='xmlChSRangePtr' info=' points to an array of ranges'/>
- <field name='longRange' type='xmlChLRangePtr' info=''/>
+ <field name='shortRange' type='const xmlChSRange *' info=' points to an array of ranges'/>
+ <field name='longRange' type='const xmlChLRange *' info=''/>
</struct>
<typedef name='xmlChRangeGroupPtr' file='chvalid' type='xmlChRangeGroup *'/>
<struct name='xmlChSRange' file='chvalid' type='struct _xmlChSRange'>
@@ -6746,13 +6748,13 @@ Could we use @subtypes for this?'/>
<variable name='xmlGenericErrorContext' file='globals' type='void *'/>
<variable name='xmlGetWarningsDefaultValue' file='globals' type='int'/>
<variable name='xmlIndentTreeOutput' file='globals' type='int'/>
- <variable name='xmlIsBaseCharGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsCharGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsCombiningGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsDigitGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsExtenderGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsIdeographicGroup' file='chvalid' type='xmlChRangeGroup'/>
- <variable name='xmlIsPubidChar_tab' file='chvalid' type='unsigned charxmlIsPubidChar_tab[256]'/>
+ <variable name='xmlIsBaseCharGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsCharGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsCombiningGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsDigitGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsExtenderGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsIdeographicGroup' file='chvalid' type='const xmlChRangeGroup'/>
+ <variable name='xmlIsPubidChar_tab' file='chvalid' type='const unsigned charxmlIsPubidChar_tab[256]'/>
<variable name='xmlKeepBlanksDefaultValue' file='globals' type='int'/>
<variable name='xmlLastError' file='globals' type='xmlError'/>
<variable name='xmlLineNumbersDefaultValue' file='globals' type='int'/>
@@ -8680,7 +8682,7 @@ Could we use @subtypes for this?'/>
<info>Does a binary search of the range table to determine if char is valid</info>
<return type='int' info='true if character valid, false otherwise'/>
<arg name='val' type='unsigned int' info='character to be validated'/>
- <arg name='rptr' type='const xmlChRangeGroupPtr' info='pointer to range to be used to validate'/>
+ <arg name='rptr' type='const xmlChRangeGroup *' info='pointer to range to be used to validate'/>
</function>
<function name='xmlCharStrdup' file='xmlstring' module='xmlstring'>
<info>a strdup for char&apos;s to xmlChar&apos;s</info>
@@ -9033,13 +9035,25 @@ Could we use @subtypes for this?'/>
<arg name='len' type='int *' info='pointer to the length of the char read'/>
</function>
<function name='xmlDOMWrapAdoptNode' file='tree' module='tree'>
- <info>Ensures that ns-references point to @destDoc: either to elements-&gt;nsDef entries if @destParent is given, or to @destDoc-&gt;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.</info>
- <return type='int' info='0 if succeeded, -1 otherwise and on API/internal errors.'/>
+ <info>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-&gt;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.</info>
+ <return type='int' info='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.'/>
+ <arg name='ctxt' type='xmlDOMWrapCtxtPtr' info='the optional context for custom processing'/>
+ <arg name='sourceDoc' type='xmlDocPtr' info='the optional sourceDoc'/>
+ <arg name='node' type='xmlNodePtr' info='the node to start with'/>
+ <arg name='destDoc' type='xmlDocPtr' info='the destination doc'/>
+ <arg name='destParent' type='xmlNodePtr' info='the optional new parent of @node in @destDoc'/>
+ <arg name='options' type='int' info='option flags'/>
+ </function>
+ <function name='xmlDOMWrapCloneNode' file='tree' module='tree'>
+ <info>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-&gt;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.</info>
+ <return type='int' info='0 if the operation succeeded, 1 if a node of unsupported (or not yet supported) type was given, -1 on API/internal errors.'/>
<arg name='ctxt' type='xmlDOMWrapCtxtPtr' info='the optional context for custom processing'/>
<arg name='sourceDoc' type='xmlDocPtr' info='the optional sourceDoc'/>
<arg name='node' type='xmlNodePtr' info='the node to start with'/>
+ <arg name='resNode' type='xmlNodePtr *' info='the clone of the given @node'/>
<arg name='destDoc' type='xmlDocPtr' info='the destination doc'/>
<arg name='destParent' type='xmlNodePtr' info='the optional new parent of @node in @destDoc'/>
+ <arg name='deep' type='int' info='descend into child if set'/>
<arg name='options' type='int' info='option flags'/>
</function>
<function name='xmlDOMWrapFreeCtxt' file='tree' module='tree'>
@@ -12677,6 +12691,14 @@ Could we use @subtypes for this?'/>
<arg name='warn' type='xmlRelaxNGValidityWarningFunc' info='the warning callback'/>
<arg name='ctx' type='void *' info='contextual data for the callbacks'/>
</function>
+ <function name='xmlRelaxNGSetParserStructuredErrors' file='relaxng' module='relaxng'>
+ <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond>
+ <info>Set the callback functions used to handle errors for a parsing context</info>
+ <return type='void'/>
+ <arg name='ctxt' type='xmlRelaxNGParserCtxtPtr' info='a Relax-NG parser context'/>
+ <arg name='serror' type='xmlStructuredErrorFunc' info='the error callback'/>
+ <arg name='ctx' type='void *' info='contextual data for the callbacks'/>
+ </function>
<function name='xmlRelaxNGSetValidErrors' file='relaxng' module='relaxng'>
<cond>defined(LIBXML_SCHEMAS_ENABLED)</cond>
<info>Set the error and warning callback informations</info>
@@ -12763,7 +12785,6 @@ Could we use @subtypes for this?'/>
<arg name='attr' type='xmlAttrPtr' info='the attribute'/>
</function>
<function name='xmlRemoveProp' file='tree' module='tree'>
- <cond>defined(LIBXML_TREE_ENABLED)</cond>
<info>Unlink and free one attribute, all the content is freed too Note this doesn&apos;t work for namespace definition attributes</info>
<return type='int' info='0 if success and -1 in case of error.'/>
<arg name='cur' type='xmlAttrPtr' info='an attribute'/>
@@ -13826,7 +13847,7 @@ Could we use @subtypes for this?'/>
</function>
<function name='xmlSetNsProp' file='tree' module='tree'>
<cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XINCLUDE_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED) || defined(LIBXML_HTML_ENABLED)</cond>
- <info>Set (or reset) an attribute carried by a node. The ns structure must be in scope, this is not checked.</info>
+ <info>Set (or reset) an attribute carried by a node. The ns structure must be in scope, this is not checked</info>
<return type='xmlAttrPtr' info='the attribute pointer.'/>
<arg name='node' type='xmlNodePtr' info='the node'/>
<arg name='ns' type='xmlNsPtr' info='the namespace definition'/>
@@ -13835,10 +13856,10 @@ Could we use @subtypes for this?'/>
</function>
<function name='xmlSetProp' file='tree' module='tree'>
<cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XINCLUDE_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED) || defined(LIBXML_HTML_ENABLED)</cond>
- <info>Set (or reset) an attribute carried by a node.</info>
+ <info>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&apos;s no such ns-binding for the prefix in scope.</info>
<return type='xmlAttrPtr' info='the attribute pointer.'/>
<arg name='node' type='xmlNodePtr' info='the node'/>
- <arg name='name' type='const xmlChar *' info='the attribute name'/>
+ <arg name='name' type='const xmlChar *' info='the attribute name (a QName)'/>
<arg name='value' type='const xmlChar *' info='the attribute value'/>
</function>
<function name='xmlSetStructuredErrorFunc' file='xmlerror' module='error'>
@@ -16501,7 +16522,7 @@ Could we use @subtypes for this?'/>
</function>
<function name='xmlUnsetProp' file='tree' module='tree'>
<cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)</cond>
- <info>Remove an attribute carried by a node.</info>
+ <info>Remove an attribute carried by a node. This handles only attributes in no namespace.</info>
<return type='int' info='0 if successful, -1 if not found'/>
<arg name='node' type='xmlNodePtr' info='the node'/>
<arg name='name' type='const xmlChar *' info='the attribute name'/>