diff options
Diffstat (limited to 'doc/libxml2-api.xml')
| -rw-r--r-- | doc/libxml2-api.xml | 346 |
1 files changed, 207 insertions, 139 deletions
diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml index 867ac92..98dc568 100644 --- a/doc/libxml2-api.xml +++ b/doc/libxml2-api.xml @@ -445,6 +445,7 @@ <exports symbol='xmlEntitiesTablePtr' type='typedef'/> <exports symbol='_xmlEntity' type='struct'/> <exports symbol='xmlAddDocEntity' type='function'/> + <exports symbol='xmlNewEntity' type='function'/> <exports symbol='xmlEncodeEntitiesReentrant' type='function'/> <exports symbol='xmlGetDocEntity' type='function'/> <exports symbol='xmlGetDtdEntity' type='function'/> @@ -665,6 +666,7 @@ <exports symbol='XML_SAX2_MAGIC' type='macro'/> <exports symbol='XML_DETECT_IDS' type='macro'/> <exports symbol='XML_DEFAULT_VERSION' type='macro'/> + <exports symbol='XML_WITH_NONE' type='enum'/> <exports symbol='XML_WITH_SCHEMATRON' type='enum'/> <exports symbol='XML_PARSER_ENTITY_DECL' type='enum'/> <exports symbol='XML_PARSER_CONTENT' type='enum'/> @@ -674,9 +676,10 @@ <exports symbol='XML_PARSER_SYSTEM_LITERAL' type='enum'/> <exports symbol='XML_WITH_REGEXP' type='enum'/> <exports symbol='XML_PARSER_PI' type='enum'/> - <exports symbol='XML_WITH_FTP' type='enum'/> + <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_WITH_WRITER' type='enum'/> <exports symbol='XML_WITH_C14N' type='enum'/> <exports symbol='XML_PARSE_PUSH_DOM' type='enum'/> @@ -699,7 +702,7 @@ <exports symbol='XML_WITH_LEGACY' type='enum'/> <exports symbol='XML_PARSE_XINCLUDE' type='enum'/> <exports symbol='XML_PARSE_NOXINCNODE' type='enum'/> - <exports symbol='XML_WITH_NONE' type='enum'/> + <exports symbol='XML_PARSE_NOBASEFIX' type='enum'/> <exports symbol='XML_WITH_OUTPUT' type='enum'/> <exports symbol='XML_WITH_XINCLUDE' type='enum'/> <exports symbol='XML_WITH_PUSH' type='enum'/> @@ -711,7 +714,7 @@ <exports symbol='XML_PARSE_DTDLOAD' type='enum'/> <exports symbol='XML_PARSE_DTDATTR' type='enum'/> <exports symbol='XML_PARSE_NOWARNING' type='enum'/> - <exports symbol='XML_WITH_VALID' type='enum'/> + <exports symbol='XML_PARSE_OLD10' type='enum'/> <exports symbol='XML_PARSE_NOERROR' type='enum'/> <exports symbol='XML_WITH_ISO8859X' type='enum'/> <exports symbol='XML_WITH_EXPR' type='enum'/> @@ -729,7 +732,7 @@ <exports symbol='XML_PARSER_MISC' type='enum'/> <exports symbol='XML_PARSER_START' type='enum'/> <exports symbol='XML_WITH_DEBUG_MEM' type='enum'/> - <exports symbol='XML_PARSE_UNKNOWN' type='enum'/> + <exports symbol='XML_PARSE_HUGE' type='enum'/> <exports symbol='XML_PARSER_START_TAG' type='enum'/> <exports symbol='XML_PARSER_IGNORE' type='enum'/> <exports symbol='XML_PARSER_COMMENT' type='enum'/> @@ -738,6 +741,7 @@ <exports symbol='XML_WITH_AUTOMATA' type='enum'/> <exports symbol='XML_WITH_DEBUG_RUN' type='enum'/> <exports symbol='XML_WITH_SAX1' type='enum'/> + <exports symbol='XML_WITH_VALID' type='enum'/> <exports symbol='xmlParserNodeInfoSeqPtr' type='typedef'/> <exports symbol='xmlSAXHandlerV1' type='typedef'/> <exports symbol='xmlParserInputState' type='typedef'/> @@ -1393,36 +1397,44 @@ <exports symbol='BASE_BUFFER_SIZE' type='macro'/> <exports symbol='XML_ATTRIBUTE_IMPLIED' type='enum'/> <exports symbol='XML_ELEMENT_CONTENT_ELEMENT' type='enum'/> + <exports symbol='XML_ENTITY_REF_NODE' type='enum'/> <exports symbol='XML_ATTRIBUTE_IDREFS' type='enum'/> <exports symbol='XML_BUFFER_ALLOC_DOUBLEIT' type='enum'/> <exports symbol='XML_XINCLUDE_END' type='enum'/> <exports symbol='XML_ATTRIBUTE_NODE' type='enum'/> + <exports symbol='XML_ATTRIBUTE_NMTOKENS' type='enum'/> <exports symbol='XML_ATTRIBUTE_IDREF' type='enum'/> <exports symbol='XML_ELEMENT_TYPE_ELEMENT' type='enum'/> + <exports symbol='XML_TEXT_NODE' type='enum'/> <exports symbol='XML_CDATA_SECTION_NODE' type='enum'/> <exports symbol='XML_ELEMENT_NODE' type='enum'/> <exports symbol='XML_ELEMENT_DECL' type='enum'/> - <exports symbol='XML_ELEMENT_CONTENT_SEQ' type='enum'/> + <exports symbol='XML_DOC_USERBUILT' type='enum'/> + <exports symbol='XML_DOC_INTERNAL' type='enum'/> <exports symbol='XML_ATTRIBUTE_REQUIRED' type='enum'/> <exports symbol='XML_DOCUMENT_FRAG_NODE' type='enum'/> + <exports symbol='XML_DOC_DTDVALID' type='enum'/> <exports symbol='XML_ELEMENT_TYPE_ANY' type='enum'/> + <exports symbol='XML_DOC_NSVALID' type='enum'/> <exports symbol='XML_ELEMENT_CONTENT_ONCE' type='enum'/> <exports symbol='XML_ELEMENT_CONTENT_PCDATA' type='enum'/> <exports symbol='XML_ATTRIBUTE_FIXED' type='enum'/> <exports symbol='XML_DOCUMENT_TYPE_NODE' type='enum'/> + <exports symbol='XML_DOC_HTML' type='enum'/> <exports symbol='XML_ELEMENT_CONTENT_OPT' type='enum'/> <exports symbol='XML_NAMESPACE_DECL' type='enum'/> <exports symbol='XML_ATTRIBUTE_NOTATION' type='enum'/> <exports symbol='XML_ELEMENT_TYPE_MIXED' type='enum'/> <exports symbol='XML_XINCLUDE_START' type='enum'/> - <exports symbol='XML_TEXT_NODE' type='enum'/> + <exports symbol='XML_DOC_XINCLUDE' type='enum'/> <exports symbol='XML_BUFFER_ALLOC_EXACT' type='enum'/> <exports symbol='XML_ATTRIBUTE_ENTITIES' type='enum'/> <exports symbol='XML_BUFFER_ALLOC_IMMUTABLE' type='enum'/> <exports symbol='XML_NOTATION_NODE' type='enum'/> - <exports symbol='XML_ENTITY_REF_NODE' type='enum'/> + <exports symbol='XML_ELEMENT_CONTENT_SEQ' type='enum'/> <exports symbol='XML_ELEMENT_TYPE_EMPTY' type='enum'/> <exports symbol='XML_ATTRIBUTE_ENUMERATION' type='enum'/> + <exports symbol='XML_DOC_OLD10' type='enum'/> <exports symbol='XML_HTML_DOCUMENT_NODE' type='enum'/> <exports symbol='XML_ELEMENT_TYPE_UNDEFINED' type='enum'/> <exports symbol='XML_DOCUMENT_NODE' type='enum'/> @@ -1433,9 +1445,10 @@ <exports symbol='XML_ELEMENT_CONTENT_OR' type='enum'/> <exports symbol='XML_ATTRIBUTE_NMTOKEN' type='enum'/> <exports symbol='XML_PI_NODE' type='enum'/> - <exports symbol='XML_ATTRIBUTE_NMTOKENS' type='enum'/> + <exports symbol='XML_BUFFER_ALLOC_IO' type='enum'/> <exports symbol='XML_ENTITY_NODE' type='enum'/> <exports symbol='XML_ATTRIBUTE_ENTITY' type='enum'/> + <exports symbol='XML_DOC_WELLFORMED' type='enum'/> <exports symbol='XML_ATTRIBUTE_DECL' type='enum'/> <exports symbol='XML_ENTITY_DECL' type='enum'/> <exports symbol='XML_ATTRIBUTE_ID' type='enum'/> @@ -1487,6 +1500,7 @@ <exports symbol='xmlSAXLocator' type='typedef'/> <exports symbol='xmlElementContentPtr' type='typedef'/> <exports symbol='xmlElementContentType' type='typedef'/> + <exports symbol='xmlDocProperties' type='typedef'/> <exports symbol='xmlIDPtr' type='typedef'/> <exports symbol='xmlDtd' type='typedef'/> <exports symbol='xmlAttribute' type='typedef'/> @@ -2010,7 +2024,6 @@ <exports symbol='XML_ERR_ENTITY_LOOP' type='enum'/> <exports symbol='XML_IO_EINPROGRESS' type='enum'/> <exports symbol='XML_SCHEMAP_REDEFINED_NOTATION' type='enum'/> - <exports symbol='XML_IO_EFAULT' type='enum'/> <exports symbol='XML_HTML_STRUCURE_ERROR' type='enum'/> <exports symbol='XML_DTD_INVALID_DEFAULT' type='enum'/> <exports symbol='XML_FROM_SCHEMATRONV' type='enum'/> @@ -2023,7 +2036,7 @@ <exports symbol='XML_SCHEMAP_COS_ST_RESTRICTS_1_1' type='enum'/> <exports symbol='XML_SCHEMAP_UNKNOWN_SIMPLETYPE_CHILD' type='enum'/> <exports symbol='XML_ERR_PEREF_AT_EOF' type='enum'/> - <exports symbol='XML_IO_LOAD_ERROR' type='enum'/> + <exports symbol='XML_DTD_NOT_EMPTY' type='enum'/> <exports symbol='XML_RNGP_PAT_START_LIST' type='enum'/> <exports symbol='XML_ERR_LT_REQUIRED' type='enum'/> <exports symbol='XML_SCHEMAP_DERIVATION_OK_RESTRICTION_2_2' type='enum'/> @@ -2062,7 +2075,7 @@ <exports symbol='XML_SCHEMAV_NOTDETERMINIST' type='enum'/> <exports symbol='XML_SCHEMAP_UNKNOWN_EXTENSION_CHILD' type='enum'/> <exports symbol='XML_SCHEMAV_MISSING' type='enum'/> - <exports symbol='XML_RNGP_GRAMMAR_CONTENT' type='enum'/> + <exports symbol='XML_IO_EFAULT' type='enum'/> <exports symbol='XML_XINCLUDE_XPTR_FAILED' type='enum'/> <exports symbol='XML_FROM_FTP' type='enum'/> <exports symbol='XML_RNGP_PARENTREF_CREATE_FAILED' type='enum'/> @@ -2193,6 +2206,7 @@ <exports symbol='XML_ERR_NOTATION_NOT_STARTED' type='enum'/> <exports symbol='XML_DTD_ENTITY_TYPE' type='enum'/> <exports symbol='XML_SCHEMAP_SRC_SIMPLE_TYPE_4' type='enum'/> + <exports symbol='XML_RNGP_GRAMMAR_CONTENT' type='enum'/> <exports symbol='XML_FTP_URL_SYNTAX' type='enum'/> <exports symbol='XML_ERR_NONE' type='enum'/> <exports symbol='XML_SCHEMAP_UNKNOWN_COMPLEXTYPE_CHILD' type='enum'/> @@ -2266,7 +2280,7 @@ <exports symbol='XML_ERR_ATTRIBUTE_NOT_FINISHED' type='enum'/> <exports symbol='XML_SCHEMAV_CVC_FRACTIONDIGITS_VALID' type='enum'/> <exports symbol='XML_SCHEMAP_SRC_LIST_ITEMTYPE_OR_SIMPLETYPE' type='enum'/> - <exports symbol='XML_RNGP_GRAMMAR_EMPTY' type='enum'/> + <exports symbol='XML_IO_EINVAL' type='enum'/> <exports symbol='XML_IO_ENAMETOOLONG' type='enum'/> <exports symbol='XML_RNGP_EXTERNAL_REF_FAILURE' type='enum'/> <exports symbol='XML_RNGP_PAT_START_TEXT' type='enum'/> @@ -2360,6 +2374,7 @@ <exports symbol='XML_SCHEMAP_UNION_NOT_EXPRESSIBLE' type='enum'/> <exports symbol='XML_RNGP_PAT_DATA_EXCEPT_ATTR' type='enum'/> <exports symbol='XML_FTP_PASV_ANSWER' type='enum'/> + <exports symbol='XML_ERR_VERSION_MISMATCH' type='enum'/> <exports symbol='XML_SCHEMAP_INVALID_BOOLEAN' type='enum'/> <exports symbol='XML_SCHEMAV_CVC_ELT_4_2' type='enum'/> <exports symbol='XML_DTD_ELEM_DEFAULT_NAMESPACE' type='enum'/> @@ -2470,7 +2485,7 @@ <exports symbol='XML_ERR_ENTITY_PROCESSING' type='enum'/> <exports symbol='XML_FROM_XINCLUDE' type='enum'/> <exports symbol='XML_SCHEMAP_CVC_SIMPLE_TYPE' type='enum'/> - <exports symbol='XML_IO_EINVAL' type='enum'/> + <exports symbol='XML_RNGP_GRAMMAR_EMPTY' type='enum'/> <exports symbol='XML_CHECK_NOT_NCNAME' type='enum'/> <exports symbol='XML_RNGP_ELEMENT_NO_CONTENT' type='enum'/> <exports symbol='XML_XINCLUDE_NO_HREF' type='enum'/> @@ -2505,6 +2520,7 @@ <exports symbol='XML_I18N_NO_HANDLER' type='enum'/> <exports symbol='XML_RNGP_MISSING_HREF' type='enum'/> <exports symbol='XML_ERR_PI_NOT_FINISHED' type='enum'/> + <exports symbol='XML_ERR_UNKNOWN_VERSION' type='enum'/> <exports symbol='XML_FROM_RELAXNGP' type='enum'/> <exports symbol='XML_FROM_VALID' type='enum'/> <exports symbol='XML_SCHEMAP_S4S_ATTR_INVALID_VALUE' type='enum'/> @@ -2521,6 +2537,7 @@ <exports symbol='XML_SCHEMAP_RECURSIVE' type='enum'/> <exports symbol='XML_HTTP_URL_SYNTAX' type='enum'/> <exports symbol='XML_SCHEMAP_GROUP_NONAME_NOREF' type='enum'/> + <exports symbol='XML_DTD_DUP_TOKEN' type='enum'/> <exports symbol='XML_SCHEMAP_COS_ST_RESTRICTS_2_3_2_4' type='enum'/> <exports symbol='XML_SCHEMAP_S4S_ELEM_MISSING' type='enum'/> <exports symbol='XML_SCHEMAV_CVC_ELT_5_1_1' type='enum'/> @@ -2557,7 +2574,7 @@ <exports symbol='XML_SCHEMAP_DERIVATION_OK_RESTRICTION_1' type='enum'/> <exports symbol='XML_SCHEMAV_CVC_COMPLEX_TYPE_5_1' type='enum'/> <exports symbol='XML_SCHEMAP_DERIVATION_OK_RESTRICTION_3' type='enum'/> - <exports symbol='XML_DTD_NOT_EMPTY' type='enum'/> + <exports symbol='XML_IO_LOAD_ERROR' type='enum'/> <exports symbol='XML_CHECK_NOT_ENTITY_DECL' type='enum'/> <exports symbol='XML_RNGP_CREATE_FAILURE' type='enum'/> <exports symbol='XML_IO_EBADF' type='enum'/> @@ -2666,6 +2683,7 @@ <exports symbol='XML_SCHEMAP_COS_VALID_DEFAULT_2_2_2' type='enum'/> <exports symbol='XML_SCHEMAP_COS_VALID_DEFAULT_2_2_1' type='enum'/> <exports symbol='XML_ERR_OK' type='enum'/> + <exports symbol='XML_NS_ERR_COLON' type='enum'/> <exports symbol='XML_WAR_ENTITY_REDEFINED' type='enum'/> <exports symbol='XML_ERR_ATTRIBUTE_REDEFINED' type='enum'/> <exports symbol='XML_SCHEMAP_SIMPLETYPE_NONAME' type='enum'/> @@ -2742,6 +2760,7 @@ <exports symbol='xmlInitMemory' type='function'/> <exports symbol='xmlMemFree' type='function'/> <exports symbol='xmlMemMalloc' type='function'/> + <exports symbol='xmlMemDisplayLast' type='function'/> <exports symbol='xmlMemGet' type='function'/> <exports symbol='xmlMemoryDump' type='function'/> <exports symbol='xmlMallocLoc' type='function'/> @@ -3046,6 +3065,7 @@ <exports symbol='xmlSchemaValidityWarningFunc' type='function'/> <exports symbol='xmlSchemaDump' type='function'/> <exports symbol='xmlSchemaFreeValidCtxt' type='function'/> + <exports symbol='xmlSchemaValidCtxtGetParserCtxt' type='function'/> <exports symbol='xmlSchemaSetParserStructuredErrors' type='function'/> <exports symbol='xmlSchemaNewValidCtxt' type='function'/> </file> @@ -4579,9 +4599,10 @@ <enum name='XML_ATTRIBUTE_NONE' file='tree' value='1' type='xmlAttributeDefault'/> <enum name='XML_ATTRIBUTE_NOTATION' file='tree' value='10' type='xmlAttributeType'/> <enum name='XML_ATTRIBUTE_REQUIRED' file='tree' value='2' type='xmlAttributeDefault'/> - <enum name='XML_BUFFER_ALLOC_DOUBLEIT' file='tree' value='1' type='xmlBufferAllocationScheme'/> - <enum name='XML_BUFFER_ALLOC_EXACT' file='tree' value='2' type='xmlBufferAllocationScheme'/> - <enum name='XML_BUFFER_ALLOC_IMMUTABLE' file='tree' value='3' type='xmlBufferAllocationScheme'/> + <enum name='XML_BUFFER_ALLOC_DOUBLEIT' file='tree' value='1' type='xmlBufferAllocationScheme' info='double each time one need to grow'/> + <enum name='XML_BUFFER_ALLOC_EXACT' file='tree' value='2' type='xmlBufferAllocationScheme' info='grow only to the minimal size'/> + <enum name='XML_BUFFER_ALLOC_IMMUTABLE' file='tree' value='3' type='xmlBufferAllocationScheme' info='immutable buffer'/> + <enum name='XML_BUFFER_ALLOC_IO' file='tree' value='4' type='xmlBufferAllocationScheme' info=' special allocation scheme used for I/O'/> <enum name='XML_C14N_CREATE_CTXT' file='xmlerror' value='1950' type='xmlParserErrors'/> <enum name='XML_C14N_CREATE_STACK' file='xmlerror' value='1952' type='xmlParserErrors' info='1952'/> <enum name='XML_C14N_INVALID_NODE' file='xmlerror' value='1953' type='xmlParserErrors' info='1953'/> @@ -4670,6 +4691,15 @@ <enum name='XML_DOCUMENT_FRAG_NODE' file='tree' value='11' type='xmlElementType'/> <enum name='XML_DOCUMENT_NODE' file='tree' value='9' type='xmlElementType'/> <enum name='XML_DOCUMENT_TYPE_NODE' file='tree' value='10' type='xmlElementType'/> + <enum name='XML_DOC_DTDVALID' file='tree' value='8' type='xmlDocProperties' info='DTD validation was successful'/> + <enum name='XML_DOC_HTML' file='tree' value='128' type='xmlDocProperties' info=' parsed or built HTML document'/> + <enum name='XML_DOC_INTERNAL' file='tree' value='64' type='xmlDocProperties' info='built for internal processing'/> + <enum name='XML_DOC_NSVALID' file='tree' value='2' type='xmlDocProperties' info='document is Namespace valid'/> + <enum name='XML_DOC_OLD10' file='tree' value='4' type='xmlDocProperties' info='parsed with old XML-1.0 parser'/> + <enum name='XML_DOC_USERBUILT' file='tree' value='32' type='xmlDocProperties' info='Document was built using the API +and not by parsing an instance'/> + <enum name='XML_DOC_WELLFORMED' file='tree' value='1' type='xmlDocProperties' info='document is XML well formed'/> + <enum name='XML_DOC_XINCLUDE' file='tree' value='16' type='xmlDocProperties' info='XInclude substitution was done'/> <enum name='XML_DTD_ATTRIBUTE_DEFAULT' file='xmlerror' value='500' type='xmlParserErrors'/> <enum name='XML_DTD_ATTRIBUTE_REDEFINED' file='xmlerror' value='501' type='xmlParserErrors' info='501'/> <enum name='XML_DTD_ATTRIBUTE_VALUE' file='xmlerror' value='502' type='xmlParserErrors' info='502'/> @@ -4677,6 +4707,7 @@ <enum name='XML_DTD_CONTENT_MODEL' file='xmlerror' value='504' type='xmlParserErrors' info='504'/> <enum name='XML_DTD_CONTENT_NOT_DETERMINIST' file='xmlerror' value='505' type='xmlParserErrors' info='505'/> <enum name='XML_DTD_DIFFERENT_PREFIX' file='xmlerror' value='506' type='xmlParserErrors' info='506'/> + <enum name='XML_DTD_DUP_TOKEN' file='xmlerror' value='541' type='xmlParserErrors' info='541'/> <enum name='XML_DTD_ELEM_DEFAULT_NAMESPACE' file='xmlerror' value='507' type='xmlParserErrors' info='507'/> <enum name='XML_DTD_ELEM_NAMESPACE' file='xmlerror' value='508' type='xmlParserErrors' info='508'/> <enum name='XML_DTD_ELEM_REDEFINED' file='xmlerror' value='509' type='xmlParserErrors' info='509'/> @@ -4824,11 +4855,13 @@ <enum name='XML_ERR_TAG_NOT_FINISHED' file='xmlerror' value='77' type='xmlParserErrors' info='77'/> <enum name='XML_ERR_UNDECLARED_ENTITY' file='xmlerror' value='26' type='xmlParserErrors' info='26'/> <enum name='XML_ERR_UNKNOWN_ENCODING' file='xmlerror' value='31' type='xmlParserErrors' info='31'/> + <enum name='XML_ERR_UNKNOWN_VERSION' file='xmlerror' value='108' type='xmlParserErrors' info='108'/> <enum name='XML_ERR_UNPARSED_ENTITY' file='xmlerror' value='28' type='xmlParserErrors' info='28'/> <enum name='XML_ERR_UNSUPPORTED_ENCODING' file='xmlerror' value='32' type='xmlParserErrors' info='32'/> <enum name='XML_ERR_URI_FRAGMENT' file='xmlerror' value='92' type='xmlParserErrors' info='92'/> <enum name='XML_ERR_URI_REQUIRED' file='xmlerror' value='70' type='xmlParserErrors' info='70'/> <enum name='XML_ERR_VALUE_REQUIRED' file='xmlerror' value='84' type='xmlParserErrors' info='84'/> + <enum name='XML_ERR_VERSION_MISMATCH' file='xmlerror' value='109' type='xmlParserErrors' info='109'/> <enum name='XML_ERR_VERSION_MISSING' file='xmlerror' value='96' type='xmlParserErrors' info='96'/> <enum name='XML_ERR_WARNING' file='xmlerror' value='1' type='xmlErrorLevel' info='A simple warning'/> <enum name='XML_ERR_XMLDECL_NOT_FINISHED' file='xmlerror' value='57' type='xmlParserErrors' info='57'/> @@ -4953,6 +4986,7 @@ <enum name='XML_NAMESPACE_DECL' file='tree' value='18' type='xmlElementType'/> <enum name='XML_NOTATION_NODE' file='tree' value='12' type='xmlElementType'/> <enum name='XML_NS_ERR_ATTRIBUTE_REDEFINED' file='xmlerror' value='203' type='xmlParserErrors' info='203'/> + <enum name='XML_NS_ERR_COLON' file='xmlerror' value='205' type='xmlParserErrors' info='205'/> <enum name='XML_NS_ERR_EMPTY' file='xmlerror' value='204' type='xmlParserErrors' info='204'/> <enum name='XML_NS_ERR_QNAME' file='xmlerror' value='202' type='xmlParserErrors' info='202'/> <enum name='XML_NS_ERR_UNDEFINED_NAMESPACE' file='xmlerror' value='201' type='xmlParserErrors' info='201'/> @@ -4983,13 +5017,15 @@ <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; no modification of + <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'/> <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_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'/> <enum name='XML_PARSE_NODICT' file='parser' value='4096' type='xmlParserOption' info='Do not reuse the context dictionnary'/> @@ -4999,6 +5035,7 @@ crash if you try to modify the tree)'/> <enum name='XML_PARSE_NOWARNING' file='parser' value='64' type='xmlParserOption' info='suppress warning reports'/> <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_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'/> @@ -5861,6 +5898,7 @@ if necessary or NULL'/> <field name='use' type='unsigned int' info=' The buffer size used'/> <field name='size' type='unsigned int' info=' The buffer size'/> <field name='alloc' type='xmlBufferAllocationScheme' info=' The realloc method'/> + <field name='contentIO' type='xmlChar *' info=' in IO mode we may have a different base'/> </struct> <typedef name='xmlBufferAllocationScheme' file='tree' type='enum'/> <typedef name='xmlBufferPtr' file='tree' type='xmlBuffer *'/> @@ -5940,7 +5978,12 @@ standalone attribute was specified'/> actually an xmlCharEncoding'/> <field name='dict' type='struct _xmlDict *' info=' dict used to allocate names or NULL'/> <field name='psvi' type='void *' info=' for type/PSVI informations'/> + <field name='parseFlags' type='int' info=' set of xmlParserOption used to parse the +document'/> + <field name='properties' type='int' info=' set of xmlDocProperties for this document +set at the end of parsing'/> </struct> + <typedef name='xmlDocProperties' file='tree' type='enum'/> <typedef name='xmlDocPtr' file='tree' type='xmlDoc *'/> <struct name='xmlDtd' file='tree' type='struct _xmlDtd'> <field name='_private' type='void *' info=' application data'/> @@ -6016,7 +6059,8 @@ 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'/> + <field name='checked' type='int' info=' was the entity content checked this is also used to count entites +* references done from that entity'/> </struct> <typedef name='xmlEntityPtr' file='tree' type='xmlEntity *'/> <typedef name='xmlEntityType' file='entities' type='enum'/> @@ -6255,6 +6299,8 @@ actually an xmlCharEncoding'/> *'/> <field name='lastError' type='xmlError' info=''/> <field name='parseMode' type='xmlParserMode' info=' the parser mode'/> + <field name='nbentities' type='unsigned long' info=' number of entities references'/> + <field name='sizeentities' type='unsigned long' info=' size of parsed entities'/> </struct> <typedef name='xmlParserCtxtPtr' file='tree' type='xmlParserCtxt *'/> <typedef name='xmlParserErrors' file='xmlerror' type='enum'/> @@ -7727,7 +7773,7 @@ Could we use @subtypes for this?'/> </function> <function name='inputPush' file='parserInternals' module='parser'> <info>Pushes a new parser input on top of the input stack</info> - <return type='int' info='0 in case of error, the index in the stack otherwise'/> + <return type='int' info='-1 in case of error, the index in the stack otherwise'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='value' type='xmlParserInputPtr' info='the parser input'/> </function> @@ -7793,7 +7839,7 @@ Could we use @subtypes for this?'/> </function> <function name='nodePush' file='parserInternals' module='parser'> <info>Pushes a new element node on top of the node stack</info> - <return type='int' info='0 in case of error, the index in the stack otherwise'/> + <return type='int' info='-1 in case of error, the index in the stack otherwise'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='value' type='xmlNodePtr' info='the element node'/> </function> @@ -8552,11 +8598,11 @@ Could we use @subtypes for this?'/> </function> <functype name='xmlC14NIsVisibleCallback' file='c14n' module='c14n'> <cond>defined(LIBXML_C14N_ENABLED) && defined(LIBXML_OUTPUT_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='user_data' type='void *' info=''/> - <arg name='node' type='xmlNodePtr' info=''/> - <arg name='parent' type='xmlNodePtr' info=''/> + <info>Signature for a C14N callback on visible nodes</info> + <return type='int' info='1 if the node should be included'/> + <arg name='user_data' type='void *' info='user data'/> + <arg name='node' type='xmlNodePtr' info='the curent node'/> + <arg name='parent' type='xmlNodePtr' info='the parent node'/> </functype> <function name='xmlCanonicPath' file='uri' module='uri'> <info>Constructs a canonic path from the specified path.</info> @@ -9247,9 +9293,9 @@ Could we use @subtypes for this?'/> <arg name='func' type='xmlDeregisterNodeFunc' info='function pointer to the new DeregisterNodeFunc'/> </function> <functype name='xmlDeregisterNodeFunc' file='globals' module='globals'> - <info></info> + <info>Signature for the deregistration callback of a discarded node</info> <return type='void'/> - <arg name='node' type='xmlNodePtr' info=''/> + <arg name='node' type='xmlNodePtr' info='the current node'/> </functype> <function name='xmlDetectCharEncoding' file='encoding' module='encoding'> <info>Guess the encoding of the entity using the first bytes of the entity content according to the non-normative appendix F of the XML-1.0 recommendation.</info> @@ -10742,6 +10788,12 @@ Could we use @subtypes for this?'/> <return type='void'/> <arg name='fp' type='FILE *' info='a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist'/> </function> + <function name='xmlMemDisplayLast' file='xmlmemory' module='xmlmemory'> + <info>the last nbBytes of memory allocated and not freed, useful for dumping the memory left allocated between two places at runtime.</info> + <return type='void'/> + <arg name='fp' type='FILE *' info='a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist'/> + <arg name='nbBytes' type='long' info='the amount of memory to dump'/> + </function> <function name='xmlMemFree' file='xmlmemory' module='xmlmemory'> <info>a free() equivalent, with error checking.</info> <return type='void'/> @@ -11257,6 +11309,16 @@ Could we use @subtypes for this?'/> <arg name='name' type='const xmlChar *' info='the subelement name or NULL'/> <arg name='type' type='xmlElementContentType' info='the type of element content decl'/> </function> + <function name='xmlNewEntity' file='entities' module='entities'> + <info>Create a new entity, this differs from xmlAddDocEntity() that if the document is NULL or has no internal subset defined, then an unlinked entity structure will be returned, it is then the responsability of the caller to link it to the document later or free it when not needed anymore.</info> + <return type='xmlEntityPtr' info='a pointer to the entity or NULL in case of error'/> + <arg name='doc' type='xmlDocPtr' info='the document'/> + <arg name='name' type='const xmlChar *' info='the entity name'/> + <arg name='type' type='int' info='the entity type XML_xxx_yyy_ENTITY'/> + <arg name='ExternalID' type='const xmlChar *' info='the entity external ID if available'/> + <arg name='SystemID' type='const xmlChar *' info='the entity system ID if available'/> + <arg name='content' type='const xmlChar *' info='the entity content'/> + </function> <function name='xmlNewEntityInputStream' file='parserInternals' module='parserInternals'> <info>Create a new input stream based on an xmlEntityPtr</info> <return type='xmlParserInputPtr' info='the new input stream or NULL'/> @@ -11628,9 +11690,9 @@ Could we use @subtypes for this?'/> <arg name='func' type='xmlOutputBufferCreateFilenameFunc' info='function pointer to the new OutputBufferCreateFilenameFunc'/> </function> <functype name='xmlOutputBufferCreateFilenameFunc' file='globals' module='globals'> - <info></info> - <return type='xmlOutputBufferPtr' info=''/> - <arg name='URI' type='const char *' info=''/> + <info>Signature for the function doing the lookup for a suitable output method corresponding to an URI.</info> + <return type='xmlOutputBufferPtr' info='the new xmlOutputBufferPtr in case of success or NULL if no method was found.'/> + <arg name='URI' type='const char *' info='the URI to write to'/> <arg name='encoder' type='xmlCharEncodingHandlerPtr' info=''/> <arg name='compression' type='int' info=''/> </functype> @@ -12042,23 +12104,23 @@ Could we use @subtypes for this?'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> <function name='xmlParseTextDecl' file='parserInternals' module='parser'> - <info>parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>' Question: Seems that EncodingDecl is mandatory ? Is that a typo ?</info> + <info>parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'</info> <return type='void'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> <function name='xmlParseURI' file='uri' module='uri'> - <info>Parse an URI URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]</info> + <info>Parse an URI based on RFC 3986 URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]</info> <return type='xmlURIPtr' info='a newly built xmlURIPtr or NULL in case of error'/> <arg name='str' type='const char *' info='the URI string to analyze'/> </function> <function name='xmlParseURIRaw' file='uri' module='uri'> - <info>Parse an URI but allows to keep intact the original fragments. URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]</info> + <info>Parse an URI but allows to keep intact the original fragments. URI-reference = URI / relative-ref</info> <return type='xmlURIPtr' info='a newly built xmlURIPtr or NULL in case of error'/> <arg name='str' type='const char *' info='the URI string to analyze'/> <arg name='raw' type='int' info='if 1 unescaping of URI pieces are disabled'/> </function> <function name='xmlParseURIReference' file='uri' module='uri'> - <info>Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]</info> + <info>Parse an URI reference string based on RFC 3986 and fills in the appropriate fields of the @uri structure URI-reference = URI / relative-ref</info> <return type='int' info='0 or the error code'/> <arg name='uri' type='xmlURIPtr' info='pointer to an URI structure'/> <arg name='str' type='const char *' info='the string to analyze'/> @@ -12069,7 +12131,7 @@ Could we use @subtypes for this?'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> <function name='xmlParseVersionNum' file='parserInternals' module='parser'> - <info>parse the XML version value. [26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+</info> + <info>parse the XML version value. [26] VersionNum ::= '1.' [0-9]+ In practice allow [0-9].[0-9]+ at that level</info> <return type='xmlChar *' info='the string giving the XML version number, or NULL'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> </function> @@ -12143,10 +12205,10 @@ Could we use @subtypes for this?'/> <arg name='func' type='xmlParserInputBufferCreateFilenameFunc' info='function pointer to the new ParserInputBufferCreateFilenameFunc'/> </function> <functype name='xmlParserInputBufferCreateFilenameFunc' file='globals' module='globals'> - <info></info> - <return type='xmlParserInputBufferPtr' info=''/> - <arg name='URI' type='const char *' info=''/> - <arg name='enc' type='xmlCharEncoding' info=''/> + <info>Signature for the function doing the lookup for a suitable input method corresponding to an URI.</info> + <return type='xmlParserInputBufferPtr' info='the new xmlParserInputBufferPtr in case of success or NULL if no method was found.'/> + <arg name='URI' type='const char *' info='the URI to read from'/> + <arg name='enc' type='xmlCharEncoding' info='the requested source encoding'/> </functype> <function name='xmlParserInputBufferCreateIO' file='xmlIO' module='xmlIO'> <info>Create a buffered parser input for the progressive parsing for the input from an I/O handler</info> @@ -12315,7 +12377,7 @@ Could we use @subtypes for this?'/> </function> <function name='xmlPushInput' file='parserInternals' module='parser'> <info>xmlPushInput: switch to a new input stream which is stacked on top of the previous one(s).</info> - <return type='void'/> + <return type='int' info='-1 in case of error or the index in the input stack'/> <arg name='ctxt' type='xmlParserCtxtPtr' info='an XML parser context'/> <arg name='input' type='xmlParserInputPtr' info='an XML parser input fragment (entity, XML fragment ...).'/> </function> @@ -12525,12 +12587,12 @@ Could we use @subtypes for this?'/> </function> <functype name='xmlRegExecCallbacks' file='xmlregexp' module='xmlregexp'> <cond>defined(LIBXML_REGEXP_ENABLED)</cond> - <info></info> + <info>Callback function when doing a transition in the automata</info> <return type='void'/> - <arg name='exec' type='xmlRegExecCtxtPtr' info=''/> - <arg name='token' type='const xmlChar *' info=''/> - <arg name='transdata' type='void *' info=''/> - <arg name='inputdata' type='void *' info=''/> + <arg name='exec' type='xmlRegExecCtxtPtr' info='the regular expression context'/> + <arg name='token' type='const xmlChar *' info='the current token string'/> + <arg name='transdata' type='void *' info='transition data'/> + <arg name='inputdata' type='void *' info='input data'/> </functype> <function name='xmlRegExecErrInfo' file='xmlregexp' module='xmlregexp'> <cond>defined(LIBXML_REGEXP_ENABLED)</cond> @@ -12649,9 +12711,9 @@ Could we use @subtypes for this?'/> <arg name='func' type='xmlRegisterNodeFunc' info='function pointer to the new RegisterNodeFunc'/> </function> <functype name='xmlRegisterNodeFunc' file='globals' module='globals'> - <info></info> + <info>Signature for the registration callback of a created node</info> <return type='void'/> - <arg name='node' type='xmlNodePtr' info=''/> + <arg name='node' type='xmlNodePtr' info='the current node'/> </functype> <function name='xmlRegisterOutputCallbacks' file='xmlIO' module='xmlIO'> <cond>defined(LIBXML_OUTPUT_ENABLED)</cond> @@ -12828,19 +12890,19 @@ Could we use @subtypes for this?'/> </function> <functype name='xmlRelaxNGValidityErrorFunc' file='relaxng' module='relaxng'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Signature of an error callback from a Relax-NG validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <functype name='xmlRelaxNGValidityWarningFunc' file='relaxng' module='relaxng'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Signature of a warning callback from a Relax-NG validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <function name='xmlRelaxParserSetFlag' file='relaxng' module='relaxng'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13405,9 +13467,9 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaFreeValidCtxt' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Free the resources associated to the schema validation context</info> <return type='void'/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='the schema validation context'/> </function> <function name='xmlSchemaFreeValue' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13478,12 +13540,12 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaGetValidErrors' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='err' type='xmlSchemaValidityErrorFunc *' info=''/> - <arg name='warn' type='xmlSchemaValidityWarningFunc *' info=''/> - <arg name='ctx' type='void **' info=''/> + <info>Get the error and warning callback informations</info> + <return type='int' info='-1 in case of error and 0 otherwise'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a XML-Schema validation context'/> + <arg name='err' type='xmlSchemaValidityErrorFunc *' info='the error function result'/> + <arg name='warn' type='xmlSchemaValidityWarningFunc *' info='the warning function result'/> + <arg name='ctx' type='void **' info='the functions context result'/> </function> <function name='xmlSchemaInitTypes' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13499,9 +13561,9 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaIsValid' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> + <info>Check if any error was detected during validation.</info> + <return type='int' info='1 if valid so far, 0 if errors were detected, and -1 in case of internal error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='the schema validation context'/> </function> <function name='xmlSchemaNewDocParserCtxt' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13550,9 +13612,9 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaNewValidCtxt' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='schema' type='xmlSchemaPtr' info=''/> + <info>Create an XML Schemas validation context based on the given schema.</info> + <return type='xmlSchemaValidCtxtPtr' info='the validation context or NULL in case of error'/> + <arg name='schema' type='xmlSchemaPtr' info='a precompiled XML Schemas'/> </function> <function name='xmlSchemaParse' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13562,17 +13624,17 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaSAXPlug' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='xmlSchemaSAXPlugPtr' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='sax' type='xmlSAXHandlerPtr *' info=''/> - <arg name='user_data' type='void **' info=''/> + <info>Plug a SAX based validation layer in a SAX parsing event flow. The original @saxptr and @dataptr data are replaced by new pointers but the calls to the original will be maintained.</info> + <return type='xmlSchemaSAXPlugPtr' info='a pointer to a data structure needed to unplug the validation layer or NULL in case of errors.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='sax' type='xmlSAXHandlerPtr *' info='a pointer to the original xmlSAXHandlerPtr'/> + <arg name='user_data' type='void **' info='a pointer to the original SAX user data pointer'/> </function> <function name='xmlSchemaSAXUnplug' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='plug' type='xmlSchemaSAXPlugPtr' info=''/> + <info>Unplug a SAX based validation layer in a SAX parsing event flow. The original pointers used in the call are restored.</info> + <return type='int' info='0 in case of success and -1 in case of failure.'/> + <arg name='plug' type='xmlSchemaSAXPlugPtr' info='a data structure returned by xmlSchemaSAXPlug'/> </function> <function name='xmlSchemaSetParserErrors' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13593,27 +13655,27 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaSetValidErrors' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Set the error and warning callback informations</info> <return type='void'/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='err' type='xmlSchemaValidityErrorFunc' info=''/> - <arg name='warn' type='xmlSchemaValidityWarningFunc' info=''/> - <arg name='ctx' type='void *' info=''/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='err' type='xmlSchemaValidityErrorFunc' info='the error function'/> + <arg name='warn' type='xmlSchemaValidityWarningFunc' info='the warning function'/> + <arg name='ctx' type='void *' info='the functions context'/> </function> <function name='xmlSchemaSetValidOptions' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='options' type='int' info=''/> + <info>Sets the options to be used during the validation.</info> + <return type='int' info='0 in case of success, -1 in case of an API error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='options' type='int' info='a combination of xmlSchemaValidOption'/> </function> <function name='xmlSchemaSetValidStructuredErrors' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Set the structured error callback</info> <return type='void'/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='serror' type='xmlStructuredErrorFunc' info=''/> - <arg name='ctx' type='void *' info=''/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='serror' type='xmlStructuredErrorFunc' info='the structured error function'/> + <arg name='ctx' type='void *' info='the functions context'/> </function> <function name='xmlSchemaValPredefTypeNode' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13635,16 +13697,22 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaValidCtxtGetOptions' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> + <info>Get the validation context options.</info> + <return type='int' info='the option combination or -1 on error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + </function> + <function name='xmlSchemaValidCtxtGetParserCtxt' file='xmlschemas' module='xmlschemas'> + <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> + <info>allow access to the parser context of the schema validation context</info> + <return type='xmlParserCtxtPtr' info='the parser context of the schema validation context or NULL in case of error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> </function> <function name='xmlSchemaValidateDoc' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='instance' type='xmlDocPtr' info=''/> + <info>Validate a document tree in memory.</info> + <return type='int' info='0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='doc' type='xmlDocPtr' info='a parsed document tree'/> </function> <function name='xmlSchemaValidateFacet' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13668,11 +13736,11 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaValidateFile' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='filename' type='const char *' info=''/> - <arg name='options' type='int' info=''/> + <info>Do a schemas validation of the given resource, it will use the SAX streamable validation internally.</info> + <return type='int' info='0 if the document is valid, a positive error code number otherwise and -1 in case of an internal or API error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='filename' type='const char *' info='the URI of the instance'/> + <arg name='options' type='int' info='a future set of options, currently unused'/> </function> <function name='xmlSchemaValidateLengthFacet' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13706,10 +13774,10 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaValidateOneElement' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='elem' type='xmlNodePtr' info=''/> + <info>Validate a branch of a tree, starting with the given @elem.</info> + <return type='int' info='0 if the element and its subtree is valid, a positive error code number otherwise and -1 in case of an internal or API error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='elem' type='xmlNodePtr' info='an element node'/> </function> <function name='xmlSchemaValidatePredefinedType' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13721,29 +13789,29 @@ Could we use @subtypes for this?'/> </function> <function name='xmlSchemaValidateStream' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> - <return type='int' info=''/> - <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info=''/> - <arg name='input' type='xmlParserInputBufferPtr' info=''/> - <arg name='enc' type='xmlCharEncoding' info=''/> - <arg name='sax' type='xmlSAXHandlerPtr' info=''/> - <arg name='user_data' type='void *' info=''/> + <info>Validate an input based on a flow of SAX event from the parser and forward the events to the @sax handler with the provided @user_data the user provided @sax handler must be a SAX2 one.</info> + <return type='int' info='0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error.'/> + <arg name='ctxt' type='xmlSchemaValidCtxtPtr' info='a schema validation context'/> + <arg name='input' type='xmlParserInputBufferPtr' info='the input to use for reading the data'/> + <arg name='enc' type='xmlCharEncoding' info='an optional encoding information'/> + <arg name='sax' type='xmlSAXHandlerPtr' info='a SAX handler for the resulting events'/> + <arg name='user_data' type='void *' info='the context to provide to the SAX handler.'/> </function> <functype name='xmlSchemaValidityErrorFunc' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Signature of an error callback from an XSD validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <functype name='xmlSchemaValidityWarningFunc' file='xmlschemas' module='xmlschemas'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> - <info></info> + <info>Signature of a warning callback from an XSD validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <function name='xmlSchemaValueAppend' file='xmlschemastypes' module='xmlschemastypes'> <cond>defined(LIBXML_SCHEMAS_ENABLED)</cond> @@ -13843,19 +13911,19 @@ Could we use @subtypes for this?'/> </function> <functype name='xmlSchematronValidityErrorFunc' file='schematron' module='schematron'> <cond>defined(LIBXML_SCHEMATRON_ENABLED)</cond> - <info></info> + <info>Signature of an error callback from a Schematron validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <functype name='xmlSchematronValidityWarningFunc' file='schematron' module='schematron'> <cond>defined(LIBXML_SCHEMATRON_ENABLED)</cond> - <info></info> + <info>Signature of a warning callback from a Schematron validation</info> <return type='void'/> - <arg name='ctx' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='...' type='...' info=''/> + <arg name='ctx' type='void *' info='the validation context'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='...' type='...' info='extra arguments'/> </functype> <function name='xmlSearchNs' file='tree' module='tree'> <info>Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. @nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning is generated to cover this case.</info> @@ -14486,12 +14554,12 @@ Could we use @subtypes for this?'/> </function> <functype name='xmlTextReaderErrorFunc' file='xmlreader' module='xmlreader'> <cond>defined(LIBXML_READER_ENABLED)</cond> - <info></info> + <info>Signature of an error callback from a reader parser</info> <return type='void'/> - <arg name='arg' type='void *' info=''/> - <arg name='msg' type='const char *' info=''/> - <arg name='severity' type='xmlParserSeverities' info=''/> - <arg name='locator' type='xmlTextReaderLocatorPtr' info=''/> + <arg name='arg' type='void *' info='the user argument'/> + <arg name='msg' type='const char *' info='the message'/> + <arg name='severity' type='xmlParserSeverities' info='the severity of the error'/> + <arg name='locator' type='xmlTextReaderLocatorPtr' info='a locator indicating where the error occured'/> </functype> <function name='xmlTextReaderExpand' file='xmlreader' module='xmlreader'> <cond>defined(LIBXML_READER_ENABLED)</cond> @@ -16670,10 +16738,10 @@ Could we use @subtypes for this?'/> </function> <function name='xmlValidateAttributeValue' file='valid' module='valid'> <cond>defined(LIBXML_VALID_ENABLED)</cond> - <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'/> + <info></info> + <return type='int' info=''/> + <arg name='type' type='xmlAttributeType' info=''/> + <arg name='value' type='const xmlChar *' info=''/> </function> <function name='xmlValidateDocument' file='valid' module='valid'> <cond>defined(LIBXML_VALID_ENABLED)</cond> |