aboutsummaryrefslogtreecommitdiff
path: root/vendor/librune/man/u8set.3
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/librune/man/u8set.3')
-rw-r--r--vendor/librune/man/u8set.3103
1 files changed, 0 insertions, 103 deletions
diff --git a/vendor/librune/man/u8set.3 b/vendor/librune/man/u8set.3
deleted file mode 100644
index d579b0b..0000000
--- a/vendor/librune/man/u8set.3
+++ /dev/null
@@ -1,103 +0,0 @@
-.Dd January 27 2024
-.Dt U8SET 3
-.Os
-.Sh NAME
-.Nm rtou8 ,
-.Nm u8set
-.Nd encode a rune to UTF-8
-.Sh LIBRARY
-.Lb librune
-.Sh SYNOPSIS
-.In utf8.h
-.Ft int
-.Fn rtou8 "char8_t *s" "rune ch" "size_t n"
-.Ft size_t
-.Fn u8set "char8_t *s" "rune ch" "size_t n"
-.Sh DESCRIPTION
-The
-.Fn rtou8
-function writes the rune
-.Fa ch
-to the UTF-8 encoded buffer
-.Fa s
-of length
-.Fa n ,
-returning the number of bytes required to UTF-8 encode
-.Fa ch .
-.Pp
-The
-.Fn u8set
-function fills the buffer
-.Fa s
-of length
-.Fa n
-with the constant rune
-.Fa ch .
-It is similar to the
-.Fn rtou8
-function,
-but writes more than 1 rune if the given buffer has the capacity.
-Unlike
-.Fn rtou8 ,
-this function returns the number of bytes that were successfully written
-to
-.Fa s .
-If
-.Fa n
-is a multiple of
-.Fn u8wdth ch
-the return value will be equal to
-.Fa n ,
-however in the case that
-.Fa n
-is not a multiple then
-.Fa s
-is filled as much as possible,
-and a count shorter than
-.Fa n
-is returned.
-.Pp
-Both of these functions assume the input is valid UTF-8.
-.Sh RETURN VALUES
-The
-.Fn rtou8
-function returns the number of bytes required to write
-.Fa ch
-to the buffer
-.Fa s .
-.Pp
-The
-.Fn u8set
-function returns the number of bytes written to the buffer
-.Fa s .
-.Sh EXAMPLES
-The following calls to
-.Fn rtou8
-and
-.Fn u8set
-fill a buffer with box-drawing characters to create a top-row of a box.
-.Bd -literal -offset indent
-#define SCREEN_WIDTH 80
-
-int bdr_wdth = u8wdth(U'─'); /* box-drawing rune width */
-size_t bufsiz = SCREEN_WIDTH * bdr_wdth;
-char8_t *s = malloc(bufsiz);
-
-rtou8(s, U'┌', bdr_wdth);
-u8set(s + bdr_wdth, U'─', bufsiz - bdr_wdth * 2);
-rtou8(s + bufsiz - bdr_wdth, U'┐', bdr_wdth);
-.Ed
-.Sh SEE ALSO
-.Xr u8tor 3 ,
-.Xr u8tor_uc 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
-.Sh AUTHORS
-.An Thomas Voss Aq Mt mail@thomasvoss.com