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