The cl-scsu Reference Manual

Table of Contents

The cl-scsu Reference Manual

This is the cl-scsu Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:46:33 2020 GMT+0.

1 Introduction

Abstract

Standard Compression Scheme for Unicode の Common Lisp 実装。

cl-scsu is an implementation of Standard Compression Scheme for Unicode by Common Lisp.

License

The MIT License. See LICENSE file.

Loading

Libraries depending on

• asdf
• alexandria
• 1am (only by test codes)

Load by quicklisp

(ql:quickload "cl-scsu")

or, Load manually

(asdf:load-asd "cl-scsu.asd")
(asdf:load-system :cl-scsu)

For running tests, do below additionally.

(asdf:load-asd "cl-scsu-test.asd")
(asdf:test-system :cl-scsu)

Examples

Makes a test string, estimated 38 bytes long by counting Japanese characters as 2 bytes.

CL-USER> (defvar *test-string* "abcde あいうえお アイウエオ 阿伊宇江於")
*TEST-STRING*

Let's compress it. The result is only 30 bytes long.

CL-USER> (cl-scsu:encode-from-string *test-string*)
#(97 98 99 100 101 32 21 130 132 134 136 138 32 226 228 230 232 234 32
  15 150 63 79 10 91 135 108 95 101 188) ; compressin result
30                                       ; number of result bytes
23                                       ; number of read characters
#<CL-SCSU:SCSU-STATE @ #x10002ed37c2>    ; scsu state object

To restore the original string, decompress the bytes.

CL-USER> (cl-scsu:decode-to-string *)
"abcde あいうえお アイウエオ 阿伊宇江於" ; decompression result
23                                       ; number of result characters
30                                       ; number of read bytes
#<CL-SCSU:SCSU-STATE @ #x10002f469f2>    ; scsu state object

API

Please see docstrings of symbols exported from cl-scsu package:

• [Function] decode-to-string
• [Function] encode-from-string
• [Function] encode-reset-sequence
• [Class]

2 Systems

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

2.1 cl-scsu

Author

YOKOTA Yuki <y2q.actionman@gmail.com>

License

MIT

Description

An implementation of ’Standard Compression Scheme for Unicode’.

Dependency

alexandria

Source

cl-scsu.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-scsu/src

Parent

cl-scsu (system)

Location

src/

Components

• package.lisp (file)
• constant.lisp (file)
• scsu.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 cl-scsu.asd

Location

cl-scsu.asd

Systems

cl-scsu (system)

4.1.2 cl-scsu/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-scsu

4.1.3 cl-scsu/src/constant.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/constant.lisp

Exported Definitions

scsu-error (condition)

Internal Definitions

• +default-positions-for-dynamically-positioned-windows+ (constant)
• +sc0+ (constant)
• +sc1+ (constant)
• +sc2+ (constant)
• +sc3+ (constant)
• +sc4+ (constant)
• +sc5+ (constant)
• +sc6+ (constant)
• +sc7+ (constant)
• +scu+ (constant)
• +sd0+ (constant)
• +sd1+ (constant)
• +sd2+ (constant)
• +sd3+ (constant)
• +sd4+ (constant)
• +sd5+ (constant)
• +sd6+ (constant)
• +sd7+ (constant)
• +sdx+ (constant)
• +sq0+ (constant)
• +sq1+ (constant)
• +sq2+ (constant)
• +sq3+ (constant)
• +sq4+ (constant)
• +sq5+ (constant)
• +sq6+ (constant)
• +sq7+ (constant)
• +squ+ (constant)
• +static-windows+ (constant)
• +uc0+ (constant)
• +uc1+ (constant)
• +uc2+ (constant)
• +uc3+ (constant)
• +uc4+ (constant)
• +uc5+ (constant)
• +uc6+ (constant)
• +uc7+ (constant)
• +ud0+ (constant)
• +ud1+ (constant)
• +ud2+ (constant)
• +ud3+ (constant)
• +ud4+ (constant)
• +ud5+ (constant)
• +ud6+ (constant)
• +ud7+ (constant)
• +udx+ (constant)
• +uqu+ (constant)
• +window-count+ (constant)
• decode-extended-window-tag (function)
• decode-from-surrogate-pair (function)
• define-window-find-function (macro)
• encode-extended-window-tag (function)
• encode-to-surrogate-pair (function)
• find-scn-window (function)
• find-sdn-window (function)
• find-sqn-window (function)
• find-ucn-window (function)
• find-udn-window (function)
• list-offset-candidates (function)
• lookup-static-window (function)
• lookup-window-offset-table (function)
• scsu-error-dst-error-position (method)
• (setf scsu-error-dst-error-position) (method)
• scsu-error-parental-condition (method)
• (setf scsu-error-parental-condition) (method)
• scsu-error-src-error-position (method)
• (setf scsu-error-src-error-position) (method)
• standalone-character-p (function)
• unicode-code-point (type)
• window-index (type)
• window-offset-to-table-index (function)

4.1.4 cl-scsu/src/scsu.lisp

Dependency

constant.lisp (file)

Parent

src (module)

Location

src/scsu.lisp

Exported Definitions

• decode-to-string (function)
• encode-from-string (function)
• encode-reset-sequence (function)
• scsu-state (class)

Internal Definitions

• *scsu-state-trace* (special variable)
• 1byte-encodable-p (function)
• apply-define-window (function)
• decode-define-window-extended (function)
• decode-quote-unicode (function)
• decode-unit (function)
• decode-unit* (function)
• decode-unit*/single-byte-mode (function)
• decode-unit*/unicode-mode (function)
• encode-define-window (function)
• encode-unit (function)
• encode-unit* (function)
• encode-unit*/single-byte-mode (function)
• encode-unit*/unicode-mode (function)
• fill-pointer-if-exists (function)
• find-lru-dynamic-window (function)
• find-suitable-dynamic-window (function)
• find-suitable-static-window (function)
• find-suitable-window* (function)
• in-active-window-p (function)
• in-window-p (function)
• initialize-timestamp (function)
• lookup-dynamic-window (generic function)
• lookup-dynamic-window (method)
• (setf lookup-dynamic-window) (method)
• (setf lookup-dynamic-window) (generic function)
• read-func-type (type)
• scsu-state-active-window-index (method)
• (setf scsu-state-active-window-index) (method)
• scsu-state-active-window-offset (generic function)
• scsu-state-active-window-offset (method)
• (setf scsu-state-active-window-offset) (method)
• (setf scsu-state-active-window-offset) (generic function)
• scsu-state-current-timestamp (method)
• (setf scsu-state-current-timestamp) (method)
• scsu-state-dynamic-window (method)
• (setf scsu-state-dynamic-window) (method)
• scsu-state-fix-dynamic-window (method)
• (setf scsu-state-fix-dynamic-window) (method)
• scsu-state-mode (method)
• (setf scsu-state-mode) (method)
• scsu-state-reset (generic function)
• scsu-state-reset (method)
• scsu-state-timestamp (generic function)
• scsu-state-timestamp (method)
• (setf scsu-state-timestamp) (method)
• (setf scsu-state-timestamp) (generic function)
• scsu-state-timestamp-vector (method)
• (setf scsu-state-timestamp-vector) (method)
• scsu-trace-output (function)
• update-timestamp (function)
• use-define-window-p (function)
• with-buffer-accessor (macro)
• with-scsu-error-handling (macro)
• write-16bit-code-point (function)
• write-func-type (type)

5 Packages

Packages are listed by definition order.

5.1 cl-scsu

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• decode-to-string (function)
• encode-from-string (function)
• encode-reset-sequence (function)
• scsu-error (condition)
• scsu-state (class)

Internal Definitions

• *scsu-state-trace* (special variable)
• +default-positions-for-dynamically-positioned-windows+ (constant)
• +sc0+ (constant)
• +sc1+ (constant)
• +sc2+ (constant)
• +sc3+ (constant)
• +sc4+ (constant)
• +sc5+ (constant)
• +sc6+ (constant)
• +sc7+ (constant)
• +scu+ (constant)
• +sd0+ (constant)
• +sd1+ (constant)
• +sd2+ (constant)
• +sd3+ (constant)
• +sd4+ (constant)
• +sd5+ (constant)
• +sd6+ (constant)
• +sd7+ (constant)
• +sdx+ (constant)
• +sq0+ (constant)
• +sq1+ (constant)
• +sq2+ (constant)
• +sq3+ (constant)
• +sq4+ (constant)
• +sq5+ (constant)
• +sq6+ (constant)
• +sq7+ (constant)
• +squ+ (constant)
• +static-windows+ (constant)
• +uc0+ (constant)
• +uc1+ (constant)
• +uc2+ (constant)
• +uc3+ (constant)
• +uc4+ (constant)
• +uc5+ (constant)
• +uc6+ (constant)
• +uc7+ (constant)
• +ud0+ (constant)
• +ud1+ (constant)
• +ud2+ (constant)
• +ud3+ (constant)
• +ud4+ (constant)
• +ud5+ (constant)
• +ud6+ (constant)
• +ud7+ (constant)
• +udx+ (constant)
• +uqu+ (constant)
• +window-count+ (constant)
• 1byte-encodable-p (function)
• apply-define-window (function)
• decode-define-window-extended (function)
• decode-extended-window-tag (function)
• decode-from-surrogate-pair (function)
• decode-quote-unicode (function)
• decode-unit (function)
• decode-unit* (function)
• decode-unit*/single-byte-mode (function)
• decode-unit*/unicode-mode (function)
• define-window-find-function (macro)
• encode-define-window (function)
• encode-extended-window-tag (function)
• encode-to-surrogate-pair (function)
• encode-unit (function)
• encode-unit* (function)
• encode-unit*/single-byte-mode (function)
• encode-unit*/unicode-mode (function)
• fill-pointer-if-exists (function)
• find-lru-dynamic-window (function)
• find-scn-window (function)
• find-sdn-window (function)
• find-sqn-window (function)
• find-suitable-dynamic-window (function)
• find-suitable-static-window (function)
• find-suitable-window* (function)
• find-ucn-window (function)
• find-udn-window (function)
• in-active-window-p (function)
• in-window-p (function)
• initialize-timestamp (function)
• list-offset-candidates (function)
• lookup-dynamic-window (generic function)
• lookup-dynamic-window (method)
• (setf lookup-dynamic-window) (method)
• (setf lookup-dynamic-window) (generic function)
• lookup-static-window (function)
• lookup-window-offset-table (function)
• read-func-type (type)
• scsu-error-dst-error-position (generic function)
• scsu-error-dst-error-position (method)
• (setf scsu-error-dst-error-position) (method)
• (setf scsu-error-dst-error-position) (generic function)
• scsu-error-parental-condition (generic function)
• scsu-error-parental-condition (method)
• (setf scsu-error-parental-condition) (method)
• (setf scsu-error-parental-condition) (generic function)
• scsu-error-src-error-position (generic function)
• scsu-error-src-error-position (method)
• (setf scsu-error-src-error-position) (method)
• (setf scsu-error-src-error-position) (generic function)
• scsu-state-active-window-index (generic function)
• scsu-state-active-window-index (method)
• (setf scsu-state-active-window-index) (method)
• (setf scsu-state-active-window-index) (generic function)
• scsu-state-active-window-offset (generic function)
• scsu-state-active-window-offset (method)
• (setf scsu-state-active-window-offset) (method)
• (setf scsu-state-active-window-offset) (generic function)
• scsu-state-current-timestamp (generic function)
• scsu-state-current-timestamp (method)
• (setf scsu-state-current-timestamp) (method)
• (setf scsu-state-current-timestamp) (generic function)
• scsu-state-dynamic-window (generic function)
• scsu-state-dynamic-window (method)
• (setf scsu-state-dynamic-window) (method)
• (setf scsu-state-dynamic-window) (generic function)
• scsu-state-fix-dynamic-window (generic function)
• scsu-state-fix-dynamic-window (method)
• (setf scsu-state-fix-dynamic-window) (method)
• (setf scsu-state-fix-dynamic-window) (generic function)
• scsu-state-mode (generic function)
• scsu-state-mode (method)
• (setf scsu-state-mode) (method)
• (setf scsu-state-mode) (generic function)
• scsu-state-reset (generic function)
• scsu-state-reset (method)
• scsu-state-timestamp (generic function)
• scsu-state-timestamp (method)
• (setf scsu-state-timestamp) (method)
• (setf scsu-state-timestamp) (generic function)
• scsu-state-timestamp-vector (generic function)
• scsu-state-timestamp-vector (method)
• (setf scsu-state-timestamp-vector) (method)
• (setf scsu-state-timestamp-vector) (generic function)
• scsu-trace-output (function)
• standalone-character-p (function)
• unicode-code-point (type)
• update-timestamp (function)
• use-define-window-p (function)
• window-index (type)
• window-offset-to-table-index (function)
• with-buffer-accessor (macro)
• with-scsu-error-handling (macro)
• write-16bit-code-point (function)
• write-func-type (type)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: decode-to-string BYTES &key START1 END1 STRING START2 END2 STATE &aux STRING-FILL-POINTER-AT-FIRST

This function decompresses BYTES compressed by the SCSU and returns the result as a string. Returned values are following:

1. The result string decompressed by SCSU.
2. The position of the next of the last character written to the result string.
3. The position of the next of the last byte read from BYTES.
4. ‘scsu-state’ object.

Arguments are:

- BYTES

A byte sequence compressed by SCSU.

- START1, END1

Specifies the range of BYTES argument should be used.
Initial value is 0 and the length of BYTES respectively.

- STRING

Specifies an output storage filled by the decompression result.
This specified string is returned by ‘decode-to-string’.
If not specified, a new string is allocated and returned.

- START2, END2

Specifies the range of STRING argument used.
Initial value is 0 and the length of STRING respectively.
If STRING is not specified, these arguments are ignored.

- STATE

If specifies a ‘scsu-state’ object returned by previous ‘decode-to-string’ calls,
the shift state included the object is used.
If not specified, the initial state [http://unicode.org/reports/tr6/#Initial_State] is used.

====

BYTES に渡された SCSU で圧縮されたバイト列を文字列に変換して返す。
戻値は以下の通り:

1. SCSU解凍結果の文字列
2. 1. で返された文字列に、最後に書き出した文字の次の位置
3. BYTES で渡したバイト列で、最後に読み込んだバイトの次の位置
4. ‘scsu-state’ オブジェクト

引数:

- BYTES

SCSU圧縮されたバイト列。

- START1, END1

BYTES 引数に渡したバイト列の使用範囲を指定する。初期値は、それぞれ ‘0’ と BYTES の長さ.

- STRING

SCSU解凍結果を格納する先の文字列。ここで指定された文字列が返される。
未指定の場合、新しい文字列を割り当てて返す。

- START2, END2

STRING 引数に渡した文字列の使用範囲を指定する。
初期値は、それぞれ 0 と STRING の長さ.
STRING を指定しなかった場合、無視される。

- STATE

他の ‘decode-to-string’ 呼び出しで返された ‘scsu-state’ オブジェクトを
渡すことにより、シフト状態などを引き継いで使用できる。
指定しない場合、 初期シフト状態 [http://unicode.org/reports/tr6/#Initial_State] を使用する。

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-from-string STRING &key START1 END1 BYTES START2 END2 INITIAL-PRIORITY STATE &aux BYTES-FILL-POINTER-AT-FIRST

This function compresses STRING by SCSU and returns the result as a byte sequence.
Returned values are following:

1. The result byte sequence compressed by SCSU.
2. The position of the next of the last byte written to the result byte sequence.
3. The position of the next of the last characted read from STRING.
4. ‘scsu-state’ object.

Arguments are:

- STRING

A string to be compressed by SCSU.

- START1, END1

Specifies the range of STRING argument should be used.
Initial value is 0 and the length of STRING respectively.

- BYTES

Specifies an output storage filled by the compression result.
This specified byte sequence is returned by ‘encode-from-string’.
If not specified, a new byte sequence is allocated and returned.

- START2, END2

Specifies the range of BYTES argument used.
Initial value is 0 and the length of BYTES respectively.
If BYTES is not specified, these arguments are ignored.

- INITIAL-PRIORITY

Specifies how to determine the priority of the initial dynamic window [http://unicode.org/reports/tr6/#Initial_Window] of SCSU as following:

- ‘:lookahead’ (default) :: Determines by lookaheading STRING argument.
- ‘:fixed’ :: Don’t change dynamic window.
- ‘:random’ :: determines randomly.
- an interger array :: Uses the array as a priority. Bigger is prior.

- STATE

If specifies a ‘scsu-state’ object returned by previous ‘encode-from-string’ calls,
the shift state included the object is used.
If not specified, the initial state [http://unicode.org/reports/tr6/#Initial_State] is used.

====

STRING を SCSU で圧縮したバイト列に変換して返す。
戻値は以下の通り:

1. SCSU圧縮結果のバイト列
2. 1. で返されたバイト列に、最後に書き出したバイトの次の位置
3. BYTES で渡した文字列で、最後に読み込んだ文字の次の位置
4. ‘scsu-state’ オブジェクト

- STRING

SCSU圧縮する文字列。

- START1, END1

STRING 引数に渡した文字列の使用範囲を指定する。初期値は、それぞれ 0 と STRING の長さ.

- BYTES

SCSU圧縮結果を格納する先のバイト列。ここで指定されたバイト列が返される。
未指定の場合、新しいバイト列を割り当てて返す。

- START2, END2

BYTES 引数に渡したバイト列の使用範囲を指定する。
初期値は、それぞれ 0 と BYTES の長さ.
BYTES を指定しなかった場合、無視される。

- INITIAL-PRIORITY

SCSUの 初期 dynamic window [http://unicode.org/reports/tr6/#Initial_Window] の優先順序を指定する。指定可能な値は以下の通り:
- ‘:LOOKAHEAD’ (初期値) :: STRING 引数の内容を先読みして決定する。
- ‘:fixed’ :: dynamic window を変更しない。
- ‘:random’ :: 乱数で適当に決める。
- 数値配列 :: 渡した数列を初期 dynamic window の優先度として使用する。大きい値が優先される。

- STATE

他の ‘encode-from-string’ 呼び出しで返された ‘scsu-state’ オブジェクトを
渡すことにより、シフト状態などを引き継いで使用できる。
指定しない場合、 初期シフト状態 [http://unicode.org/reports/tr6/#Initial_State] を使用する。

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-reset-sequence STATE &key BYTES START END &aux BYTES-FILL-POINTER-AT-FIRST

This function returns a byte sequence to change STATE to the initial state. Returned values are following:

1. A byte sequence.
2. The position of the next of the last byte written to the result byte sequence. 3. ‘scsu-state’ object.

Arguments are:

- STATE

A ‘scsu-state’ object.

- BYTES

Specifies an output storage filled by the result.
This specified byte sequence is returned by ‘encode-reset-sequence’.
If not specified, a new byte sequence is allocated and returned.

- START, END

Specifies the range of BYTES argument used.
Initial value is 0 and the length of BYTES respectively.
If BYTES is not specified, these arguments are ignored.

====

STATE の内部状態を SCSU の初期状態に戻すためのバイト列を返す。
戻値は以下の通り:

1. バイト列
2. 1. で返されたバイト列に、最後に書き出したバイトの次の位置
3. ‘scsu-state’ オブジェクト

- STATE

‘scsu-state’ オブジェクト.

- BYTES

格納先のバイト列。ここで指定されたバイト列が返される。
未指定の場合、新しいバイト列を割り当てて返す。

- START, END

BYTES 引数に渡したバイト列の使用範囲を指定する。
初期値は、それぞれ 0 と BYTES の長さ.
BYTES を指定しなかった場合、無視される。

Package

cl-scsu

Source

scsu.lisp (file)

6.1.2 Conditions

Condition: scsu-error ()

If some error occurs in ‘decode-to-string’,
‘encode-from-string’, or ‘encode-reset-sequence’, this condition is reported. ====
‘decode-to-string’, ‘encode-from-string’, ‘encode-reset-sequence’ で エラーが発生した場合、この condition が報告される。

Package

cl-scsu

Source

constant.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods

• scsu-error-parental-condition (method)
• scsu-error-parental-condition (method)
• scsu-error-dst-error-position (method)
• scsu-error-dst-error-position (method)
• scsu-error-src-error-position (method)
• scsu-error-src-error-position (method)

Direct slots

Slot: src-error-position

Initform

(quote nil)

Readers

scsu-error-src-error-position (generic function)

Writers

(setf scsu-error-src-error-position) (generic function)

Slot: dst-error-position

Initform

(quote nil)

Readers

scsu-error-dst-error-position (generic function)

Writers

(setf scsu-error-dst-error-position) (generic function)

Slot: parental-condition

Initargs

cl-scsu::parental-condition

Initform

(quote nil)

Readers

scsu-error-parental-condition (generic function)

Writers

(setf scsu-error-parental-condition) (generic function)

6.1.3 Classes

Class: scsu-state ()

The class of an object holding the internal state of SCSU. ====
SCSUの内部状態を保持するオブジェクトのクラス。

Package

cl-scsu

Source

scsu.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• scsu-state-reset (method)
• scsu-state-timestamp (method)
• scsu-state-timestamp (method)
• scsu-state-active-window-offset (method)
• scsu-state-active-window-offset (method)
• lookup-dynamic-window (method)
• lookup-dynamic-window (method)
• scsu-state-fix-dynamic-window (method)
• scsu-state-fix-dynamic-window (method)
• scsu-state-current-timestamp (method)
• scsu-state-current-timestamp (method)
• scsu-state-timestamp-vector (method)
• scsu-state-timestamp-vector (method)
• scsu-state-active-window-index (method)
• scsu-state-active-window-index (method)
• scsu-state-dynamic-window (method)
• scsu-state-dynamic-window (method)
• scsu-state-mode (method)
• scsu-state-mode (method)

Direct slots

Slot: mode

Initform

:single-byte-mode

Readers

scsu-state-mode (generic function)

Writers

(setf scsu-state-mode) (generic function)

Slot: dynamic-window

Readers

scsu-state-dynamic-window (generic function)

Writers

(setf scsu-state-dynamic-window) (generic function)

Slot: active-window-index

Type

cl-scsu::window-index

Initform

0

Readers

scsu-state-active-window-index (generic function)

Writers

(setf scsu-state-active-window-index) (generic function)

Slot: timestamp-vector

Readers

scsu-state-timestamp-vector (generic function)

Writers

(setf scsu-state-timestamp-vector) (generic function)

Slot: current-timestamp

Type

fixnum

Initform

0

Readers

scsu-state-current-timestamp (generic function)

Writers

(setf scsu-state-current-timestamp) (generic function)

Slot: fix-dynamic-window

Type

boolean

Initargs

:fix-dynamic-window

Readers

scsu-state-fix-dynamic-window (generic function)

Writers

(setf scsu-state-fix-dynamic-window) (generic function)

6.2 Internal definitions

6.2.1 Constants

Constant: +default-positions-for-dynamically-positioned-windows+

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc0+

Change to Window 0

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc1+

Change to Window 1

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc2+

Change to Window 2

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc3+

Change to Window 3

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc4+

Change to Window 4

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc5+

Change to Window 5

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc6+

Change to Window 6

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sc7+

Change to Window 7

Package

cl-scsu

Source

constant.lisp (file)

Constant: +scu+

Change to Unicode

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd0+

Define Window 0

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd1+

Define Window 1

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd2+

Define Window 2

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd3+

Define Window 3

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd4+

Define Window 4

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd5+

Define Window 5

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd6+

Define Window 6

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sd7+

Define Window 7

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sdx+

Define Extended

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq0+

Quote from Window 0

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq1+

Quote from Window 1

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq2+

Quote from Window 2

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq3+

Quote from Window 3

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq4+

Quote from Window 4

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq5+

Quote from Window 5

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq6+

Quote from Window 6

Package

cl-scsu

Source

constant.lisp (file)

Constant: +sq7+

Quote from Window 7

Package

cl-scsu

Source

constant.lisp (file)

Constant: +squ+

Quote Unicode

Package

cl-scsu

Source

constant.lisp (file)

Constant: +static-windows+

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc0+

Change to Window 0

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc1+

Change to Window 1

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc2+

Change to Window 2

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc3+

Change to Window 3

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc4+

Change to Window 4

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc5+

Change to Window 5

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc6+

Change to Window 6

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uc7+

Change to Window 7

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud0+

Define Window 0

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud1+

Define Window 1

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud2+

Define Window 2

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud3+

Define Window 3

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud4+

Define Window 4

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud5+

Define Window 5

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud6+

Define Window 6

Package

cl-scsu

Source

constant.lisp (file)

Constant: +ud7+

Define Window 7

Package

cl-scsu

Source

constant.lisp (file)

Constant: +udx+

Define Extended

Package

cl-scsu

Source

constant.lisp (file)

Constant: +uqu+

Quote Unicode

Package

cl-scsu

Source

constant.lisp (file)

Constant: +window-count+

The number of static or dynamic windows.

Package

cl-scsu

Source

constant.lisp (file)

6.2.2 Special variables

Special Variable: *scsu-state-trace*

If set to T, outputs tag or character informations seen by the decoder to *trace-output*

Package

cl-scsu

Source

scsu.lisp (file)

6.2.3 Macros

Macro: define-window-find-function NAME LOWER

Package

cl-scsu

Source

constant.lisp (file)

Macro: with-buffer-accessor (CURRENT &key READER WRITER) (BUFFER START END &key ELEMENT-TYPE) &body BODY

Package

cl-scsu

Source

scsu.lisp (file)

Macro: with-scsu-error-handling (STATE &key SRC DST RETURN) &body BODY

Package

cl-scsu

Source

scsu.lisp (file)

6.2.4 Functions

Function: 1byte-encodable-p STATE CODE-POINT &optional WINDOW

Package

cl-scsu

Source

scsu.lisp (file)

Function: apply-define-window STATE WINDOW OFFSET

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-define-window-extended STATE READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-extended-window-tag HBYTE LBYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: decode-from-surrogate-pair HIGH LOW

Package

cl-scsu

Source

constant.lisp (file)

Function: decode-quote-unicode READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-unit STATE READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-unit* STATE READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-unit*/single-byte-mode STATE READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: decode-unit*/unicode-mode STATE READ-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-define-window STATE OFFSET TABLE-INDEX WRITE-FUNC DEFINE-WINDOW-TAG DEFINE-EXTENDED-TAG

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-extended-window-tag WINDOW OFFSET

Package

cl-scsu

Source

constant.lisp (file)

Function: encode-to-surrogate-pair CODE-POINT

Package

cl-scsu

Source

constant.lisp (file)

Function: encode-unit STATE READ-FUNC WRITE-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-unit* STATE CODE-POINT NEXT-CODE-POINT WRITE-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-unit*/single-byte-mode STATE CODE-POINT NEXT-CODE-POINT WRITE-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: encode-unit*/unicode-mode STATE CODE-POINT NEXT-CODE-POINT WRITE-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: fill-pointer-if-exists OBJ

Package

cl-scsu

Source

scsu.lisp (file)

Function: find-lru-dynamic-window STATE

Package

cl-scsu

Source

scsu.lisp (file)

Function: find-scn-window BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: find-sdn-window BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: find-sqn-window BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: find-suitable-dynamic-window STATE CODE-POINT

Package

cl-scsu

Source

scsu.lisp (file)

Function: find-suitable-static-window CODE-POINT

Package

cl-scsu

Source

scsu.lisp (file)

Function: find-suitable-window* CODE-POINT OFFSET-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

Function: find-ucn-window BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: find-udn-window BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: in-active-window-p STATE CODE-POINT

Package

cl-scsu

Source

scsu.lisp (file)

Function: in-window-p OFFSET CODE-POINT

Package

cl-scsu

Source

scsu.lisp (file)

Function: initialize-timestamp STATE INITIAL-PRIORITY STRING START END

Package

cl-scsu

Source

scsu.lisp (file)

Function: list-offset-candidates CODE-POINT

Package

cl-scsu

Source

constant.lisp (file)

Function: lookup-static-window WINDOW

Package

cl-scsu

Source

constant.lisp (file)

Function: lookup-window-offset-table BYTE

Package

cl-scsu

Source

constant.lisp (file)

Function: scsu-trace-output FORMAT-CONTROL &rest FORMAT-ARGUMENTS

Package

cl-scsu

Source

scsu.lisp (file)

Function: standalone-character-p CODE-POINT

Package

cl-scsu

Source

constant.lisp (file)

Function: update-timestamp STATE &optional WINDOW

Package

cl-scsu

Source

scsu.lisp (file)

Function: use-define-window-p STATE CODE-POINT &optional NEXT-CODE-POINT

Package

cl-scsu

Source

scsu.lisp (file)

Function: window-offset-to-table-index OFFSET

Package

cl-scsu

Source

constant.lisp (file)

Function: write-16bit-code-point CODE-POINT WRITE-FUNC

Package

cl-scsu

Source

scsu.lisp (file)

6.2.5 Generic functions

Generic Function: lookup-dynamic-window STATE WINDOW

Generic Function: (setf lookup-dynamic-window) OFFSET STATE WINDOW

Package

cl-scsu

Source

scsu.lisp (file)

Methods

Method: lookup-dynamic-window (STATE scsu-state) WINDOW

Method: (setf lookup-dynamic-window) OFFSET (STATE scsu-state) WINDOW

Generic Function: scsu-error-dst-error-position CONDITION

Generic Function: (setf scsu-error-dst-error-position) NEW-VALUE CONDITION

Package

cl-scsu

Methods

Method: scsu-error-dst-error-position (CONDITION scsu-error)

Method: (setf scsu-error-dst-error-position) NEW-VALUE (CONDITION scsu-error)

Source

constant.lisp (file)

Generic Function: scsu-error-parental-condition CONDITION

Generic Function: (setf scsu-error-parental-condition) NEW-VALUE CONDITION

Package

cl-scsu

Methods

Method: scsu-error-parental-condition (CONDITION scsu-error)

Method: (setf scsu-error-parental-condition) NEW-VALUE (CONDITION scsu-error)

Source

constant.lisp (file)

Generic Function: scsu-error-src-error-position CONDITION

Generic Function: (setf scsu-error-src-error-position) NEW-VALUE CONDITION

Package

cl-scsu

Methods

Method: scsu-error-src-error-position (CONDITION scsu-error)

Method: (setf scsu-error-src-error-position) NEW-VALUE (CONDITION scsu-error)

Source

constant.lisp (file)

Generic Function: scsu-state-active-window-index OBJECT

Generic Function: (setf scsu-state-active-window-index) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-active-window-index (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-active-window-index) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

Generic Function: scsu-state-active-window-offset STATE

Generic Function: (setf scsu-state-active-window-offset) OFFSET STATE

Package

cl-scsu

Source

scsu.lisp (file)

Methods

Method: scsu-state-active-window-offset (STATE scsu-state)

Method: (setf scsu-state-active-window-offset) OFFSET (STATE scsu-state)

Generic Function: scsu-state-current-timestamp OBJECT

Generic Function: (setf scsu-state-current-timestamp) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-current-timestamp (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-current-timestamp) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

Generic Function: scsu-state-dynamic-window OBJECT

Generic Function: (setf scsu-state-dynamic-window) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-dynamic-window (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-dynamic-window) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

Generic Function: scsu-state-fix-dynamic-window OBJECT

Generic Function: (setf scsu-state-fix-dynamic-window) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-fix-dynamic-window (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-fix-dynamic-window) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

Generic Function: scsu-state-mode OBJECT

Generic Function: (setf scsu-state-mode) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-mode (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-mode) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

Generic Function: scsu-state-reset STATE

Package

cl-scsu

Source

scsu.lisp (file)

Methods

Method: scsu-state-reset (STATE scsu-state)

Generic Function: scsu-state-timestamp STATE WINDOW

Generic Function: (setf scsu-state-timestamp) VAL STATE WINDOW

Package

cl-scsu

Source

scsu.lisp (file)

Methods

Method: scsu-state-timestamp (STATE scsu-state) WINDOW

Method: (setf scsu-state-timestamp) VAL (STATE scsu-state) WINDOW

Generic Function: scsu-state-timestamp-vector OBJECT

Generic Function: (setf scsu-state-timestamp-vector) NEW-VALUE OBJECT

Package

cl-scsu

Methods

Method: scsu-state-timestamp-vector (SCSU-STATE scsu-state)

automatically generated reader method

Source

scsu.lisp (file)

Method: (setf scsu-state-timestamp-vector) NEW-VALUE (SCSU-STATE scsu-state)

automatically generated writer method

Source

scsu.lisp (file)

6.2.6 Types

Type: read-func-type ()

Package

cl-scsu

Source

scsu.lisp (file)

Type: unicode-code-point ()

Package

cl-scsu

Source

constant.lisp (file)

Type: window-index ()

Package

cl-scsu

Source

constant.lisp (file)

Type: write-func-type ()

Package

cl-scsu

Source

scsu.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types