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