Bump to 1.14.1
[platform/upstream/augeas.git] / lib / striconv.h
1 /* Charset conversion.
2    Copyright (C) 2001-2004, 2006-2007, 2009-2016 Free Software Foundation, Inc.
3    Written by Bruno Haible and Simon Josefsson.
4
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 2, or (at your option)
8    any later version.
9
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.
14
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/>.  */
17
18 #ifndef _STRICONV_H
19 #define _STRICONV_H
20
21 #include <stddef.h>
22 #if HAVE_ICONV
23 #include <iconv.h>
24 #endif
25
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31
32 #if HAVE_ICONV
33
34 /* Convert an entire string from one encoding to another, using iconv.
35    The original string is at [SRC,...,SRC+SRCLEN-1].
36    The conversion descriptor is passed as CD.
37    *RESULTP and *LENGTH should initially be a scratch buffer and its size,
38    or *RESULTP can initially be NULL.
39    May erase the contents of the memory at *RESULTP.
40    Return value: 0 if successful, otherwise -1 and errno set.
41    If successful: The resulting string is stored in *RESULTP and its length
42    in *LENGTHP.  *RESULTP is set to a freshly allocated memory block, or is
43    unchanged if no dynamic memory allocation was necessary.  */
44 extern int mem_cd_iconv (const char *src, size_t srclen, iconv_t cd,
45                          char **resultp, size_t *lengthp);
46
47 /* Convert an entire string from one encoding to another, using iconv.
48    The original string is the NUL-terminated string starting at SRC.
49    The conversion descriptor is passed as CD.  Both the "from" and the "to"
50    encoding must use a single NUL byte at the end of the string (i.e. not
51    UCS-2, UCS-4, UTF-16, UTF-32).
52    Allocate a malloced memory block for the result.
53    Return value: the freshly allocated resulting NUL-terminated string if
54    successful, otherwise NULL and errno set.  */
55 extern char * str_cd_iconv (const char *src, iconv_t cd);
56
57 #endif
58
59 /* Convert an entire string from one encoding to another, using iconv.
60    The original string is the NUL-terminated string starting at SRC.
61    Both the "from" and the "to" encoding must use a single NUL byte at the
62    end of the string (i.e. not UCS-2, UCS-4, UTF-16, UTF-32).
63    Allocate a malloced memory block for the result.
64    Return value: the freshly allocated resulting NUL-terminated string if
65    successful, otherwise NULL and errno set.  */
66 extern char * str_iconv (const char *src,
67                          const char *from_codeset, const char *to_codeset);
68
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74
75 #endif /* _STRICONV_H */