The utf8-input-stream Reference Manual

This is the utf8-input-stream Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:00:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 utf8-input-stream

A UTF-8 string input stream over a binary stream for Common Lisp

Author

Vee Satayamas <>

License

MIT

Version

0.0.1

Dependencies
  • babel (system).
  • trivial-gray-streams (system).
Source

utf8-input-stream.asd.

Child Component

utf8-input-stream.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 utf8-input-stream/utf8-input-stream.asd

Source

utf8-input-stream.asd.

Parent Component

utf8-input-stream (system).

ASDF Systems

utf8-input-stream.


3.1.2 utf8-input-stream/utf8-input-stream.lisp

Source

utf8-input-stream.asd.

Parent Component

utf8-input-stream (system).

Packages

utf8-input-stream.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 utf8-input-stream

Source

utf8-input-stream.lisp.

Use List
  • common-lisp.
  • trivial-gray-streams.
Public Interface

make-utf8-input-stream (function).

Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-utf8-input-stream (binary-input-stream)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.


5.1.2 Standalone methods

Method: stream-read-char ((s character-input-stream))
Package

sb-gray.

Source

utf8-input-stream.lisp.

Method: stream-read-line ((s character-input-stream))
Package

sb-gray.

Source

utf8-input-stream.lisp.

Method: stream-unread-char ((s character-input-stream) ch)
Package

sb-gray.

Source

utf8-input-stream.lisp.


5.2 Internals


5.2.1 Constants

Constant: +max-bytes-in-ch+
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.


5.2.2 Special variables

Special Variable: *line-buffer-size*
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Special Variable: *line-tmp-size*
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.


5.2.3 Macros

Macro: buf-is-consumed? (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Macro: four-bytes-ch? (b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Macro: one-byte-ch? (b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Macro: refill-buffer (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Macro: three-bytes-ch? (b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Macro: two-bytes-ch? (b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.


5.2.4 Ordinary functions

Function: copy-stream-context (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: end-of-stream? (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: fetch-1-byte-ch (ctx b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: fetch-2-bytes-ch (ctx b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: fetch-3-bytes-ch (ctx b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: fetch-4-bytes-ch (ctx b0)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: fetch-ch (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: make-ch-buf ()
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: make-stream-context (&key binary-input-stream pos buf-pos buf buf-len)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: managed-read-byte (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: new-buf ()
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: read-byte-from-buf (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: read-char-from-buf (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: read-from-stream (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: reset-buf-pos (ctx)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Reader: stream-context-binary-input-stream (instance)
Writer: (setf stream-context-binary-input-stream) (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Target Slot

binary-input-stream.

Reader: stream-context-buf (instance)
Writer: (setf stream-context-buf) (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Target Slot

buf.

Reader: stream-context-buf-len (instance)
Writer: (setf stream-context-buf-len) (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Target Slot

buf-len.

Reader: stream-context-buf-pos (instance)
Writer: (setf stream-context-buf-pos) (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Target Slot

buf-pos.

Function: stream-context-p (object)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Reader: stream-context-pos (instance)
Writer: (setf stream-context-pos) (instance)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Target Slot

pos.

Function: utf8-char-code-size (code)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Function: vector-to-string (v)
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.


5.2.5 Generic functions

Generic Reader: ctx (object)
Package

utf8-input-stream.

Methods
Reader Method: ctx ((character-input-stream character-input-stream))

automatically generated reader method

Source

utf8-input-stream.lisp.

Target Slot

ctx.

Generic Writer: (setf ctx) (object)
Package

utf8-input-stream.

Methods
Writer Method: (setf ctx) ((character-input-stream character-input-stream))

automatically generated writer method

Source

utf8-input-stream.lisp.

Target Slot

ctx.

Generic Reader: pos (condition)
Package

utf8-input-stream.

Methods
Reader Method: pos ((condition character-encoding-error))
Source

utf8-input-stream.lisp.

Target Slot

pos.


5.2.6 Conditions

Condition: character-encoding-error
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Direct superclasses

error.

Direct methods

pos.

Direct slots
Slot: pos
Initargs

:pos

Readers

pos.

Writers

This slot is read-only.


5.2.7 Structures

Structure: stream-context
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: binary-input-stream
Readers

stream-context-binary-input-stream.

Writers

(setf stream-context-binary-input-stream).

Slot: pos
Type

integer

Initform

0

Readers

stream-context-pos.

Writers

(setf stream-context-pos).

Slot: buf-pos
Type

integer

Initform

0

Readers

stream-context-buf-pos.

Writers

(setf stream-context-buf-pos).

Slot: buf
Readers

stream-context-buf.

Writers

(setf stream-context-buf).

Slot: buf-len
Type

integer

Initform

0

Readers

stream-context-buf-len.

Writers

(setf stream-context-buf-len).


5.2.8 Classes

Class: character-input-stream
Package

utf8-input-stream.

Source

utf8-input-stream.lisp.

Direct superclasses

fundamental-character-input-stream.

Direct methods
Direct slots
Slot: ctx
Readers

ctx.

Writers

(setf ctx).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   E   F   G   M   N   O   P   R   S   T   U   V  
Index Entry  Section

(
(setf ctx): Private generic functions
(setf ctx): Private generic functions
(setf stream-context-binary-input-stream): Private ordinary functions
(setf stream-context-buf): Private ordinary functions
(setf stream-context-buf-len): Private ordinary functions
(setf stream-context-buf-pos): Private ordinary functions
(setf stream-context-pos): Private ordinary functions

B
buf-is-consumed?: Private macros

C
copy-stream-context: Private ordinary functions
ctx: Private generic functions
ctx: Private generic functions

E
end-of-stream?: Private ordinary functions

F
fetch-1-byte-ch: Private ordinary functions
fetch-2-bytes-ch: Private ordinary functions
fetch-3-bytes-ch: Private ordinary functions
fetch-4-bytes-ch: Private ordinary functions
fetch-ch: Private ordinary functions
four-bytes-ch?: Private macros
Function, (setf stream-context-binary-input-stream): Private ordinary functions
Function, (setf stream-context-buf): Private ordinary functions
Function, (setf stream-context-buf-len): Private ordinary functions
Function, (setf stream-context-buf-pos): Private ordinary functions
Function, (setf stream-context-pos): Private ordinary functions
Function, copy-stream-context: Private ordinary functions
Function, end-of-stream?: Private ordinary functions
Function, fetch-1-byte-ch: Private ordinary functions
Function, fetch-2-bytes-ch: Private ordinary functions
Function, fetch-3-bytes-ch: Private ordinary functions
Function, fetch-4-bytes-ch: Private ordinary functions
Function, fetch-ch: Private ordinary functions
Function, make-ch-buf: Private ordinary functions
Function, make-stream-context: Private ordinary functions
Function, make-utf8-input-stream: Public ordinary functions
Function, managed-read-byte: Private ordinary functions
Function, new-buf: Private ordinary functions
Function, read-byte-from-buf: Private ordinary functions
Function, read-char-from-buf: Private ordinary functions
Function, read-from-stream: Private ordinary functions
Function, reset-buf-pos: Private ordinary functions
Function, stream-context-binary-input-stream: Private ordinary functions
Function, stream-context-buf: Private ordinary functions
Function, stream-context-buf-len: Private ordinary functions
Function, stream-context-buf-pos: Private ordinary functions
Function, stream-context-p: Private ordinary functions
Function, stream-context-pos: Private ordinary functions
Function, utf8-char-code-size: Private ordinary functions
Function, vector-to-string: Private ordinary functions

G
Generic Function, (setf ctx): Private generic functions
Generic Function, ctx: Private generic functions
Generic Function, pos: Private generic functions

M
Macro, buf-is-consumed?: Private macros
Macro, four-bytes-ch?: Private macros
Macro, one-byte-ch?: Private macros
Macro, refill-buffer: Private macros
Macro, three-bytes-ch?: Private macros
Macro, two-bytes-ch?: Private macros
make-ch-buf: Private ordinary functions
make-stream-context: Private ordinary functions
make-utf8-input-stream: Public ordinary functions
managed-read-byte: Private ordinary functions
Method, (setf ctx): Private generic functions
Method, ctx: Private generic functions
Method, pos: Private generic functions
Method, stream-read-char: Public standalone methods
Method, stream-read-line: Public standalone methods
Method, stream-unread-char: Public standalone methods

N
new-buf: Private ordinary functions

O
one-byte-ch?: Private macros

P
pos: Private generic functions
pos: Private generic functions

R
read-byte-from-buf: Private ordinary functions
read-char-from-buf: Private ordinary functions
read-from-stream: Private ordinary functions
refill-buffer: Private macros
reset-buf-pos: Private ordinary functions

S
stream-context-binary-input-stream: Private ordinary functions
stream-context-buf: Private ordinary functions
stream-context-buf-len: Private ordinary functions
stream-context-buf-pos: Private ordinary functions
stream-context-p: Private ordinary functions
stream-context-pos: Private ordinary functions
stream-read-char: Public standalone methods
stream-read-line: Public standalone methods
stream-unread-char: Public standalone methods

T
three-bytes-ch?: Private macros
two-bytes-ch?: Private macros

U
utf8-char-code-size: Private ordinary functions

V
vector-to-string: Private ordinary functions