aboutsummaryrefslogtreecommitdiff
path: root/vendor/librune/man/u8glen.3
blob: dfe02834a3197e90c63b68276c254c2f7a0e7291 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
.Dd January 15 2024
.Dt U8GLEN 3
.Os
.Sh NAME
.Nm u8glen
.Nd count Unicode graphemes
.Sh LIBRARY
.Lb librune
.Sh SYNOPSIS
.In gbrk.h
.Ft size_t
.Fn u8glen "const char8_t *s" "size_t n"
.Sh DESCRIPTION
The
.Fn u8glen
function returns the number of UTF-8 encoded Unicode graphemes in the
buffer
.Fa s
of length
.Fa n
bytes.
.Pp
This function assumes that
.Fa s
contains only valid UTF-8.
.Sh RETURN VALUES
The
.Fn u8glen
function returns the number of graphemes in the buffer
.Fa s .
.Sh EXAMPLES
The following call to
.Fn u8glen
will return 6 while the call to
.Fn u8len
will return 7 as a result of user-preceived characters such as
.Sq е́
taking up multiple codepoints.
.Bd -literal -offset indent
char8_t s[] = u8\(dqПриве́т\(dq;
size_t cplen, glen;

cplen = u8len(s, sizeof(s) - 1);
glen = u8glen(s, sizeof(s) - 1);
.Ed
.Sh SEE ALSO
.Xr u8len 3 ,
.Xr u8wdth 3 ,
.Xr unicode 7 ,
.Xr utf\-8 7
.Sh STANDARDS
.Rs
.%A F. Yergeau
.%D November 2003
.%R RFC 3629
.%T UTF-8, a transformation format of ISO 10646
.Re
.Pp
.Lk https://www.unicode.org/versions/Unicode15.1.0/ \
"The Unicode\(rg Standard Version 15.1.0"
.Sh AUTHORS
.An Thomas Voss Aq Mt mail@thomasvoss.com