.Dd 2022-10-06
.Dt GRAPHEME_IS_TITLECASE 3
.Os suckless.org
.Sh NAME
.Nm grapheme_is_titlecase
.Nd check if codepoint array is titlecase
.Sh SYNOPSIS
.In grapheme.h
.Ft size_t
.Fn grapheme_is_titlecase "const uint_least32_t *str" "size_t len" "size_t *caselen"
.Sh DESCRIPTION
The
.Fn grapheme_is_titlecase
function checks if the codepoint array
.Va str
is titlecase and writes the length of the matching titlecase-sequence to the integer pointed to by
.Va caselen ,
unless
.Va caselen
is set to
.Dv NULL .
.Pp
If
.Va len
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_is_titlecase_utf8 3
can be used instead.
.Sh RETURN VALUES
The
.Fn grapheme_is_titlecase
function returns
.Dv true
if the codepoint array
.Va str
is titlecase, otherwise
.Dv false .
.Sh SEE ALSO
.Xr grapheme_is_titlecase_utf8 3 ,
.Xr libgrapheme 7
.Sh STANDARDS
.Fn grapheme_is_titlecase
is compliant with the Unicode 15.0.0 specification.
.Sh AUTHORS
.An Laslo Hunhold Aq Mt dev@frign.de