diff options
Diffstat (limited to 'doc/libxml2-api.xml')
| -rw-r--r-- | doc/libxml2-api.xml | 71 |
1 files changed, 55 insertions, 16 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 3da8dbe..6a93755 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -1023,6 +1023,7 @@ <exports symbol='xmlRelaxNGGetValidErrors' type='function'/> <exports symbol='xmlRelaxNGNewMemParserCtxt' type='function'/> <exports symbol='xmlRelaxNGDump' type='function'/> + <exports symbol='xmlRelaxNGInitTypes' type='function'/> <exports symbol='xmlRelaxNGValidityErrorFunc' type='function'/> <exports symbol='xmlRelaxNGParse' type='function'/> <exports symbol='xmlRelaxNGDumpTree' type='function'/> @@ -1557,6 +1558,8 @@ <summary>The DTD validation</summary> <description>API for the DTD handling and the validity checking </description> <author>Daniel Veillard </author> + <exports symbol='XML_CTXT_FINISH_DTD_0' type='macro'/> + <exports symbol='XML_CTXT_FINISH_DTD_1' type='macro'/> <exports symbol='xmlElementTable' type='typedef'/> <exports symbol='xmlValidStatePtr' type='typedef'/> <exports symbol='xmlIDTablePtr' type='typedef'/> @@ -1992,6 +1995,7 @@ <exports symbol='XML_SCHEMAP_INVALID_ATTR_COMBINATION' type='enum'/> <exports symbol='XML_RNGP_PARAM_FORBIDDEN' type='enum'/> <exports symbol='XML_SCHEMAP_UNKNOWN_PROCESSCONTENT_CHILD' type='enum'/> + <exports symbol='XML_FROM_WRITER' type='enum'/> <exports symbol='XML_ERR_UNSUPPORTED_ENCODING' type='enum'/> <exports symbol='XML_RNGP_PAT_NSNAME_EXCEPT_ANYNAME' type='enum'/> <exports symbol='XML_ERR_ENTITYREF_IN_PROLOG' type='enum'/> @@ -2578,6 +2582,7 @@ <exports symbol='xmlReallocFunc' type='function'/> <exports symbol='xmlMallocFunc' type='function'/> <exports symbol='xmlMemDisplay' type='function'/> + <exports symbol='xmlMemBlocks' type='function'/> <exports symbol='xmlGcMemSetup' type='function'/> <exports symbol='xmlMemShow' type='function'/> <exports symbol='xmlMemoryStrdup' type='function'/> @@ -3177,6 +3182,7 @@ <exports symbol='XPATH_RANGE' type='enum'/> <exports symbol='XPTR_SYNTAX_ERROR' type='enum'/> <exports symbol='XPATH_LOCATIONSET' type='enum'/> + <exports symbol='XPATH_INVALID_CTXT' type='enum'/> <exports symbol='XPATH_INVALID_CHAR_ERROR' type='enum'/> <exports symbol='XPATH_UNDEF_VARIABLE_ERROR' type='enum'/> <exports symbol='XPATH_UNCLOSED_ERROR' type='enum'/> @@ -3191,9 +3197,9 @@ <exports symbol='XPATH_EXPR_ERROR' type='enum'/> <exports symbol='XPATH_VARIABLE_REF_ERROR' type='enum'/> <exports symbol='XPATH_INVALID_TYPE' type='enum'/> - <exports symbol='XPATH_INVALID_CTXT_SIZE' type='enum'/> - <exports symbol='XPATH_INVALID_CTXT_POSITION' type='enum'/> <exports symbol='XPATH_UNDEFINED' type='enum'/> + <exports symbol='XPATH_INVALID_CTXT_POSITION' type='enum'/> + <exports symbol='XPATH_INVALID_CTXT_SIZE' type='enum'/> <exports symbol='XPATH_MEMORY_ERROR' type='enum'/> <exports symbol='XPATH_UNFINISHED_LITERAL_ERROR' type='enum'/> <exports symbol='XPATH_NUMBER' type='enum'/> @@ -3751,6 +3757,12 @@ <macro name='XML_COMPLETE_ATTRS' file='parser'> <info>Bit in the loadsubset context field to tell to do complete the elements attributes lists with the ones defaulted from the DTDs. Use it to initialize xmlLoadExtDtdDefaultValue.</info> </macro> + <macro name='XML_CTXT_FINISH_DTD_0' file='valid'> + <info>Special value for finishDtd field when embedded in an xmlParserCtxt</info> + </macro> + <macro name='XML_CTXT_FINISH_DTD_1' file='valid'> + <info>Special value for finishDtd field when embedded in an xmlParserCtxt</info> + </macro> <macro name='XML_DEFAULT_VERSION' file='parser'> <info>The default version of XML used: 1.0</info> </macro> @@ -4465,7 +4477,7 @@ <enum name='XML_EXTERNAL_PARAMETER_ENTITY' file='entities' value='5' type='xmlEntityType'/> <enum name='XML_FROM_C14N' file='xmlerror' value='21' type='xmlErrorDomain' info='The Canonicalization module'/> <enum name='XML_FROM_CATALOG' file='xmlerror' value='20' type='xmlErrorDomain' info='The Catalog module'/> - <enum name='XML_FROM_CHECK' file='xmlerror' value='24' type='xmlErrorDomain' info=' The error checking module'/> + <enum name='XML_FROM_CHECK' file='xmlerror' value='24' type='xmlErrorDomain' info='The error checking module'/> <enum name='XML_FROM_DATATYPE' file='xmlerror' value='15' type='xmlErrorDomain' info='The W3C XML Schemas Datatype module'/> <enum name='XML_FROM_DTD' file='xmlerror' value='4' type='xmlErrorDomain' info='The XML DTD validation with parser contex'/> <enum name='XML_FROM_FTP' file='xmlerror' value='9' type='xmlErrorDomain' info='The FTP module'/> @@ -4484,6 +4496,7 @@ <enum name='XML_FROM_SCHEMASV' file='xmlerror' value='17' type='xmlErrorDomain' info='The W3C XML Schemas validation module'/> <enum name='XML_FROM_TREE' file='xmlerror' value='2' type='xmlErrorDomain' info='The tree module'/> <enum name='XML_FROM_VALID' file='xmlerror' value='23' type='xmlErrorDomain' info='The XML DTD validation with valid context'/> + <enum name='XML_FROM_WRITER' file='xmlerror' value='25' type='xmlErrorDomain' info=' The xmlwriter module'/> <enum name='XML_FROM_XINCLUDE' file='xmlerror' value='11' type='xmlErrorDomain' info='The XInclude processing'/> <enum name='XML_FROM_XPATH' file='xmlerror' value='12' type='xmlErrorDomain' info='The XPath module'/> <enum name='XML_FROM_XPOINTER' file='xmlerror' value='13' type='xmlErrorDomain' info='The XPointer module'/> @@ -5244,6 +5257,7 @@ <enum name='XPATH_EXPR_ERROR' file='xpath' value='7' type='xmlXPathError'/> <enum name='XPATH_INVALID_ARITY' file='xpath' value='12' type='xmlXPathError'/> <enum name='XPATH_INVALID_CHAR_ERROR' file='xpath' value='21' type='xmlXPathError'/> + <enum name='XPATH_INVALID_CTXT' file='xpath' value='22' type='xmlXPathError'/> <enum name='XPATH_INVALID_CTXT_POSITION' file='xpath' value='14' type='xmlXPathError'/> <enum name='XPATH_INVALID_CTXT_SIZE' file='xpath' value='13' type='xmlXPathError'/> <enum name='XPATH_INVALID_OPERAND' file='xpath' value='10' type='xmlXPathError'/> @@ -6125,7 +6139,7 @@ actually an xmlCharEncoding'/> <field name='nodeNr' type='int' info=' Depth of the parsing stack'/> <field name='nodeMax' type='int' info=' Max depth of the parsing stack'/> <field name='nodeTab' type='xmlNodePtr *' info=' array of nodes'/> - <field name='finishDtd' type='int' info=' finished validating the Dtd ?'/> + <field name='finishDtd' type='unsigned int' info=' finished validating the Dtd ?'/> <field name='doc' type='xmlDocPtr' info=' the document'/> <field name='valid' type='int' info=' temporary validity check result state state used for non-determinist content validation'/> <field name='vstate' type='xmlValidState *' info=' current state'/> @@ -8866,7 +8880,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlFileRead' file='xmlIO'> <info>Read @len bytes to @buffer from the I/O channel.</info> - <return type='int' info='the number of bytes written'/> + <return type='int' info='the number of bytes written or < 0 in case of failure'/> <arg name='context' type='void *' info='the I/O context'/> <arg name='buffer' type='char *' info='where to drop data'/> <arg name='len' type='int' info='number of bytes to write'/> @@ -9735,7 +9749,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlListEmpty' file='list'> <info>Is the list empty ?</info> - <return type='int' info='1 if the list is empty, 0 otherwise'/> + <return type='int' info='1 if the list is empty, 0 if not empty and -1 in case of error'/> <arg name='l' type='xmlListPtr' info='a list'/> </function> <function name='xmlListEnd' file='list'> @@ -9826,7 +9840,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlListSize' file='list'> <info>Get the number of elements in the list</info> - <return type='int' info='the number of elements in the list'/> + <return type='int' info='the number of elements in the list or -1 in case of error'/> <arg name='l' type='xmlListPtr' info='a list'/> </function> <function name='xmlListSort' file='list'> @@ -9914,6 +9928,10 @@ actually an xmlCharEncoding'/> <arg name='file' type='const char *' info='the file name or NULL'/> <arg name='line' type='int' info='the line number'/> </function> + <function name='xmlMemBlocks' file='xmlmemory'> + <info>Provides the number of memory areas currently allocated</info> + <return type='int' info='an int representing the number of blocks'/> + </function> <function name='xmlMemDisplay' file='xmlmemory'> <info>show in-extenso the memory blocks allocated</info> <return type='void'/> @@ -10044,14 +10062,14 @@ actually an xmlCharEncoding'/> <info>Tries to change the remote directory</info> <return type='int' info='-1 incase of error, 1 if CWD worked, 0 if it failed'/> <arg name='ctx' type='void *' info='an FTP context'/> - <arg name='directory' type='char *' info='a directory on the server'/> + <arg name='directory' type='const char *' info='a directory on the server'/> </function> <function name='xmlNanoFTPDele' file='nanoftp'> <cond>LIBXML_FTP_ENABLED</cond> <info>Tries to delete an item (file or directory) from server</info> <return type='int' info='-1 incase of error, 1 if DELE worked, 0 if it failed'/> <arg name='ctx' type='void *' info='an FTP context'/> - <arg name='file' type='char *' info='a file or directory on the server'/> + <arg name='file' type='const char *' info='a file or directory on the server'/> </function> <function name='xmlNanoFTPFreeCtxt' file='nanoftp'> <cond>LIBXML_FTP_ENABLED</cond> @@ -10099,7 +10117,7 @@ actually an xmlCharEncoding'/> <arg name='ctx' type='void *' info='an FTP context'/> <arg name='callback' type='ftpListCallback' info='the user callback'/> <arg name='userData' type='void *' info='the user callback data'/> - <arg name='filename' type='char *' info='optional files to list'/> + <arg name='filename' type='const char *' info='optional files to list'/> </function> <function name='xmlNanoFTPNewCtxt' file='nanoftp'> <cond>LIBXML_FTP_ENABLED</cond> @@ -10533,7 +10551,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlNewTextWriter' file='xmlwriter'> <cond>LIBXML_WRITER_ENABLED</cond> - <info>Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr</info> + <info>Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr NOTE: the @out parameter will be deallocated when the writer is closed (if the call succeed.)</info> <return type='xmlTextWriterPtr' info='the new xmlTextWriterPtr or NULL in case of error'/> <arg name='out' type='xmlOutputBufferPtr' info='an xmlOutputBufferPtr'/> </function> @@ -10560,7 +10578,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlNewTextWriterPushParser' file='xmlwriter'> <cond>LIBXML_WRITER_ENABLED</cond> - <info>Create a new xmlNewTextWriter structure with @ctxt as output TODO: handle compression</info> + <info>Create a new xmlNewTextWriter structure with @ctxt as output NOTE: the @ctxt context will be freed with the resulting writer (if the call succeeds). TODO: handle compression</info> <return type='xmlTextWriterPtr' info='the new xmlTextWriterPtr or NULL in case of error'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='xmlParserCtxtPtr to hold the new XML document tree'/> <arg name='compression' type='int' info='compress the output?'/> @@ -11767,6 +11785,11 @@ actually an xmlCharEncoding'/> <arg name='warn' type='xmlRelaxNGValidityWarningFunc *' info='the warning function result'/> <arg name='ctx' type='void **' info='the functions context result'/> </function> + <function name='xmlRelaxNGInitTypes' file='relaxng'> + <cond>LIBXML_SCHEMAS_ENABLED</cond> + <info>Initilize the default type libraries.</info> + <return type='int' info='0 in case of success and -1 in case of error.'/> + </function> <function name='xmlRelaxNGNewDocParserCtxt' file='relaxng'> <cond>LIBXML_SCHEMAS_ENABLED</cond> <info>Create an XML RelaxNGs parser context for that document. Note: since the process of compiling a RelaxNG schemas modifies the document, the @doc parameter is duplicated internally.</info> @@ -12244,7 +12267,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlSaveFileTo' file='tree'> <cond>LIBXML_OUTPUT_ENABLED</cond> - <info>Dump an XML document to an I/O buffer.</info> + <info>Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.</info> <return type='int' info='the number of bytes written or -1 in case of failure.'/> <arg name='buf' type='xmlOutputBufferPtr' info='an output I/O buffer'/> <arg name='cur' type='xmlDocPtr' info='the document'/> @@ -12275,7 +12298,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlSaveFormatFileTo' file='tree'> <cond>LIBXML_OUTPUT_ENABLED</cond> - <info>Dump an XML document to an I/O buffer. NOTE: the I/O buffer is closed as part of the call.</info> + <info>Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.</info> <return type='int' info='the number of bytes written or -1 in case of failure.'/> <arg name='buf' type='xmlOutputBufferPtr' info='an output I/O buffer'/> <arg name='cur' type='xmlDocPtr' info='the document'/> @@ -12735,6 +12758,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShell' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell This allow to load, validate, view, modify and save a document using a environment similar to a UNIX commandline.</info> <return type='void'/> <arg name='doc' type='xmlDocPtr' info='the initial document'/> @@ -12744,6 +12768,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellBase' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "base" dumps the current XML base of the node</info> <return type='int' info='0'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12753,6 +12778,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellCat' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).</info> <return type='int' info='0'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12762,6 +12788,7 @@ actually an xmlCharEncoding'/> </function> <functype name='xmlShellCmd' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>This is a generic signature for the XML shell functions.</info> <return type='int' info='an int, negative returns indicating errors.'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='a shell context'/> @@ -12771,6 +12798,7 @@ actually an xmlCharEncoding'/> </functype> <function name='xmlShellDir' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).</info> <return type='int' info='0'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12780,6 +12808,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellDu' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.</info> <return type='int' info='0 or -1 in case of error'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12789,6 +12818,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellList' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)</info> <return type='int' info='0'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12798,6 +12828,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellLoad' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "load" loads a new document specified by the filename</info> <return type='int' info='0 or -1 if loading failed'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12807,12 +12838,14 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellPrintNode' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Print node to the output FILE</info> <return type='void'/> <arg name='node' type='xmlNodePtr' info='a non-null node to print to the output FILE'/> </function> <function name='xmlShellPrintXPathError' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Print the xpath error to libxml default error channel</info> <return type='void'/> <arg name='errorType' type='int' info='valid xpath error id'/> @@ -12820,12 +12853,14 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellPrintXPathResult' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Prints result to the output FILE</info> <return type='void'/> <arg name='list' type='xmlXPathObjectPtr' info='a valid result generated by an xpath evaluation'/> </function> <function name='xmlShellPwd' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.</info> <return type='int' info='0 or -1 in case of error'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12835,12 +12870,14 @@ actually an xmlCharEncoding'/> </function> <functype name='xmlShellReadlineFunc' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>This is a generic signature for the XML shell input function.</info> <return type='char *' info='a string which will be freed by the Shell.'/> <arg name='prompt' type='char *' info='a string prompt'/> </functype> <function name='xmlShellSave' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <cond>LIBXML_OUTPUT_ENABLED</cond> <info>Implements the XML shell function "save" Write the current document to the filename, or it's original name</info> <return type='int' info='0 or -1 in case of error'/> @@ -12851,6 +12888,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellValidate' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <info>Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.</info> <return type='int' info='0 or -1 in case of error'/> <arg name='ctxt' type='xmlShellCtxtPtr' info='the shell context'/> @@ -12860,6 +12898,7 @@ actually an xmlCharEncoding'/> </function> <function name='xmlShellWrite' file='debugXML'> <cond>LIBXML_DEBUG_ENABLED</cond> + <cond>LIBXML_XPATH_ENABLED</cond> <cond>LIBXML_OUTPUT_ENABLED</cond> <info>Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified</info> <return type='int' info='0 or -1 in case of error'/> @@ -15263,12 +15302,12 @@ actually an xmlCharEncoding'/> </function> <function name='xmlUTF8Strpos' file='xmlstring'> <info>a function to provide the equivalent of fetching a character from a string array</info> - <return type='xmlChar *' info='a pointer to the UTF8 character or NULL'/> + <return type='const xmlChar *' info='a pointer to the UTF8 character or NULL'/> <arg name='utf' type='const xmlChar *' info='the input UTF8 *'/> <arg name='pos' type='int' info='the position of the desired UTF8 char (in chars)'/> </function> <function name='xmlUTF8Strsize' file='xmlstring'> - <info>storage size of an UTF8 string</info> + <info>storage size of an UTF8 string the behaviour is not garanteed if the input string is not UTF-8</info> <return type='int' info='the storage size of the first 'len' characters of ARRAY'/> <arg name='utf' type='const xmlChar *' info='a sequence of UTF-8 encoded bytes'/> <arg name='len' type='int' info='the number of characters in the array'/> |