xref: /dflybsd-src/lib/libc/locale/mbintowcr.3 (revision 9ef1e017fc7fdc61dd2e78a093efae5913f7c536)

.\"-
.\" Copyright (c) 2015 Matthew Dillon
.\" 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 August 24, 2015
.Dt MBINTOWCR 3
.Os
.Sh NAME
.Nm mbintowcr ,
.Nm mbintowcr_l ,
.Nm utf8towcr ,
.Nm wcrtombin ,
.Nm wcrtombin_l ,
.Nm wcrtoutf8
.Nd "8-bit-clean wchar conversion w/escaping or validation"
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In wchar.h
.Ft size_t
.Fo mbintowcr
.Fa "wchar_t * restrict dst" "const char * restrict src"
.Fa "size_t dlen" "size_t *slen" "int flags"
.Fc
.Ft size_t
.Fo utf8towcr
.Fa "wchar_t * restrict dst" "const char * restrict src"
.Fa "size_t dlen" "size_t *slen" "int flags"
.Fc
.Ft size_t
.Fo wcrtombin
.Fa "char * restrict dst" "const wchar_t * restrict src"
.Fa "size_t dlen" "size_t *slen" "int flags"
.Fc
.Ft size_t
.Fo wcrtoutf8
.Fa "char * restrict dst" "const wchar_t * restrict src"
.Fa "size_t dlen" "size_t *slen" "int flags"
.Fc
.In xlocale.h
.Ft size_t
.Fo mbintowcr_l
.Fa "wchar_t * restrict dst" "const char * restrict src"
.Fa "size_t dlen" "size_t *slen" "locale_t locale" "int flags"
.Fc
.Ft size_t
.Fo wcrtombin_l
.Fa "char * restrict dst" "const wchar_t * restrict src"
.Fa "size_t dlen" "size_t *slen" "locale_t locale" "int flags"
.Fc
.Sh DESCRIPTION
The
.Fn mbintowcr
and
.Fn wcrtombin
functions translate byte data into wide-char format and back again.
Under normal conditions (but not with all flags) these functions
guarantee that the round-trip will be 8-bit-clean.
Some care must be taken to properly specify the
.Dv WCSBIN_EOF
flag to properly handle trailing incomplete sequences at stream EOF.
.Pp
For the "C" locale these functions are 1:1 (do not convert UTF-8).
For UTF-8 locales these functions convert to/from UTF-8.
Most of the discussion below pertains to UTF-8 translations.
.Pp
The
.Fn utf8towcr
and
.Fn wcrtoutf8
functions do exactly the same thing as the above functions but are locked
to the UTF-8 locale.
That is, these functions work regardless of which localehas been selected
and also do not require any initial
.Fn setlocale
call to initialize.
Applications working explicitly in UTF-8 should use these versions.
.Pp
Any illegal sequences will be escaped using UTF-8B (U+DC80 - U+DCFF).
Illegal sequences include surrogate-space encodings, non-canonical encodings,
codings >= 0x10FFFF, 5-byte and 6-byte codings (which are not legal anymore),
and malformed codings.
Flags may be used to modify this behavior.
.Pp
The
.Fn mbintowcr
function takes generic 8-bit byte data as its input which the caller
expects to be loosely coded in UTF-8 and converts it to an array of
.Vt wchar_t ,
and returns the number of
.Vt wchar_t
that were converted.
The caller must set
.Fa *slen
to the number of bytes in the input buffer and the function will
set
.Fa *slen
on return to the number of bytes in the input buffer that were processed.
.Pp
Fewer bytes than specified might be processed due to the output buffer
reaching its limit or due to an incomplete sequence at the end of the input
buffer when the
.Dv WCSBIN_EOF
flag has not been specified.
.Pp
If processing a stream, the caller
typically copies any unprocessed data at the end of the buffer back to
the beginning and then continues loading the buffer from there.
Be sure to check for an incomplete translation at stream EOF and do a
final translation of the remainder with the
.Dv WCSBIN_EOF
flag set.
.Pp
This function will always generate escapes for illegal UTF-8 code sequences
and by can produce a clean BYTE-WCHAR-BYTE conversion.
See the flags description later on.
.Pp
This function cannot return an error unless the
.Dv WCSBIN_STRICT
flag is set.
In case of error, any valid conversions are returned first and the caller
is expected to iterate.
The error is returned when it becomes the first element of the buffer.
.Pp
A
.Dv NULL
destination buffer may be specified in which case this function operates
identically except for actually trying to fill the buffer.
This feature is typically used for validation with
.Dv WCSBIN_STRICT
and sometimes also used in combination with
.Dv WCSBIN_SURRO
(set if you want to allow surrogates).
.Pp
The
.Fn wcrtombin
function takes an array of
.Vt wchar_t
as its input which is usually expected to be well-formed and converts it
to an array of generic 8-bit byte data.
The caller must set
.Fa *slen
to the number of elements in the input buffer and the function will set
.Fa *slen
on return to the number of elements in the input buffer that were processed.
.Pp
Be sure to properly set the
.Dv WCSBIN_EOF
flag for the last buffer at stream EOF.
.Pp
This function can return an error regardless of the flags if a supplied
wchar code is out of range.
Some flags change the range of allowed wchar codes.
In case of error, any valid conversions are returned first and the
caller is expected to iterate.
The error is returned when it becomes the first element of the buffer.
.Pp
A
.Dv NULL
destination buffer may be specified in which case this function operates
identically except for actually trying to fill the buffer.
This feature is typically used for validation with or without
.Dv WCSBIN_STRICT
and sometimes also used in combination with
.Dv WCSBIN_SURRO .
.Pp
One final note on the use of
.Dv WCSBIN_SURRO
for wchars-to-bytes.
If this flag
is not set surrogates in the escape range will be de-escaped (giving us our
8-bit-clean round-trip), and other surrogates will be passed through as UTF-8
encodings.
In
.Dv WCSBIN_STRICT
mode this flag works slightly differently.
If not specified no surrogates are allowed at all (escaped or otherwise),
and if specified all surrogates are allowed and will never be de-escaped.
.Pp
The _l-suffixed versions of
.Fn mbintowcr
and
.Fn wcrtombin
take an explicit
.Fa locale
argument, whereas the
non-suffixed versions use the current global or per-thread locale.
.Sh UTF-8B ESCAPE SEQUENCES
Escaping is handled by converting one or more bytes in the byte sequence to
the UTF-8B escape wchar (U+DC80 - U+DCFF).
Most illegal sequences escape the first byte and then reprocess the remaining
bytes.
An illegal byte
sequence length (5 or 6 bytes), non-canonical encoding, or illegal wchar value
(beyond 0x10FFFF if not modified by flags) will escape all bytes in the
sequence as long as they were not malformed.
.Pp
When converting back to a byte-sequence, if not modified by flags, UTF-8B
escape wchars are converted back to their original bytes.
Other surrogate codes (U+D800 - U+DFFF which are normally illegal) will be
passed through and encoded as UTF-8.
.Sh FLAGS
.Bl -tag -width ".Dv WCSBIN_LONGCODES"
.It Dv WCSBIN_EOF
Indicate that the input buffer represents the last of the input stream.
This causes any partial sequences at the end of the input buffer to be
processed.
.It Dv WCSBIN_SURRO
This flag passes-through any surrogate codes that are already UTF-8-encoded.
This is normally illegal but if you are processing a stream which has already
been UTF-8B escaped this flag will prevent the U+DC80 - U+DCFF codes from
being re-escaped bytes-to-wchars and will prevent decoding back to the
original bytes wchars-to-bytes.
This flag is sometimes used on input if the
caller expects the input stream to already be escaped, and not usually used
on output unless the caller explicitly wants to encode to an intermediate
illegal UTF-8 encoding that retains the escapes as escapes.
.Pp
This flag does not prevent additional escapes from being translated on
bytes-to-wchars
.Dv ( WCSBIN_STRICT
prevents escaping on bytes-to-wchars), but
will prevent de-escaping on wchars-to-bytes.
.Pp
This flag breaks round-trip 8-bit-clean operation since escape codes use
the surrogate space and will mix with surrogates that are passed through
on input by this flag in a way that cannot be distinguished.
.It Dv WCSBIN_LONGCODES
Specifying this flag in the bytes-to-wchars direction allows for decoding
of legacy 5-byte and 6-byte sequences as well as 4-byte sequences which
would normally be illegal.
These sequences are illegal and this flag should
not normally be used unless the caller explicitly wants to handle the legacy
case.
.Pp
Specifying this flag in the wchars-to-bytes direction allows normally illegal
wchars to be encoded.
Again, not recommended.
.Pp
This flag does not allow decoding non-canonical sequences.
Such sequences will still be escaped.
.It Dv WCSBIN_STRICT
This flag forces strict parsing in the bytes-to-wchars direction and will
cause
.Fn mbintowcr
to process short or return with an error once processing reaches the
illegal coding rather than escaping the illegal sequence.
This flag is usually specified only when the caller desires to validate
a UTF-8 buffer.
Remember that an error may also be present with return values greater than 0.
A partial sequences at the end of the buffer is not
considered to be an error unless
.Dv WCSBIN_EOF
is also specified.
.Pp
Caller is reminded that when using this feature for validation, a
short-return can happen rather than an error if the error is not at the
base of the source or if
.Dv WCSBIN_EOF
is not specified.
If the caller is not chaining buffers then
.Dv WCSBIN_EOF
should be specified and a simple check of whether
.Fa *slen
equals the original input buffer length on return is sufficient to determine
if an error occurred or not.
If the caller is chaining buffers
.Dv WCSBIN_EOF
is not specified and the caller must proceed with the copy-down / continued
buffer loading loop to distinguish between an incomplete buffer and an error.
.El
.Sh RETURN VALUES
The
.Fn mbintowcr ,
.Fn mbintowcr_l ,
.Fn utf8towcr ,
.Fn wcrtombin ,
.Fn wcrtombin_l
and
.Fn wcrtoutf8
functions return the number of output elements generated and set
.Fa *slen
to the number of input elements converted.
If an error occurs but the output buffer has already been populated,
a short return will occur and the next iteration where the error is
the first element will return the error.
The caller is responsible for processing any error conditions before
continuing.
.Pp
The
.Fn mbintowcr ,
.Fn mbintowcr_l
and
.Fn utf8towcr
functions can return a (size_t)-1 error if
.Dv WCSBIN_STRICT
is specified, and otherwise cannot.
.Pp
The
.Fn wcrtombin ,
.Fn wcrtombin_l
and
.Fn wcrtoutf8
functions can return a (size_t)-1 error if given an illegal wchar code,
as modified by
.Fa flags .
Any wchar code >= 0x80000000U always causes an error to be returned.
.Sh ERRORS
If an error is returned, errno will be set to
.Er EILSEQ .
.Sh SEE ALSO
.Xr mbtowc 3 ,
.Xr multibyte 3 ,
.Xr setlocale 3 ,
.Xr wcrtomb 3 ,
.Xr xlocale 3
.Sh STANDARDS
The
.Fn mbintowcr ,
.Fn mbintowcr_l ,
.Fn utf8towcr ,
.Fn wcrtombin ,
.Fn wcrtombin_l
and
.Fn wcrtoutf8
functions are non-standard extensions to libc.