This is the trivial-utf-8 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:58:41 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-utf-8A small library for doing UTF-8-based input and output.
Gábor Melis <mega@retes.hu>
Marijn Haverbeke <marijnh@gmail.com>
(GIT https://gitlab.common-lisp.net/trivial-utf-8/trivial-utf-8.git)
https://gitlab.common-lisp.net/trivial-utf-8/trivial-utf-8/-/issues
ZLIB
mgl-pax-bootstrap (system).
trivial-utf-8.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-utf-8/trivial-utf-8.lisptrivial-utf-8 (system).
read-utf-8-string (function).
string-to-utf-8-bytes (function).
utf-8-byte-length (function).
utf-8-bytes-to-string (function).
utf-8-decoding-error (condition).
utf-8-group-size (function).
*optimize* (special variable).
@trivial-utf-8-introduction (special variable).
@trivial-utf-8-links (special variable).
@trivial-utf-8-manual (special variable).
@trivial-utf-8-reference (special variable).
as-utf-8-bytes (macro).
get-utf-8-character (function).
pax-pages (function).
pax-sections (function).
utf-8-string-length (function).
write-utf-8-bytes (function).
Packages are listed by definition order.
trivial-utf-8common-lisp.
read-utf-8-string (function).
string-to-utf-8-bytes (function).
utf-8-byte-length (function).
utf-8-bytes-to-string (function).
utf-8-decoding-error (condition).
utf-8-group-size (function).
*optimize* (special variable).
@trivial-utf-8-introduction (special variable).
@trivial-utf-8-links (special variable).
@trivial-utf-8-manual (special variable).
@trivial-utf-8-reference (special variable).
as-utf-8-bytes (macro).
get-utf-8-character (function).
pax-pages (function).
pax-sections (function).
utf-8-string-length (function).
write-utf-8-bytes (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Read UTF-8 encoded data from INPUT, a byte stream, and construct a string with the characters found. When NULL-TERMINATED is given, stop reading at a null character. If STOP-AT-EOF, then stop at END-OF-FILE without raising an error. The CHAR-LENGTH and BYTE-LENGTH parameters can be used to specify the max amount of characters or bytes to read, where -1 means no limit. May signal UTF-8-DECODING-ERROR.
Convert STRING into an array of unsigned bytes containing its UTF-8 representation. If NULL-TERMINATE, add an extra 0 byte at the end.
Calculate the amount of bytes needed to encode STRING.
Convert the START, END subsequence of the array of BYTES containing
UTF-8 encoded characters to a [STRING][type]. The element type of
BYTES may be anything as long as it can be ‘COERCE‘d into
an ‘(UNSIGNED-BYTES 8)‘ array. May signal UTF-8-DECODING-ERROR.
Determine the amount of bytes that are part of the character whose encoding starts with BYTE. May signal UTF-8-DECODING-ERROR.
Given the character CHAR, call the WRITER for every byte in the UTF-8 encoded form of that character. WRITER may a function or a macro.
Extract the character from an array of BYTES encoded in GROUP-SIZE number of bytes from the START position. May signal UTF-8-DECODING-ERROR.
Calculate the length of the string encoded by the subsequence of the array of BYTES bounded by START and END.
Write STRING to BYTE-STREAM, encoding it as UTF-8. If NULL-TERMINATE, write an extra 0 byte at the end.
| Jump to: | A F G M P R S U W |
|---|
| Jump to: | A F G M P R S U W |
|---|
| Jump to: | *
@
B M S |
|---|
| Jump to: | *
@
B M S |
|---|
| Jump to: | C F P S T U |
|---|
| Jump to: | C F P S T U |
|---|