lib/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-21 14:53:44 +03:00
Code Activity

doc: Adjust documentation of enums

Browse Source
This commit is contained in:
Nick Wellnhofer
2025-04-28 14:55:47 +02:00
parent e549622bc5
commit 8816f267be
12 changed files with 413 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
include/libxml/HTMLparser.h
View File

@@ -198,25 +198,39 @@ XMLPUBFUN void
/* /*
* New set of simpler/more flexible APIs * New set of simpler/more flexible APIs
*/ */
/** /**
* * This is the set of HTML parser options that can be passed down
* This is the set of XML parser options that can be passed down * to the htmlReadDoc() and similar calls. See htmlCtxtSetOptions()
* to the xmlReadDoc() and similar calls. * for a more detailed description.
*/ */
typedef enum { typedef enum {
HTML_PARSE_RECOVER = 1<<0, /* No effect */ /** No effect */
HTML_PARSE_NODEFDTD = 1<<2, /* do not default a doctype if not found */ HTML_PARSE_RECOVER = 1<<0,
HTML_PARSE_NOERROR = 1<<5, /* suppress error reports */ /** do not default a doctype if not found */
HTML_PARSE_NOWARNING= 1<<6, /* suppress warning reports */ HTML_PARSE_NODEFDTD = 1<<2,
HTML_PARSE_PEDANTIC = 1<<7, /* No effect */ /** suppress error reports */
HTML_PARSE_NOBLANKS = 1<<8, /* remove blank nodes */ HTML_PARSE_NOERROR = 1<<5,
HTML_PARSE_NONET = 1<<11,/* No effect */ /** suppress warning reports */
HTML_PARSE_NOIMPLIED= 1<<13,/* Do not add implied html/body... elements */ HTML_PARSE_NOWARNING= 1<<6,
HTML_PARSE_COMPACT = 1<<16,/* compact small text nodes */ /** No effect */
HTML_PARSE_HUGE = 1<<19,/* relax any hardcoded limit from the parser */ HTML_PARSE_PEDANTIC = 1<<7,
HTML_PARSE_IGNORE_ENC=1<<21,/* ignore internal document encoding hint */ /** remove blank nodes */
HTML_PARSE_BIG_LINES= 1<<22,/* Store big lines numbers in text PSVI field */ HTML_PARSE_NOBLANKS = 1<<8,
HTML_PARSE_HTML5 = 1<<26 /* HTML5 support */ /** No effect */
HTML_PARSE_NONET = 1<<11,
/** Do not add implied html/body... elements */
HTML_PARSE_NOIMPLIED= 1<<13,
/** compact small text nodes */
HTML_PARSE_COMPACT = 1<<16,
/** relax any hardcoded limit from the parser */
HTML_PARSE_HUGE = 1<<19,
/** ignore internal document encoding hint */
HTML_PARSE_IGNORE_ENC=1<<21,
/** Store big lines numbers in text PSVI field */
HTML_PARSE_BIG_LINES= 1<<22,
/** HTML5 support */
HTML_PARSE_HTML5 = 1<<26
} htmlParserOption; } htmlParserOption;
XMLPUBFUN void XMLPUBFUN void

13
include/libxml/c14n.h
View File

@@ -45,15 +45,16 @@ extern "C" {
* following options: XML_PARSE_DTDATTR | XML_PARSE_NOENT * following options: XML_PARSE_DTDATTR | XML_PARSE_NOENT
*/ */
/* /**
*
* Predefined values for C14N modes * Predefined values for C14N modes
*
*/ */
typedef enum { typedef enum {
XML_C14N_1_0 = 0, /* Original C14N 1.0 spec */ /** Original C14N 1.0 spec */
XML_C14N_EXCLUSIVE_1_0 = 1, /* Exclusive C14N 1.0 spec */ XML_C14N_1_0 = 0,
XML_C14N_1_1 = 2 /* C14N 1.1 spec */ /** Exclusive C14N 1.0 spec */
XML_C14N_EXCLUSIVE_1_0 = 1,
/** C14N 1.1 spec */
XML_C14N_1_1 = 2
} xmlC14NMode; } xmlC14NMode;
XMLPUBFUN int XMLPUBFUN int

113
include/libxml/encoding.h
View File

@@ -38,56 +38,99 @@ extern "C" {
#define UTF8Toisolat1 xmlUTF8ToIsolat1 #define UTF8Toisolat1 xmlUTF8ToIsolat1
#define isolat1ToUTF8 xmlIsolat1ToUTF8 #define isolat1ToUTF8 xmlIsolat1ToUTF8
/**
* Encoding conversion errors
*/
typedef enum { typedef enum {
/** Success */
XML_ENC_ERR_SUCCESS = 0, XML_ENC_ERR_SUCCESS = 0,
/** Internal or unclassified error */
XML_ENC_ERR_INTERNAL = -1, XML_ENC_ERR_INTERNAL = -1,
/** Invalid or untranslatable input sequence */
XML_ENC_ERR_INPUT = -2, XML_ENC_ERR_INPUT = -2,
/** Not enough space in output buffer */
XML_ENC_ERR_SPACE = -3, XML_ENC_ERR_SPACE = -3,
/** Out-of-memory error */
XML_ENC_ERR_MEMORY = -4 XML_ENC_ERR_MEMORY = -4
} xmlCharEncError; } xmlCharEncError;
/* /**
*
* Predefined values for some standard encodings. * Predefined values for some standard encodings.
*/ */
typedef enum { typedef enum {
XML_CHAR_ENCODING_ERROR= -1, /* No char encoding detected */ /** No char encoding detected */
XML_CHAR_ENCODING_NONE= 0, /* No char encoding detected */ XML_CHAR_ENCODING_ERROR= -1,
XML_CHAR_ENCODING_UTF8= 1, /* UTF-8 */ /** No char encoding detected */
XML_CHAR_ENCODING_UTF16LE= 2, /* UTF-16 little endian */ XML_CHAR_ENCODING_NONE= 0,
XML_CHAR_ENCODING_UTF16BE= 3, /* UTF-16 big endian */ /** UTF-8 */
XML_CHAR_ENCODING_UCS4LE= 4, /* UCS-4 little endian */ XML_CHAR_ENCODING_UTF8= 1,
XML_CHAR_ENCODING_UCS4BE= 5, /* UCS-4 big endian */ /** UTF-16 little endian */
XML_CHAR_ENCODING_EBCDIC= 6, /* EBCDIC uh! */ XML_CHAR_ENCODING_UTF16LE= 2,
XML_CHAR_ENCODING_UCS4_2143=7, /* UCS-4 unusual ordering */ /** UTF-16 big endian */
XML_CHAR_ENCODING_UCS4_3412=8, /* UCS-4 unusual ordering */ XML_CHAR_ENCODING_UTF16BE= 3,
XML_CHAR_ENCODING_UCS2= 9, /* UCS-2 */ /** UCS-4 little endian */
XML_CHAR_ENCODING_8859_1= 10,/* ISO-8859-1 ISO Latin 1 */ XML_CHAR_ENCODING_UCS4LE= 4,
XML_CHAR_ENCODING_8859_2= 11,/* ISO-8859-2 ISO Latin 2 */ /** UCS-4 big endian */
XML_CHAR_ENCODING_8859_3= 12,/* ISO-8859-3 */ XML_CHAR_ENCODING_UCS4BE= 5,
XML_CHAR_ENCODING_8859_4= 13,/* ISO-8859-4 */ /** EBCDIC uh! */
XML_CHAR_ENCODING_8859_5= 14,/* ISO-8859-5 */ XML_CHAR_ENCODING_EBCDIC= 6,
XML_CHAR_ENCODING_8859_6= 15,/* ISO-8859-6 */ /** UCS-4 unusual ordering */
XML_CHAR_ENCODING_8859_7= 16,/* ISO-8859-7 */ XML_CHAR_ENCODING_UCS4_2143=7,
XML_CHAR_ENCODING_8859_8= 17,/* ISO-8859-8 */ /** UCS-4 unusual ordering */
XML_CHAR_ENCODING_8859_9= 18,/* ISO-8859-9 */ XML_CHAR_ENCODING_UCS4_3412=8,
XML_CHAR_ENCODING_2022_JP= 19,/* ISO-2022-JP */ /** UCS-2 */
XML_CHAR_ENCODING_SHIFT_JIS=20,/* Shift_JIS */ XML_CHAR_ENCODING_UCS2= 9,
XML_CHAR_ENCODING_EUC_JP= 21,/* EUC-JP */ /** ISO-8859-1 ISO Latin 1 */
XML_CHAR_ENCODING_ASCII= 22,/* pure ASCII */ XML_CHAR_ENCODING_8859_1= 10,
/* Available since 2.14.0 */ /** ISO-8859-2 ISO Latin 2 */
XML_CHAR_ENCODING_UTF16= 23,/* UTF-16 native */ XML_CHAR_ENCODING_8859_2= 11,
XML_CHAR_ENCODING_HTML= 24,/* HTML (output only) */ /** ISO-8859-3 */
XML_CHAR_ENCODING_8859_10= 25,/* ISO-8859-10 */ XML_CHAR_ENCODING_8859_3= 12,
XML_CHAR_ENCODING_8859_11= 26,/* ISO-8859-11 */ /** ISO-8859-4 */
XML_CHAR_ENCODING_8859_13= 27,/* ISO-8859-13 */ XML_CHAR_ENCODING_8859_4= 13,
XML_CHAR_ENCODING_8859_14= 28,/* ISO-8859-14 */ /** ISO-8859-5 */
XML_CHAR_ENCODING_8859_15= 29,/* ISO-8859-15 */ XML_CHAR_ENCODING_8859_5= 14,
XML_CHAR_ENCODING_8859_16= 30 /* ISO-8859-16 */ /** ISO-8859-6 */
XML_CHAR_ENCODING_8859_6= 15,
/** ISO-8859-7 */
XML_CHAR_ENCODING_8859_7= 16,
/** ISO-8859-8 */
XML_CHAR_ENCODING_8859_8= 17,
/** ISO-8859-9 */
XML_CHAR_ENCODING_8859_9= 18,
/** ISO-2022-JP */
XML_CHAR_ENCODING_2022_JP= 19,
/** Shift_JIS */
XML_CHAR_ENCODING_SHIFT_JIS=20,
/** EUC-JP */
XML_CHAR_ENCODING_EUC_JP= 21,
/** pure ASCII */
XML_CHAR_ENCODING_ASCII= 22,
/** UTF-16 native, available since 2.14 */
XML_CHAR_ENCODING_UTF16= 23,
/** HTML (output only), available since 2.14 */
XML_CHAR_ENCODING_HTML= 24,
/** ISO-8859-10, available since 2.14 */
XML_CHAR_ENCODING_8859_10= 25,
/** ISO-8859-11, available since 2.14 */
XML_CHAR_ENCODING_8859_11= 26,
/** ISO-8859-13, available since 2.14 */
XML_CHAR_ENCODING_8859_13= 27,
/** ISO-8859-14, available since 2.14 */
XML_CHAR_ENCODING_8859_14= 28,
/** ISO-8859-15, available since 2.14 */
XML_CHAR_ENCODING_8859_15= 29,
/** ISO-8859-16, available since 2.14 */
XML_CHAR_ENCODING_8859_16= 30
} xmlCharEncoding; } xmlCharEncoding;
/**
* Encoding conversion flags
*/
typedef enum { typedef enum {
/** Create converter for input (conversion to UTF-8) */
XML_ENC_INPUT = (1 << 0), XML_ENC_INPUT = (1 << 0),
/** Create converter for output (conversion from UTF-8) */
XML_ENC_OUTPUT = (1 << 1) XML_ENC_OUTPUT = (1 << 1)
} xmlCharEncFlags; } xmlCharEncFlags;

8
include/libxml/entities.h
View File

@@ -23,15 +23,21 @@
extern "C" { extern "C" {
#endif #endif
/* /**
* The different valid entity types. * The different valid entity types.
*/ */
typedef enum { typedef enum {
/** internal general entity */
XML_INTERNAL_GENERAL_ENTITY = 1, XML_INTERNAL_GENERAL_ENTITY = 1,
/** external general parsed entity */
XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2, XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2,
/** external general unparsed entity */
XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3, XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3,
/** internal parameter entity */
XML_INTERNAL_PARAMETER_ENTITY = 4, XML_INTERNAL_PARAMETER_ENTITY = 4,
/** external parameter entity */
XML_EXTERNAL_PARAMETER_ENTITY = 5, XML_EXTERNAL_PARAMETER_ENTITY = 5,
/** internal predefined entity */
XML_INTERNAL_PREDEFINED_ENTITY = 6 XML_INTERNAL_PREDEFINED_ENTITY = 6
} xmlEntityType; } xmlEntityType;

164
include/libxml/parser.h
View File

@@ -41,27 +41,52 @@ extern "C" {
*/ */
#define XML_DEFAULT_VERSION "1.0" #define XML_DEFAULT_VERSION "1.0"
/**
* Status after parsing a document
*/
typedef enum { typedef enum {
/** not well-formed */
XML_STATUS_NOT_WELL_FORMED = (1 << 0), XML_STATUS_NOT_WELL_FORMED = (1 << 0),
/** not namespace-well-formed */
XML_STATUS_NOT_NS_WELL_FORMED = (1 << 1), XML_STATUS_NOT_NS_WELL_FORMED = (1 << 1),
/** DTD validation failed */
XML_STATUS_DTD_VALIDATION_FAILED = (1 << 2), XML_STATUS_DTD_VALIDATION_FAILED = (1 << 2),
/** catastrophic failure like OOM or I/O error */
XML_STATUS_CATASTROPHIC_ERROR = (1 << 3) XML_STATUS_CATASTROPHIC_ERROR = (1 << 3)
} xmlParserStatus; } xmlParserStatus;
/**
* Resource type for resource loaders
*/
typedef enum { typedef enum {
/** unknown */
XML_RESOURCE_UNKNOWN = 0, XML_RESOURCE_UNKNOWN = 0,
/** main document */
XML_RESOURCE_MAIN_DOCUMENT, XML_RESOURCE_MAIN_DOCUMENT,
/** external DTD */
XML_RESOURCE_DTD, XML_RESOURCE_DTD,
/** external general entity */
XML_RESOURCE_GENERAL_ENTITY, XML_RESOURCE_GENERAL_ENTITY,
/** external parameter entity */
XML_RESOURCE_PARAMETER_ENTITY, XML_RESOURCE_PARAMETER_ENTITY,
/** XIncluded document */
XML_RESOURCE_XINCLUDE, XML_RESOURCE_XINCLUDE,
/** XIncluded text */
XML_RESOURCE_XINCLUDE_TEXT XML_RESOURCE_XINCLUDE_TEXT
} xmlResourceType; } xmlResourceType;
/**
* Flags for parser input
*/
typedef enum { typedef enum {
/** The input buffer won't be changed during parsing. */
XML_INPUT_BUF_STATIC = (1 << 1), XML_INPUT_BUF_STATIC = (1 << 1),
/** The input buffer is zero-terminated. (Note that the zero
byte shouldn't be included in buffer size.) */
XML_INPUT_BUF_ZERO_TERMINATED = (1 << 2), XML_INPUT_BUF_ZERO_TERMINATED = (1 << 2),
/** Uncompress gzipped file input */
XML_INPUT_UNZIP = (1 << 3), XML_INPUT_UNZIP = (1 << 3),
/** Allow network access. Unused internally. */
XML_INPUT_NETWORK = (1 << 4) XML_INPUT_NETWORK = (1 << 4)
} xmlParserInputFlags; } xmlParserInputFlags;
@@ -145,10 +170,8 @@ struct _xmlParserNodeInfoSeq {
xmlParserNodeInfo* buffer; xmlParserNodeInfo* buffer;
}; };
/** /*
* * Internal type
* The parser is now working also as a state based parser.
* The recursive one use the state info for entities processing.
*/ */
typedef enum { typedef enum {
XML_PARSER_EOF = -1, /* nothing is to be parsed */ XML_PARSER_EOF = -1, /* nothing is to be parsed */
@@ -181,9 +204,8 @@ typedef enum {
#define XML_SKIP_IDS 8 #define XML_SKIP_IDS 8
/** @endcond */ /** @endcond */
/** /*
* * Internal type. Only XML_PARSE_READER is used.
* A parser can operate in various modes
*/ */
typedef enum { typedef enum {
XML_PARSE_UNKNOWN = 0, XML_PARSE_UNKNOWN = 0,
@@ -1370,43 +1392,69 @@ XMLPUBFUN long
/* /*
* New set of simpler/more flexible APIs * New set of simpler/more flexible APIs
*/ */
/** /**
*
* This is the set of XML parser options that can be passed down * This is the set of XML parser options that can be passed down
* to the xmlReadDoc() and similar calls. * to the xmlReadDoc() and similar calls. See xmlCtxtSetOptions()
* for a more detailed description.
*/ */
typedef enum { typedef enum {
XML_PARSE_RECOVER = 1<<0, /* recover on errors */ /** recover on errors */
XML_PARSE_NOENT = 1<<1, /* substitute entities */ XML_PARSE_RECOVER = 1<<0,
XML_PARSE_DTDLOAD = 1<<2, /* load the external subset */ /** substitute entities */
XML_PARSE_DTDATTR = 1<<3, /* default DTD attributes */ XML_PARSE_NOENT = 1<<1,
XML_PARSE_DTDVALID = 1<<4, /* validate with the DTD */ /** load the external subset */
XML_PARSE_NOERROR = 1<<5, /* suppress error reports */ XML_PARSE_DTDLOAD = 1<<2,
XML_PARSE_NOWARNING = 1<<6, /* suppress warning reports */ /** default DTD attributes */
XML_PARSE_PEDANTIC = 1<<7, /* pedantic error reporting */ XML_PARSE_DTDATTR = 1<<3,
XML_PARSE_NOBLANKS = 1<<8, /* remove blank nodes */ /** validate with the DTD */
XML_PARSE_SAX1 = 1<<9, /* use the SAX1 interface internally */ XML_PARSE_DTDVALID = 1<<4,
XML_PARSE_XINCLUDE = 1<<10,/* Implement XInclude substitution */ /** suppress error reports */
XML_PARSE_NONET = 1<<11,/* Forbid network access */ XML_PARSE_NOERROR = 1<<5,
XML_PARSE_NODICT = 1<<12,/* Do not reuse the context dictionary */ /** suppress warning reports */
XML_PARSE_NSCLEAN = 1<<13,/* remove redundant namespaces declarations */ XML_PARSE_NOWARNING = 1<<6,
XML_PARSE_NOCDATA = 1<<14,/* merge CDATA as text nodes */ /** pedantic error reporting */
XML_PARSE_NOXINCNODE= 1<<15,/* do not generate XINCLUDE START/END nodes */ XML_PARSE_PEDANTIC = 1<<7,
XML_PARSE_COMPACT = 1<<16,/* compact small text nodes; no modification of /** remove blank nodes */
XML_PARSE_NOBLANKS = 1<<8,
/** use the SAX1 interface internally */
XML_PARSE_SAX1 = 1<<9,
/** Implement XInclude substitution */
XML_PARSE_XINCLUDE = 1<<10,
/** Forbid network access */
XML_PARSE_NONET = 1<<11,
/** Do not reuse the context dictionary */
XML_PARSE_NODICT = 1<<12,
/** remove redundant namespaces declarations */
XML_PARSE_NSCLEAN = 1<<13,
/** merge CDATA as text nodes */
XML_PARSE_NOCDATA = 1<<14,
/** do not generate XINCLUDE START/END nodes */
XML_PARSE_NOXINCNODE= 1<<15,
/** compact small text nodes; no modification of
the tree allowed afterwards (will possibly the tree allowed afterwards (will possibly
crash if you try to modify the tree) */ crash if you try to modify the tree) */
XML_PARSE_OLD10 = 1<<17,/* parse using XML-1.0 before update 5 */ XML_PARSE_COMPACT = 1<<16,
XML_PARSE_NOBASEFIX = 1<<18,/* do not fixup XINCLUDE xml:base uris */ /** parse using XML-1.0 before update 5 */
XML_PARSE_HUGE = 1<<19,/* relax any hardcoded limit from the parser */ XML_PARSE_OLD10 = 1<<17,
XML_PARSE_OLDSAX = 1<<20,/* parse using SAX2 interface before 2.7.0 */ /** do not fixup XINCLUDE xml:base uris */
XML_PARSE_IGNORE_ENC= 1<<21,/* ignore internal document encoding hint */ XML_PARSE_NOBASEFIX = 1<<18,
XML_PARSE_BIG_LINES = 1<<22,/* Store big lines numbers in text PSVI field */ /** relax any hardcoded limit from the parser */
/* since 2.13.0 */ XML_PARSE_HUGE = 1<<19,
XML_PARSE_NO_XXE = 1<<23,/* disable loading of external content */ /** parse using SAX2 interface before 2.7.0 */
/* since 2.14.0 */ XML_PARSE_OLDSAX = 1<<20,
XML_PARSE_UNZIP = 1<<24,/* allow compressed content */ /** ignore internal document encoding hint */
XML_PARSE_NO_SYS_CATALOG = 1<<25,/* disable global system catalog */ XML_PARSE_IGNORE_ENC= 1<<21,
XML_PARSE_CATALOG_PI = 1<<26 /* allow catalog PIs */ /** Store big lines numbers in text PSVI field */
XML_PARSE_BIG_LINES = 1<<22,
/** disable loading of external content, since 2.13 */
XML_PARSE_NO_XXE = 1<<23,
/** allow compressed content, since 2.14 */
XML_PARSE_UNZIP = 1<<24,
/** disable global system catalog, since 2.14 */
XML_PARSE_NO_SYS_CATALOG = 1<<25,
/** allow catalog PIs, sincew 2.14 */
XML_PARSE_CATALOG_PI = 1<<26
} xmlParserOption; } xmlParserOption;
XMLPUBFUN void XMLPUBFUN void
@@ -1572,47 +1620,81 @@ xmlInputSetEncodingHandler(xmlParserInputPtr input,
/* /*
* Library wide options * Library wide options
*/ */
/** /**
*
* Used to examine the existence of features that can be enabled * Used to examine the existence of features that can be enabled
* or disabled at compile-time. * or disabled at compile-time.
* They used to be called XML_FEATURE_xxx but this clashed with Expat * They used to be called XML_FEATURE_xxx but this clashed with Expat
*/ */
typedef enum { typedef enum {
/** Multithreading support */
XML_WITH_THREAD = 1, XML_WITH_THREAD = 1,
/** @deprecated Always available */
XML_WITH_TREE = 2, XML_WITH_TREE = 2,
/** Serialization support */
XML_WITH_OUTPUT = 3, XML_WITH_OUTPUT = 3,
/** Push parser */
XML_WITH_PUSH = 4, XML_WITH_PUSH = 4,
/** XML Reader */
XML_WITH_READER = 5, XML_WITH_READER = 5,
/** Streaming patterns */
XML_WITH_PATTERN = 6, XML_WITH_PATTERN = 6,
/** XML Writer */
XML_WITH_WRITER = 7, XML_WITH_WRITER = 7,
/** Legacy SAX1 API */
XML_WITH_SAX1 = 8, XML_WITH_SAX1 = 8,
/** @deprecated FTP support was removed */
XML_WITH_FTP = 9, XML_WITH_FTP = 9,
/** @deprecated HTTP support was removed */
XML_WITH_HTTP = 10, XML_WITH_HTTP = 10,
/** DTD validation */
XML_WITH_VALID = 11, XML_WITH_VALID = 11,
/** HTML parser */
XML_WITH_HTML = 12, XML_WITH_HTML = 12,
/** Legacy symbols */
XML_WITH_LEGACY = 13, XML_WITH_LEGACY = 13,
/** Canonical XML */
XML_WITH_C14N = 14, XML_WITH_C14N = 14,
/** XML Catalogs */
XML_WITH_CATALOG = 15, XML_WITH_CATALOG = 15,
/** XPath */
XML_WITH_XPATH = 16, XML_WITH_XPATH = 16,
/** XPointer */
XML_WITH_XPTR = 17, XML_WITH_XPTR = 17,
/** XInclude */
XML_WITH_XINCLUDE = 18, XML_WITH_XINCLUDE = 18,
/** iconv */
XML_WITH_ICONV = 19, XML_WITH_ICONV = 19,
/** Built-in ISO-8859-X */
XML_WITH_ISO8859X = 20, XML_WITH_ISO8859X = 20,
/** @deprecated Removed */
XML_WITH_UNICODE = 21, XML_WITH_UNICODE = 21,
/** Regular expressions */
XML_WITH_REGEXP = 22, XML_WITH_REGEXP = 22,
/** @deprecated Same as XML_WITH_REGEXP */
XML_WITH_AUTOMATA = 23, XML_WITH_AUTOMATA = 23,
/** @deprecated Removed */
XML_WITH_EXPR = 24, XML_WITH_EXPR = 24,
/** XML Schemas */
XML_WITH_SCHEMAS = 25, XML_WITH_SCHEMAS = 25,
/** Schematron */
XML_WITH_SCHEMATRON = 26, XML_WITH_SCHEMATRON = 26,
/** Loadable modules */
XML_WITH_MODULES = 27, XML_WITH_MODULES = 27,
/** Debugging API */
XML_WITH_DEBUG = 28, XML_WITH_DEBUG = 28,
/** @deprecated Removed */
XML_WITH_DEBUG_MEM = 29, XML_WITH_DEBUG_MEM = 29,
XML_WITH_DEBUG_RUN = 30, /* unused */ /** @deprecated Removed */
XML_WITH_DEBUG_RUN = 30,
/** GZIP compression */
XML_WITH_ZLIB = 31, XML_WITH_ZLIB = 31,
/** ICU */
XML_WITH_ICU = 32, XML_WITH_ICU = 32,
/** LZMA compression */
XML_WITH_LZMA = 33, XML_WITH_LZMA = 33,
XML_WITH_RELAXNG = 34, /* since 2.14.0 */ /** RELAXNG, since 2.14 */
XML_WITH_RELAXNG = 34,
XML_WITH_NONE = 99999 /* just to be sure of allocation size */ XML_WITH_NONE = 99999 /* just to be sure of allocation size */
} xmlFeature; } xmlFeature;

8
include/libxml/pattern.h
View File

@@ -31,11 +31,9 @@ extern "C" {
typedef struct _xmlPattern xmlPattern; typedef struct _xmlPattern xmlPattern;
typedef xmlPattern *xmlPatternPtr; typedef xmlPattern *xmlPatternPtr;
/** /*
* * Internal type. This is the set of options affecting the behaviour
* This is the set of options affecting the behaviour of pattern * of pattern matching with this module.
* matching with this module
*
*/ */
typedef enum { typedef enum {
XML_PATTERN_DEFAULT = 0, /* simple pattern match */ XML_PATTERN_DEFAULT = 0, /* simple pattern match */

2
include/libxml/relaxng.h
View File

@@ -61,7 +61,6 @@ typedef struct _xmlRelaxNGValidCtxt xmlRelaxNGValidCtxt;
typedef xmlRelaxNGValidCtxt *xmlRelaxNGValidCtxtPtr; typedef xmlRelaxNGValidCtxt *xmlRelaxNGValidCtxtPtr;
/* /*
*
* List of possible Relax NG validation errors * List of possible Relax NG validation errors
*/ */
typedef enum { typedef enum {
@@ -108,7 +107,6 @@ typedef enum {
} xmlRelaxNGValidErr; } xmlRelaxNGValidErr;
/* /*
*
* List of possible Relax NG Parser flags * List of possible Relax NG Parser flags
*/ */
typedef enum { typedef enum {

80
include/libxml/tree.h
View File

@@ -77,12 +77,9 @@ typedef xmlEntity *xmlEntityPtr;
*/ */
/* #define LIBXML_NAMESPACE_DICT */ /* #define LIBXML_NAMESPACE_DICT */
/** /*
* * Removed, buffers always use XML_BUFFER_ALLOC_IO now.
* A buffer allocation scheme can be defined to either match exactly the
* need or double it's allocated size each time it is found too small.
*/ */
typedef enum { typedef enum {
XML_BUFFER_ALLOC_DOUBLEIT, /* double each time one need to grow */ XML_BUFFER_ALLOC_DOUBLEIT, /* double each time one need to grow */
XML_BUFFER_ALLOC_EXACT, /* grow only to the minimal size */ XML_BUFFER_ALLOC_EXACT, /* grow only to the minimal size */
@@ -161,7 +158,7 @@ XMLPUBFUN size_t xmlBufShrink (xmlBufPtr buf, size_t len);
*/ */
#define XML_XML_ID (const xmlChar *) "xml:id" #define XML_XML_ID (const xmlChar *) "xml:id"
/* /**
* The different element types carried by an XML tree. * The different element types carried by an XML tree.
* *
* NOTE: This is synchronized with DOM Level1 values * NOTE: This is synchronized with DOM Level1 values
@@ -171,25 +168,45 @@ XMLPUBFUN size_t xmlBufShrink (xmlBufPtr buf, size_t len);
* be deprecated to use an XML_DTD_NODE. * be deprecated to use an XML_DTD_NODE.
*/ */
typedef enum { typedef enum {
/** element */
XML_ELEMENT_NODE= 1, XML_ELEMENT_NODE= 1,
/** attribute */
XML_ATTRIBUTE_NODE= 2, XML_ATTRIBUTE_NODE= 2,
/** text */
XML_TEXT_NODE= 3, XML_TEXT_NODE= 3,
/** CDATA section */
XML_CDATA_SECTION_NODE= 4, XML_CDATA_SECTION_NODE= 4,
/** entity reference */
XML_ENTITY_REF_NODE= 5, XML_ENTITY_REF_NODE= 5,
XML_ENTITY_NODE= 6, /* unused */ /** unused */
XML_ENTITY_NODE= 6,
/** processing instruction */
XML_PI_NODE= 7, XML_PI_NODE= 7,
/** comment */
XML_COMMENT_NODE= 8, XML_COMMENT_NODE= 8,
/** document */
XML_DOCUMENT_NODE= 9, XML_DOCUMENT_NODE= 9,
XML_DOCUMENT_TYPE_NODE= 10, /* unused */ /** unused */
XML_DOCUMENT_TYPE_NODE= 10,
/** document fragment */
XML_DOCUMENT_FRAG_NODE= 11, XML_DOCUMENT_FRAG_NODE= 11,
XML_NOTATION_NODE= 12, /* unused */ /** notation, unused */
XML_NOTATION_NODE= 12,
/** HTML document */
XML_HTML_DOCUMENT_NODE= 13, XML_HTML_DOCUMENT_NODE= 13,
/** DTD */
XML_DTD_NODE= 14, XML_DTD_NODE= 14,
/** element declaration */
XML_ELEMENT_DECL= 15, XML_ELEMENT_DECL= 15,
/** attribute declaration */
XML_ATTRIBUTE_DECL= 16, XML_ATTRIBUTE_DECL= 16,
/** entity declaration */
XML_ENTITY_DECL= 17, XML_ENTITY_DECL= 17,
/** XPath namespace node */
XML_NAMESPACE_DECL= 18, XML_NAMESPACE_DECL= 18,
/** XInclude start marker */
XML_XINCLUDE_START= 19, XML_XINCLUDE_START= 19,
/** XInclude end marker */
XML_XINCLUDE_END= 20 XML_XINCLUDE_END= 20
/* XML_DOCB_DOCUMENT_NODE= 21 */ /* removed */ /* XML_DOCB_DOCUMENT_NODE= 21 */ /* removed */
} xmlElementType; } xmlElementType;
@@ -212,11 +229,9 @@ struct _xmlNotation {
const xmlChar *SystemID; /* System identifier, if any */ const xmlChar *SystemID; /* System identifier, if any */
}; };
/** /*
*
* A DTD Attribute type definition. * A DTD Attribute type definition.
*/ */
typedef enum { typedef enum {
XML_ATTRIBUTE_CDATA = 1, XML_ATTRIBUTE_CDATA = 1,
XML_ATTRIBUTE_ID, XML_ATTRIBUTE_ID,
@@ -230,11 +245,9 @@ typedef enum {
XML_ATTRIBUTE_NOTATION XML_ATTRIBUTE_NOTATION
} xmlAttributeType; } xmlAttributeType;
/** /*
*
* A DTD Attribute default definition. * A DTD Attribute default definition.
*/ */
typedef enum { typedef enum {
XML_ATTRIBUTE_NONE = 1, XML_ATTRIBUTE_NONE = 1,
XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_REQUIRED,
@@ -281,8 +294,7 @@ struct _xmlAttribute {
const xmlChar *elem; /* Element holding the attribute */ const xmlChar *elem; /* Element holding the attribute */
}; };
/** /*
*
* Possible definitions of element content types. * Possible definitions of element content types.
*/ */
typedef enum { typedef enum {
@@ -292,8 +304,7 @@ typedef enum {
XML_ELEMENT_CONTENT_OR XML_ELEMENT_CONTENT_OR
} xmlElementContentType; } xmlElementContentType;
/** /*
*
* Possible definitions of element content occurrences. * Possible definitions of element content occurrences.
*/ */
typedef enum { typedef enum {
@@ -321,11 +332,9 @@ struct _xmlElementContent {
const xmlChar *prefix; /* Namespace prefix */ const xmlChar *prefix; /* Namespace prefix */
}; };
/** /*
*
* The different possibilities for an element content type. * The different possibilities for an element content type.
*/ */
typedef enum { typedef enum {
XML_ELEMENT_TYPE_UNDEFINED = 0, XML_ELEMENT_TYPE_UNDEFINED = 0,
XML_ELEMENT_TYPE_EMPTY = 1, XML_ELEMENT_TYPE_EMPTY = 1,
@@ -517,21 +526,26 @@ struct _xmlNode {
(xmlGetLineNo(n)) (xmlGetLineNo(n))
/** /**
* xmlDocProperty
*
* Set of properties of the document as found by the parser * Set of properties of the document as found by the parser
* Some of them are linked to similarly named xmlParserOption * Some of them are linked to similarly named xmlParserOption
*/ */
typedef enum { typedef enum {
XML_DOC_WELLFORMED = 1<<0, /* document is XML well formed */ /** document is XML well formed */
XML_DOC_NSVALID = 1<<1, /* document is Namespace valid */ XML_DOC_WELLFORMED = 1<<0,
XML_DOC_OLD10 = 1<<2, /* parsed with old XML-1.0 parser */ /** document is Namespace valid */
XML_DOC_DTDVALID = 1<<3, /* DTD validation was successful */ XML_DOC_NSVALID = 1<<1,
XML_DOC_XINCLUDE = 1<<4, /* XInclude substitution was done */ /** parsed with old XML-1.0 parser */
XML_DOC_USERBUILT = 1<<5, /* Document was built using the API XML_DOC_OLD10 = 1<<2,
and not by parsing an instance */ /** DTD validation was successful */
XML_DOC_INTERNAL = 1<<6, /* built for internal processing */ XML_DOC_DTDVALID = 1<<3,
XML_DOC_HTML = 1<<7 /* parsed or built HTML document */ /** XInclude substitution was done */
XML_DOC_XINCLUDE = 1<<4,
/** Document was built using the API and not by parsing an instance */
XML_DOC_USERBUILT = 1<<5,
/** built for internal processing */
XML_DOC_INTERNAL = 1<<6,
/** parsed or built HTML document */
XML_DOC_HTML = 1<<7
} xmlDocProperties; } xmlDocProperties;
/** /**

107
include/libxml/xmlerror.h
View File

@@ -25,52 +25,86 @@ extern "C" {
#define initGenericErrorDefaultFunc(h) xmlSetGenericErrorFunc(NULL, *(h)) #define initGenericErrorDefaultFunc(h) xmlSetGenericErrorFunc(NULL, *(h))
/** /**
*
* Indicates the level of an error * Indicates the level of an error
*/ */
typedef enum { typedef enum {
/** Success */
XML_ERR_NONE = 0, XML_ERR_NONE = 0,
XML_ERR_WARNING = 1, /* A simple warning */ /** A simple warning */
XML_ERR_ERROR = 2, /* A recoverable error */ XML_ERR_WARNING = 1,
XML_ERR_FATAL = 3 /* A fatal error */ /** A recoverable error (namespace and validity errors,
certain undeclared entities) */
XML_ERR_ERROR = 2,
/** A fatal error (not well-formed, OOM and I/O errors) */
XML_ERR_FATAL = 3
} xmlErrorLevel; } xmlErrorLevel;
/** /**
*
* Indicates where an error may have come from * Indicates where an error may have come from
*/ */
typedef enum { typedef enum {
/** Unknown */
XML_FROM_NONE = 0, XML_FROM_NONE = 0,
XML_FROM_PARSER, /* The XML parser */ /** The XML parser */
XML_FROM_TREE, /* The tree module */ XML_FROM_PARSER,
XML_FROM_NAMESPACE, /* The XML Namespace module */ /** The tree module */
XML_FROM_DTD, /* The XML DTD validation with parser context*/ XML_FROM_TREE,
XML_FROM_HTML, /* The HTML parser */ /** The XML Namespace module */
XML_FROM_MEMORY, /* The memory allocator */ XML_FROM_NAMESPACE,
XML_FROM_OUTPUT, /* The serialization code */ /** The XML DTD validation with parser context*/
XML_FROM_IO, /* The Input/Output stack */ XML_FROM_DTD,
XML_FROM_FTP, /* The FTP module */ /** The HTML parser */
XML_FROM_HTTP, /* The HTTP module */ XML_FROM_HTML,
XML_FROM_XINCLUDE, /* The XInclude processing */ /** The memory allocator */
XML_FROM_XPATH, /* The XPath module */ XML_FROM_MEMORY,
XML_FROM_XPOINTER, /* The XPointer module */ /** The serialization code */
XML_FROM_REGEXP, /* The regular expressions module */ XML_FROM_OUTPUT,
XML_FROM_DATATYPE, /* The W3C XML Schemas Datatype module */ /** The Input/Output stack */
XML_FROM_SCHEMASP, /* The W3C XML Schemas parser module */ XML_FROM_IO,
XML_FROM_SCHEMASV, /* The W3C XML Schemas validation module */ /** The FTP module */
XML_FROM_RELAXNGP, /* The Relax-NG parser module */ XML_FROM_FTP,
XML_FROM_RELAXNGV, /* The Relax-NG validator module */ /** The HTTP module */
XML_FROM_CATALOG, /* The Catalog module */ XML_FROM_HTTP,
XML_FROM_C14N, /* The Canonicalization module */ /** The XInclude processing */
XML_FROM_XSLT, /* The XSLT engine from libxslt */ XML_FROM_XINCLUDE,
XML_FROM_VALID, /* The XML DTD validation with valid context */ /** The XPath module */
XML_FROM_CHECK, /* The error checking module */ XML_FROM_XPATH,
XML_FROM_WRITER, /* The xmlwriter module */ /** The XPointer module */
XML_FROM_MODULE, /* The dynamically loaded module module*/ XML_FROM_XPOINTER,
XML_FROM_I18N, /* The module handling character conversion */ /** The regular expressions module */
XML_FROM_SCHEMATRONV,/* The Schematron validator module */ XML_FROM_REGEXP,
XML_FROM_BUFFER, /* The buffers module */ /** The W3C XML Schemas Datatype module */
XML_FROM_URI /* The URI module */ XML_FROM_DATATYPE,
/** The W3C XML Schemas parser module */
XML_FROM_SCHEMASP,
/** The W3C XML Schemas validation module */
XML_FROM_SCHEMASV,
/** The Relax-NG parser module */
XML_FROM_RELAXNGP,
/** The Relax-NG validator module */
XML_FROM_RELAXNGV,
/** The Catalog module */
XML_FROM_CATALOG,
/** The Canonicalization module */
XML_FROM_C14N,
/** The XSLT engine from libxslt */
XML_FROM_XSLT,
/** The XML DTD validation with valid context */
XML_FROM_VALID,
/** The error checking module */
XML_FROM_CHECK,
/** The xmlwriter module */
XML_FROM_WRITER,
/** The dynamically loaded module module*/
XML_FROM_MODULE,
/** The module handling character conversion */
XML_FROM_I18N,
/** The Schematron validator module */
XML_FROM_SCHEMATRONV,
/** The buffers module */
XML_FROM_BUFFER,
/** The URI module */
XML_FROM_URI
} xmlErrorDomain; } xmlErrorDomain;
/** /**
@@ -97,8 +131,7 @@ struct _xmlError {
}; };
/** /**
* * Error codes
* This is an error that the XML (or HTML) parser can generate
*/ */
typedef enum { typedef enum {
XML_ERR_OK = 0, XML_ERR_OK = 0,

3
include/libxml/xmlmodule.h
View File

@@ -29,8 +29,7 @@ extern "C" {
typedef struct _xmlModule xmlModule; typedef struct _xmlModule xmlModule;
typedef xmlModule *xmlModulePtr; typedef xmlModule *xmlModulePtr;
/** /*
*
* enumeration of options that can be passed down to xmlModuleOpen() * enumeration of options that can be passed down to xmlModuleOpen()
*/ */
typedef enum { typedef enum {

28
include/libxml/xmlreader.h
View File

@@ -30,7 +30,6 @@ extern "C" {
#endif #endif
/** /**
*
* How severe an error callback is when the per-reader error callback API * How severe an error callback is when the per-reader error callback API
* is used. * is used.
*/ */
@@ -43,8 +42,7 @@ typedef enum {
#ifdef LIBXML_READER_ENABLED #ifdef LIBXML_READER_ENABLED
/** /*
*
* Internal state values for the reader. * Internal state values for the reader.
*/ */
typedef enum { typedef enum {
@@ -57,40 +55,60 @@ typedef enum {
} xmlTextReaderMode; } xmlTextReaderMode;
/** /**
*
* Some common options to use with xmlTextReaderSetParserProp, but it * Some common options to use with xmlTextReaderSetParserProp, but it
* is better to use xmlParserOption and the xmlReaderNewxxx and * is better to use xmlParserOption and the xmlReaderNewxxx and
* xmlReaderForxxx APIs now. * xmlReaderForxxx APIs now.
*/ */
typedef enum { typedef enum {
/* load external DTD */
XML_PARSER_LOADDTD = 1, XML_PARSER_LOADDTD = 1,
/* use default attributes */
XML_PARSER_DEFAULTATTRS = 2, XML_PARSER_DEFAULTATTRS = 2,
/* DTD validation */
XML_PARSER_VALIDATE = 3, XML_PARSER_VALIDATE = 3,
/* substitute entities */
XML_PARSER_SUBST_ENTITIES = 4 XML_PARSER_SUBST_ENTITIES = 4
} xmlParserProperties; } xmlParserProperties;
/** /**
*
* Predefined constants for the different types of nodes. * Predefined constants for the different types of nodes.
*/ */
typedef enum { typedef enum {
/** unknown or error */
XML_READER_TYPE_NONE = 0, XML_READER_TYPE_NONE = 0,
/** element */
XML_READER_TYPE_ELEMENT = 1, XML_READER_TYPE_ELEMENT = 1,
/** attribute */
XML_READER_TYPE_ATTRIBUTE = 2, XML_READER_TYPE_ATTRIBUTE = 2,
/** text */
XML_READER_TYPE_TEXT = 3, XML_READER_TYPE_TEXT = 3,
/** CDATA section */
XML_READER_TYPE_CDATA = 4, XML_READER_TYPE_CDATA = 4,
/** entity reference */
XML_READER_TYPE_ENTITY_REFERENCE = 5, XML_READER_TYPE_ENTITY_REFERENCE = 5,
/** unused */
XML_READER_TYPE_ENTITY = 6, XML_READER_TYPE_ENTITY = 6,
/** processing instruction */
XML_READER_TYPE_PROCESSING_INSTRUCTION = 7, XML_READER_TYPE_PROCESSING_INSTRUCTION = 7,
/** comment */
XML_READER_TYPE_COMMENT = 8, XML_READER_TYPE_COMMENT = 8,
/** document */
XML_READER_TYPE_DOCUMENT = 9, XML_READER_TYPE_DOCUMENT = 9,
/** unused */
XML_READER_TYPE_DOCUMENT_TYPE = 10, XML_READER_TYPE_DOCUMENT_TYPE = 10,
/** document fragment */
XML_READER_TYPE_DOCUMENT_FRAGMENT = 11, XML_READER_TYPE_DOCUMENT_FRAGMENT = 11,
/** notation, unused */
XML_READER_TYPE_NOTATION = 12, XML_READER_TYPE_NOTATION = 12,
/** whitespace */
XML_READER_TYPE_WHITESPACE = 13, XML_READER_TYPE_WHITESPACE = 13,
/** significant whitespace */
XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14, XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14,
/** end of element */
XML_READER_TYPE_END_ELEMENT = 15, XML_READER_TYPE_END_ELEMENT = 15,
/** unused */
XML_READER_TYPE_END_ENTITY = 16, XML_READER_TYPE_END_ENTITY = 16,
/** unused */
XML_READER_TYPE_XML_DECLARATION = 17 XML_READER_TYPE_XML_DECLARATION = 17
} xmlReaderTypes; } xmlReaderTypes;

35
include/libxml/xmlsave.h
View File

@@ -24,23 +24,32 @@ extern "C" {
#endif #endif
/** /**
*
* This is the set of XML save options that can be passed down * This is the set of XML save options that can be passed down
* to the xmlSaveToFd() and similar calls. * to the xmlSaveToFd() and similar calls.
*/ */
typedef enum { typedef enum {
XML_SAVE_FORMAT = 1<<0, /* format save output */ /** format save output */
XML_SAVE_NO_DECL = 1<<1, /* drop the xml declaration */ XML_SAVE_FORMAT = 1<<0,
XML_SAVE_NO_EMPTY = 1<<2, /* no empty tags */ /** drop the xml declaration */
XML_SAVE_NO_XHTML = 1<<3, /* disable XHTML1 specific rules */ XML_SAVE_NO_DECL = 1<<1,
XML_SAVE_XHTML = 1<<4, /* force XHTML1 specific rules */ /** no empty tags */
XML_SAVE_AS_XML = 1<<5, /* force XML serialization on HTML doc */ XML_SAVE_NO_EMPTY = 1<<2,
XML_SAVE_AS_HTML = 1<<6, /* force HTML serialization on XML doc */ /** disable XHTML1 specific rules */
XML_SAVE_WSNONSIG = 1<<7, /* format with non-significant whitespace */ XML_SAVE_NO_XHTML = 1<<3,
/* Available since 2.14.0 */ /** force XHTML1 specific rules */
XML_SAVE_EMPTY = 1<<8, /* force empty tags, overriding global */ XML_SAVE_XHTML = 1<<4,
XML_SAVE_NO_INDENT = 1<<9, /* disable indenting */ /** force XML serialization on HTML doc */
XML_SAVE_INDENT = 1<<10 /* force indenting, overriding global */ XML_SAVE_AS_XML = 1<<5,
/** force HTML serialization on XML doc */
XML_SAVE_AS_HTML = 1<<6,
/** format with non-significant whitespace */
XML_SAVE_WSNONSIG = 1<<7,
/** force empty tags, overriding global, available since 2.14 */
XML_SAVE_EMPTY = 1<<8,
/** disable indenting, available since 2.14 */
XML_SAVE_NO_INDENT = 1<<9,
/** force indenting, overriding global, available since 2.14 */
XML_SAVE_INDENT = 1<<10
} xmlSaveOption; } xmlSaveOption;