summaryrefslogtreecommitdiff
path: root/doc/libxml2-api.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libxml2-api.xml')
-rw-r--r--doc/libxml2-api.xml71
1 files changed, 60 insertions, 11 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml
index b396c3e..30da57c 100644
--- a/doc/libxml2-api.xml
+++ b/doc/libxml2-api.xml
@@ -679,7 +679,7 @@
<exports symbol='XML_PARSE_UNKNOWN' type='enum'/>
<exports symbol='XML_WITH_XPATH' type='enum'/>
<exports symbol='XML_WITH_HTML' type='enum'/>
- <exports symbol='XML_WITH_FTP' type='enum'/>
+ <exports symbol='XML_PARSE_OLDSAX' type='enum'/>
<exports symbol='XML_WITH_WRITER' type='enum'/>
<exports symbol='XML_WITH_C14N' type='enum'/>
<exports symbol='XML_PARSE_PUSH_DOM' type='enum'/>
@@ -733,6 +733,7 @@
<exports symbol='XML_PARSER_START' type='enum'/>
<exports symbol='XML_WITH_DEBUG_MEM' type='enum'/>
<exports symbol='XML_PARSE_HUGE' type='enum'/>
+ <exports symbol='XML_WITH_FTP' type='enum'/>
<exports symbol='XML_PARSER_START_TAG' type='enum'/>
<exports symbol='XML_PARSER_IGNORE' type='enum'/>
<exports symbol='XML_PARSER_COMMENT' type='enum'/>
@@ -886,6 +887,7 @@
<exports symbol='IS_EXTENDER_CH' type='macro'/>
<exports symbol='IS_BLANK_CH' type='macro'/>
<exports symbol='IS_LETTER_CH' type='macro'/>
+ <exports symbol='XML_MAX_TEXT_LENGTH' type='macro'/>
<exports symbol='XML_SUBSTITUTE_NONE' type='macro'/>
<exports symbol='IS_COMBINING' type='macro'/>
<exports symbol='XML_MAX_NAMELEN' type='macro'/>
@@ -1543,11 +1545,12 @@
<exports symbol='xmlBufferAddHead' type='function'/>
<exports symbol='xmlNewPI' type='function'/>
<exports symbol='xmlDocDumpFormatMemoryEnc' type='function'/>
- <exports symbol='xmlUnsetNsProp' type='function'/>
+ <exports symbol='xmlChildElementCount' type='function'/>
<exports symbol='xmlElemDump' type='function'/>
<exports symbol='xmlSaveFormatFileTo' type='function'/>
<exports symbol='xmlGetIntSubset' type='function'/>
<exports symbol='xmlNodeBufGetContent' type='function'/>
+ <exports symbol='xmlNextElementSibling' type='function'/>
<exports symbol='xmlBufferWriteChar' type='function'/>
<exports symbol='xmlBufferFree' type='function'/>
<exports symbol='xmlDOMWrapCloneNode' type='function'/>
@@ -1577,6 +1580,8 @@
<exports symbol='xmlGetNodePath' type='function'/>
<exports symbol='xmlFreePropList' type='function'/>
<exports symbol='xmlNodeAddContent' type='function'/>
+ <exports symbol='xmlUnsetNsProp' type='function'/>
+ <exports symbol='xmlFirstElementChild' type='function'/>
<exports symbol='xmlAddNextSibling' type='function'/>
<exports symbol='xmlIsBlankNode' type='function'/>
<exports symbol='xmlNewGlobalNs' type='function'/>
@@ -1597,6 +1602,7 @@
<exports symbol='xmlTextConcat' type='function'/>
<exports symbol='xmlNodeGetSpacePreserve' type='function'/>
<exports symbol='xmlBufferShrink' type='function'/>
+ <exports symbol='xmlPreviousElementSibling' type='function'/>
<exports symbol='xmlNodeSetContentLen' type='function'/>
<exports symbol='xmlNodeAddContentLen' type='function'/>
<exports symbol='xmlBufferWriteQuotedString' type='function'/>
@@ -1611,6 +1617,7 @@
<exports symbol='xmlGetLineNo' type='function'/>
<exports symbol='xmlBufferContent' type='function'/>
<exports symbol='xmlRemoveProp' type='function'/>
+ <exports symbol='xmlLastElementChild' type='function'/>
<exports symbol='xmlNodeGetLang' type='function'/>
<exports symbol='xmlGetDocCompressMode' type='function'/>
<exports symbol='xmlGetNsProp' type='function'/>
@@ -3329,7 +3336,7 @@
<description>compile-time version informations for the XML library </description>
<author>Daniel Veillard </author>
<exports symbol='LIBXML_VERSION_EXTRA' type='macro'/>
- <exports symbol='LIBXML_MODULES_ENABLED' type='macro'/>
+ <exports symbol='LIBXML_DOCB_ENABLED' type='macro'/>
<exports symbol='LIBXML_LEGACY_ENABLED' type='macro'/>
<exports symbol='LIBXML_READER_ENABLED' type='macro'/>
<exports symbol='LIBXML_THREAD_ENABLED' type='macro'/>
@@ -3338,8 +3345,8 @@
<exports symbol='LIBXML_DEBUG_ENABLED' type='macro'/>
<exports symbol='LIBXML_XINCLUDE_ENABLED' type='macro'/>
<exports symbol='ATTRIBUTE_UNUSED' type='macro'/>
- <exports symbol='LIBXML_DOCB_ENABLED' type='macro'/>
- <exports symbol='LIBXML_PUSH_ENABLED' type='macro'/>
+ <exports symbol='LIBXML_MODULES_ENABLED' type='macro'/>
+ <exports symbol='ATTRIBUTE_PRINTF' type='macro'/>
<exports symbol='LIBXML_SAX1_ENABLED' type='macro'/>
<exports symbol='WITHOUT_TRIO' type='macro'/>
<exports symbol='LIBXML_SCHEMATRON_ENABLED' type='macro'/>
@@ -3355,11 +3362,13 @@
<exports symbol='LIBXML_MODULE_EXTENSION' type='macro'/>
<exports symbol='LIBXML_ICONV_ENABLED' type='macro'/>
<exports symbol='LIBXML_HTML_ENABLED' type='macro'/>
+ <exports symbol='LIBXML_WRITER_ENABLED' type='macro'/>
<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='ATTRIBUTE_ALLOC_SIZE' type='macro'/>
+ <exports symbol='LIBXML_PUSH_ENABLED' type='macro'/>
<exports symbol='LIBXML_C14N_ENABLED' type='macro'/>
<exports symbol='LIBXML_SCHEMAS_ENABLED' type='macro'/>
<exports symbol='DEBUG_MEMORY_LOCATION' type='macro'/>
@@ -3759,6 +3768,12 @@
</file>
</files>
<symbols>
+ <macro name='ATTRIBUTE_ALLOC_SIZE' file='xmlversion'>
+ <info>Macro used to indicate to GCC this is an allocator function</info>
+ </macro>
+ <macro name='ATTRIBUTE_PRINTF' file='xmlversion'>
+ <info>Macro used to indicate to GCC the parameter are printf like</info>
+ </macro>
<macro name='ATTRIBUTE_UNUSED' file='xmlversion'>
<info>Macro used to signal to GCC unused function parameters</info>
</macro>
@@ -4101,6 +4116,9 @@
<macro name='XML_MAX_NAMELEN' file='parserInternals'>
<info>Identifiers can be longer, but this will be more costly at runtime.</info>
</macro>
+ <macro name='XML_MAX_TEXT_LENGTH' file='parserInternals'>
+ <info>Maximum size allowed for a single text node when building a tree. This is not a limitation of the parser but a safety boundary feature, use XML_PARSE_HUGE option to override it.</info>
+ </macro>
<macro name='XML_SAX2_MAGIC' file='parser'>
<info>Special constant found in SAX2 blocks initialized fields</info>
</macro>
@@ -5027,7 +5045,7 @@ crash if you try to modify the tree)'/>
<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'/>
<enum name='XML_PARSE_DTDVALID' file='parser' value='16' type='xmlParserOption' info='validate with the DTD'/>
- <enum name='XML_PARSE_HUGE' file='parser' value='524288' type='xmlParserOption' info=' relax any hardcoded limit from the parser'/>
+ <enum name='XML_PARSE_HUGE' file='parser' value='524288' type='xmlParserOption' info='relax any hardcoded limit from the parser'/>
<enum name='XML_PARSE_NOBASEFIX' file='parser' value='262144' type='xmlParserOption' info='do not fixup XINCLUDE xml:base uris'/>
<enum name='XML_PARSE_NOBLANKS' file='parser' value='256' type='xmlParserOption' info='remove blank nodes'/>
<enum name='XML_PARSE_NOCDATA' file='parser' value='16384' type='xmlParserOption' info='merge CDATA as text nodes'/>
@@ -5039,6 +5057,7 @@ crash if you try to modify the tree)'/>
<enum name='XML_PARSE_NOXINCNODE' file='parser' value='32768' type='xmlParserOption' info='do not generate XINCLUDE START/END nodes'/>
<enum name='XML_PARSE_NSCLEAN' file='parser' value='8192' type='xmlParserOption' info='remove redundant namespaces declarations'/>
<enum name='XML_PARSE_OLD10' file='parser' value='131072' type='xmlParserOption' info='parse using XML-1.0 before update 5'/>
+ <enum name='XML_PARSE_OLDSAX' file='parser' value='1048576' type='xmlParserOption' info=' parse using SAX2 interface from before 2.7.0'/>
<enum name='XML_PARSE_PEDANTIC' file='parser' value='128' type='xmlParserOption' info='pedantic error reporting'/>
<enum name='XML_PARSE_PUSH_DOM' file='parser' value='3' type='xmlParserMode'/>
<enum name='XML_PARSE_PUSH_SAX' file='parser' value='4' type='xmlParserMode'/>
@@ -8824,6 +8843,12 @@ Could we use @subtypes for this?'/>
<return type='void'/>
<arg name='version' type='int' info='the include version number'/>
</function>
+ <function name='xmlChildElementCount' file='tree' module='tree'>
+ <cond>defined(LIBXML_TREE_ENABLED)</cond>
+ <info>Finds the current number of child nodes of that element which are element nodes. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don&apos;t have back reference from entities content to entities references.</info>
+ <return type='unsigned long' info='the count of element child or 0 if not available'/>
+ <arg name='parent' type='xmlNodePtr' info='the parent node'/>
+ </function>
<function name='xmlCleanupCharEncodingHandlers' file='encoding' module='encoding'>
<info>Cleanup the memory allocated for the char encoding support, it unregisters all the encoding handlers and the aliases.</info>
<return type='void'/>
@@ -9718,6 +9743,12 @@ Could we use @subtypes for this?'/>
<return type='xmlCharEncodingHandlerPtr' info='the handler or NULL if not found'/>
<arg name='name' type='const char *' info='a string describing the char encoding.'/>
</function>
+ <function name='xmlFirstElementChild' file='tree' module='tree'>
+ <cond>defined(LIBXML_TREE_ENABLED)</cond>
+ <info>Finds the first child node of that element which is a Element node Note the handling of entities references is different than in the W3C DOM element traversal spec since we don&apos;t have back reference from entities content to entities references.</info>
+ <return type='xmlNodePtr' info='the first element child or NULL if not available'/>
+ <arg name='parent' type='xmlNodePtr' info='the parent node'/>
+ </function>
<function name='xmlFreeAttributeTable' file='valid' module='valid'>
<info>Deallocate the memory used by an entities hash table.</info>
<return type='void'/>
@@ -10550,6 +10581,12 @@ Could we use @subtypes for this?'/>
<return type='int' info='the last value for 0 for no substitution, 1 for substitution.'/>
<arg name='val' type='int' info='int 0 or 1'/>
</function>
+ <function name='xmlLastElementChild' file='tree' module='tree'>
+ <cond>defined(LIBXML_TREE_ENABLED)</cond>
+ <info>Finds the last child node of that element which is a Element node Note the handling of entities references is different than in the W3C DOM element traversal spec since we don&apos;t have back reference from entities content to entities references.</info>
+ <return type='xmlNodePtr' info='the last element child or NULL if not available'/>
+ <arg name='parent' type='xmlNodePtr' info='the parent node'/>
+ </function>
<function name='xmlLineNumbersDefault' file='parser' module='parserInternals'>
<info>Set and return the previous value for enabling line numbers in elements contents. This may break on old application and is turned off by default.</info>
<return type='int' info='the last value for 0 for no substitution, 1 for substitution.'/>
@@ -11515,6 +11552,12 @@ Could we use @subtypes for this?'/>
<return type='void'/>
<arg name='ctxt' type='xmlParserCtxtPtr' info='the XML parser context'/>
</function>
+ <function name='xmlNextElementSibling' file='tree' module='tree'>
+ <cond>defined(LIBXML_TREE_ENABLED)</cond>
+ <info>Finds the first closest next sibling of the node which is an element node. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don&apos;t have back reference from entities content to entities references.</info>
+ <return type='xmlNodePtr' info='the next element sibling or NULL if not available'/>
+ <arg name='node' type='xmlNodePtr' info='the current node'/>
+ </function>
<function name='xmlNoNetExternalEntityLoader' file='xmlIO' module='xmlIO'>
<info>A specific entity loader disabling network accesses, though still allowing local catalog accesses for resolution.</info>
<return type='xmlParserInputPtr' info='a new allocated xmlParserInputPtr, or NULL.'/>
@@ -12375,6 +12418,12 @@ Could we use @subtypes for this?'/>
<info>Clear the top input callback from the input stack. this includes the compiled-in I/O.</info>
<return type='int' info='the number of input callback registered or -1 in case of error.'/>
</function>
+ <function name='xmlPreviousElementSibling' file='tree' module='tree'>
+ <cond>defined(LIBXML_TREE_ENABLED)</cond>
+ <info>Finds the first closest previous sibling of the node which is an element node. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don&apos;t have back reference from entities content to entities references.</info>
+ <return type='xmlNodePtr' info='the previous element sibling or NULL if not available'/>
+ <arg name='node' type='xmlNodePtr' info='the current node'/>
+ </function>
<function name='xmlPrintURI' file='uri' module='uri'>
<info>Prints the URI in the stream @stream.</info>
<return type='void'/>
@@ -16744,10 +16793,10 @@ Could we use @subtypes for this?'/>
</function>
<function name='xmlValidateAttributeValue' file='valid' module='valid'>
<cond>defined(LIBXML_VALID_ENABLED)</cond>
- <info></info>
- <return type='int' info=''/>
- <arg name='type' type='xmlAttributeType' info=''/>
- <arg name='value' type='const xmlChar *' info=''/>
+ <info>Validate that the given attribute value match the proper production [ VC: ID ] Values of type ID must match the Name production.... [ VC: IDREF ] Values of type IDREF must match the Name production, and values of type IDREFS must match Names ... [ VC: Entity Name ] Values of type ENTITY must match the Name production, values of type ENTITIES must match Names ... [ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values of type NMTOKENS must match Nmtokens.</info>
+ <return type='int' info='1 if valid or 0 otherwise'/>
+ <arg name='type' type='xmlAttributeType' info='an attribute type'/>
+ <arg name='value' type='const xmlChar *' info='an attribute value'/>
</function>
<function name='xmlValidateDocument' file='valid' module='valid'>
<cond>defined(LIBXML_VALID_ENABLED)</cond>