1 /* Character set conversion with error handling and autodetection.
2 Copyright (C) 2002, 2005, 2007-2008 Free Software Foundation, Inc.
3 Written by Bruno Haible.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18 #ifndef _STRICONVEHA_H
19 #define _STRICONVEHA_H
23 #include "striconveh.h"
31 /* Convert an entire string from one encoding to another, using iconv.
32 The original string is at [SRC,...,SRC+SRCLEN-1].
33 The "from" encoding can also be a name defined for autodetection.
34 If TRANSLITERATE is true, transliteration will attempted to avoid conversion
35 errors, for iconv implementations that support this. Usually you'll choose
36 TRANSLITERATE = true if HANDLER != iconveh_error.
37 If OFFSETS is not NULL, it should point to an array of SRCLEN integers; this
38 array is filled with offsets into the result, i.e. the character starting
39 at SRC[i] corresponds to the character starting at (*RESULTP)[OFFSETS[i]],
40 and other offsets are set to (size_t)(-1).
41 *RESULTP and *LENGTH should initially be a scratch buffer and its size,
42 or *RESULTP can initially be NULL.
43 May erase the contents of the memory at *RESULTP.
44 Return value: 0 if successful, otherwise -1 and errno set.
45 If successful: The resulting string is stored in *RESULTP and its length
46 in *LENGTHP. *RESULTP is set to a freshly allocated memory block, or is
47 unchanged if no dynamic memory allocation was necessary. */
49 mem_iconveha (const char *src, size_t srclen,
50 const char *from_codeset, const char *to_codeset,
52 enum iconv_ilseq_handler handler,
54 char **resultp, size_t *lengthp);
56 /* Convert an entire string from one encoding to another, using iconv.
57 The original string is the NUL-terminated string starting at SRC.
58 Both the "from" and the "to" encoding must use a single NUL byte at the
59 end of the string (i.e. not UCS-2, UCS-4, UTF-16, UTF-32).
60 The "from" encoding can also be a name defined for autodetection.
61 If TRANSLITERATE is true, transliteration will attempted to avoid conversion
62 errors, for iconv implementations that support this. Usually you'll choose
63 TRANSLITERATE = true if HANDLER != iconveh_error.
64 Allocate a malloced memory block for the result.
65 Return value: the freshly allocated resulting NUL-terminated string if
66 successful, otherwise NULL and errno set. */
68 str_iconveha (const char *src,
69 const char *from_codeset, const char *to_codeset,
71 enum iconv_ilseq_handler handler);
74 /* In the above, FROM_CODESET can also be one of the following values:
75 "autodetect_utf8" supports ISO-8859-1 and UTF-8
76 "autodetect_jp" supports EUC-JP, ISO-2022-JP-2 and SHIFT_JIS
77 "autodetect_kr" supports EUC-KR and ISO-2022-KR
78 More names can be defined for autodetection. */
80 /* Registers an encoding name for autodetection.
81 TRY_IN_ORDER is a NULL terminated list of encodings to be tried.
82 Returns 0 upon success, or -1 (with errno set) in case of error.
83 Particular errno values: ENOMEM. */
85 uniconv_register_autodetect (const char *name,
86 const char * const *try_in_order);
94 #endif /* _STRICONVEHA_H */