1 .\" Copyright (c) 2002-2004 Tim J. Robbins
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .Nd "convert a character to a wide-character code (restartable)"
41 .Fa "wchar_t * restrict pc" "const char * restrict s" "size_t n"
42 .Fa "mbstate_t * restrict ps"
47 .Fa "char16_t * restrict pc" "const char * restrict s" "size_t n"
48 .Fa "mbstate_t * restrict ps"
52 .Fa "char32_t * restrict pc" "const char * restrict s" "size_t n"
53 .Fa "mbstate_t * restrict ps"
61 functions inspect at most
65 to determine the number of bytes needed to complete the next multibyte
67 If a character can be completed, and
71 the wide character which is represented by
84 these functions behave as if
99 is used to keep track of the shift state.
102 these functions use an internal, static
104 object, which is initialized to the initial conversion state
109 is not large enough to represent certain multibyte characters, the
111 function may need to be invoked multiple times to convert a single
112 multibyte character sequence.
120 .Bl -tag -width indent
125 represent the null wide character
130 or fewer bytes represent a valid character, these functions
131 return the number of bytes used to complete the multibyte character.
132 .It Po Vt size_t Pc Ns \-1
133 An encoding error has occurred.
136 or fewer bytes do not contribute to a valid multibyte character.
137 .It Po Vt size_t Pc Ns \-2
140 contribute to, but do not complete, a valid multibyte character sequence,
143 bytes have been processed.
148 function also returns:
149 .Bl -tag -width indent
150 .It Po Vt size_t Pc Ns \-3
151 The next character resulting from a previous call has been stored.
152 No bytes from the input have been consumed.
160 functions will fail if:
163 An invalid multibyte sequence was detected.
165 The conversion state is invalid.