.Dd 2022-10-06
.Dt GRAPHEME_TO_LOWERCASE 3
.Os suckless.org
.Sh NAME
.Nm grapheme_to_lowercase
.Nd convert codepoint array to lowercase
.Sh SYNOPSIS
.In grapheme.h
.Ft size_t
.Fn grapheme_to_lowercase "const uint_least32_t *src" "size_t srclen" "uint_least32_t *dest" "size_t destlen"
.Sh DESCRIPTION
The
.Fn grapheme_to_lowercase
function converts the codepoint array
.Va str
to lowercase and writes the result to
.Va dest
up to
.Va destlen ,
unless
.Va dest
is set to
.Dv NULL .
.Pp
If
.Va srclen
is set to
.Dv SIZE_MAX
(stdint.h is already included by grapheme.h) the codepoint array
.Va src
is interpreted to be NUL-terminated and processing stops when a
NUL-byte is encountered.
.Pp
For UTF-8-encoded input data
.Xr grapheme_to_lowercase_utf8 3
can be used instead.
.Sh RETURN VALUES
The
.Fn grapheme_to_lowercase
function returns the number of codepoints in the array resulting
from converting
.Va src
to lowercase, even if
.Va destlen
is not large enough or
.Va dest
is
.Dv NULL .
.Sh SEE ALSO
.Xr grapheme_to_lowercase_utf8 3 ,
.Xr libgrapheme 7
.Sh STANDARDS
.Fn grapheme_to_lowercase
is compliant with the Unicode 15.0.0 specification.
.Sh AUTHORS
.An Laslo Hunhold Aq Mt dev@frign.de