The trivial-utf-8 Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The trivial-utf-8 Reference Manual

This is the trivial-utf-8 Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:42:41 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 trivial-utf-8

Source

trivial-utf-8.asd (file)

Component

trivial-utf-8.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 trivial-utf-8.asd

Location

trivial-utf-8.asd

Systems

trivial-utf-8 (system)

Packages

trivial-utf-8-system


Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 trivial-utf-8-system

Source

trivial-utf-8.asd

Use List

Previous: , Up: Packages   [Contents][Index]

3.2 trivial-utf-8

Source

trivial-utf-8.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *optimize*
Package

trivial-utf-8

Source

trivial-utf-8.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-utf-8.asd: The trivial-utf-8<dot>asd file
File, Lisp, trivial-utf-8/trivial-utf-8.lisp: The trivial-utf-8/trivial-utf-8<dot>lisp file

L
Lisp File, trivial-utf-8.asd: The trivial-utf-8<dot>asd file
Lisp File, trivial-utf-8/trivial-utf-8.lisp: The trivial-utf-8/trivial-utf-8<dot>lisp file

T
trivial-utf-8.asd: The trivial-utf-8<dot>asd file
trivial-utf-8/trivial-utf-8.lisp: The trivial-utf-8/trivial-utf-8<dot>lisp file

Jump to:   F   L   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   F   G   M   R   S   U   W  
Index Entry  Section

A
as-utf-8-bytes: Internal macros

F
Function, get-utf-8-character: Internal functions
Function, read-utf-8-string: Exported functions
Function, string-to-utf-8-bytes: Exported functions
Function, utf-8-byte-length: Exported functions
Function, utf-8-bytes-to-string: Exported functions
Function, utf-8-group-size: Exported functions
Function, utf-8-string-length: Internal functions
Function, write-utf-8-bytes: Exported functions

G
get-utf-8-character: Internal functions

M
Macro, as-utf-8-bytes: Internal macros

R
read-utf-8-string: Exported functions

S
string-to-utf-8-bytes: Exported functions

U
utf-8-byte-length: Exported functions
utf-8-bytes-to-string: Exported functions
utf-8-group-size: Exported functions
utf-8-string-length: Internal functions

W
write-utf-8-bytes: Exported functions

Jump to:   A   F   G   M   R   S   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
B   M   S  
Index Entry  Section

*
*optimize*: Internal special variables

B
byte: Exported conditions

M
message: Exported conditions

S
Slot, byte: Exported conditions
Slot, message: Exported conditions
Special Variable, *optimize*: Internal special variables

Jump to:   *  
B   M   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   T   U  
Index Entry  Section

C
Condition, utf-8-decoding-error: Exported conditions

P
Package, trivial-utf-8: The trivial-utf-8 package
Package, trivial-utf-8-system: The trivial-utf-8-system package

S
System, trivial-utf-8: The trivial-utf-8 system

T
trivial-utf-8: The trivial-utf-8 system
trivial-utf-8: The trivial-utf-8 package
trivial-utf-8-system: The trivial-utf-8-system package

U
utf-8-decoding-error: Exported conditions

Jump to:   C   P   S   T   U