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
25 .\" $FreeBSD: head/lib/libc/locale/mbrlen.3 131360 2004-06-30 19:32:41Z ru $
33 .Nd "get number of bytes in a character (restartable)"
39 .Fn mbrlen "const char * restrict s" "size_t n" "mbstate_t * restrict ps"
42 .Fn mbrlen_l "const char * restrict s" "size_t n" "mbstate_t * restrict ps" "locale_t locale"
48 functions inspect at most
52 to determine the number of bytes needed to complete the next
59 is used to keep track of the shift state.
65 use an internal, static
67 object, which is initialized to the initial conversion state
72 .Dl "mbrtowc(NULL, s, n, ps);"
82 use their own static, internal
84 object to keep track of the shift state.
88 function takes an explicit
92 function uses the current global or per-thread locale.
99 .Bl -tag -width indent
104 represent the null wide character
110 represent a valid character,
114 return the number of bytes used to complete the multibyte character.
115 .It Po Vt size_t Pc Ns \-2
118 contribute to, but do not complete, a valid multibyte character sequence,
121 bytes have been processed.
122 .It Po Vt size_t Pc Ns \-1
123 An encoding error has occurred.
126 or fewer bytes do not contribute to a valid multibyte character.
129 A function that calculates the number of characters in a multibyte
131 .Bd -literal -offset indent
133 nchars(const char *s)
135 size_t charlen, chars;
139 memset(&mbs, 0, sizeof(mbs));
140 while ((charlen = mbrlen(s, MB_CUR_MAX, &mbs)) != 0 &&
141 charlen != (size_t)-1 && charlen != (size_t)-2) {
154 functions will fail if:
157 An invalid multibyte sequence was detected.
159 The conversion state is invalid.