diff options
Diffstat (limited to 'doc/libxml2-api.xml')
| -rw-r--r-- | doc/libxml2-api.xml | 90 |
1 files changed, 73 insertions, 17 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 2dbf900..dd49a2b 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -94,6 +94,7 @@ <exports symbol='htmlReadFile' type='function'/> <exports symbol='htmlCtxtReadFile' type='function'/> <exports symbol='htmlParseDocument' type='function'/> + <exports symbol='htmlNewParserCtxt' type='function'/> <exports symbol='htmlSAXParseDoc' type='function'/> <exports symbol='htmlCtxtUseOptions' type='function'/> <exports symbol='htmlParseDoc' type='function'/> @@ -722,6 +723,7 @@ <exports symbol='XML_PARSE_NOCDATA' type='enum'/> <exports symbol='XML_PARSE_COMPACT' type='enum'/> <exports symbol='XML_PARSE_SAX1' type='enum'/> + <exports symbol='XML_WITH_ZLIB' type='enum'/> <exports symbol='XML_WITH_READER' type='enum'/> <exports symbol='XML_PARSER_DTD' type='enum'/> <exports symbol='XML_PARSER_MISC' type='enum'/> @@ -1587,6 +1589,7 @@ <exports symbol='xmlCopyNode' type='function'/> <exports symbol='xmlUnlinkNode' type='function'/> <exports symbol='xmlSplitQName3' type='function'/> + <exports symbol='xmlDOMWrapAcquireNsFunction' type='function'/> <exports symbol='xmlDocSetRootElement' type='function'/> <exports symbol='xmlGetLineNo' type='function'/> <exports symbol='xmlBufferContent' type='function'/> @@ -1668,6 +1671,7 @@ <exports symbol='xmlParseURI' type='function'/> <exports symbol='xmlCreateURI' type='function'/> <exports symbol='xmlURIEscapeStr' type='function'/> + <exports symbol='xmlPathToURI' type='function'/> <exports symbol='xmlCanonicPath' type='function'/> <exports symbol='xmlFreeURI' type='function'/> <exports symbol='xmlParseURIReference' type='function'/> @@ -1786,6 +1790,7 @@ <exports symbol='XINCLUDE_OLD_NS' type='macro'/> <exports symbol='xmlXIncludeCtxt' type='typedef'/> <exports symbol='xmlXIncludeCtxtPtr' type='typedef'/> + <exports symbol='xmlXIncludeProcessFlagsData' type='function'/> <exports symbol='xmlXIncludeProcessFlags' type='function'/> <exports symbol='xmlXIncludeProcessTree' type='function'/> <exports symbol='xmlXIncludeProcessNode' type='function'/> @@ -3322,6 +3327,7 @@ <exports symbol='LIBXML_UNICODE_ENABLED' type='macro'/> <exports symbol='LIBXML_FTP_ENABLED' type='macro'/> <exports symbol='LIBXML_AUTOMATA_ENABLED' type='macro'/> + <exports symbol='LIBXML_ZLIB_ENABLED' type='macro'/> <exports symbol='LIBXML_WRITER_ENABLED' type='macro'/> <exports symbol='LIBXML_C14N_ENABLED' type='macro'/> <exports symbol='LIBXML_SCHEMAS_ENABLED' type='macro'/> @@ -3501,7 +3507,7 @@ <exports symbol='xmlXPathIsNaN' type='function'/> <exports symbol='xmlXPathContextSetCache' type='function'/> <exports symbol='xmlXPathConvertString' type='function'/> - <exports symbol='xmlXPathConvertBoolean' type='function'/> + <exports symbol='xmlXPathCompiledEvalToBoolean' type='function'/> <exports symbol='xmlXPathIsInf' type='function'/> <exports symbol='xmlXPathOrderDocElems' type='function'/> <exports symbol='xmlXPathNodeSetCreate' type='function'/> @@ -3523,11 +3529,12 @@ <exports symbol='xmlXPathCompiledEval' type='function'/> <exports symbol='xmlXPathEvalExpression' type='function'/> <exports symbol='xmlXPathInit' type='function'/> - <exports symbol='xmlXPathCtxtCompile' type='function'/> + <exports symbol='xmlXPathConvertBoolean' type='function'/> <exports symbol='xmlXPathConvertFunc' type='function'/> <exports symbol='xmlXPathFunction' type='function'/> <exports symbol='xmlXPathCmpNodes' type='function'/> <exports symbol='xmlXPathCastToString' type='function'/> + <exports symbol='xmlXPathCtxtCompile' type='function'/> <exports symbol='xmlXPathEvalFunc' type='function'/> <exports symbol='xmlXPathCastBooleanToString' type='function'/> <exports symbol='xmlXPathCastNumberToBoolean' type='function'/> @@ -3947,13 +3954,13 @@ <info>Whether the DTD validation support is configured in</info> </macro> <macro name='LIBXML_VERSION' file='xmlversion'> - <info>the version number: 1.2.3 value is 1002003</info> + <info>the version number: 1.2.3 value is 10203</info> </macro> <macro name='LIBXML_VERSION_EXTRA' file='xmlversion'> <info>extra version information, used to show a CVS compilation</info> </macro> <macro name='LIBXML_VERSION_STRING' file='xmlversion'> - <info>the version number string, 1.2.3 value is "1002003"</info> + <info>the version number string, 1.2.3 value is "10203"</info> </macro> <macro name='LIBXML_WRITER_ENABLED' file='xmlversion'> <info>Whether the xmlWriter saving interface is configured in</info> @@ -3967,6 +3974,9 @@ <macro name='LIBXML_XPTR_ENABLED' file='xmlversion'> <info>Whether XPointer is configured in</info> </macro> + <macro name='LIBXML_ZLIB_ENABLED' file='xmlversion'> + <info>Whether the Zlib support is compiled in</info> + </macro> <macro name='MOVETO_ENDTAG' file='parserInternals'> <info>Skips to the next '>' char.</info> <arg name='p' info='and UTF8 string pointer'/> @@ -4964,7 +4974,9 @@ <enum name='XML_PARSER_SUBST_ENTITIES' file='xmlreader' value='4' type='xmlParserProperties'/> <enum name='XML_PARSER_SYSTEM_LITERAL' file='parser' value='13' type='xmlParserInputState' info='within a SYSTEM value'/> <enum name='XML_PARSER_VALIDATE' file='xmlreader' value='3' type='xmlParserProperties'/> - <enum name='XML_PARSE_COMPACT' file='parser' value='65536' type='xmlParserOption' info=' compact small text nodes'/> + <enum name='XML_PARSE_COMPACT' file='parser' value='65536' type='xmlParserOption' info=' compact small text nodes; no modification of +the tree allowed afterwards (will possibly +crash if you try to modify the tree)'/> <enum name='XML_PARSE_DOM' file='parser' value='1' type='xmlParserMode'/> <enum name='XML_PARSE_DTDATTR' file='parser' value='8' type='xmlParserOption' info='default DTD attributes'/> <enum name='XML_PARSE_DTDLOAD' file='parser' value='4' type='xmlParserOption' info='load the external subset'/> @@ -5641,6 +5653,7 @@ <enum name='XML_WITH_XINCLUDE' file='parser' value='18' type='xmlFeature'/> <enum name='XML_WITH_XPATH' file='parser' value='16' type='xmlFeature'/> <enum name='XML_WITH_XPTR' file='parser' value='17' type='xmlFeature'/> + <enum name='XML_WITH_ZLIB' file='parser' value='31' type='xmlFeature'/> <enum name='XML_XINCLUDE_BUILD_FAILED' file='xmlerror' value='1609' type='xmlParserErrors' info='1609'/> <enum name='XML_XINCLUDE_DEPRECATED_NS' file='xmlerror' value='1617' type='xmlParserErrors' info='1617'/> <enum name='XML_XINCLUDE_END' file='tree' value='20' type='xmlElementType'/> @@ -5872,7 +5885,15 @@ if necessary or NULL'/> </struct> <typedef name='xmlCharEncodingHandlerPtr' file='encoding' type='xmlCharEncodingHandler *'/> <struct name='xmlDOMWrapCtxt' file='tree' type='struct _xmlDOMWrapCtxt'> - <field name='_private' type='void *' info=''/> + <field name='_private' type='void *' info='* The type of this context, just in case we need specialized +* contexts in the future. +*'/> + <field name='type' type='int' info='* Internal namespace map used for various operations. +*'/> + <field name='namespaceMap' type='void *' info='* Use this one to acquire an xmlNsPtr intended for node->ns. +* (Note that this is not intended for elem->nsDef). +*'/> + <field name='getNsForNodeFunc' type='xmlDOMWrapAcquireNsFunction' info=''/> </struct> <typedef name='xmlDOMWrapCtxtPtr' file='tree' type='xmlDOMWrapCtxt *'/> <struct name='xmlDict' file='dict' type='struct _xmlDict'/> @@ -5977,6 +5998,7 @@ actually an xmlCharEncoding'/> <field name='nexte' type='struct _xmlEntity *' info=' unused'/> <field name='URI' type='const xmlChar *' info=' the full URI as computed'/> <field name='owner' type='int' info=' does the entity own the childrens'/> + <field name='checked' type='int' info=' was the entity content checked'/> </struct> <typedef name='xmlEntityPtr' file='tree' type='xmlEntity *'/> <typedef name='xmlEntityType' file='entities' type='enum'/> @@ -6113,6 +6135,7 @@ actually an xmlCharEncoding'/> <field name='href' type='const xmlChar *' info=' URL for the namespace'/> <field name='prefix' type='const xmlChar *' info=' prefix for the namespace'/> <field name='_private' type='void *' info=' application data'/> + <field name='context' type='struct _xmlDoc *' info=' normally an xmlDoc'/> </struct> <typedef name='xmlNsPtr' file='tree' type='xmlNs *'/> <typedef name='xmlNsType' file='tree' type='xmlElementType'/> @@ -7432,6 +7455,11 @@ Could we use @subtypes for this?'/> <arg name='URI' type='const xmlChar *' info='URI for the dtd, or NULL'/> <arg name='ExternalID' type='const xmlChar *' info='the external ID of the DTD, or NULL'/> </function> + <function name='htmlNewParserCtxt' file='HTMLparser' module='HTMLparser'> + <cond>defined(LIBXML_HTML_ENABLED)</cond> + <info>Allocate and initialize a new parser context.</info> + <return type='htmlParserCtxtPtr' info='the htmlParserCtxtPtr or NULL in case of allocation error'/> + </function> <function name='htmlNodeDump' file='HTMLtree' module='HTMLtree'> <cond>defined(LIBXML_HTML_ENABLED) && defined(LIBXML_OUTPUT_ENABLED)</cond> <info>Dump an HTML node, recursive behaviour,children are printed too, and formatting returns are added.</info> @@ -9038,8 +9066,16 @@ Could we use @subtypes for this?'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/> <arg name='len' type='int *' info='pointer to the length of the char read'/> </function> + <functype name='xmlDOMWrapAcquireNsFunction' file='tree' module='tree'> + <info>A function called to acquire namespaces (xmlNs) from the wrapper.</info> + <return type='xmlNsPtr' info='an xmlNsPtr or NULL in case of an error.'/> + <arg name='ctxt' type='xmlDOMWrapCtxtPtr' info='a DOM wrapper context'/> + <arg name='node' type='xmlNodePtr' info='the context node (element or attribute)'/> + <arg name='nsName' type='const xmlChar *' info='the requested namespace name'/> + <arg name='nsPrefix' type='const xmlChar *' info='the requested namespace prefix'/> + </functype> <function name='xmlDOMWrapAdoptNode' 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->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> + <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->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.</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'/> @@ -9049,7 +9085,7 @@ Could we use @subtypes for this?'/> <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->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> + <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->oldNs entries are used. This is the case when you don't know already where the cloned branch will be added to. 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) What to do with XInclude? Currently this returns an error for XInclude.</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'/> @@ -9070,14 +9106,14 @@ Could we use @subtypes for this?'/> <return type='xmlDOMWrapCtxtPtr' info='the xmlDOMWrapCtxtPtr or NULL in case of an internal errror.'/> </function> <function name='xmlDOMWrapReconcileNamespaces' file='tree' module='tree'> - <info>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.</info> + <info>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.</info> <return type='int' info='0 if succeeded, -1 otherwise and on API/internal errors.'/> <arg name='ctxt' type='xmlDOMWrapCtxtPtr' info='DOM wrapper context, unused at the moment'/> <arg name='elem' type='xmlNodePtr' info='the element-node'/> <arg name='options' type='int' info='option flags'/> </function> <function name='xmlDOMWrapRemoveNode' file='tree' module='tree'> - <info>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.</info> + <info>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.</info> <return type='int' info='0 on success, 1 if the node is not supported, -1 on API and internal errors.'/> <arg name='ctxt' type='xmlDOMWrapCtxtPtr' info='a DOM wrapper context'/> <arg name='doc' type='xmlDocPtr' info='the doc'/> @@ -9329,9 +9365,9 @@ Could we use @subtypes for this?'/> <function name='xmlDocSetRootElement' file='tree' module='tree'> <cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_WRITER_ENABLED)</cond> <info>Set the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).</info> - <return type='xmlNodePtr' info='the old root element if any was found'/> + <return type='xmlNodePtr' info='the old root element if any was found, NULL if root was NULL'/> <arg name='doc' type='xmlDocPtr' info='the document'/> - <arg name='root' type='xmlNodePtr' info='the new document root element'/> + <arg name='root' type='xmlNodePtr' info='the new document root element, if root is NULL no action is taken, to remove a node from a document use xmlUnlinkNode(root) instead.'/> </function> <function name='xmlDumpAttributeDecl' file='valid' module='valid'> <cond>defined(LIBXML_OUTPUT_ENABLED)</cond> @@ -9933,7 +9969,7 @@ Could we use @subtypes for this?'/> <arg name='node' type='xmlNodePtr' info='a node'/> </function> <function name='xmlGetNsList' file='tree' module='tree'> - <cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XPATH_ENABLED)</cond> + <cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)</cond> <info>Search all the namespace applying to a given element.</info> <return type='xmlNsPtr *' info='an NULL terminated array of all the #xmlNsPtr found that need to be freed by the caller or NULL if no namespace if defined'/> <arg name='doc' type='xmlDocPtr' info='the document'/> @@ -10279,7 +10315,7 @@ Could we use @subtypes for this?'/> <function name='xmlIOParseDTD' file='parser' module='parser'> <cond>defined(LIBXML_VALID_ENABLED)</cond> <info>Load and parse a DTD</info> - <return type='xmlDtdPtr' info='the resulting xmlDtdPtr or NULL in case of error. @input will be freed at parsing end.'/> + <return type='xmlDtdPtr' info='the resulting xmlDtdPtr or NULL in case of error. @input will be freed by the function in any case.'/> <arg name='sax' type='xmlSAXHandlerPtr' info='the SAX handler block or NULL'/> <arg name='input' type='xmlParserInputBufferPtr' info='an Input Buffer'/> <arg name='enc' type='xmlCharEncoding' info='the charset encoding if known'/> @@ -12180,6 +12216,11 @@ Could we use @subtypes for this?'/> <arg name='msg' type='const char *' info='the message to display/transmit'/> <arg name='...' type='...' info='extra parameters for the message display'/> </function> + <function name='xmlPathToURI' file='uri' module='uri'> + <info>Constructs an URI expressing the existing path</info> + <return type='xmlChar *' info='a new URI, or a duplicate of the path parameter if the construction fails. The caller is responsible for freeing the memory occupied by the returned string. If there is insufficient memory available, or the argument is NULL, the function returns NULL.'/> + <arg name='path' type='const xmlChar *' info='the resource locator in a filesystem notation'/> + </function> <function name='xmlPatternFromRoot' file='pattern' module='pattern'> <cond>defined(LIBXML_PATTERN_ENABLED)</cond> <info>Check if the pattern must be looked at from the root.</info> @@ -13250,7 +13291,7 @@ Could we use @subtypes for this?'/> <info>Save a subtree starting at the node parameter to a saving context TODO: The function is not fully implemented yet as it does not return the byte count but 0 instead</info> <return type='long' info='the number of byte written or -1 in case of error'/> <arg name='ctxt' type='xmlSaveCtxtPtr' info='a document saving context'/> - <arg name='node' type='xmlNodePtr' info='a document'/> + <arg name='node' type='xmlNodePtr' info='the top node of the subtree to save'/> </function> <function name='xmlSaveUri' file='uri' module='uri'> <info>Save the URI as an escaped string</info> @@ -16636,7 +16677,7 @@ Could we use @subtypes for this?'/> <arg name='elem' type='xmlElementPtr' info='an element definition'/> </function> <function name='xmlValidateNCName' file='tree' module='tree'> - <cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED) || defined(LIBXML_DEBUG_ENABLED) || defined (LIBXML_HTML_ENABLED)</cond> + <cond>defined(LIBXML_TREE_ENABLED) || defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED) || defined(LIBXML_DEBUG_ENABLED) || defined (LIBXML_HTML_ENABLED) || defined(LIBXML_SAX1_ENABLED) || defined(LIBXML_HTML_ENABLED) || defined(LIBXML_WRITER_ENABLED) || defined(LIBXML_DOCB_ENABLED)</cond> <info>Check that a value conforms to the lexical space of NCName</info> <return type='int' info='0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.'/> <arg name='value' type='const xmlChar *' info='the value to check'/> @@ -16804,6 +16845,14 @@ Could we use @subtypes for this?'/> <arg name='doc' type='xmlDocPtr' info='an XML document'/> <arg name='flags' type='int' info='a set of xmlParserOption used for parsing XML includes'/> </function> + <function name='xmlXIncludeProcessFlagsData' file='xinclude' module='xinclude'> + <cond>defined(LIBXML_XINCLUDE_ENABLED)</cond> + <info>Implement the XInclude substitution on the XML document @doc</info> + <return type='int' info='0 if no substitution were done, -1 if some processing failed or the number of substitutions done.'/> + <arg name='doc' type='xmlDocPtr' info='an XML document'/> + <arg name='flags' type='int' info='a set of xmlParserOption used for parsing XML includes'/> + <arg name='data' type='void *' info='application data that will be passed to the parser context in the _private field of the parser context(s)'/> + </function> <function name='xmlXIncludeProcessNode' file='xinclude' module='xinclude'> <cond>defined(LIBXML_XINCLUDE_ENABLED)</cond> <info>Implement the XInclude substitution for the given subtree reusing the informations and data coming from the given context.</info> @@ -16932,7 +16981,7 @@ Could we use @subtypes for this?'/> <function name='xmlXPathCastToString' file='xpath' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Converts an existing object to its string() equivalent</info> - <return type='xmlChar *' info='the string value of the object, NULL in case of error. A new string is allocated only if needed (@val isn't a string object).'/> + <return type='xmlChar *' info='the allocated string value of the object, NULL in case of error. It's up to the caller to free the string memory with xmlFree().'/> <arg name='val' type='xmlXPathObjectPtr' info='an XPath object'/> </function> <function name='xmlXPathCeilingFunction' file='xpathInternals' module='xpath'> @@ -16970,6 +17019,13 @@ Could we use @subtypes for this?'/> <arg name='comp' type='xmlXPathCompExprPtr' info='the compiled XPath expression'/> <arg name='ctx' type='xmlXPathContextPtr' info='the XPath context'/> </function> + <function name='xmlXPathCompiledEvalToBoolean' file='xpath' module='xpath'> + <cond>defined(LIBXML_XPATH_ENABLED)</cond> + <info>Applies the XPath boolean() function on the result of the given compiled expression.</info> + <return type='int' info='1 if the expression evaluated to true, 0 if to false and -1 in API and internal errors.'/> + <arg name='comp' type='xmlXPathCompExprPtr' info='the compiled XPath expression'/> + <arg name='ctxt' type='xmlXPathContextPtr' info='the XPath context'/> + </function> <function name='xmlXPathConcatFunction' file='xpathInternals' module='xpath'> <cond>defined(LIBXML_XPATH_ENABLED)</cond> <info>Implement the concat() XPath function string concat(string, string, string*) The concat function returns the concatenation of its arguments.</info> |