Initial Commit

libs/libgrapheme-2.0.2/man/grapheme_is_uppercase_utf8.3

@@ -0,0 +1,51 @@
+.Dd 2022-10-06
+.Dt GRAPHEME_IS_LOWERCASE_UTF8 3
+.Os suckless.org
+.Sh NAME
+.Nm grapheme_is_lowercase_utf8
+.Nd check if UTF-8-encoded string is lowercase
+.Sh SYNOPSIS
+.In grapheme.h
+.Ft size_t
+.Fn grapheme_is_lowercase_utf8 "const char *str" "size_t len" "size_t *caselen"
+.Sh DESCRIPTION
+The
+.Fn grapheme_is_lowercase_utf8
+function checks if the UTF-8-encoded string
+.Va str
+is lowercase and writes the length of the matching lowercase-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 UTF-8-encoded string
+.Va src
+is interpreted to be NUL-terminated and processing stops when a
+NUL-byte is encountered.
+.Pp
+For non-UTF-8 input data
+.Xr grapheme_is_lowercase 3
+can be used instead.
+.Sh RETURN VALUES
+The
+.Fn grapheme_is_lowercase_utf8
+function returns
+.Dv true
+if the UTF-8-encoded string
+.Va str
+is lowercase, otherwise
+.Dv false .
+.Sh SEE ALSO
+.Xr grapheme_is_lowercase 3 ,
+.Xr libgrapheme 7
+.Sh STANDARDS
+.Fn grapheme_is_lowercase_utf8
+is compliant with the Unicode 15.0.0 specification.
+.Sh AUTHORS
+.An Laslo Hunhold Aq Mt dev@frign.de