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