(* * 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. * * Author: Daniel Veillard *) {$IFDEF POINTER} xmlCharEncodingHandlerPtr = ^xmlCharEncodingHandler; {$ENDIF} (* * 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. *) {$IFDEF TYPE} xmlCharEncoding = ( 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 *) ); (** * 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 * * Take a block of chars in the original encoding and try to convert * it to an UTF-8 block of chars out. * * 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. *) xmlCharEncodingInputFunc = function(_out: pchar; outlen: pcint; _in: pchar; inlen: pcint): cint; cdecl; (** * 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 * * 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. * * 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. *) xmlCharEncodingOutputFunc = function(_out: pchar; outlen: pcint; _in: pchar; inlen: pcint): cint; cdecl; (* * Block defining the handlers for non UTF-8 encodings. * If iconv is supported, there are two extra fields. *) xmlCharEncodingHandler = record name : pchar; input : xmlCharEncodingInputFunc; output : xmlCharEncodingOutputFunc; {$IFDEF LIBXML_ICONV_ENABLED} iconv_in : iconv_t; iconv_out : iconv_t; {$ENDIF} (* LIBXML_ICONV_ENABLED *) end; {$ENDIF} {$IFDEF FUNCTION} (* * Interfaces for encoding handlers. *) procedure xmlInitCharEncodingHandlers; EXTDECL; external xml2lib; procedure xmlCleanupCharEncodingHandlers; EXTDECL; external xml2lib; procedure xmlRegisterCharEncodingHandler(handler: xmlCharEncodingHandlerPtr); EXTDECL; external xml2lib; function xmlGetCharEncodingHandler(enc: xmlCharEncoding): xmlCharEncodingHandlerPtr; EXTDECL; external xml2lib; function xmlFindCharEncodingHandler(name: pchar): xmlCharEncodingHandlerPtr; EXTDECL; external xml2lib; function xmlNewCharEncodingHandler(name: pchar; input: xmlCharEncodingInputFunc; output: xmlCharEncodingOutputFunc): xmlCharEncodingHandlerPtr; EXTDECL; external xml2lib; (* * Interfaces for encoding names and aliases. *) function xmlAddEncodingAlias(name: pchar; alias: pchar): cint; EXTDECL; external xml2lib; function xmlDelEncodingAlias(alias: pchar): cint; EXTDECL; external xml2lib; function xmlGetEncodingAlias(alias: pchar): pchar; EXTDECL; external xml2lib; procedure xmlCleanupEncodingAliases; EXTDECL; external xml2lib; function xmlParseCharEncoding(name: pchar): xmlCharEncoding; EXTDECL; external xml2lib; function xmlGetCharEncodingName(enc: xmlCharEncoding): pchar; EXTDECL; external xml2lib; (* * Interfaces directly used by the parsers. *) function xmlDetectCharEncoding(_in: pchar; len: cint): xmlCharEncoding; EXTDECL; external xml2lib; function xmlCharEncOutFunc(handler: xmlCharEncodingHandlerPtr; _out, _in: xmlBufferPtr): cint; EXTDECL; external xml2lib; function xmlCharEncInFunc(handler: xmlCharEncodingHandlerPtr; _out, _in: xmlBufferPtr): cint; EXTDECL; external xml2lib; function xmlCharEncFirstLine(handler: xmlCharEncodingHandlerPtr; _out, _in: xmlBufferPtr): cint; EXTDECL; external xml2lib; function xmlCharEncCloseFunc(handler: xmlCharEncodingHandlerPtr): cint; EXTDECL; external xml2lib; (* * Export a few useful functions *) {$IFDEF LIBXML_OUTPUT_ENABLED} function UTF8Toisolat1(_out: pchar; outlen: pcint; _in: pchar; inlen: pcint): cint; EXTDECL; external xml2lib; {$ENDIF} (* LIBXML_OUTPUT_ENABLED *) function isolat1ToUTF8(_out: pchar; outlen: pcint; _in: pchar; inlen: pcint): cint; EXTDECL; external xml2lib; {$ENDIF}