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/types.h>
37
38#include <wchar.h>
39
40#include <sys/types.h>
41
42#ifdef __cplusplus
43typedef	bool	__iconv_bool;
44#elif __STDC_VERSION__ >= 199901L
45typedef	_Bool	__iconv_bool;
46#else
47typedef	int	__iconv_bool;
48#endif
49
50struct __tag_iconv_t;
51typedef	struct __tag_iconv_t	*iconv_t;
52
53__BEGIN_DECLS
54iconv_t	iconv_open(const char *, const char *);
55size_t	iconv(iconv_t, char ** __restrict,
56	      size_t * __restrict, char ** __restrict,
57	      size_t * __restrict);
58int	iconv_close(iconv_t);
59/*
60 * non-portable interfaces for iconv
61 */
62int	__iconv_get_list(char ***, size_t *, __iconv_bool);
63void	__iconv_free_list(char **, size_t);
64size_t	__iconv(iconv_t, char **, size_t *, char **,
65		     size_t *, __uint32_t, size_t *);
66#define __ICONV_F_HIDE_INVALID	0x0001
67
68/*
69 * GNU interfaces for iconv
70 */
71typedef struct {
72	void	*spaceholder[64];
73} iconv_allocation_t;
74
75int	 iconv_open_into(const char *, const char *, iconv_allocation_t *);
76void	 iconv_set_relocation_prefix(const char *, const char *);
77
78/*
79 * iconvctl() request macros
80 */
81#define ICONV_TRIVIALP		0
82#define	ICONV_GET_TRANSLITERATE	1
83#define	ICONV_SET_TRANSLITERATE	2
84#define ICONV_GET_DISCARD_ILSEQ	3
85#define ICONV_SET_DISCARD_ILSEQ	4
86#define ICONV_SET_HOOKS		5
87#define ICONV_SET_FALLBACKS	6
88#define ICONV_GET_ILSEQ_INVALID	128
89#define ICONV_SET_ILSEQ_INVALID	129
90
91typedef void (*iconv_unicode_char_hook) (unsigned int mbr, void *data);
92typedef void (*iconv_wide_char_hook) (wchar_t wc, void *data);
93
94struct iconv_hooks {
95	iconv_unicode_char_hook		 uc_hook;
96	iconv_wide_char_hook		 wc_hook;
97	void				*data;
98};
99
100/*
101 * Fallbacks aren't supported but type definitions are provided for
102 * source compatibility.
103 */
104typedef void (*iconv_unicode_mb_to_uc_fallback) (const char*,
105		size_t, void (*write_replacement) (const unsigned int *,
106		size_t, void*),	void*, void*);
107typedef void (*iconv_unicode_uc_to_mb_fallback) (unsigned int,
108		void (*write_replacement) (const char *, size_t, void*),
109		void*, void*);
110typedef void (*iconv_wchar_mb_to_wc_fallback) (const char*, size_t,
111		void (*write_replacement) (const wchar_t *, size_t, void*),
112		void*, void*);
113typedef void (*iconv_wchar_wc_to_mb_fallback) (wchar_t,
114		void (*write_replacement) (const char *, size_t, void*),
115		void*, void*);
116
117struct iconv_fallbacks {
118	iconv_unicode_mb_to_uc_fallback	 mb_to_uc_fallback;
119	iconv_unicode_uc_to_mb_fallback  uc_to_mb_fallback;
120	iconv_wchar_mb_to_wc_fallback	 mb_to_wc_fallback;
121	iconv_wchar_wc_to_mb_fallback	 wc_to_mb_fallback;
122	void				*data;
123};
124
125
126void		 iconvlist(int (*do_one) (unsigned int, const char * const *,
127		    void *), void *);
128const char	*iconv_canonicalize(const char *);
129int		 iconvctl(iconv_t, int, void *);
130__END_DECLS
131
132#endif /* !_ICONV_H_ */
133