2fe8fb192f
There is important information about booting non-ack images in docs/UPDATING. ack/aout-format images can't be built any more, and booting clang/ELF-format ones is a little different. Updating to the new boot monitor is recommended. Changes in this commit: . drop boot monitor -> allowing dropping ack support . facility to copy ELF boot files to /boot so that old boot monitor can still boot fairly easily, see UPDATING . no more ack-format libraries -> single-case libraries . some cleanup of OBJECT_FMT, COMPILER_TYPE, etc cases . drop several ack toolchain commands, but not all support commands (e.g. aal is gone but acksize is not yet). . a few libc files moved to netbsd libc dir . new /bin/date as minix date used code in libc/ . test compile fix . harmonize includes . /usr/lib is no longer special: without ack, /usr/lib plays no kind of special bootstrapping role any more and bootstrapping is done exclusively through packages, so releases depend even less on the state of the machine making them now. . rename nbsd_lib* to lib* . reduce mtree
181 lines
5.1 KiB
Groff
181 lines
5.1 KiB
Groff
.\" $NetBSD: mbsrtowcs.3,v 1.12 2010/12/16 17:42:27 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c)2002 Citrus Project,
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd February 4, 2002
|
|
.Dt MBSRTOWCS 3
|
|
.Os
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh NAME
|
|
.Nm mbsrtowcs
|
|
.Nd converts a multibyte character string to a wide-character string \
|
|
(restartable)
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh SYNOPSIS
|
|
.In wchar.h
|
|
.Ft size_t
|
|
.Fn mbsrtowcs "wchar_t * restrict pwcs" "const char ** restrict s" "size_t n" \
|
|
"mbstate_t * restrict ps"
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn mbsrtowcs
|
|
converts the multibyte character string indirectly pointed to by
|
|
.Fa s
|
|
to the corresponding wide-character string, and stores it in the
|
|
array pointed to by
|
|
.Fa pwcs .
|
|
The conversion stops due to the following reasons:
|
|
.Bl -bullet
|
|
.It
|
|
The conversion reaches a nul byte.
|
|
In this case, the nul byte is also converted.
|
|
.It
|
|
The
|
|
.Fn mbsrtowcs
|
|
has already stored
|
|
.Fa n
|
|
wide characters.
|
|
.It
|
|
The conversion encounters an invalid character.
|
|
.El
|
|
.Pp
|
|
Each character will be converted as if
|
|
.Xr mbrtowc 3
|
|
is continuously called.
|
|
.Pp
|
|
After conversion,
|
|
if
|
|
.Fa pwcs
|
|
is not a null pointer,
|
|
the pointer object pointed to by
|
|
.Fa s
|
|
is a null pointer (if the conversion is stopped due to reaching a
|
|
nul byte) or the first byte of the character just after the last
|
|
character converted.
|
|
.Pp
|
|
If
|
|
.Fa pwcs
|
|
is not a null pointer and the conversion is stopped due to reaching
|
|
a nul byte, the
|
|
.Fn mbsrtowcs
|
|
places the state object pointed to by
|
|
.Fa ps
|
|
to an initial state after the conversion has taken place.
|
|
.Pp
|
|
The behaviour of
|
|
.Fn mbsrtowcs
|
|
is affected by the
|
|
.Dv LC_CTYPE
|
|
category of the current locale.
|
|
.Pp
|
|
These are the special cases:
|
|
.Bl -tag -width 012345678901
|
|
.It "s == NULL || *s == NULL"
|
|
Undefined (may cause the program to crash).
|
|
.It "pwcs == NULL"
|
|
The conversion has taken place, but the resulting wide-character string
|
|
was discarded.
|
|
In this case, the pointer object pointed to by
|
|
.Fa s
|
|
is not modified and
|
|
.Fa n
|
|
is ignored.
|
|
.It "ps == NULL"
|
|
The
|
|
.Fn mbsrtowcs
|
|
uses its own internal state object to keep the conversion state,
|
|
instead of
|
|
.Fa ps
|
|
mentioned in this manual page.
|
|
.Pp
|
|
Calling any other functions in
|
|
.Lb libc
|
|
never changes the internal state of
|
|
.Fn mbsrtowcs ,
|
|
which is initialized at startup time of the program.
|
|
.El
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh RETURN VALUES
|
|
.Fn mbsrtowcs
|
|
returns:
|
|
.Bl -tag -width 012345678901
|
|
.It 0 or positive
|
|
The value returned is the number of elements stored in the array
|
|
pointed to by
|
|
.Fa pwcs ,
|
|
except for a terminating nul wide character (if any).
|
|
If
|
|
.Fa pwcs
|
|
is not
|
|
.Dv NULL
|
|
and the value returned is equal to
|
|
.Fa n ,
|
|
the wide-character string pointed to by
|
|
.Fa pwcs
|
|
is not nul-terminated.
|
|
If
|
|
.Fa pwcs
|
|
is a null pointer, the value returned is the number of elements to contain
|
|
the whole string converted, except for a terminating nul wide character.
|
|
.It (size_t)-1
|
|
The array indirectly pointed to by
|
|
.Fa s
|
|
contains a byte sequence forming invalid character.
|
|
In this case,
|
|
.Fn mbsrtowcs
|
|
sets
|
|
.Va errno
|
|
to indicate the error.
|
|
.El
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh ERRORS
|
|
.Fn mbsrtowcs
|
|
may cause an error in the following case:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EILSEQ
|
|
The pointer pointed to by
|
|
.Fa s
|
|
points to an invalid or incomplete multibyte character.
|
|
.It Bq Er EINVAL
|
|
.Fa ps
|
|
points to an invalid or uninitialized mbstate_t object.
|
|
.El
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh SEE ALSO
|
|
.Xr mbrtowc 3 ,
|
|
.Xr mbstowcs 3 ,
|
|
.Xr setlocale 3
|
|
.\" ----------------------------------------------------------------------
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn mbsrtowcs
|
|
function conforms to
|
|
.St -isoC-amd1 .
|
|
The restrict qualifier is added at
|
|
.St -isoC-99 .
|