lxml 5.4.0__cp311-cp311-macosx_10_9_universal2.whl → 6.0.0__cp311-cp311-macosx_10_9_universal2.whl

lxml/includes/libxml/encoding.h

@@ -23,44 +23,30 @@
 #define __XML_CHAR_ENCODING_H__
 
 #include <libxml/xmlversion.h>
-
-#ifdef LIBXML_ICONV_ENABLED
-#include <iconv.h>
-#endif
+#include <libxml/xmlerror.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/*
+ * Backward compatibility
+ */
+#define UTF8Toisolat1 xmlUTF8ToIsolat1
+#define isolat1ToUTF8 xmlIsolat1ToUTF8
+
 typedef enum {
     XML_ENC_ERR_SUCCESS     =  0,
-    XML_ENC_ERR_SPACE       = -1,
+    XML_ENC_ERR_INTERNAL    = -1,
     XML_ENC_ERR_INPUT       = -2,
-    XML_ENC_ERR_PARTIAL     = -3,
-    XML_ENC_ERR_INTERNAL    = -4,
-    XML_ENC_ERR_MEMORY      = -5
+    XML_ENC_ERR_SPACE       = -3,
+    XML_ENC_ERR_MEMORY      = -4
 } xmlCharEncError;
 
 /*
  * xmlCharEncoding:
  *
  * Predefined values for some standard encodings.
- * Libxml does not do beforehand translation on UTF8 and ISOLatinX.
- * It also supports ASCII, ISO-8859-1, and UTF16 (LE and BE) by default.
- *
- * Anything else would have to be translated to UTF8 before being
- * given to the parser itself. The BOM for UTF16 and the encoding
- * declaration are looked at and a converter is looked for at that
- * point. If not found the parser stops here as asked by the XML REC. A
- * converter can be registered by the user using xmlRegisterCharEncodingHandler
- * but the current form doesn't allow stateful transcoding (a serious
- * problem agreed !). If iconv has been found it will be used
- * automatically and allow stateful transcoding, the simplest is then
- * to be sure to enable iconv and to provide iconv libs for the encoding
- * support needed.
- *
- * Note that the generic "UTF-16" is not a predefined value.  Instead, only
- * the specific UTF-16LE and UTF-16BE are present.
  */
 typedef enum {
     XML_CHAR_ENCODING_ERROR=   -1, /* No char encoding detected */
@@ -86,9 +72,23 @@ typedef enum {
     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 */
+    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 */
 } xmlCharEncoding;
 
+typedef enum {
+    XML_ENC_INPUT = (1 << 0),
+    XML_ENC_OUTPUT = (1 << 1)
+} xmlCharEncFlags;
+
 /**
  * xmlCharEncodingInputFunc:
  * @out:  a pointer to an array of bytes to store the UTF-8 result
@@ -96,17 +96,15 @@ typedef enum {
  * @in:  a pointer to an array of chars in the original encoding
  * @inlen:  the length of @in
  *
- * Take a block of chars in the original encoding and try to convert
- * it to an UTF-8 block of chars out.
+ * Convert characters to UTF-8.
  *
- * Returns the number of bytes written, -1 if lack of space, or -2
- *     if the transcoding failed.
- * The value of @inlen after return is the number of octets consumed
- *     if the return value is positive, else unpredictiable.
- * The value of @outlen after return is the number of octets consumed.
+ * 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.
  */
-typedef int (* xmlCharEncodingInputFunc)(unsigned char *out, int *outlen,
-                                         const unsigned char *in, int *inlen);
+typedef int (*xmlCharEncodingInputFunc)(unsigned char *out, int *outlen,
+                                        const unsigned char *in, int *inlen);
 
 
 /**
@@ -116,41 +114,92 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char *out, int *outlen,
  * @in:  a pointer to an array of UTF-8 chars
  * @inlen:  the length of @in
  *
- * Take a block of UTF-8 chars in and try to convert it to another
- * encoding.
- * Note: a first call designed to produce heading info is called with
- * in = NULL. If stateful this should also initialize the encoder state.
+ * Convert characters from UTF-8.
  *
- * Returns the number of bytes written, -1 if lack of space, or -2
- *     if the transcoding failed.
- * The value of @inlen after return is the number of octets consumed
- *     if the return value is positive, else unpredictiable.
- * The value of @outlen after return is the number of octets 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.
  */
-typedef int (* xmlCharEncodingOutputFunc)(unsigned char *out, int *outlen,
-                                          const unsigned char *in, int *inlen);
+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.
+ *
+ * If the converter can consume partial multi-byte sequences, the
+ * @flush flag can be used to detect truncated sequences at EOF.
+ * Otherwise, the flag can be ignored.
+ *
+ * Returns an XML_ENC_ERR 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.
+ */
+typedef void
+(*xmlCharEncConvCtxtDtor)(void *vctxt);
+
 /*
  * Block defining the handlers for non UTF-8 encodings.
- * If iconv is supported, there are two extra fields.
+ *
+ * This structure will be made private.
  */
 typedef struct _xmlCharEncodingHandler xmlCharEncodingHandler;
 typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;
 struct _xmlCharEncodingHandler {
-    char                       *name;
-    xmlCharEncodingInputFunc   input;
-    xmlCharEncodingOutputFunc  output;
-#ifdef LIBXML_ICONV_ENABLED
-    iconv_t                    iconv_in;
-    iconv_t                    iconv_out;
-#endif /* LIBXML_ICONV_ENABLED */
-#ifdef LIBXML_ICU_ENABLED
-    struct _uconv_t            *uconv_in;
-    struct _uconv_t            *uconv_out;
-#endif /* LIBXML_ICU_ENABLED */
+    char *name XML_DEPRECATED_MEMBER;
+    union {
+        xmlCharEncConvFunc func;
+        xmlCharEncodingInputFunc legacyFunc;
+    } input XML_DEPRECATED_MEMBER;
+    union {
+        xmlCharEncConvFunc func;
+        xmlCharEncodingOutputFunc legacyFunc;
+    } output XML_DEPRECATED_MEMBER;
+    void *inputCtxt XML_DEPRECATED_MEMBER;
+    void *outputCtxt XML_DEPRECATED_MEMBER;
+    xmlCharEncConvCtxtDtor ctxtDtor XML_DEPRECATED_MEMBER;
+    int flags XML_DEPRECATED_MEMBER;
 };
 
+/**
+ * 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
+ * pointer with an encoding handler. The handler can be obtained
+ * from xmlCharEncNewCustomHandler.
+ *
+ * @flags can contain XML_ENC_INPUT, XML_ENC_OUTPUT or both.
+ *
+ * Returns an xmlParserErrors code.
+ */
+typedef xmlParserErrors
+(*xmlCharEncConvImpl)(void *vctxt, const char *name, xmlCharEncFlags flags,
+                      xmlCharEncodingHandler **out);
+
 /*
  * Interfaces for encoding handlers.
  */
@@ -162,13 +211,19 @@ XMLPUBFUN void
 	xmlCleanupCharEncodingHandlers	(void);
 XMLPUBFUN void
 	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandlerPtr handler);
-XMLPUBFUN int
+XMLPUBFUN xmlParserErrors
 	xmlLookupCharEncodingHandler	(xmlCharEncoding enc,
 					 xmlCharEncodingHandlerPtr *out);
-XMLPUBFUN int
+XMLPUBFUN xmlParserErrors
 	xmlOpenCharEncodingHandler	(const char *name,
 					 int output,
 					 xmlCharEncodingHandlerPtr *out);
+XMLPUBFUN xmlParserErrors
+	xmlCreateCharEncodingHandler	(const char *name,
+					 xmlCharEncFlags flags,
+					 xmlCharEncConvImpl impl,
+					 void *implCtxt,
+					 xmlCharEncodingHandlerPtr *out);
 XMLPUBFUN xmlCharEncodingHandlerPtr
 	xmlGetCharEncodingHandler	(xmlCharEncoding enc);
 XMLPUBFUN xmlCharEncodingHandlerPtr
@@ -177,6 +232,14 @@ XMLPUBFUN xmlCharEncodingHandlerPtr
 	xmlNewCharEncodingHandler	(const char *name,
 					 xmlCharEncodingInputFunc input,
 					 xmlCharEncodingOutputFunc output);
+XMLPUBFUN xmlParserErrors
+	xmlCharEncNewCustomHandler	(const char *name,
+					 xmlCharEncConvFunc input,
+					 xmlCharEncConvFunc output,
+					 xmlCharEncConvCtxtDtor ctxtDtor,
+					 void *inputCtxt,
+					 void *outputCtxt,
+					 xmlCharEncodingHandler **out);
 
 /*
  * Interfaces for encoding names and aliases.
@@ -227,13 +290,13 @@ XMLPUBFUN int
  */
 #ifdef LIBXML_OUTPUT_ENABLED
 XMLPUBFUN int
-	UTF8Toisolat1			(unsigned char *out,
+	xmlUTF8ToIsolat1		(unsigned char *out,
 					 int *outlen,
 					 const unsigned char *in,
 					 int *inlen);
 #endif /* LIBXML_OUTPUT_ENABLED */
 XMLPUBFUN int
-	isolat1ToUTF8			(unsigned char *out,
+	xmlIsolat1ToUTF8		(unsigned char *out,
 					 int *outlen,
 					 const unsigned char *in,
 					 int *inlen);

lxml/includes/libxml/entities.h

@@ -76,12 +76,6 @@ typedef xmlEntitiesTable *xmlEntitiesTablePtr;
  * External functions:
  */
 
-#ifdef LIBXML_LEGACY_ENABLED
-XML_DEPRECATED
-XMLPUBFUN void
-		xmlInitializePredefinedEntities	(void);
-#endif /* LIBXML_LEGACY_ENABLED */
-
 XMLPUBFUN xmlEntityPtr
 			xmlNewEntity		(xmlDocPtr doc,
 						 const xmlChar *name,
@@ -125,12 +119,6 @@ XMLPUBFUN xmlEntityPtr
 XMLPUBFUN xmlEntityPtr
 			xmlGetParameterEntity	(xmlDocPtr doc,
 						 const xmlChar *name);
-#ifdef LIBXML_LEGACY_ENABLED
-XML_DEPRECATED
-XMLPUBFUN const xmlChar *
-			xmlEncodeEntities	(xmlDocPtr doc,
-						 const xmlChar *input);
-#endif /* LIBXML_LEGACY_ENABLED */
 XMLPUBFUN xmlChar *
 			xmlEncodeEntitiesReentrant(xmlDocPtr doc,
 						 const xmlChar *input);
@@ -139,10 +127,8 @@ XMLPUBFUN xmlChar *
 						 const xmlChar *input);
 XMLPUBFUN xmlEntitiesTablePtr
 			xmlCreateEntitiesTable	(void);
-#ifdef LIBXML_TREE_ENABLED
 XMLPUBFUN xmlEntitiesTablePtr
 			xmlCopyEntitiesTable	(xmlEntitiesTablePtr table);
-#endif /* LIBXML_TREE_ENABLED */
 XMLPUBFUN void
 			xmlFreeEntitiesTable	(xmlEntitiesTablePtr table);
 #ifdef LIBXML_OUTPUT_ENABLED
@@ -153,11 +139,6 @@ XMLPUBFUN void
 			xmlDumpEntityDecl	(xmlBufferPtr buf,
 						 xmlEntityPtr ent);
 #endif /* LIBXML_OUTPUT_ENABLED */
-#ifdef LIBXML_LEGACY_ENABLED
-XMLPUBFUN void
-			xmlCleanupPredefinedEntities(void);
-#endif /* LIBXML_LEGACY_ENABLED */
-
 
 #ifdef __cplusplus
 }

lxml/includes/libxml/globals.h

@@ -22,20 +22,4 @@
 #include <libxml/xmlsave.h>
 #include <libxml/threads.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-typedef struct _xmlGlobalState xmlGlobalState;
-typedef xmlGlobalState *xmlGlobalStatePtr;
-
-XML_DEPRECATED XMLPUBFUN void
-xmlInitializeGlobalState(xmlGlobalStatePtr gs);
-XML_DEPRECATED XMLPUBFUN
-xmlGlobalStatePtr xmlGetGlobalState(void);
-
-#ifdef __cplusplus
-}
-#endif
-
 #endif /* __XML_GLOBALS_H */

lxml/includes/libxml/nanoftp.h

@@ -1,8 +1,5 @@
 /*
- * Summary: minimal FTP implementation
- * Description: minimal FTP implementation allowing to fetch resources
- *              like external subset. This module is DEPRECATED, do not
- *              use any of its functions.
+ * Summary: Removed legacy symbols for an outdated FTP client
  *
  * Copy: See Copyright for the status of this software.
  *
@@ -12,175 +9,8 @@
 #ifndef __NANO_FTP_H__
 #define __NANO_FTP_H__
 
-#include <libxml/xmlversion.h>
-
-#if defined(LIBXML_FTP_ENABLED)
-
-/* Needed for portability to Windows 64 bits */
-#if defined(_WIN32)
-#include <winsock2.h>
-#else
-/**
- * SOCKET:
- *
- * macro used to provide portability of code to windows sockets
- */
-#define SOCKET int
-/**
- * INVALID_SOCKET:
- *
- * macro used to provide portability of code to windows sockets
- * the value to be used when the socket is not valid
- */
-#undef  INVALID_SOCKET
-#define INVALID_SOCKET (-1)
-#endif
-
-#ifdef __cplusplus
-extern "C" {
+#ifdef __GNUC__
+  #warning "libxml/nanoftp.h is deprecated"
 #endif
 
-/**
- * ftpListCallback:
- * @userData:  user provided data for the callback
- * @filename:  the file name (including "->" when links are shown)
- * @attrib:  the attribute string
- * @owner:  the owner string
- * @group:  the group string
- * @size:  the file size
- * @links:  the link count
- * @year:  the year
- * @month:  the month
- * @day:  the day
- * @hour:  the hour
- * @minute:  the minute
- *
- * A callback for the xmlNanoFTPList command.
- * Note that only one of year and day:minute are specified.
- */
-typedef void (*ftpListCallback) (void *userData,
-	                         const char *filename, const char *attrib,
-	                         const char *owner, const char *group,
-				 unsigned long size, int links, int year,
-				 const char *month, int day, int hour,
-				 int minute);
-/**
- * ftpDataCallback:
- * @userData: the user provided context
- * @data: the data received
- * @len: its size in bytes
- *
- * A callback for the xmlNanoFTPGet command.
- */
-typedef void (*ftpDataCallback) (void *userData,
-				 const char *data,
-				 int len);
-
-/*
- * Init
- */
-XML_DEPRECATED
-XMLPUBFUN void
-	xmlNanoFTPInit		(void);
-XML_DEPRECATED
-XMLPUBFUN void
-	xmlNanoFTPCleanup	(void);
-
-/*
- * Creating/freeing contexts.
- */
-XML_DEPRECATED
-XMLPUBFUN void *
-	xmlNanoFTPNewCtxt	(const char *URL);
-XML_DEPRECATED
-XMLPUBFUN void
-	xmlNanoFTPFreeCtxt	(void * ctx);
-XML_DEPRECATED
-XMLPUBFUN void *
-	xmlNanoFTPConnectTo	(const char *server,
-				 int port);
-/*
- * Opening/closing session connections.
- */
-XML_DEPRECATED
-XMLPUBFUN void *
-	xmlNanoFTPOpen		(const char *URL);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPConnect	(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPClose		(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPQuit		(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN void
-	xmlNanoFTPScanProxy	(const char *URL);
-XML_DEPRECATED
-XMLPUBFUN void
-	xmlNanoFTPProxy		(const char *host,
-				 int port,
-				 const char *user,
-				 const char *passwd,
-				 int type);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPUpdateURL	(void *ctx,
-				 const char *URL);
-
-/*
- * Rather internal commands.
- */
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPGetResponse	(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPCheckResponse	(void *ctx);
-
-/*
- * CD/DIR/GET handlers.
- */
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPCwd		(void *ctx,
-				 const char *directory);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPDele		(void *ctx,
-				 const char *file);
-
-XML_DEPRECATED
-XMLPUBFUN SOCKET
-	xmlNanoFTPGetConnection	(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPCloseConnection(void *ctx);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPList		(void *ctx,
-				 ftpListCallback callback,
-				 void *userData,
-				 const char *filename);
-XML_DEPRECATED
-XMLPUBFUN SOCKET
-	xmlNanoFTPGetSocket	(void *ctx,
-				 const char *filename);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPGet		(void *ctx,
-				 ftpDataCallback callback,
-				 void *userData,
-				 const char *filename);
-XML_DEPRECATED
-XMLPUBFUN int
-	xmlNanoFTPRead		(void *ctx,
-				 void *dest,
-				 int len);
-
-#ifdef __cplusplus
-}
-#endif
-#endif /* defined(LIBXML_FTP_ENABLED) || defined(LIBXML_LEGACY_ENABLED) */
 #endif /* __NANO_FTP_H__ */