@img/sharp-libvips-dev 1.2.2 → 1.2.4-rc.0

package/include/libxml2/libxml/dict.h

@@ -1,11 +1,14 @@
-/*
- * Summary: string dictionary
- * Description: dictionary of reusable strings, just used to avoid allocation
+/**
+ * @file
+ * 
+ * @brief string dictionary
+ * 
+ * dictionary of reusable strings, just used to avoid allocation
  *         and freeing operations.
  *
- * Copy: See Copyright for the status of this software.
+ * @copyright See Copyright for the status of this software.
  *
- * Author: Daniel Veillard
+ * @author Daniel Veillard
  */
 
 #ifndef __XML_DICT_H__
@@ -19,8 +22,8 @@
 extern "C" {
 #endif
 
-/*
- * The dictionary.
+/**
+ * Dictionary (pool for interned strings)
  */
 typedef struct _xmlDict xmlDict;
 typedef xmlDict *xmlDictPtr;
@@ -34,40 +37,40 @@ XMLPUBFUN int  xmlInitializeDict(void);
 /*
  * Constructor and destructor.
  */
-XMLPUBFUN xmlDictPtr
+XMLPUBFUN xmlDict *
 			xmlDictCreate	(void);
 XMLPUBFUN size_t
-			xmlDictSetLimit	(xmlDictPtr dict,
+			xmlDictSetLimit	(xmlDict *dict,
                                          size_t limit);
 XMLPUBFUN size_t
-			xmlDictGetUsage (xmlDictPtr dict);
-XMLPUBFUN xmlDictPtr
-			xmlDictCreateSub(xmlDictPtr sub);
+			xmlDictGetUsage (xmlDict *dict);
+XMLPUBFUN xmlDict *
+			xmlDictCreateSub(xmlDict *sub);
 XMLPUBFUN int
-			xmlDictReference(xmlDictPtr dict);
+			xmlDictReference(xmlDict *dict);
 XMLPUBFUN void
-			xmlDictFree	(xmlDictPtr dict);
+			xmlDictFree	(xmlDict *dict);
 
 /*
  * Lookup of entry in the dictionary.
  */
 XMLPUBFUN const xmlChar *
-			xmlDictLookup	(xmlDictPtr dict,
+			xmlDictLookup	(xmlDict *dict,
 		                         const xmlChar *name,
 		                         int len);
 XMLPUBFUN const xmlChar *
-			xmlDictExists	(xmlDictPtr dict,
+			xmlDictExists	(xmlDict *dict,
 		                         const xmlChar *name,
 		                         int len);
 XMLPUBFUN const xmlChar *
-			xmlDictQLookup	(xmlDictPtr dict,
+			xmlDictQLookup	(xmlDict *dict,
 		                         const xmlChar *prefix,
 		                         const xmlChar *name);
 XMLPUBFUN int
-			xmlDictOwns	(xmlDictPtr dict,
+			xmlDictOwns	(xmlDict *dict,
 					 const xmlChar *str);
 XMLPUBFUN int
-			xmlDictSize	(xmlDictPtr dict);
+			xmlDictSize	(xmlDict *dict);
 
 /*
  * Cleanup function

package/include/libxml2/libxml/encoding.h

@@ -1,22 +1,11 @@
-/*
- * Summary: interface for the encoding conversion functions
- * Description: interface for the encoding conversion functions needed for
- *              XML basic encoding and iconv() support.
- *
- * Related specs are
- * rfc2044        (UTF-8 and UTF-16) F. Yergeau Alis Technologies
- * [ISO-10646]    UTF-8 and UTF-16 in Annexes
- * [ISO-8859-1]   ISO Latin-1 characters codes.
- * [UNICODE]      The Unicode Consortium, "The Unicode Standard --
- *                Worldwide Character Encoding -- Version 1.0", Addison-
- *                Wesley, Volume 1, 1991, Volume 2, 1992.  UTF-8 is
- *                described in Unicode Technical Report #4.
- * [US-ASCII]     Coded Character Set--7-bit American Standard Code for
- *                Information Interchange, ANSI X3.4-1986.
- *
- * Copy: See Copyright for the status of this software.
+/**
+ * @file
+ * 
+ * @brief Character encoding conversion functions
+ * 
+ * @copyright See Copyright for the status of this software.
  *
- * Author: Daniel Veillard
+ * @author Daniel Veillard
  */
 
 #ifndef __XML_CHAR_ENCODING_H__
@@ -32,139 +21,181 @@ extern "C" {
 /*
  * Backward compatibility
  */
+/** @cond ignore */
 #define UTF8Toisolat1 xmlUTF8ToIsolat1
 #define isolat1ToUTF8 xmlIsolat1ToUTF8
+/** @endcond */
 
+/**
+ * Encoding conversion errors
+ */
 typedef enum {
+    /** Success */
     XML_ENC_ERR_SUCCESS     =  0,
+    /** Internal or unclassified error */
     XML_ENC_ERR_INTERNAL    = -1,
+    /** Invalid or untranslatable input sequence */
     XML_ENC_ERR_INPUT       = -2,
+    /** Not enough space in output buffer */
     XML_ENC_ERR_SPACE       = -3,
+    /** Out-of-memory error */
     XML_ENC_ERR_MEMORY      = -4
 } xmlCharEncError;
 
-/*
- * xmlCharEncoding:
- *
+/**
  * Predefined values for some standard encodings.
  */
 typedef enum {
-    XML_CHAR_ENCODING_ERROR=   -1, /* No char encoding detected */
-    XML_CHAR_ENCODING_NONE=	0, /* No char encoding detected */
-    XML_CHAR_ENCODING_UTF8=	1, /* UTF-8 */
-    XML_CHAR_ENCODING_UTF16LE=	2, /* UTF-16 little endian */
-    XML_CHAR_ENCODING_UTF16BE=	3, /* UTF-16 big endian */
-    XML_CHAR_ENCODING_UCS4LE=	4, /* UCS-4 little endian */
-    XML_CHAR_ENCODING_UCS4BE=	5, /* UCS-4 big endian */
-    XML_CHAR_ENCODING_EBCDIC=	6, /* EBCDIC uh! */
-    XML_CHAR_ENCODING_UCS4_2143=7, /* UCS-4 unusual ordering */
-    XML_CHAR_ENCODING_UCS4_3412=8, /* UCS-4 unusual ordering */
-    XML_CHAR_ENCODING_UCS2=	9, /* UCS-2 */
-    XML_CHAR_ENCODING_8859_1=	10,/* ISO-8859-1 ISO Latin 1 */
-    XML_CHAR_ENCODING_8859_2=	11,/* ISO-8859-2 ISO Latin 2 */
-    XML_CHAR_ENCODING_8859_3=	12,/* ISO-8859-3 */
-    XML_CHAR_ENCODING_8859_4=	13,/* ISO-8859-4 */
-    XML_CHAR_ENCODING_8859_5=	14,/* ISO-8859-5 */
-    XML_CHAR_ENCODING_8859_6=	15,/* ISO-8859-6 */
-    XML_CHAR_ENCODING_8859_7=	16,/* ISO-8859-7 */
-    XML_CHAR_ENCODING_8859_8=	17,/* ISO-8859-8 */
-    XML_CHAR_ENCODING_8859_9=	18,/* ISO-8859-9 */
-    XML_CHAR_ENCODING_2022_JP=  19,/* ISO-2022-JP */
-    XML_CHAR_ENCODING_SHIFT_JIS=20,/* Shift_JIS */
-    XML_CHAR_ENCODING_EUC_JP=   21,/* EUC-JP */
-    XML_CHAR_ENCODING_ASCII=    22,/* pure ASCII */
-    /* Available since 2.14.0 */
-    XML_CHAR_ENCODING_UTF16=	23,/* UTF-16 native */
-    XML_CHAR_ENCODING_HTML=	24,/* HTML (output only) */
-    XML_CHAR_ENCODING_8859_10=	25,/* ISO-8859-10 */
-    XML_CHAR_ENCODING_8859_11=	26,/* ISO-8859-11 */
-    XML_CHAR_ENCODING_8859_13=	27,/* ISO-8859-13 */
-    XML_CHAR_ENCODING_8859_14=	28,/* ISO-8859-14 */
-    XML_CHAR_ENCODING_8859_15=	29,/* ISO-8859-15 */
-    XML_CHAR_ENCODING_8859_16=	30 /* ISO-8859-16 */
+    /** No char encoding detected */
+    XML_CHAR_ENCODING_ERROR=   -1,
+    /** No char encoding detected */
+    XML_CHAR_ENCODING_NONE=	0,
+    /** UTF-8 */
+    XML_CHAR_ENCODING_UTF8=	1,
+    /** UTF-16 little endian */
+    XML_CHAR_ENCODING_UTF16LE=	2,
+    /** UTF-16 big endian */
+    XML_CHAR_ENCODING_UTF16BE=	3,
+    /** UCS-4 little endian */
+    XML_CHAR_ENCODING_UCS4LE=	4,
+    /** UCS-4 big endian */
+    XML_CHAR_ENCODING_UCS4BE=	5,
+    /** EBCDIC uh! */
+    XML_CHAR_ENCODING_EBCDIC=	6,
+    /** UCS-4 unusual ordering */
+    XML_CHAR_ENCODING_UCS4_2143=7,
+    /** UCS-4 unusual ordering */
+    XML_CHAR_ENCODING_UCS4_3412=8,
+    /** UCS-2 */
+    XML_CHAR_ENCODING_UCS2=	9,
+    /** ISO-8859-1 ISO Latin 1 */
+    XML_CHAR_ENCODING_8859_1=	10,
+    /** ISO-8859-2 ISO Latin 2 */
+    XML_CHAR_ENCODING_8859_2=	11,
+    /** ISO-8859-3 */
+    XML_CHAR_ENCODING_8859_3=	12,
+    /** ISO-8859-4 */
+    XML_CHAR_ENCODING_8859_4=	13,
+    /** ISO-8859-5 */
+    XML_CHAR_ENCODING_8859_5=	14,
+    /** 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,
+    /** windows-1252, available since 2.15 */
+    XML_CHAR_ENCODING_WINDOWS_1252 = 31
 } xmlCharEncoding;
 
+/**
+ * Encoding conversion flags
+ */
 typedef enum {
+    /** Create converter for input (conversion to UTF-8) */
     XML_ENC_INPUT = (1 << 0),
-    XML_ENC_OUTPUT = (1 << 1)
+    /** Create converter for output (conversion from UTF-8) */
+    XML_ENC_OUTPUT = (1 << 1),
+    /** Use HTML5 mappings */
+    XML_ENC_HTML = (1 << 2)
 } xmlCharEncFlags;
 
 /**
- * xmlCharEncodingInputFunc:
- * @out:  a pointer to an array of bytes to store the UTF-8 result
- * @outlen:  the length of @out
- * @in:  a pointer to an array of chars in the original encoding
- * @inlen:  the length of @in
- *
  * Convert characters to UTF-8.
  *
- * On success, the value of @inlen after return is the number of
- * bytes consumed and @outlen is the number of bytes produced.
+ * On success, the value of `inlen` after return is the number of
+ * bytes consumed and `outlen` is the number of bytes produced.
  *
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @param out  a pointer to an array of bytes to store the UTF-8 result
+ * @param outlen  the length of `out`
+ * @param in  a pointer to an array of chars in the original encoding
+ * @param inlen  the length of `in`
+ * @returns the number of bytes written or an xmlCharEncError code.
  */
 typedef int (*xmlCharEncodingInputFunc)(unsigned char *out, int *outlen,
                                         const unsigned char *in, int *inlen);
 
 
 /**
- * xmlCharEncodingOutputFunc:
- * @out:  a pointer to an array of bytes to store the result
- * @outlen:  the length of @out
- * @in:  a pointer to an array of UTF-8 chars
- * @inlen:  the length of @in
- *
  * Convert characters from UTF-8.
  *
- * On success, the value of @inlen after return is the number of
- * bytes consumed and @outlen is the number of bytes produced.
+ * On success, the value of `inlen` after return is the number of
+ * bytes consumed and `outlen` is the number of bytes produced.
  *
- * Returns the number of bytes written or an XML_ENC_ERR code.
+ * @param out  a pointer to an array of bytes to store the result
+ * @param outlen  the length of `out`
+ * @param in  a pointer to an array of UTF-8 chars
+ * @param inlen  the length of `in`
+ * @returns the number of bytes written or an xmlCharEncError code.
  */
 typedef int (*xmlCharEncodingOutputFunc)(unsigned char *out, int *outlen,
                                          const unsigned char *in, int *inlen);
 
 
 /**
- * xmlCharEncConvFunc:
- * @vctxt:  conversion context
- * @out:  a pointer to an array of bytes to store the result
- * @outlen:  the length of @out
- * @in:  a pointer to an array of input bytes
- * @inlen:  the length of @in
- * @flush:  end of input
- *
  * Convert between character encodings.
  *
- * The value of @inlen after return is the number of bytes consumed
- * and @outlen is the number of bytes produced.
+ * The value of `inlen` after return is the number of bytes consumed
+ * and `outlen` is the number of bytes produced.
  *
  * If the converter can consume partial multi-byte sequences, the
- * @flush flag can be used to detect truncated sequences at EOF.
+ * `flush` flag can be used to detect truncated sequences at EOF.
  * Otherwise, the flag can be ignored.
  *
- * Returns an XML_ENC_ERR code.
+ * @param vctxt  conversion context
+ * @param out  a pointer to an array of bytes to store the result
+ * @param outlen  the length of `out`
+ * @param in  a pointer to an array of input bytes
+ * @param inlen  the length of `in`
+ * @param flush  end of input
+ * @returns an xmlCharEncError code.
  */
 typedef xmlCharEncError
 (*xmlCharEncConvFunc)(void *vctxt, unsigned char *out, int *outlen,
                       const unsigned char *in, int *inlen, int flush);
 
 /**
- * xmlCharEncConvCtxtDtor:
- * @vctxt:  conversion context
- *
  * Free a conversion context.
+ *
+ * @param vctxt  conversion context
  */
 typedef void
 (*xmlCharEncConvCtxtDtor)(void *vctxt);
 
-/*
- * Block defining the handlers for non UTF-8 encodings.
+/** Character encoding converter */
+typedef struct _xmlCharEncodingHandler xmlCharEncodingHandler;
+typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;
+/**
+ * A character encoding conversion handler for non UTF-8 encodings.
  *
  * This structure will be made private.
  */
-typedef struct _xmlCharEncodingHandler xmlCharEncodingHandler;
-typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;
 struct _xmlCharEncodingHandler {
     char *name XML_DEPRECATED_MEMBER;
     union {
@@ -182,19 +213,17 @@ struct _xmlCharEncodingHandler {
 };
 
 /**
- * xmlCharEncConvImpl:
- * @vctxt:  user data
- * @name:  encoding name
- * @flags:  bit mask of flags
- * @out:  pointer to resulting handler
- *
- * If this function returns XML_ERR_OK, it must fill the @out
+ * If this function returns XML_ERR_OK, it must fill the `out`
  * pointer with an encoding handler. The handler can be obtained
- * from xmlCharEncNewCustomHandler.
+ * from #xmlCharEncNewCustomHandler.
  *
- * @flags can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
+ * `flags` can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
  *
- * Returns an xmlParserErrors code.
+ * @param vctxt  user data
+ * @param name  encoding name
+ * @param flags  bit mask of flags
+ * @param out  pointer to resulting handler
+ * @returns an xmlParserErrors code.
  */
 typedef xmlParserErrors
 (*xmlCharEncConvImpl)(void *vctxt, const char *name, xmlCharEncFlags flags,
@@ -209,26 +238,28 @@ XMLPUBFUN void
 XML_DEPRECATED
 XMLPUBFUN void
 	xmlCleanupCharEncodingHandlers	(void);
+XML_DEPRECATED
 XMLPUBFUN void
-	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandlerPtr handler);
+	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandler *handler);
 XMLPUBFUN xmlParserErrors
 	xmlLookupCharEncodingHandler	(xmlCharEncoding enc,
-					 xmlCharEncodingHandlerPtr *out);
+					 xmlCharEncodingHandler **out);
 XMLPUBFUN xmlParserErrors
 	xmlOpenCharEncodingHandler	(const char *name,
 					 int output,
-					 xmlCharEncodingHandlerPtr *out);
+					 xmlCharEncodingHandler **out);
 XMLPUBFUN xmlParserErrors
 	xmlCreateCharEncodingHandler	(const char *name,
 					 xmlCharEncFlags flags,
 					 xmlCharEncConvImpl impl,
 					 void *implCtxt,
-					 xmlCharEncodingHandlerPtr *out);
-XMLPUBFUN xmlCharEncodingHandlerPtr
+					 xmlCharEncodingHandler **out);
+XMLPUBFUN xmlCharEncodingHandler *
 	xmlGetCharEncodingHandler	(xmlCharEncoding enc);
-XMLPUBFUN xmlCharEncodingHandlerPtr
+XMLPUBFUN xmlCharEncodingHandler *
 	xmlFindCharEncodingHandler	(const char *name);
-XMLPUBFUN xmlCharEncodingHandlerPtr
+XML_DEPRECATED
+XMLPUBFUN xmlCharEncodingHandler *
 	xmlNewCharEncodingHandler	(const char *name,
 					 xmlCharEncodingInputFunc input,
 					 xmlCharEncodingOutputFunc output);
@@ -244,13 +275,17 @@ XMLPUBFUN xmlParserErrors
 /*
  * Interfaces for encoding names and aliases.
  */
+XML_DEPRECATED
 XMLPUBFUN int
 	xmlAddEncodingAlias		(const char *name,
 					 const char *alias);
+XML_DEPRECATED
 XMLPUBFUN int
 	xmlDelEncodingAlias		(const char *alias);
+XML_DEPRECATED
 XMLPUBFUN const char *
 	xmlGetEncodingAlias		(const char *alias);
+XML_DEPRECATED
 XMLPUBFUN void
 	xmlCleanupEncodingAliases	(void);
 XMLPUBFUN xmlCharEncoding
@@ -265,9 +300,7 @@ XMLPUBFUN xmlCharEncoding
 	xmlDetectCharEncoding		(const unsigned char *in,
 					 int len);
 
-/** DOC_DISABLE */
 struct _xmlBuffer;
-/** DOC_ENABLE */
 XMLPUBFUN int
 	xmlCharEncOutFunc		(xmlCharEncodingHandler *handler,
 					 struct _xmlBuffer *out,