The trivial-utf-8 Reference Manual

Table of Contents

The trivial-utf-8 Reference Manual

This is the trivial-utf-8 Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 13:13:52 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 trivial-utf-8

Source

trivial-utf-8.asd (file)

Component

trivial-utf-8.lisp (file)

2 Files

Files are sorted by type and then listed depth-first from the systems components trees.

2.1 Lisp

2.1.1 trivial-utf-8.asd

Location

trivial-utf-8.asd

Systems

trivial-utf-8 (system)

Packages

trivial-utf-8-system

2.1.2 trivial-utf-8/trivial-utf-8.lisp

Parent

trivial-utf-8 (system)

Location

trivial-utf-8.lisp

Packages

trivial-utf-8

Exported Definitions

• 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)
• write-utf-8-bytes (function)

Internal Definitions

• *optimize* (special variable)
• as-utf-8-bytes (macro)
• get-utf-8-character (function)
• utf-8-string-length (function)

3 Packages

Packages are listed by definition order.

3.1 trivial-utf-8-system

Source

trivial-utf-8.asd

Use List

• asdf/interface
• common-lisp

3.2 trivial-utf-8

Source

trivial-utf-8.lisp (file)

Use List

common-lisp

Exported Definitions

• 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)
• write-utf-8-bytes (function)

Internal Definitions

• *optimize* (special variable)
• as-utf-8-bytes (macro)
• get-utf-8-character (function)
• utf-8-string-length (function)

4 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

4.1 Exported definitions

4.1.1 Functions

Function: read-utf-8-string INPUT &key NULL-TERMINATED STOP-AT-EOF CHAR-LENGTH BYTE-LENGTH

Read utf-8 encoded data from a byte stream and construct a string with the characters found. When null-terminated is given it will stop reading at a null character, stop-at-eof tells it to stop at the end of file without raising an error, and the char-length and byte-length parameters can be used to specify the max amount of characters or bytes to read.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: string-to-utf-8-bytes STRING &key NULL-TERMINATE

Convert a string into an array of unsigned bytes containing its utf-8 representation.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: utf-8-byte-length STRING

Calculate the amount of bytes needed to encode a string.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: utf-8-bytes-to-string BYTES-IN &key START END

Convert a byte array containing utf-8 encoded characters into the string it encodes.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: utf-8-group-size BYTE

Determine the amount of bytes that are part of the character starting with a given byte.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: write-utf-8-bytes STRING OUTPUT &key NULL-TERMINATE

Write a string to a byte-stream, encoding it as utf-8.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

4.1.2 Conditions

Condition: utf-8-decoding-error ()

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Direct superclasses

simple-error (condition)

Direct slots

Slot: message

Initargs

:message

Slot: byte

Initargs

:byte

Initform

(quote nil)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *optimize*

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

4.2.2 Macros

Macro: as-utf-8-bytes CHAR WRITER

Given a character, calls the writer function for every byte in the encoded form of that character.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

4.2.3 Functions

Function: get-utf-8-character BYTES GROUP-SIZE &optional START

Given an array of bytes and the amount of bytes to use, extract the character starting at the given start position.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Function: utf-8-string-length BYTES &key START END

Calculate the length of the string encoded by the given bytes.

Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types