This is the cl-scsu Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:37:31 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-scsuAn implementation of ’Standard Compression Scheme for Unicode’.
YOKOTA Yuki <y2q.actionman@gmail.com>
MIT
alexandria (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-scsu/srccl-scsu (system).
package.lisp (file).
constant.lisp (file).
scsu.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-scsu/src/constant.lisppackage.lisp (file).
src (module).
scsu-error (condition).
+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 (reader method).
(setf scsu-error-dst-error-position) (writer method).
scsu-error-parental-condition (reader method).
(setf scsu-error-parental-condition) (writer method).
scsu-error-src-error-position (reader method).
(setf scsu-error-src-error-position) (writer method).
standalone-character-p (function).
unicode-code-point (type).
window-index (type).
window-offset-to-table-index (function).
cl-scsu/src/scsu.lispconstant.lisp (file).
src (module).
decode-to-string (function).
encode-from-string (function).
encode-reset-sequence (function).
scsu-state (class).
*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).
(setf lookup-dynamic-window) (generic function).
read-func-type (type).
scsu-state-active-window-index (reader method).
(setf scsu-state-active-window-index) (writer method).
scsu-state-active-window-offset (generic function).
(setf scsu-state-active-window-offset) (generic function).
scsu-state-current-timestamp (reader method).
(setf scsu-state-current-timestamp) (writer method).
scsu-state-dynamic-window (reader method).
(setf scsu-state-dynamic-window) (writer method).
scsu-state-fix-dynamic-window (reader method).
(setf scsu-state-fix-dynamic-window) (writer method).
scsu-state-mode (reader method).
(setf scsu-state-mode) (writer method).
scsu-state-reset (generic function).
scsu-state-timestamp (generic function).
(setf scsu-state-timestamp) (generic function).
scsu-state-timestamp-vector (reader method).
(setf scsu-state-timestamp-vector) (writer 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).
Packages are listed by definition order.
cl-scsucommon-lisp.
decode-to-string (function).
encode-from-string (function).
encode-reset-sequence (function).
scsu-error (condition).
scsu-state (class).
*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).
(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 reader).
(setf scsu-error-dst-error-position) (generic writer).
scsu-error-parental-condition (generic reader).
(setf scsu-error-parental-condition) (generic writer).
scsu-error-src-error-position (generic reader).
(setf scsu-error-src-error-position) (generic writer).
scsu-state-active-window-index (generic reader).
(setf scsu-state-active-window-index) (generic writer).
scsu-state-active-window-offset (generic function).
(setf scsu-state-active-window-offset) (generic function).
scsu-state-current-timestamp (generic reader).
(setf scsu-state-current-timestamp) (generic writer).
scsu-state-dynamic-window (generic reader).
(setf scsu-state-dynamic-window) (generic writer).
scsu-state-fix-dynamic-window (generic reader).
(setf scsu-state-fix-dynamic-window) (generic writer).
scsu-state-mode (generic reader).
(setf scsu-state-mode) (generic writer).
scsu-state-reset (generic function).
scsu-state-timestamp (generic function).
(setf scsu-state-timestamp) (generic function).
scsu-state-timestamp-vector (generic reader).
(setf scsu-state-timestamp-vector) (generic writer).
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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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] を使用する。
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] を使用する。
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 を指定しなかった場合、無視される。
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 が報告される。
simple-error.
(quote nil)
(quote nil)
(quote nil)
cl-scsu::parental-condition
The class of an object holding the internal state of SCSU.
====
SCSUの内部状態を保持するオブジェクトのクラス。
(setf lookup-dynamic-window).
lookup-dynamic-window.
(setf scsu-state-active-window-index).
scsu-state-active-window-index.
(setf scsu-state-active-window-offset).
scsu-state-active-window-offset.
(setf scsu-state-current-timestamp).
scsu-state-current-timestamp.
(setf scsu-state-dynamic-window).
scsu-state-dynamic-window.
(setf scsu-state-fix-dynamic-window).
scsu-state-fix-dynamic-window.
(setf scsu-state-mode).
scsu-state-mode.
scsu-state-reset.
(setf scsu-state-timestamp).
scsu-state-timestamp.
(setf scsu-state-timestamp-vector).
scsu-state-timestamp-vector.
:single-byte-mode
cl-scsu::window-index
0
fixnum
0
boolean
:fix-dynamic-window
Change to Window 0
Change to Window 1
Change to Window 2
Change to Window 3
Change to Window 4
Change to Window 5
Change to Window 6
Change to Window 7
Change to Unicode
Define Window 0
Define Window 1
Define Window 2
Define Window 3
Define Window 4
Define Window 5
Define Window 6
Define Window 7
Define Extended
Quote from Window 0
Quote from Window 1
Quote from Window 2
Quote from Window 3
Quote from Window 4
Quote from Window 5
Quote from Window 6
Quote from Window 7
Quote Unicode
Change to Window 0
Change to Window 1
Change to Window 2
Change to Window 3
Change to Window 4
Change to Window 5
Change to Window 6
Change to Window 7
Define Window 0
Define Window 1
Define Window 2
Define Window 3
Define Window 4
Define Window 5
Define Window 6
Define Window 7
Define Extended
Quote Unicode
The number of static or dynamic windows.
If set to T, outputs tag or character informations seen by the decoder to *trace-output*
scsu-state) window) ¶scsu-state) window) ¶scsu-error)) ¶scsu-error)) ¶scsu-error)) ¶scsu-error)) ¶scsu-error)) ¶scsu-error)) ¶scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
scsu-state)) ¶scsu-state)) ¶scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
scsu-state)) ¶scsu-state) window) ¶scsu-state) window) ¶scsu-state)) ¶automatically generated reader method
scsu-state)) ¶automatically generated writer method
| Jump to: | (
1
A D E F G I L M S U W |
|---|
| Jump to: | (
1
A D E F G I L M S U W |
|---|
| Jump to: | *
+
A C D F M P S T |
|---|
| Jump to: | *
+
A C D F M P S T |
|---|
| Jump to: | C F M P R S T U W |
|---|
| Jump to: | C F M P R S T U W |
|---|