xref: /freebsd/include/iconv.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*	$NetBSD: iconv.h,v 1.6 2005/02/03 04:39:32 perry Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-2-Clause
5  *
6  * Copyright (c) 2003 Citrus Project,
7  * Copyright (c) 2009, 2010 Gabor Kovesdan <gabor@FreeBSD.org>
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  */
32 
33 #ifndef _ICONV_H_
34 #define _ICONV_H_
35 
36 #include <sys/cdefs.h>
37 #include <sys/types.h>
38 
39 #include <wchar.h>
40 
41 #include <sys/cdefs.h>
42 #include <sys/types.h>
43 
44 #ifdef __cplusplus
45 typedef	bool	__iconv_bool;
46 #elif __STDC_VERSION__ >= 199901L
47 typedef	_Bool	__iconv_bool;
48 #else
49 typedef	int	__iconv_bool;
50 #endif
51 
52 struct __tag_iconv_t;
53 typedef	struct __tag_iconv_t	*iconv_t;
54 
55 __BEGIN_DECLS
56 iconv_t	iconv_open(const char *, const char *);
57 size_t	iconv(iconv_t, char ** __restrict,
58 	      size_t * __restrict, char ** __restrict,
59 	      size_t * __restrict);
60 int	iconv_close(iconv_t);
61 /*
62  * non-portable interfaces for iconv
63  */
64 int	__iconv_get_list(char ***, size_t *, __iconv_bool);
65 void	__iconv_free_list(char **, size_t);
66 size_t	__iconv(iconv_t, char **, size_t *, char **,
67 		     size_t *, __uint32_t, size_t *);
68 #define __ICONV_F_HIDE_INVALID	0x0001
69 
70 /*
71  * GNU interfaces for iconv
72  */
73 typedef struct {
74 	void	*spaceholder[64];
75 } iconv_allocation_t;
76 
77 int	 iconv_open_into(const char *, const char *, iconv_allocation_t *);
78 void	 iconv_set_relocation_prefix(const char *, const char *);
79 
80 /*
81  * iconvctl() request macros
82  */
83 #define ICONV_TRIVIALP		0
84 #define	ICONV_GET_TRANSLITERATE	1
85 #define	ICONV_SET_TRANSLITERATE	2
86 #define ICONV_GET_DISCARD_ILSEQ	3
87 #define ICONV_SET_DISCARD_ILSEQ	4
88 #define ICONV_SET_HOOKS		5
89 #define ICONV_SET_FALLBACKS	6
90 #define ICONV_GET_ILSEQ_INVALID	128
91 #define ICONV_SET_ILSEQ_INVALID	129
92 
93 typedef void (*iconv_unicode_char_hook) (unsigned int mbr, void *data);
94 typedef void (*iconv_wide_char_hook) (wchar_t wc, void *data);
95 
96 struct iconv_hooks {
97 	iconv_unicode_char_hook		 uc_hook;
98 	iconv_wide_char_hook		 wc_hook;
99 	void				*data;
100 };
101 
102 /*
103  * Fallbacks aren't supported but type definitions are provided for
104  * source compatibility.
105  */
106 typedef void (*iconv_unicode_mb_to_uc_fallback) (const char*,
107 		size_t, void (*write_replacement) (const unsigned int *,
108 		size_t, void*),	void*, void*);
109 typedef void (*iconv_unicode_uc_to_mb_fallback) (unsigned int,
110 		void (*write_replacement) (const char *, size_t, void*),
111 		void*, void*);
112 typedef void (*iconv_wchar_mb_to_wc_fallback) (const char*, size_t,
113 		void (*write_replacement) (const wchar_t *, size_t, void*),
114 		void*, void*);
115 typedef void (*iconv_wchar_wc_to_mb_fallback) (wchar_t,
116 		void (*write_replacement) (const char *, size_t, void*),
117 		void*, void*);
118 
119 struct iconv_fallbacks {
120 	iconv_unicode_mb_to_uc_fallback	 mb_to_uc_fallback;
121 	iconv_unicode_uc_to_mb_fallback  uc_to_mb_fallback;
122 	iconv_wchar_mb_to_wc_fallback	 mb_to_wc_fallback;
123 	iconv_wchar_wc_to_mb_fallback	 wc_to_mb_fallback;
124 	void				*data;
125 };
126 
127 
128 void		 iconvlist(int (*do_one) (unsigned int, const char * const *,
129 		    void *), void *);
130 const char	*iconv_canonicalize(const char *);
131 int		 iconvctl(iconv_t, int, void *);
132 __END_DECLS
133 
134 #endif /* !_ICONV_H_ */
135