The cl-scsu Reference Manual

Next: , Previous: , 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


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

Load by quicklisp

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:


2 Systems

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


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

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

cl-scsu.asd.

Child Component

src (module).


3 Modules

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


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

3.1 cl-scsu/src

Source

cl-scsu.asd.

Parent Component

cl-scsu (system).

Child Components

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-scsu/cl-scsu.asd

Source

cl-scsu.asd.

Parent Component

cl-scsu (system).

ASDF Systems

cl-scsu.


4.1.2 cl-scsu/src/package.lisp

Source

cl-scsu.asd.

Parent Component

src (module).

Packages

cl-scsu.


4.1.3 cl-scsu/src/constant.lisp

Dependency

package.lisp (file).

Source

cl-scsu.asd.

Parent Component

src (module).

Public Interface

scsu-error (condition).

Internals

4.1.4 cl-scsu/src/scsu.lisp

Dependency

constant.lisp (file).

Source

cl-scsu.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


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

5.1 cl-scsu

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


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] を使用する。

Package

cl-scsu.

Source

scsu.lisp.

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] を使用する。

Package

cl-scsu.

Source

scsu.lisp.

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 を指定しなかった場合、無視される。

Package

cl-scsu.

Source

scsu.lisp.


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.

Direct superclasses

simple-error.

Direct methods
Direct slots
Slot: src-error-position
Initform

(quote nil)

Readers

scsu-error-src-error-position.

Writers

(setf scsu-error-src-error-position).

Slot: dst-error-position
Initform

(quote nil)

Readers

scsu-error-dst-error-position.

Writers

(setf scsu-error-dst-error-position).

Slot: parental-condition
Initform

(quote nil)

Initargs

cl-scsu::parental-condition

Readers

scsu-error-parental-condition.

Writers

(setf scsu-error-parental-condition).


Previous: , 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

cl-scsu.

Source

scsu.lisp.

Direct methods
Direct slots
Slot: mode
Initform

:single-byte-mode

Readers

scsu-state-mode.

Writers

(setf scsu-state-mode).

Slot: dynamic-window
Readers

scsu-state-dynamic-window.

Writers

(setf scsu-state-dynamic-window).

Slot: active-window-index
Type

cl-scsu::window-index

Initform

0

Readers

scsu-state-active-window-index.

Writers

(setf scsu-state-active-window-index).

Slot: timestamp-vector
Readers

scsu-state-timestamp-vector.

Writers

(setf scsu-state-timestamp-vector).

Slot: current-timestamp
Type

fixnum

Initform

0

Readers

scsu-state-current-timestamp.

Writers

(setf scsu-state-current-timestamp).

Slot: fix-dynamic-window
Type

boolean

Initargs

:fix-dynamic-window

Readers

scsu-state-fix-dynamic-window.

Writers

(setf scsu-state-fix-dynamic-window).


6.2 Internals


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

6.2.1 Constants

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

cl-scsu.

Source

constant.lisp.

Constant: +sc0+

Change to Window 0

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc1+

Change to Window 1

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc2+

Change to Window 2

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc3+

Change to Window 3

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc4+

Change to Window 4

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc5+

Change to Window 5

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc6+

Change to Window 6

Package

cl-scsu.

Source

constant.lisp.

Constant: +sc7+

Change to Window 7

Package

cl-scsu.

Source

constant.lisp.

Constant: +scu+

Change to Unicode

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd0+

Define Window 0

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd1+

Define Window 1

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd2+

Define Window 2

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd3+

Define Window 3

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd4+

Define Window 4

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd5+

Define Window 5

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd6+

Define Window 6

Package

cl-scsu.

Source

constant.lisp.

Constant: +sd7+

Define Window 7

Package

cl-scsu.

Source

constant.lisp.

Constant: +sdx+

Define Extended

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq0+

Quote from Window 0

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq1+

Quote from Window 1

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq2+

Quote from Window 2

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq3+

Quote from Window 3

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq4+

Quote from Window 4

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq5+

Quote from Window 5

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq6+

Quote from Window 6

Package

cl-scsu.

Source

constant.lisp.

Constant: +sq7+

Quote from Window 7

Package

cl-scsu.

Source

constant.lisp.

Constant: +squ+

Quote Unicode

Package

cl-scsu.

Source

constant.lisp.

Constant: +static-windows+
Package

cl-scsu.

Source

constant.lisp.

Constant: +uc0+

Change to Window 0

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc1+

Change to Window 1

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc2+

Change to Window 2

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc3+

Change to Window 3

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc4+

Change to Window 4

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc5+

Change to Window 5

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc6+

Change to Window 6

Package

cl-scsu.

Source

constant.lisp.

Constant: +uc7+

Change to Window 7

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud0+

Define Window 0

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud1+

Define Window 1

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud2+

Define Window 2

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud3+

Define Window 3

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud4+

Define Window 4

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud5+

Define Window 5

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud6+

Define Window 6

Package

cl-scsu.

Source

constant.lisp.

Constant: +ud7+

Define Window 7

Package

cl-scsu.

Source

constant.lisp.

Constant: +udx+

Define Extended

Package

cl-scsu.

Source

constant.lisp.

Constant: +uqu+

Quote Unicode

Package

cl-scsu.

Source

constant.lisp.

Constant: +window-count+

The number of static or dynamic windows.

Package

cl-scsu.

Source

constant.lisp.


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

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.


6.2.3 Macros

Macro: define-window-find-function (name lower)
Package

cl-scsu.

Source

constant.lisp.

Macro: with-buffer-accessor ((current &key reader writer) (buffer start end &key element-type) &body body)
Package

cl-scsu.

Source

scsu.lisp.

Macro: with-scsu-error-handling ((state &key src dst return) &body body)
Package

cl-scsu.

Source

scsu.lisp.


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

6.2.4 Ordinary functions

Function: 1byte-encodable-p (state code-point &optional window)
Package

cl-scsu.

Source

scsu.lisp.

Function: apply-define-window (state window offset)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-define-window-extended (state read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-extended-window-tag (hbyte lbyte)
Package

cl-scsu.

Source

constant.lisp.

Function: decode-from-surrogate-pair (high low)
Package

cl-scsu.

Source

constant.lisp.

Function: decode-quote-unicode (read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-unit (state read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-unit* (state read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-unit*/single-byte-mode (state read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: decode-unit*/unicode-mode (state read-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: encode-define-window (state offset table-index write-func define-window-tag define-extended-tag)
Package

cl-scsu.

Source

scsu.lisp.

Function: encode-extended-window-tag (window offset)
Package

cl-scsu.

Source

constant.lisp.

Function: encode-to-surrogate-pair (code-point)
Package

cl-scsu.

Source

constant.lisp.

Function: encode-unit (state read-func write-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: encode-unit* (state code-point next-code-point write-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: encode-unit*/single-byte-mode (state code-point next-code-point write-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: encode-unit*/unicode-mode (state code-point next-code-point write-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: fill-pointer-if-exists (obj)
Package

cl-scsu.

Source

scsu.lisp.

Function: find-lru-dynamic-window (state)
Package

cl-scsu.

Source

scsu.lisp.

Function: find-scn-window (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: find-sdn-window (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: find-sqn-window (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: find-suitable-dynamic-window (state code-point)
Package

cl-scsu.

Source

scsu.lisp.

Function: find-suitable-static-window (code-point)
Package

cl-scsu.

Source

scsu.lisp.

Function: find-suitable-window* (code-point offset-func)
Package

cl-scsu.

Source

scsu.lisp.

Function: find-ucn-window (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: find-udn-window (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: in-active-window-p (state code-point)
Package

cl-scsu.

Source

scsu.lisp.

Function: in-window-p (offset code-point)
Package

cl-scsu.

Source

scsu.lisp.

Function: initialize-timestamp (state initial-priority string start end)
Package

cl-scsu.

Source

scsu.lisp.

Function: list-offset-candidates (code-point)
Package

cl-scsu.

Source

constant.lisp.

Function: lookup-static-window (window)
Package

cl-scsu.

Source

constant.lisp.

Function: lookup-window-offset-table (byte)
Package

cl-scsu.

Source

constant.lisp.

Function: scsu-trace-output (format-control &rest format-arguments)
Package

cl-scsu.

Source

scsu.lisp.

Function: standalone-character-p (code-point)
Package

cl-scsu.

Source

constant.lisp.

Function: update-timestamp (state &optional window)
Package

cl-scsu.

Source

scsu.lisp.

Function: use-define-window-p (state code-point &optional next-code-point)
Package

cl-scsu.

Source

scsu.lisp.

Function: window-offset-to-table-index (offset)
Package

cl-scsu.

Source

constant.lisp.

Function: write-16bit-code-point (code-point write-func)
Package

cl-scsu.

Source

scsu.lisp.


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

6.2.5 Generic functions

Generic Function: lookup-dynamic-window (state window)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: lookup-dynamic-window ((state scsu-state) window)
Generic Function: (setf lookup-dynamic-window) (state window)
Package

cl-scsu.

Source

scsu.lisp.

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

cl-scsu.

Methods
Reader Method: scsu-error-dst-error-position ((condition scsu-error))
Writer Method: (setf scsu-error-dst-error-position) ((condition scsu-error))
Source

constant.lisp.

Target Slot

dst-error-position.

Generic Reader: scsu-error-parental-condition (condition)
Generic Writer: (setf scsu-error-parental-condition) (condition)
Package

cl-scsu.

Methods
Reader Method: scsu-error-parental-condition ((condition scsu-error))
Writer Method: (setf scsu-error-parental-condition) ((condition scsu-error))
Source

constant.lisp.

Target Slot

parental-condition.

Generic Reader: scsu-error-src-error-position (condition)
Generic Writer: (setf scsu-error-src-error-position) (condition)
Package

cl-scsu.

Methods
Reader Method: scsu-error-src-error-position ((condition scsu-error))
Writer Method: (setf scsu-error-src-error-position) ((condition scsu-error))
Source

constant.lisp.

Target Slot

src-error-position.

Generic Reader: scsu-state-active-window-index (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-active-window-index ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

active-window-index.

Generic Writer: (setf scsu-state-active-window-index) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-active-window-index) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

active-window-index.

Generic Function: scsu-state-active-window-offset (state)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: scsu-state-active-window-offset ((state scsu-state))
Generic Function: (setf scsu-state-active-window-offset) (state)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: (setf scsu-state-active-window-offset) ((state scsu-state))
Generic Reader: scsu-state-current-timestamp (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-current-timestamp ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

current-timestamp.

Generic Writer: (setf scsu-state-current-timestamp) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-current-timestamp) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

current-timestamp.

Generic Reader: scsu-state-dynamic-window (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-dynamic-window ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

dynamic-window.

Generic Writer: (setf scsu-state-dynamic-window) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-dynamic-window) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

dynamic-window.

Generic Reader: scsu-state-fix-dynamic-window (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-fix-dynamic-window ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

fix-dynamic-window.

Generic Writer: (setf scsu-state-fix-dynamic-window) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-fix-dynamic-window) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

fix-dynamic-window.

Generic Reader: scsu-state-mode (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-mode ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

mode.

Generic Writer: (setf scsu-state-mode) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-mode) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

mode.

Generic Function: scsu-state-reset (state)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: scsu-state-reset ((state scsu-state))
Generic Function: scsu-state-timestamp (state window)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: scsu-state-timestamp ((state scsu-state) window)
Generic Function: (setf scsu-state-timestamp) (state window)
Package

cl-scsu.

Source

scsu.lisp.

Methods
Method: (setf scsu-state-timestamp) ((state scsu-state) window)
Generic Reader: scsu-state-timestamp-vector (object)
Package

cl-scsu.

Methods
Reader Method: scsu-state-timestamp-vector ((scsu-state scsu-state))

automatically generated reader method

Source

scsu.lisp.

Target Slot

timestamp-vector.

Generic Writer: (setf scsu-state-timestamp-vector) (object)
Package

cl-scsu.

Methods
Writer Method: (setf scsu-state-timestamp-vector) ((scsu-state scsu-state))

automatically generated writer method

Source

scsu.lisp.

Target Slot

timestamp-vector.


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

6.2.6 Types

Type: read-func-type ()
Package

cl-scsu.

Source

scsu.lisp.

Type: unicode-code-point ()
Package

cl-scsu.

Source

constant.lisp.

Type: window-index ()
Package

cl-scsu.

Source

constant.lisp.

Type: write-func-type ()
Package

cl-scsu.

Source

scsu.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   (   1  
A   D   E   F   G   I   L   M   S   U   W  
Index Entry  Section

(
(setf lookup-dynamic-window): Private generic functions
(setf lookup-dynamic-window): Private generic functions
(setf scsu-error-dst-error-position): Private generic functions
(setf scsu-error-dst-error-position): Private generic functions
(setf scsu-error-parental-condition): Private generic functions
(setf scsu-error-parental-condition): Private generic functions
(setf scsu-error-src-error-position): Private generic functions
(setf scsu-error-src-error-position): Private generic functions
(setf scsu-state-active-window-index): Private generic functions
(setf scsu-state-active-window-index): Private generic functions
(setf scsu-state-active-window-offset): Private generic functions
(setf scsu-state-active-window-offset): Private generic functions
(setf scsu-state-current-timestamp): Private generic functions
(setf scsu-state-current-timestamp): Private generic functions
(setf scsu-state-dynamic-window): Private generic functions
(setf scsu-state-dynamic-window): Private generic functions
(setf scsu-state-fix-dynamic-window): Private generic functions
(setf scsu-state-fix-dynamic-window): Private generic functions
(setf scsu-state-mode): Private generic functions
(setf scsu-state-mode): Private generic functions
(setf scsu-state-timestamp): Private generic functions
(setf scsu-state-timestamp): Private generic functions
(setf scsu-state-timestamp-vector): Private generic functions
(setf scsu-state-timestamp-vector): Private generic functions

1
1byte-encodable-p: Private ordinary functions

A
apply-define-window: Private ordinary functions

D
decode-define-window-extended: Private ordinary functions
decode-extended-window-tag: Private ordinary functions
decode-from-surrogate-pair: Private ordinary functions
decode-quote-unicode: Private ordinary functions
decode-to-string: Public ordinary functions
decode-unit: Private ordinary functions
decode-unit*: Private ordinary functions
decode-unit*/single-byte-mode: Private ordinary functions
decode-unit*/unicode-mode: Private ordinary functions
define-window-find-function: Private macros

E
encode-define-window: Private ordinary functions
encode-extended-window-tag: Private ordinary functions
encode-from-string: Public ordinary functions
encode-reset-sequence: Public ordinary functions
encode-to-surrogate-pair: Private ordinary functions
encode-unit: Private ordinary functions
encode-unit*: Private ordinary functions
encode-unit*/single-byte-mode: Private ordinary functions
encode-unit*/unicode-mode: Private ordinary functions

F
fill-pointer-if-exists: Private ordinary functions
find-lru-dynamic-window: Private ordinary functions
find-scn-window: Private ordinary functions
find-sdn-window: Private ordinary functions
find-sqn-window: Private ordinary functions
find-suitable-dynamic-window: Private ordinary functions
find-suitable-static-window: Private ordinary functions
find-suitable-window*: Private ordinary functions
find-ucn-window: Private ordinary functions
find-udn-window: Private ordinary functions
Function, 1byte-encodable-p: Private ordinary functions
Function, apply-define-window: Private ordinary functions
Function, decode-define-window-extended: Private ordinary functions
Function, decode-extended-window-tag: Private ordinary functions
Function, decode-from-surrogate-pair: Private ordinary functions
Function, decode-quote-unicode: Private ordinary functions
Function, decode-to-string: Public ordinary functions
Function, decode-unit: Private ordinary functions
Function, decode-unit*: Private ordinary functions
Function, decode-unit*/single-byte-mode: Private ordinary functions
Function, decode-unit*/unicode-mode: Private ordinary functions
Function, encode-define-window: Private ordinary functions
Function, encode-extended-window-tag: Private ordinary functions
Function, encode-from-string: Public ordinary functions
Function, encode-reset-sequence: Public ordinary functions
Function, encode-to-surrogate-pair: Private ordinary functions
Function, encode-unit: Private ordinary functions
Function, encode-unit*: Private ordinary functions
Function, encode-unit*/single-byte-mode: Private ordinary functions
Function, encode-unit*/unicode-mode: Private ordinary functions
Function, fill-pointer-if-exists: Private ordinary functions
Function, find-lru-dynamic-window: Private ordinary functions
Function, find-scn-window: Private ordinary functions
Function, find-sdn-window: Private ordinary functions
Function, find-sqn-window: Private ordinary functions
Function, find-suitable-dynamic-window: Private ordinary functions
Function, find-suitable-static-window: Private ordinary functions
Function, find-suitable-window*: Private ordinary functions
Function, find-ucn-window: Private ordinary functions
Function, find-udn-window: Private ordinary functions
Function, in-active-window-p: Private ordinary functions
Function, in-window-p: Private ordinary functions
Function, initialize-timestamp: Private ordinary functions
Function, list-offset-candidates: Private ordinary functions
Function, lookup-static-window: Private ordinary functions
Function, lookup-window-offset-table: Private ordinary functions
Function, scsu-trace-output: Private ordinary functions
Function, standalone-character-p: Private ordinary functions
Function, update-timestamp: Private ordinary functions
Function, use-define-window-p: Private ordinary functions
Function, window-offset-to-table-index: Private ordinary functions
Function, write-16bit-code-point: Private ordinary functions

G
Generic Function, (setf lookup-dynamic-window): Private generic functions
Generic Function, (setf scsu-error-dst-error-position): Private generic functions
Generic Function, (setf scsu-error-parental-condition): Private generic functions
Generic Function, (setf scsu-error-src-error-position): Private generic functions
Generic Function, (setf scsu-state-active-window-index): Private generic functions
Generic Function, (setf scsu-state-active-window-offset): Private generic functions
Generic Function, (setf scsu-state-current-timestamp): Private generic functions
Generic Function, (setf scsu-state-dynamic-window): Private generic functions
Generic Function, (setf scsu-state-fix-dynamic-window): Private generic functions
Generic Function, (setf scsu-state-mode): Private generic functions
Generic Function, (setf scsu-state-timestamp): Private generic functions
Generic Function, (setf scsu-state-timestamp-vector): Private generic functions
Generic Function, lookup-dynamic-window: Private generic functions
Generic Function, scsu-error-dst-error-position: Private generic functions
Generic Function, scsu-error-parental-condition: Private generic functions
Generic Function, scsu-error-src-error-position: Private generic functions
Generic Function, scsu-state-active-window-index: Private generic functions
Generic Function, scsu-state-active-window-offset: Private generic functions
Generic Function, scsu-state-current-timestamp: Private generic functions
Generic Function, scsu-state-dynamic-window: Private generic functions
Generic Function, scsu-state-fix-dynamic-window: Private generic functions
Generic Function, scsu-state-mode: Private generic functions
Generic Function, scsu-state-reset: Private generic functions
Generic Function, scsu-state-timestamp: Private generic functions
Generic Function, scsu-state-timestamp-vector: Private generic functions

I
in-active-window-p: Private ordinary functions
in-window-p: Private ordinary functions
initialize-timestamp: Private ordinary functions

L
list-offset-candidates: Private ordinary functions
lookup-dynamic-window: Private generic functions
lookup-dynamic-window: Private generic functions
lookup-static-window: Private ordinary functions
lookup-window-offset-table: Private ordinary functions

M
Macro, define-window-find-function: Private macros
Macro, with-buffer-accessor: Private macros
Macro, with-scsu-error-handling: Private macros
Method, (setf lookup-dynamic-window): Private generic functions
Method, (setf scsu-error-dst-error-position): Private generic functions
Method, (setf scsu-error-parental-condition): Private generic functions
Method, (setf scsu-error-src-error-position): Private generic functions
Method, (setf scsu-state-active-window-index): Private generic functions
Method, (setf scsu-state-active-window-offset): Private generic functions
Method, (setf scsu-state-current-timestamp): Private generic functions
Method, (setf scsu-state-dynamic-window): Private generic functions
Method, (setf scsu-state-fix-dynamic-window): Private generic functions
Method, (setf scsu-state-mode): Private generic functions
Method, (setf scsu-state-timestamp): Private generic functions
Method, (setf scsu-state-timestamp-vector): Private generic functions
Method, lookup-dynamic-window: Private generic functions
Method, scsu-error-dst-error-position: Private generic functions
Method, scsu-error-parental-condition: Private generic functions
Method, scsu-error-src-error-position: Private generic functions
Method, scsu-state-active-window-index: Private generic functions
Method, scsu-state-active-window-offset: Private generic functions
Method, scsu-state-current-timestamp: Private generic functions
Method, scsu-state-dynamic-window: Private generic functions
Method, scsu-state-fix-dynamic-window: Private generic functions
Method, scsu-state-mode: Private generic functions
Method, scsu-state-reset: Private generic functions
Method, scsu-state-timestamp: Private generic functions
Method, scsu-state-timestamp-vector: Private generic functions

S
scsu-error-dst-error-position: Private generic functions
scsu-error-dst-error-position: Private generic functions
scsu-error-parental-condition: Private generic functions
scsu-error-parental-condition: Private generic functions
scsu-error-src-error-position: Private generic functions
scsu-error-src-error-position: Private generic functions
scsu-state-active-window-index: Private generic functions
scsu-state-active-window-index: Private generic functions
scsu-state-active-window-offset: Private generic functions
scsu-state-active-window-offset: Private generic functions
scsu-state-current-timestamp: Private generic functions
scsu-state-current-timestamp: Private generic functions
scsu-state-dynamic-window: Private generic functions
scsu-state-dynamic-window: Private generic functions
scsu-state-fix-dynamic-window: Private generic functions
scsu-state-fix-dynamic-window: Private generic functions
scsu-state-mode: Private generic functions
scsu-state-mode: Private generic functions
scsu-state-reset: Private generic functions
scsu-state-reset: Private generic functions
scsu-state-timestamp: Private generic functions
scsu-state-timestamp: Private generic functions
scsu-state-timestamp-vector: Private generic functions
scsu-state-timestamp-vector: Private generic functions
scsu-trace-output: Private ordinary functions
standalone-character-p: Private ordinary functions

U
update-timestamp: Private ordinary functions
use-define-window-p: Private ordinary functions

W
window-offset-to-table-index: Private ordinary functions
with-buffer-accessor: Private macros
with-scsu-error-handling: Private macros
write-16bit-code-point: Private ordinary functions

Jump to:   (   1  
A   D   E   F   G   I   L   M   S   U   W  

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

A.3 Variables

Jump to:   *   +  
A   C   D   F   M   P   S   T  
Index Entry  Section

*
*scsu-state-trace*: Private special variables

+
+default-positions-for-dynamically-positioned-windows+: Private constants
+sc0+: Private constants
+sc1+: Private constants
+sc2+: Private constants
+sc3+: Private constants
+sc4+: Private constants
+sc5+: Private constants
+sc6+: Private constants
+sc7+: Private constants
+scu+: Private constants
+sd0+: Private constants
+sd1+: Private constants
+sd2+: Private constants
+sd3+: Private constants
+sd4+: Private constants
+sd5+: Private constants
+sd6+: Private constants
+sd7+: Private constants
+sdx+: Private constants
+sq0+: Private constants
+sq1+: Private constants
+sq2+: Private constants
+sq3+: Private constants
+sq4+: Private constants
+sq5+: Private constants
+sq6+: Private constants
+sq7+: Private constants
+squ+: Private constants
+static-windows+: Private constants
+uc0+: Private constants
+uc1+: Private constants
+uc2+: Private constants
+uc3+: Private constants
+uc4+: Private constants
+uc5+: Private constants
+uc6+: Private constants
+uc7+: Private constants
+ud0+: Private constants
+ud1+: Private constants
+ud2+: Private constants
+ud3+: Private constants
+ud4+: Private constants
+ud5+: Private constants
+ud6+: Private constants
+ud7+: Private constants
+udx+: Private constants
+uqu+: Private constants
+window-count+: Private constants

A
active-window-index: Public classes

C
Constant, +default-positions-for-dynamically-positioned-windows+: Private constants
Constant, +sc0+: Private constants
Constant, +sc1+: Private constants
Constant, +sc2+: Private constants
Constant, +sc3+: Private constants
Constant, +sc4+: Private constants
Constant, +sc5+: Private constants
Constant, +sc6+: Private constants
Constant, +sc7+: Private constants
Constant, +scu+: Private constants
Constant, +sd0+: Private constants
Constant, +sd1+: Private constants
Constant, +sd2+: Private constants
Constant, +sd3+: Private constants
Constant, +sd4+: Private constants
Constant, +sd5+: Private constants
Constant, +sd6+: Private constants
Constant, +sd7+: Private constants
Constant, +sdx+: Private constants
Constant, +sq0+: Private constants
Constant, +sq1+: Private constants
Constant, +sq2+: Private constants
Constant, +sq3+: Private constants
Constant, +sq4+: Private constants
Constant, +sq5+: Private constants
Constant, +sq6+: Private constants
Constant, +sq7+: Private constants
Constant, +squ+: Private constants
Constant, +static-windows+: Private constants
Constant, +uc0+: Private constants
Constant, +uc1+: Private constants
Constant, +uc2+: Private constants
Constant, +uc3+: Private constants
Constant, +uc4+: Private constants
Constant, +uc5+: Private constants
Constant, +uc6+: Private constants
Constant, +uc7+: Private constants
Constant, +ud0+: Private constants
Constant, +ud1+: Private constants
Constant, +ud2+: Private constants
Constant, +ud3+: Private constants
Constant, +ud4+: Private constants
Constant, +ud5+: Private constants
Constant, +ud6+: Private constants
Constant, +ud7+: Private constants
Constant, +udx+: Private constants
Constant, +uqu+: Private constants
Constant, +window-count+: Private constants
current-timestamp: Public classes

D
dst-error-position: Public conditions
dynamic-window: Public classes

F
fix-dynamic-window: Public classes

M
mode: Public classes

P
parental-condition: Public conditions

S
Slot, active-window-index: Public classes
Slot, current-timestamp: Public classes
Slot, dst-error-position: Public conditions
Slot, dynamic-window: Public classes
Slot, fix-dynamic-window: Public classes
Slot, mode: Public classes
Slot, parental-condition: Public conditions
Slot, src-error-position: Public conditions
Slot, timestamp-vector: Public classes
Special Variable, *scsu-state-trace*: Private special variables
src-error-position: Public conditions

T
timestamp-vector: Public classes

Jump to:   *   +  
A   C   D   F   M   P   S   T