diff options
| author | Mike Hommey <glandium@debian.org> | 2010-11-05 08:17:59 +0100 |
|---|---|---|
| committer | Mike Hommey <glandium@debian.org> | 2010-11-05 08:17:59 +0100 |
| commit | 2d1849b271fa8697b88d07ba7d78dc83591e1363 (patch) | |
| tree | ea10e1d707176e335e17cce9ae634cedfe0d5135 /doc/libxml2-api.xml | |
| parent | eb5d521a2df72fa829a7f8196b957c696e7ccc58 (diff) | |
| download | libxml2-2d1849b271fa8697b88d07ba7d78dc83591e1363.tar.gz | |
Import upstream version 2.7.8upstream/2.7.8.dfsg
Diffstat (limited to 'doc/libxml2-api.xml')
| -rw-r--r-- | doc/libxml2-api.xml | 42 |
1 files changed, 34 insertions, 8 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 046be3d..8d53f9a 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -37,9 +37,10 @@ <exports symbol='HTML_NA' type='enum'/> <exports symbol='HTML_PARSE_COMPACT' type='enum'/> <exports symbol='HTML_VALID' type='enum'/> - <exports symbol='HTML_PARSE_NOERROR' type='enum'/> <exports symbol='HTML_PARSE_NOBLANKS' type='enum'/> + <exports symbol='HTML_PARSE_NODEFDTD' type='enum'/> <exports symbol='HTML_DEPRECATED' type='enum'/> + <exports symbol='HTML_PARSE_NOERROR' type='enum'/> <exports symbol='HTML_PARSE_PEDANTIC' type='enum'/> <exports symbol='HTML_PARSE_RECOVER' type='enum'/> <exports symbol='HTML_PARSE_NOIMPLIED' type='enum'/> @@ -409,10 +410,12 @@ <exports symbol='XML_CHAR_ENCODING_8859_1' type='enum'/> <exports symbol='XML_CHAR_ENCODING_UTF8' type='enum'/> <exports symbol='XML_CHAR_ENCODING_UCS2' type='enum'/> + <exports symbol='uconv_t' type='typedef'/> <exports symbol='xmlCharEncoding' type='typedef'/> <exports symbol='xmlCharEncodingHandler' type='typedef'/> <exports symbol='xmlCharEncodingHandlerPtr' type='typedef'/> <exports symbol='_xmlCharEncodingHandler' type='struct'/> + <exports symbol='_uconv_t' type='struct'/> <exports symbol='xmlDelEncodingAlias' type='function'/> <exports symbol='xmlGetEncodingAlias' type='function'/> <exports symbol='xmlRegisterCharEncodingHandler' type='function'/> @@ -616,6 +619,8 @@ <summary>minimal FTP implementation</summary> <description>minimal FTP implementation allowing to fetch resources like external subset. </description> <author>Daniel Veillard </author> + <exports symbol='INVALID_SOCKET' type='macro'/> + <exports symbol='SOCKET' type='macro'/> <exports symbol='xmlNanoFTPQuit' type='function'/> <exports symbol='xmlNanoFTPClose' type='function'/> <exports symbol='ftpListCallback' type='function'/> @@ -687,6 +692,7 @@ <exports symbol='XML_WITH_HTML' type='enum'/> <exports symbol='XML_PARSE_OLDSAX' type='enum'/> <exports symbol='XML_WITH_WRITER' type='enum'/> + <exports symbol='XML_WITH_ICU' type='enum'/> <exports symbol='XML_WITH_C14N' type='enum'/> <exports symbol='XML_PARSE_PUSH_DOM' type='enum'/> <exports symbol='XML_PARSER_PROLOG' type='enum'/> @@ -3003,6 +3009,7 @@ <exports symbol='XML_SAVE_NO_DECL' type='enum'/> <exports symbol='XML_SAVE_AS_HTML' type='enum'/> <exports symbol='XML_SAVE_FORMAT' type='enum'/> + <exports symbol='XML_SAVE_WSNONSIG' type='enum'/> <exports symbol='xmlSaveOption' type='typedef'/> <exports symbol='xmlSaveCtxt' type='typedef'/> <exports symbol='xmlSaveCtxtPtr' type='typedef'/> @@ -3367,6 +3374,7 @@ <exports symbol='LIBXML_CATALOG_ENABLED' type='macro'/> <exports symbol='LIBXML_ATTR_ALLOC_SIZE' type='macro'/> <exports symbol='LIBXML_REGEXP_ENABLED' type='macro'/> + <exports symbol='LIBXML_ICU_ENABLED' type='macro'/> <exports symbol='LIBXML_MODULE_EXTENSION' type='macro'/> <exports symbol='LIBXML_ICONV_ENABLED' type='macro'/> <exports symbol='LIBXML_HTML_ENABLED' type='macro'/> @@ -3381,10 +3389,10 @@ <exports symbol='LIBXML_ATTR_FORMAT' type='macro'/> <exports symbol='LIBXML_TEST_VERSION' type='macro'/> <exports symbol='LIBXML_XPATH_ENABLED' type='macro'/> - <exports symbol='LIBXML_EXPR_ENABLED' type='macro'/> + <exports symbol='LIBXML_PATTERN_ENABLED' type='macro'/> <exports symbol='LIBXML_VALID_ENABLED' type='macro'/> <exports symbol='LIBXML_TREE_ENABLED' type='macro'/> - <exports symbol='LIBXML_PATTERN_ENABLED' type='macro'/> + <exports symbol='LIBXML_EXPR_ENABLED' type='macro'/> <exports symbol='xmlCheckVersion' type='function'/> </file> <file name='xmlwriter'> @@ -3835,6 +3843,9 @@ <macro name='INPUT_CHUNK' file='parserInternals'> <info>The parser tries to always have that amount of input ready. One of the point is providing context when reporting errors.</info> </macro> + <macro name='INVALID_SOCKET' file='nanoftp'> + <info>macro used to provide portability of code to windows sockets the value to be used when the socket is not valid</info> + </macro> <macro name='IS_ASCII_DIGIT' file='parserInternals'> <info>Macro to check [0-9]</info> <arg name='c' info='an xmlChar value'/> @@ -3955,6 +3966,9 @@ <macro name='LIBXML_ICONV_ENABLED' file='xmlversion'> <info>Whether iconv support is available</info> </macro> + <macro name='LIBXML_ICU_ENABLED' file='xmlversion'> + <info>Whether icu support is available</info> + </macro> <macro name='LIBXML_ISO8859X_ENABLED' file='xmlversion'> <info>Whether ISO-8859-* support is made available in case iconv is not</info> </macro> @@ -4042,6 +4056,9 @@ <info>Skips the end of line chars.</info> <arg name='p' info='and UTF8 string pointer'/> </macro> + <macro name='SOCKET' file='nanoftp'> + <info>macro used to provide portability of code to windows sockets</info> + </macro> <macro name='WITHOUT_TRIO' file='xmlversion'> <info>defined if the trio support should not be configured in</info> </macro> @@ -4593,6 +4610,7 @@ <enum name='HTML_NA' file='HTMLparser' value='0' type='htmlStatus' info='something we don't check at all'/> <enum name='HTML_PARSE_COMPACT' file='HTMLparser' value='65536' type='htmlParserOption' info=' compact small text nodes'/> <enum name='HTML_PARSE_NOBLANKS' file='HTMLparser' value='256' type='htmlParserOption' info='remove blank nodes'/> + <enum name='HTML_PARSE_NODEFDTD' file='HTMLparser' value='4' type='htmlParserOption' info='do not default a doctype if not found'/> <enum name='HTML_PARSE_NOERROR' file='HTMLparser' value='32' type='htmlParserOption' info='suppress error reports'/> <enum name='HTML_PARSE_NOIMPLIED' file='HTMLparser' value='8192' type='htmlParserOption' info='Do not add implied html/body... elements'/> <enum name='HTML_PARSE_NONET' file='HTMLparser' value='2048' type='htmlParserOption' info='Forbid network access'/> @@ -5268,7 +5286,7 @@ crash if you try to modify the tree)'/> <enum name='XML_RNGP_VALUE_NO_CONTENT' file='xmlerror' value='1120' type='xmlParserErrors' info='1120'/> <enum name='XML_RNGP_XMLNS_NAME' file='xmlerror' value='1121' type='xmlParserErrors' info='1121'/> <enum name='XML_RNGP_XML_NS' file='xmlerror' value='1122' type='xmlParserErrors' info='1122'/> - <enum name='XML_SAVE_AS_HTML' file='xmlsave' value='64' type='xmlSaveOption' info=' force HTML serialization on XML doc'/> + <enum name='XML_SAVE_AS_HTML' file='xmlsave' value='64' type='xmlSaveOption' info='force HTML serialization on XML doc'/> <enum name='XML_SAVE_AS_XML' file='xmlsave' value='32' type='xmlSaveOption' info='force XML serialization on HTML doc'/> <enum name='XML_SAVE_CHAR_INVALID' file='xmlerror' value='1401' type='xmlParserErrors' info='1401'/> <enum name='XML_SAVE_FORMAT' file='xmlsave' value='1' type='xmlSaveOption' info='format save output'/> @@ -5278,6 +5296,7 @@ crash if you try to modify the tree)'/> <enum name='XML_SAVE_NO_EMPTY' file='xmlsave' value='4' type='xmlSaveOption' info='no empty tags'/> <enum name='XML_SAVE_NO_XHTML' file='xmlsave' value='8' type='xmlSaveOption' info='disable XHTML1 specific rules'/> <enum name='XML_SAVE_UNKNOWN_ENCODING' file='xmlerror' value='1403' type='xmlParserErrors' info='1403'/> + <enum name='XML_SAVE_WSNONSIG' file='xmlsave' value='128' type='xmlSaveOption' info=' format with non-significant whitespace'/> <enum name='XML_SAVE_XHTML' file='xmlsave' value='16' type='xmlSaveOption' info='force XHTML1 specific rules'/> <enum name='XML_SCHEMAP_AG_PROPS_CORRECT' file='xmlerror' value='3087' type='xmlParserErrors' info='3086'/> <enum name='XML_SCHEMAP_ATTRFORMDEFAULT_VALUE' file='xmlerror' value='1701' type='xmlParserErrors' info='1701'/> @@ -5719,6 +5738,7 @@ crash if you try to modify the tree)'/> <enum name='XML_WITH_HTML' file='parser' value='12' type='xmlFeature'/> <enum name='XML_WITH_HTTP' file='parser' value='10' type='xmlFeature'/> <enum name='XML_WITH_ICONV' file='parser' value='19' type='xmlFeature'/> + <enum name='XML_WITH_ICU' file='parser' value='32' type='xmlFeature'/> <enum name='XML_WITH_ISO8859X' file='parser' value='20' type='xmlFeature'/> <enum name='XML_WITH_LEGACY' file='parser' value='13' type='xmlFeature'/> <enum name='XML_WITH_MODULES' file='parser' value='27' type='xmlFeature'/> @@ -5871,6 +5891,10 @@ if necessary or NULL'/> <typedef name='htmlSAXHandler' file='HTMLparser' type='xmlSAXHandler'/> <typedef name='htmlSAXHandlerPtr' file='HTMLparser' type='xmlSAXHandlerPtr'/> <typedef name='htmlStatus' file='HTMLparser' type='enum'/> + <struct name='uconv_t' file='encoding' type='struct _uconv_t'> + <field name='uconv' type='UConverter *' info=' for conversion between an encoding and UTF-16'/> + <field name='utf8' type='UConverter *' info=' for conversion between UTF-8 and UTF-16'/> + </struct> <typedef name='xlinkActuate' file='xlink' type='enum'/> <typedef name='xlinkHRef' file='xlink' type='xmlChar *'/> <struct name='xlinkHandler' file='xlink' type='struct _xlinkHandler'> @@ -5970,6 +5994,8 @@ if necessary or NULL'/> <field name='output' type='xmlCharEncodingOutputFunc' info=''/> <field name='iconv_in' type='iconv_t' info=''/> <field name='iconv_out' type='iconv_t' info=''/> + <field name='uconv_in' type='uconv_t *' info=''/> + <field name='uconv_out' type='uconv_t *' info=''/> </struct> <typedef name='xmlCharEncodingHandlerPtr' file='encoding' type='xmlCharEncodingHandler *'/> <struct name='xmlDOMWrapCtxt' file='tree' type='struct _xmlDOMWrapCtxt'> @@ -8850,7 +8876,7 @@ Could we use @subtypes for this?'/> <arg name='ret' type='xmlParserInputPtr' info='an XML parser input'/> </function> <function name='xmlCheckLanguageID' file='parserInternals' module='parser'> - <info>Checks that the value conforms to the LanguageID production: NOTE: this is somewhat deprecated, those productions were removed from the XML Second edition. [33] LanguageID ::= Langcode ('-' Subcode)* [34] Langcode ::= ISO639Code | IanaCode | UserCode [35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z]) [36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+ [37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+ [38] Subcode ::= ([a-z] | [A-Z])+</info> + <info>Checks that the value conforms to the LanguageID production: NOTE: this is somewhat deprecated, those productions were removed from the XML Second edition. [33] LanguageID ::= Langcode ('-' Subcode)* [34] Langcode ::= ISO639Code | IanaCode | UserCode [35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z]) [36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+ [37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+ [38] Subcode ::= ([a-z] | [A-Z])+ The current REC reference the sucessors of RFC 1766, currently 5646 http://www.rfc-editor.org/rfc/rfc5646.txt langtag = language ["-" script] ["-" region] *("-" variant) *("-" extension) ["-" privateuse] language = 2*3ALPHA ; shortest ISO 639 code ["-" extlang] ; sometimes followed by ; extended language subtags / 4ALPHA ; or reserved for future use / 5*8ALPHA ; or registered language subtag extlang = 3ALPHA ; selected ISO 639 codes *2("-" 3ALPHA) ; permanently reserved script = 4ALPHA ; ISO 15924 code region = 2ALPHA ; ISO 3166-1 code / 3DIGIT ; UN M.49 code variant = 5*8alphanum ; registered variants / (DIGIT 3alphanum) extension = singleton 1*("-" (2*8alphanum)) ; Single alphanumerics ; "x" reserved for private use singleton = DIGIT ; 0 - 9 / %x41-57 ; A - W / %x59-5A ; Y - Z / %x61-77 ; a - w / %x79-7A ; y - z it sounds right to still allow Irregular i-xxx IANA and user codes too The parser below doesn't try to cope with extension or privateuse that could be added but that's not interoperable anyway</info> <return type='int' info='1 if correct 0 otherwise'/> <arg name='lang' type='const xmlChar *' info='pointer to the string value'/> </function> @@ -11040,7 +11066,7 @@ Could we use @subtypes for this?'/> <function name='xmlNanoFTPGetConnection' file='nanoftp' module='nanoftp'> <cond>defined(LIBXML_FTP_ENABLED)</cond> <info>Try to open a data connection to the server. Currently only passive mode is supported.</info> - <return type='int' info='-1 incase of error, 0 otherwise'/> + <return type='SOCKET' info='-1 incase of error, 0 otherwise'/> <arg name='ctx' type='void *' info='an FTP context'/> </function> <function name='xmlNanoFTPGetResponse' file='nanoftp' module='nanoftp'> @@ -11052,7 +11078,7 @@ Could we use @subtypes for this?'/> <function name='xmlNanoFTPGetSocket' file='nanoftp' module='nanoftp'> <cond>defined(LIBXML_FTP_ENABLED)</cond> <info>Initiate fetch of the given file from the server.</info> - <return type='int' info='the socket for the data connection, or <0 in case of error'/> + <return type='SOCKET' info='the socket for the data connection, or <0 in case of error'/> <arg name='ctx' type='void *' info='an FTP context'/> <arg name='filename' type='const char *' info='the file to retrieve (or NULL if path is in context).'/> </function> @@ -14882,7 +14908,7 @@ Could we use @subtypes for this?'/> <function name='xmlTextReaderReadOuterXml' file='xmlreader' module='xmlreader'> <cond>defined(LIBXML_READER_ENABLED) && defined(LIBXML_WRITER_ENABLED)</cond> <info>Reads the contents of the current node, including child nodes and markup.</info> - <return type='xmlChar *' info='a string containing the XML content, or NULL if the current node is neither an element nor attribute, or has no child nodes. The string must be deallocated by the caller.'/> + <return type='xmlChar *' info='a string containing the node and any XML content, or NULL if the current node cannot be serialized. The string must be deallocated by the caller.'/> <arg name='reader' type='xmlTextReaderPtr' info='the xmlTextReaderPtr used'/> </function> <function name='xmlTextReaderReadState' file='xmlreader' module='xmlreader'> |