Add citrus backend code and iconv front end. This is intentionally
[dragonfly.git] / lib / libc / citrus / citrus_iconv.h
1 /*      $NetBSD: src/lib/libc/citrus/citrus_iconv.h,v 1.3 2003/07/10 08:50:43 tshiozak Exp $    */
2 /*      $DragonFly: src/lib/libc/citrus/citrus_iconv.h,v 1.1 2005/03/11 23:33:53 joerg Exp $ */
3
4 /*-
5  * Copyright (c)2003 Citrus Project,
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29
30 #ifndef _CITRUS_ICONV_H_
31 #define _CITRUS_ICONV_H_
32
33 struct _citrus_iconv_shared;
34 struct _citrus_iconv_ops;
35 struct _citrus_iconv;
36
37 __BEGIN_DECLS
38 int     _citrus_iconv_open(struct _citrus_iconv * __restrict * __restrict,
39                            const char * __restrict,
40                            const char * __restrict, const char * __restrict);
41 void    _citrus_iconv_close(struct _citrus_iconv *);
42 __END_DECLS
43
44
45 #include "citrus_iconv_local.h"
46
47 #define _CITRUS_ICONV_F_HIDE_INVALID    0x0001
48
49 /*
50  * _citrus_iconv_convert:
51  *      convert a string.
52  */
53 static __inline int
54 _citrus_iconv_convert(struct _citrus_iconv * __restrict cv,
55                       const char * __restrict * __restrict in,
56                       size_t * __restrict inbytes,
57                       char * __restrict * __restrict out,
58                       size_t * __restrict outbytes, uint32_t flags,
59                       size_t * __restrict nresults)
60 {
61
62         _DIAGASSERT(cv && cv->cv_shared && cv->cv_shared->ci_ops &&
63                     cv->cv_shared->ci_ops->io_convert && (out || !outbytes));
64
65         return (*cv->cv_shared->ci_ops->io_convert)(cv, in, inbytes, out,
66                                                     outbytes, flags, nresults);
67 }
68
69 #endif