Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The cl-scsu Reference Manual
This is the cl-scsu Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:08:54 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The cl-scsu Reference Manual, Up: The cl-scsu Reference Manual [Contents][Index]
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]
Next: Modules, Previous: Introduction, Up: The cl-scsu Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-scsu
An implementation of ’Standard Compression Scheme for Unicode’.
- Author
YOKOTA Yuki <y2q.actionman@gmail.com>
- License
MIT
- Dependency
alexandria (system).
- Source
- Child Component
src (module).
Next: Files, Previous: Systems, Up: The cl-scsu Reference Manual [Contents][Index]
3 Modules
Modules are listed depth-first from the system components tree.
3.1 cl-scsu/src
- Source
- Parent Component
cl-scsu (system).
- Child Components
- package.lisp (file).
- constant.lisp (file).
- scsu.lisp (file).
Next: Packages, Previous: Modules, Up: The cl-scsu Reference Manual [Contents][Index]
4 Files
Files are sorted by type and then listed depth-first from the systems components trees.
4.1 Lisp
Next: cl-scsu/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
4.1.1 cl-scsu/cl-scsu.asd
- Source
- Parent Component
cl-scsu (system).
- ASDF Systems
Next: cl-scsu/src/constant.lisp, Previous: cl-scsu/cl-scsu.asd, Up: Lisp [Contents][Index]
4.1.2 cl-scsu/src/package.lisp
- Source
- Parent Component
src (module).
- Packages
Next: cl-scsu/src/scsu.lisp, Previous: cl-scsu/src/package.lisp, Up: Lisp [Contents][Index]
4.1.3 cl-scsu/src/constant.lisp
- Dependency
package.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
scsu-error (condition).
- Internals
- +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).
Previous: cl-scsu/src/constant.lisp, Up: Lisp [Contents][Index]
4.1.4 cl-scsu/src/scsu.lisp
- Dependency
constant.lisp (file).
- Source
- Parent Component
src (module).
- Public Interface
- decode-to-string (function).
- encode-from-string (function).
- encode-reset-sequence (function).
- scsu-state (class).
- Internals
- *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).
Next: Definitions, Previous: Files, Up: The cl-scsu Reference Manual [Contents][Index]
5 Packages
Packages are listed by definition order.
5.1 cl-scsu
- Source
- Use List
common-lisp.
- Public Interface
- decode-to-string (function).
- encode-from-string (function).
- encode-reset-sequence (function).
- scsu-error (condition).
- scsu-state (class).
- Internals
- *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).
Next: Indexes, Previous: Packages, Up: The cl-scsu Reference Manual [Contents][Index]
6 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
6.1 Public Interface
Next: Conditions, Previous: Public Interface, Up: Public Interface [Contents][Index]
6.1.1 Ordinary functions
- Function: decode-to-string (bytes &key start1 end1 string start2 end2 state) ¶
-
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] を使用する。
- Function: encode-from-string (string &key start1 end1 bytes start2 end2 initial-priority 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] を使用する。
- Function: encode-reset-sequence (state &key bytes start end) ¶
-
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 を指定しなかった場合、無視される。
Next: Classes, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
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
- Source
- Direct superclasses
simple-error.
- Direct methods
- Direct slots
- Slot: src-error-position ¶
-
- Initform
(quote nil)
- Readers
- Writers
- Slot: dst-error-position ¶
-
- Initform
(quote nil)
- Readers
- Writers
- Slot: parental-condition ¶
-
- Initform
(quote nil)
- Initargs
cl-scsu::parental-condition
- Readers
- Writers
Previous: Conditions, Up: Public Interface [Contents][Index]
6.1.3 Classes
- Class: scsu-state ¶
-
The class of an object holding the internal state of SCSU. ====
SCSUの内部状態を保持するオブジェクトのクラス。- Package
- Source
- Direct methods
- (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.
- Direct slots
- Slot: mode ¶
-
- Initform
:single-byte-mode
- Readers
- Writers
- Slot: dynamic-window ¶
-
- Readers
- Writers
- Slot: active-window-index ¶
-
- Type
cl-scsu::window-index
- Initform
0
- Readers
- Writers
- Slot: timestamp-vector ¶
-
- Readers
- Writers
- Slot: current-timestamp ¶
-
- Type
fixnum
- Initform
0
- Readers
- Writers
- Slot: fix-dynamic-window ¶
-
- Type
boolean
- Initargs
:fix-dynamic-window
- Readers
- Writers
Previous: Public Interface, Up: Definitions [Contents][Index]
6.2 Internals
Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]
6.2.1 Constants
- Constant: +default-positions-for-dynamically-positioned-windows+ ¶
-
- Package
- Source
- Constant: +sc0+ ¶
-
Change to Window 0
- Package
- Source
- Constant: +sc1+ ¶
-
Change to Window 1
- Package
- Source
- Constant: +sc2+ ¶
-
Change to Window 2
- Package
- Source
- Constant: +sc3+ ¶
-
Change to Window 3
- Package
- Source
- Constant: +sc4+ ¶
-
Change to Window 4
- Package
- Source
- Constant: +sc5+ ¶
-
Change to Window 5
- Package
- Source
- Constant: +sc6+ ¶
-
Change to Window 6
- Package
- Source
- Constant: +sc7+ ¶
-
Change to Window 7
- Package
- Source
- Constant: +scu+ ¶
-
Change to Unicode
- Package
- Source
- Constant: +sd0+ ¶
-
Define Window 0
- Package
- Source
- Constant: +sd1+ ¶
-
Define Window 1
- Package
- Source
- Constant: +sd2+ ¶
-
Define Window 2
- Package
- Source
- Constant: +sd3+ ¶
-
Define Window 3
- Package
- Source
- Constant: +sd4+ ¶
-
Define Window 4
- Package
- Source
- Constant: +sd5+ ¶
-
Define Window 5
- Package
- Source
- Constant: +sd6+ ¶
-
Define Window 6
- Package
- Source
- Constant: +sd7+ ¶
-
Define Window 7
- Package
- Source
- Constant: +sdx+ ¶
-
Define Extended
- Package
- Source
- Constant: +sq0+ ¶
-
Quote from Window 0
- Package
- Source
- Constant: +sq1+ ¶
-
Quote from Window 1
- Package
- Source
- Constant: +sq2+ ¶
-
Quote from Window 2
- Package
- Source
- Constant: +sq3+ ¶
-
Quote from Window 3
- Package
- Source
- Constant: +sq4+ ¶
-
Quote from Window 4
- Package
- Source
- Constant: +sq5+ ¶
-
Quote from Window 5
- Package
- Source
- Constant: +sq6+ ¶
-
Quote from Window 6
- Package
- Source
- Constant: +sq7+ ¶
-
Quote from Window 7
- Package
- Source
- Constant: +squ+ ¶
-
Quote Unicode
- Package
- Source
- Constant: +static-windows+ ¶
-
- Package
- Source
- Constant: +uc0+ ¶
-
Change to Window 0
- Package
- Source
- Constant: +uc1+ ¶
-
Change to Window 1
- Package
- Source
- Constant: +uc2+ ¶
-
Change to Window 2
- Package
- Source
- Constant: +uc3+ ¶
-
Change to Window 3
- Package
- Source
- Constant: +uc4+ ¶
-
Change to Window 4
- Package
- Source
- Constant: +uc5+ ¶
-
Change to Window 5
- Package
- Source
- Constant: +uc6+ ¶
-
Change to Window 6
- Package
- Source
- Constant: +uc7+ ¶
-
Change to Window 7
- Package
- Source
- Constant: +ud0+ ¶
-
Define Window 0
- Package
- Source
- Constant: +ud1+ ¶
-
Define Window 1
- Package
- Source
- Constant: +ud2+ ¶
-
Define Window 2
- Package
- Source
- Constant: +ud3+ ¶
-
Define Window 3
- Package
- Source
- Constant: +ud4+ ¶
-
Define Window 4
- Package
- Source
- Constant: +ud5+ ¶
-
Define Window 5
- Package
- Source
- Constant: +ud6+ ¶
-
Define Window 6
- Package
- Source
- Constant: +ud7+ ¶
-
Define Window 7
- Package
- Source
- Constant: +udx+ ¶
-
Define Extended
- Package
- Source
- Constant: +uqu+ ¶
-
Quote Unicode
- Package
- Source
- Constant: +window-count+ ¶
-
The number of static or dynamic windows.
- Package
- Source
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*
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
6.2.3 Macros
- Macro: define-window-find-function (name lower) ¶
-
- Package
- Source
- Macro: with-buffer-accessor ((current &key reader writer) (buffer start end &key element-type) &body body) ¶
- Macro: with-scsu-error-handling ((state &key src dst return) &body body) ¶
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
6.2.4 Ordinary functions
- Function: 1byte-encodable-p (state code-point &optional window) ¶
- Function: decode-extended-window-tag (hbyte lbyte) ¶
-
- Package
- Source
- Function: decode-from-surrogate-pair (high low) ¶
-
- Package
- Source
- Function: encode-define-window (state offset table-index write-func define-window-tag define-extended-tag) ¶
- Function: encode-extended-window-tag (window offset) ¶
-
- Package
- Source
- Function: encode-to-surrogate-pair (code-point) ¶
-
- Package
- Source
- Function: encode-unit* (state code-point next-code-point write-func) ¶
- Function: encode-unit*/single-byte-mode (state code-point next-code-point write-func) ¶
- Function: encode-unit*/unicode-mode (state code-point next-code-point write-func) ¶
- Function: find-scn-window (byte) ¶
-
- Package
- Source
- Function: find-sdn-window (byte) ¶
-
- Package
- Source
- Function: find-sqn-window (byte) ¶
-
- Package
- Source
- Function: find-ucn-window (byte) ¶
-
- Package
- Source
- Function: find-udn-window (byte) ¶
-
- Package
- Source
- Function: initialize-timestamp (state initial-priority string start end) ¶
- Function: list-offset-candidates (code-point) ¶
-
- Package
- Source
- Function: lookup-static-window (window) ¶
-
- Package
- Source
- Function: lookup-window-offset-table (byte) ¶
-
- Package
- Source
- Function: scsu-trace-output (format-control &rest format-arguments) ¶
- Function: standalone-character-p (code-point) ¶
-
- Package
- Source
- Function: use-define-window-p (state code-point &optional next-code-point) ¶
- Function: window-offset-to-table-index (offset) ¶
-
- Package
- Source
Next: Types, Previous: Ordinary functions, Up: Internals [Contents][Index]
6.2.5 Generic functions
- Generic Function: lookup-dynamic-window (state window) ¶
-
- Package
- Source
- Methods
- Method: lookup-dynamic-window ((state scsu-state) window) ¶
- Generic Function: (setf lookup-dynamic-window) (state window) ¶
-
- Package
- Source
- Methods
- Method: (setf lookup-dynamic-window) ((state scsu-state) window) ¶
- Generic Reader: scsu-error-dst-error-position (condition) ¶
- Generic Writer: (setf scsu-error-dst-error-position) (condition) ¶
-
- Package
- Methods
- Reader Method: scsu-error-dst-error-position ((condition scsu-error)) ¶
- Writer Method: (setf scsu-error-dst-error-position) ((condition scsu-error)) ¶
-
- Source
- Target Slot
- Generic Reader: scsu-error-parental-condition (condition) ¶
- Generic Writer: (setf scsu-error-parental-condition) (condition) ¶
-
- Package
- Methods
- Reader Method: scsu-error-parental-condition ((condition scsu-error)) ¶
- Writer Method: (setf scsu-error-parental-condition) ((condition scsu-error)) ¶
-
- Source
- Target Slot
- Generic Reader: scsu-error-src-error-position (condition) ¶
- Generic Writer: (setf scsu-error-src-error-position) (condition) ¶
-
- Package
- Methods
- Reader Method: scsu-error-src-error-position ((condition scsu-error)) ¶
- Writer Method: (setf scsu-error-src-error-position) ((condition scsu-error)) ¶
-
- Source
- Target Slot
- Generic Reader: scsu-state-active-window-index (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-active-window-index ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf scsu-state-active-window-index) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-active-window-index) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Function: scsu-state-active-window-offset (state) ¶
-
- Package
- Source
- Methods
- Method: scsu-state-active-window-offset ((state scsu-state)) ¶
- Generic Function: (setf scsu-state-active-window-offset) (state) ¶
-
- Package
- Source
- Methods
- Method: (setf scsu-state-active-window-offset) ((state scsu-state)) ¶
- Generic Reader: scsu-state-current-timestamp (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-current-timestamp ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf scsu-state-current-timestamp) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-current-timestamp) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: scsu-state-dynamic-window (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-dynamic-window ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf scsu-state-dynamic-window) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-dynamic-window) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: scsu-state-fix-dynamic-window (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-fix-dynamic-window ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf scsu-state-fix-dynamic-window) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-fix-dynamic-window) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Source
- Target Slot
- Generic Reader: scsu-state-mode (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-mode ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Generic Writer: (setf scsu-state-mode) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-mode) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Generic Function: scsu-state-reset (state) ¶
-
- Package
- Source
- Methods
- Method: scsu-state-reset ((state scsu-state)) ¶
- Generic Function: scsu-state-timestamp (state window) ¶
-
- Package
- Source
- Methods
- Method: scsu-state-timestamp ((state scsu-state) window) ¶
- Generic Function: (setf scsu-state-timestamp) (state window) ¶
-
- Package
- Source
- Methods
- Method: (setf scsu-state-timestamp) ((state scsu-state) window) ¶
- Generic Reader: scsu-state-timestamp-vector (object) ¶
-
- Package
- Methods
- Reader Method: scsu-state-timestamp-vector ((scsu-state scsu-state)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Writer: (setf scsu-state-timestamp-vector) (object) ¶
-
- Package
- Methods
- Writer Method: (setf scsu-state-timestamp-vector) ((scsu-state scsu-state)) ¶
-
automatically generated writer method
- Source
- Target Slot
Previous: Definitions, Up: The cl-scsu Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| 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 |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| Jump to: | *
+
A C D F M P S T |
|---|
| Jump to: | *
+
A C D F M P S T |
|---|
A.4 Data types
| Jump to: | C F M P R S T U W |
|---|
| Jump to: | C F M P R S T U W |
|---|