The babel Reference Manual

Table of Contents

The babel Reference Manual

This is the babel Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 19:21:44 2020 GMT+0.

1 Introduction

Babel is a charset encoding/decoding library, not unlike GNU libiconv, but completely written in Common Lisp.

It strives to achieve decent performance. To that effect, we use OpenMCL's approach of calculating the destination buffer size in advance. Most of the encoding/decoding algorithms have been adapted from OpenMCL's source.

Another important goal is reusability. Similarly to SBCL, we define an interface wherein the algorithms can be reused between a variety of data types so long we're dealing with conversions between octets and unicode code points.

Babel comes with converters between strings and (unsigned-byte 8) vectors but can be easily extended to deal with, e.g., strings and foreign memory, vectors and Closure's runes, etc...

2 Systems

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

2.1 babel

Author

Luis Oliveira <loliveira@common-lisp.net>

License

MIT

Description

Babel, a charset conversion library.

Dependencies

• trivial-features
• alexandria

Source

babel.asd (file)

Component

src (module)

3 Modules

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

3.1 babel/src

Parent

babel (system)

Location

src/

Components

• packages.lisp (file)
• encodings.lisp (file)
• enc-ascii.lisp (file)
• enc-ebcdic.lisp (file)
• enc-ebcdic-int.lisp (file)
• enc-iso-8859.lisp (file)
• enc-unicode.lisp (file)
• enc-cp1251.lisp (file)
• enc-cp1252.lisp (file)
• jpn-table.lisp (file)
• enc-jpn.lisp (file)
• enc-gbk.lisp (file)
• enc-koi8.lisp (file)
• external-format.lisp (file)
• strings.lisp (file)
• gbk-map.lisp (file)
• sharp-backslash.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 babel.asd

Location

babel.asd

Systems

babel (system)

4.1.2 babel/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• babel
• babel-encodings

4.1.3 babel/src/encodings.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/encodings.lisp

Exported Definitions

• *default-character-encoding* (special variable)
• *suppress-character-coding-errors* (special variable)
• ambiguous-encoding-p (method)
• ambiguous-encoding-p (method)
• character-coding-error (condition)
• character-coding-error-buffer (method)
• character-coding-error-encoding (method)
• character-coding-error-position (method)
• character-decoding-error (condition)
• character-decoding-error-octets (method)
• character-encoding (class)
• character-encoding-error (condition)
• character-encoding-error-code (method)
• character-out-of-range (condition)
• code-point-counter (method)
• (setf code-point-counter) (method)
• decoder (method)
• (setf decoder) (method)
• enc-aliases (method)
• enc-bom-encoding (method)
• enc-code-unit-size (method)
• enc-decode-literal-code-unit-limit (method)
• enc-default-replacement (method)
• enc-encode-literal-code-unit-limit (method)
• enc-max-units-per-char (method)
• enc-name (method)
• enc-native-endianness (method)
• enc-nul-encoding (method)
• enc-use-bom (method)
• encoder (method)
• (setf encoder) (method)
• end-of-input-in-character (condition)
• get-character-encoding (function)
• instantiate-concrete-mappings (macro)
• list-character-encodings (function)
• octet-counter (method)
• (setf octet-counter) (method)

Internal Definitions

• %register-mapping-part (function)
• *abstract-mappings* (special variable)
• *character-encodings* (special variable)
• *supported-character-encodings* (special variable)
• +default-substitution-code-point+ (constant)
• abstract-mapping (class)
• code-point (type)
• code-point-counter-factory (method)
• (setf code-point-counter-factory) (method)
• concrete-mapping (class)
• decoder-factory (method)
• (setf decoder-factory) (method)
• decoding-error (function)
• define-character-encoding (macro)
• define-code-point-counter (macro)
• define-decoder (macro)
• define-encoder (macro)
• define-octet-counter (macro)
• define-unibyte-decoder (macro)
• define-unibyte-encoder (macro)
• enc-documentation (method)
• encoder-factory (method)
• (setf encoder-factory) (method)
• encoding-error (function)
• get-abstract-mapping (function)
• (setf get-abstract-mapping) (function)
• instantiate-code-point-counter (function)
• instantiate-decoder (function)
• instantiate-encoder (function)
• instantiate-octet-counter (function)
• make-dummy-coder (function)
• make-fixed-width-counter (function)
• notice-character-encoding (function)
• octet-counter-factory (method)
• (setf octet-counter-factory) (method)
• ub8 (type)

4.1.4 babel/src/enc-ascii.lisp

Dependency

encodings.lisp (file)

Parent

src (module)

Location

src/enc-ascii.lisp

4.1.5 babel/src/enc-ebcdic.lisp

Dependency

enc-ascii.lisp (file)

Parent

src (module)

Location

src/enc-ebcdic.lisp

Internal Definitions

• +ebcdic-decode-table+ (constant)
• +ebcdic-encode-table+ (constant)

4.1.6 babel/src/enc-ebcdic-int.lisp

Dependency

enc-ebcdic.lisp (file)

Parent

src (module)

Location

src/enc-ebcdic-int.lisp

Internal Definitions

• +ebcdic-int-to-unicode+ (special variable)
• +unicode-0410-0450-ebcdic-int+ (special variable)
• +unicode-upto-ac-ebcdic-int+ (special variable)

4.1.7 babel/src/enc-iso-8859.lisp

Dependency

enc-ebcdic-int.lisp (file)

Parent

src (module)

Location

src/enc-iso-8859.lisp

Internal Definitions

• +iso-8859-10-to-unicode+ (constant)
• +iso-8859-13-to-unicode+ (constant)
• +iso-8859-14-to-unicode+ (constant)
• +iso-8859-15-to-unicode+ (constant)
• +iso-8859-16-to-unicode+ (constant)
• +iso-8859-2-to-unicode+ (constant)
• +iso-8859-3-to-unicode+ (constant)
• +iso-8859-4-to-unicode+ (constant)
• +iso-8859-5-to-unicode+ (constant)
• +iso-8859-6-to-unicode+ (constant)
• +iso-8859-7-to-unicode+ (constant)
• +iso-8859-8-to-unicode+ (constant)
• +iso-8859-9-to-unicode+ (constant)
• +unicode-00a0-0180-to-iso-8859-2+ (constant)
• +unicode-02c0-02e0-to-iso-8859-2+ (constant)
• +unicode-108-128-to-iso-8859-14+ (constant)
• +unicode-108-180-to-iso-8859-3+ (constant)
• +unicode-118-160-to-iso-8859-9+ (constant)
• +unicode-150-180-to-iso-8859-15+ (constant)
• +unicode-170-180-to-iso-8859-14+ (constant)
• +unicode-1e00-1e88-to-iso-8859-14+ (constant)
• +unicode-1ef0-1ef8-to-iso-8859-14+ (constant)
• +unicode-2008-2018-to-iso-8859-8+ (constant)
• +unicode-2010-2020-to-iso-8859-7+ (constant)
• +unicode-2018-2020-to-iso-8859-13+ (constant)
• +unicode-2018-2020-to-iso-8859-16+ (constant)
• +unicode-20ac-20b0-to-iso-8859-7+ (constant)
• +unicode-218-220-to-iso-8859-16+ (constant)
• +unicode-2c0-2e0-to-iso-8859-4+ (constant)
• +unicode-2d8-2e0-to-iso-8859-3+ (constant)
• +unicode-378-3d0-to-iso-8859-7+ (constant)
• +unicode-400-460-to-iso-8859-5+ (constant)
• +unicode-5d0-5f0-to-iso-8859-8+ (constant)
• +unicode-608-658-to-iso-8859-6+ (constant)
• +unicode-a0-100-to-iso-8859-14+ (constant)
• +unicode-a0-100-to-iso-8859-15+ (constant)
• +unicode-a0-100-to-iso-8859-3+ (constant)
• +unicode-a0-180-to-iso-8859-10+ (constant)
• +unicode-a0-180-to-iso-8859-13+ (constant)
• +unicode-a0-180-to-iso-8859-16+ (constant)
• +unicode-a0-180-to-iso-8859-4+ (constant)
• +unicode-a0-b0-to-iso-8859-5+ (constant)
• +unicode-a0-b0-to-iso-8859-6+ (constant)
• +unicode-a0-c0-to-iso-8859-7+ (constant)
• +unicode-a0-f8-to-iso-8859-8+ (constant)
• +unicode-d0-100-to-iso-8859-9+ (constant)

4.1.8 babel/src/enc-unicode.lisp

Dependency

enc-iso-8859.lisp (file)

Parent

src (module)

Location

src/enc-unicode.lisp

Exported Definitions

• invalid-utf8-continuation-byte (condition)
• invalid-utf8-starter-byte (condition)
• overlong-utf8-sequence (condition)

Internal Definitions

• +byte-order-mark-code+ (constant)
• +repl+ (constant)
• +swapped-byte-order-mark-code+ (constant)
• +swapped-byte-order-mark-code-32+ (constant)
• define-ucs (macro)
• define-utf-16 (macro)
• f-ash (macro)
• f-logand (macro)
• f-logior (macro)
• f-logxor (macro)
• utf-16-combine-surrogate-pairs (macro)
• utf16-octet-counter (macro)

4.1.9 babel/src/enc-cp1251.lisp

Dependency

enc-unicode.lisp (file)

Parent

src (module)

Location

src/enc-cp1251.lisp

Internal Definitions

• +cp1251-to-unicode+ (constant)
• +unicode-0-97-to-cp1251+ (constant)
• +unicode-10-3f-to-cp1251+ (constant)
• +unicode-a0-bf-to-cp1251+ (constant)

4.1.10 babel/src/enc-cp1252.lisp

Dependency

enc-cp1251.lisp (file)

Parent

src (module)

Location

src/enc-cp1252.lisp

Internal Definitions

• +cp1252-to-unicode+ (constant)
• +unicode-0152-017e-cp1252+ (constant)
• +unicode-2013-203a-cp1252+ (constant)

4.1.11 babel/src/jpn-table.lisp

Dependency

enc-cp1252.lisp (file)

Parent

src (module)

Location

src/jpn-table.lisp

Internal Definitions

• *cp932-only* (special variable)
• *eucjp* (special variable)
• *eucjp-only* (special variable)

4.1.12 babel/src/enc-jpn.lisp

Dependency

jpn-table.lisp (file)

Parent

src (module)

Location

src/enc-jpn.lisp

Internal Definitions

• *cp932-to-ucs-hash* (special variable)
• *eucjp-to-ucs-hash* (special variable)
• *ucs-to-cp932-hash* (special variable)
• *ucs-to-eucjp-hash* (special variable)
• cp932-to-ucs (function)
• eucjp-to-ucs (function)
• ucs-to-cp932 (function)
• ucs-to-eucjp (function)

4.1.13 babel/src/enc-gbk.lisp

Dependency

enc-jpn.lisp (file)

Parent

src (module)

Location

src/enc-gbk.lisp

Internal Definitions

• +gbk1-offset+ (constant)
• +gbk2-offset+ (constant)
• +gbk3-offset+ (constant)
• +gbk4-offset+ (constant)
• +gbk5-offset+ (constant)
• invalid-gbk-byte (condition)
• invalid-gbk-character (condition)

4.1.14 babel/src/enc-koi8.lisp

Dependency

enc-gbk.lisp (file)

Parent

src (module)

Location

src/enc-koi8.lisp

Internal Definitions

• +koi8-r-to-unicode+ (constant)
• +koi8-ru-to-unicode+ (constant)
• +koi8-u-to-unicode+ (constant)
• +unicode-04->koi8-ru+ (constant)
• +unicode-x04->koi8-r+ (constant)
• +unicode-x04->koi8-u+ (constant)
• +unicode-x25->koi8-r+ (constant)
• +unicode-x25->koi8-u+ (constant)

4.1.15 babel/src/external-format.lisp

Dependency

enc-koi8.lisp (file)

Parent

src (module)

Location

src/external-format.lisp

Exported Definitions

• *default-eol-style* (special variable)
• ensure-external-format (function)
• external-format (class)
• external-format-encoding (method)
• external-format-eol-style (method)
• external-format-equal (function)
• lookup-mapping (function)
• make-external-format (function)

Internal Definitions

eol-style (type)

4.1.16 babel/src/strings.lisp

Dependency

external-format.lisp (file)

Parent

src (module)

Location

src/strings.lisp

Exported Definitions

• concatenate-strings-to-octets (function)
• octets-to-string (function)
• simple-unicode-string (type)
• string-size-in-octets (function)
• string-to-octets (function)
• unicode-char (type)
• unicode-char-code-limit (constant)
• unicode-string (type)
• vector-size-in-chars (function)
• with-checked-simple-vector (macro)
• with-simple-vector (macro)

Internal Definitions

• *simple-base-string-vector-mappings* (special variable)
• *string-vector-mappings* (special variable)
• bom-vector (function)
• check-vector-bounds (function)
• string-get (macro)
• string-set (macro)
• ub-get (macro)
• ub-set (macro)

4.1.17 babel/src/gbk-map.lisp

Dependency

strings.lisp (file)

Parent

src (module)

Location

src/gbk-map.lisp

Internal Definitions

*gbk-unicode-mapping* (special variable)

4.1.18 babel/src/sharp-backslash.lisp

Dependency

gbk-map.lisp (file)

Parent

src (module)

Location

src/sharp-backslash.lisp

Exported Definitions

• enable-sharp-backslash-syntax (macro)
• set-sharp-backslash-syntax-in-readtable (function)

Internal Definitions

• make-sharp-backslash-reader (function)
• sharp-backslash-reader (function)

5 Packages

Packages are listed by definition order.

5.1 babel

Source

packages.lisp (file)

Use List

• alexandria.1.0.0
• babel-encodings
• common-lisp

Exported Definitions

• *default-eol-style* (special variable)
• concatenate-strings-to-octets (function)
• enable-sharp-backslash-syntax (macro)
• ensure-external-format (function)
• external-format (class)
• external-format-encoding (generic function)
• external-format-encoding (method)
• external-format-eol-style (generic function)
• external-format-eol-style (method)
• external-format-equal (function)
• make-external-format (function)
• octets-to-string (function)
• set-sharp-backslash-syntax-in-readtable (function)
• simple-unicode-string (type)
• string-size-in-octets (function)
• string-to-octets (function)
• unicode-char (type)
• unicode-char-code-limit (constant)
• unicode-string (type)
• vector-size-in-chars (function)

Internal Definitions

• *simple-base-string-vector-mappings* (special variable)
• *string-vector-mappings* (special variable)
• bom-vector (function)
• check-vector-bounds (function)
• eol-style (type)
• make-sharp-backslash-reader (function)
• sharp-backslash-reader (function)
• string-get (macro)
• string-set (macro)
• ub-get (macro)
• ub-set (macro)

5.2 babel-encodings

Source

packages.lisp (file)

Use List

• alexandria.1.0.0
• common-lisp

Used By List

babel

Exported Definitions

• *default-character-encoding* (special variable)
• *suppress-character-coding-errors* (special variable)
• ambiguous-encoding-p (generic function)
• ambiguous-encoding-p (method)
• ambiguous-encoding-p (method)
• character-coding-error (condition)
• character-coding-error-buffer (generic function)
• character-coding-error-buffer (method)
• character-coding-error-encoding (generic function)
• character-coding-error-encoding (method)
• character-coding-error-position (generic function)
• character-coding-error-position (method)
• character-decoding-error (condition)
• character-decoding-error-octets (generic function)
• character-decoding-error-octets (method)
• character-encoding (class)
• character-encoding-error (condition)
• character-encoding-error-code (generic function)
• character-encoding-error-code (method)
• character-out-of-range (condition)
• code-point-counter (generic function)
• code-point-counter (method)
• (setf code-point-counter) (method)
• (setf code-point-counter) (generic function)
• decoder (generic function)
• decoder (method)
• (setf decoder) (method)
• (setf decoder) (generic function)
• enc-aliases (generic function)
• enc-aliases (method)
• enc-bom-encoding (generic function)
• enc-bom-encoding (method)
• enc-code-unit-size (generic function)
• enc-code-unit-size (method)
• enc-decode-literal-code-unit-limit (generic function)
• enc-decode-literal-code-unit-limit (method)
• enc-default-replacement (generic function)
• enc-default-replacement (method)
• enc-encode-literal-code-unit-limit (generic function)
• enc-encode-literal-code-unit-limit (method)
• enc-max-units-per-char (generic function)
• enc-max-units-per-char (method)
• enc-name (generic function)
• enc-name (method)
• enc-native-endianness (generic function)
• enc-native-endianness (method)
• enc-nul-encoding (generic function)
• enc-nul-encoding (method)
• enc-use-bom (generic function)
• enc-use-bom (method)
• encoder (generic function)
• encoder (method)
• (setf encoder) (method)
• (setf encoder) (generic function)
• end-of-input-in-character (condition)
• get-character-encoding (function)
• instantiate-concrete-mappings (macro)
• invalid-utf8-continuation-byte (condition)
• invalid-utf8-starter-byte (condition)
• list-character-encodings (function)
• lookup-mapping (function)
• octet-counter (generic function)
• octet-counter (method)
• (setf octet-counter) (method)
• (setf octet-counter) (generic function)
• overlong-utf8-sequence (condition)
• with-checked-simple-vector (macro)
• with-simple-vector (macro)

Internal Definitions

• %register-mapping-part (function)
• *abstract-mappings* (special variable)
• *character-encodings* (special variable)
• *cp932-only* (special variable)
• *cp932-to-ucs-hash* (special variable)
• *eucjp* (special variable)
• *eucjp-only* (special variable)
• *eucjp-to-ucs-hash* (special variable)
• *gbk-unicode-mapping* (special variable)
• *supported-character-encodings* (special variable)
• *ucs-to-cp932-hash* (special variable)
• *ucs-to-eucjp-hash* (special variable)
• +byte-order-mark-code+ (constant)
• +cp1251-to-unicode+ (constant)
• +cp1252-to-unicode+ (constant)
• +default-substitution-code-point+ (constant)
• +ebcdic-decode-table+ (constant)
• +ebcdic-encode-table+ (constant)
• +ebcdic-int-to-unicode+ (special variable)
• +gbk1-offset+ (constant)
• +gbk2-offset+ (constant)
• +gbk3-offset+ (constant)
• +gbk4-offset+ (constant)
• +gbk5-offset+ (constant)
• +iso-8859-10-to-unicode+ (constant)
• +iso-8859-13-to-unicode+ (constant)
• +iso-8859-14-to-unicode+ (constant)
• +iso-8859-15-to-unicode+ (constant)
• +iso-8859-16-to-unicode+ (constant)
• +iso-8859-2-to-unicode+ (constant)
• +iso-8859-3-to-unicode+ (constant)
• +iso-8859-4-to-unicode+ (constant)
• +iso-8859-5-to-unicode+ (constant)
• +iso-8859-6-to-unicode+ (constant)
• +iso-8859-7-to-unicode+ (constant)
• +iso-8859-8-to-unicode+ (constant)
• +iso-8859-9-to-unicode+ (constant)
• +koi8-r-to-unicode+ (constant)
• +koi8-ru-to-unicode+ (constant)
• +koi8-u-to-unicode+ (constant)
• +repl+ (constant)
• +swapped-byte-order-mark-code+ (constant)
• +swapped-byte-order-mark-code-32+ (constant)
• +unicode-0-97-to-cp1251+ (constant)
• +unicode-00a0-0180-to-iso-8859-2+ (constant)
• +unicode-0152-017e-cp1252+ (constant)
• +unicode-02c0-02e0-to-iso-8859-2+ (constant)
• +unicode-04->koi8-ru+ (constant)
• +unicode-0410-0450-ebcdic-int+ (special variable)
• +unicode-10-3f-to-cp1251+ (constant)
• +unicode-108-128-to-iso-8859-14+ (constant)
• +unicode-108-180-to-iso-8859-3+ (constant)
• +unicode-118-160-to-iso-8859-9+ (constant)
• +unicode-150-180-to-iso-8859-15+ (constant)
• +unicode-170-180-to-iso-8859-14+ (constant)
• +unicode-1e00-1e88-to-iso-8859-14+ (constant)
• +unicode-1ef0-1ef8-to-iso-8859-14+ (constant)
• +unicode-2008-2018-to-iso-8859-8+ (constant)
• +unicode-2010-2020-to-iso-8859-7+ (constant)
• +unicode-2013-203a-cp1252+ (constant)
• +unicode-2018-2020-to-iso-8859-13+ (constant)
• +unicode-2018-2020-to-iso-8859-16+ (constant)
• +unicode-20ac-20b0-to-iso-8859-7+ (constant)
• +unicode-218-220-to-iso-8859-16+ (constant)
• +unicode-2c0-2e0-to-iso-8859-4+ (constant)
• +unicode-2d8-2e0-to-iso-8859-3+ (constant)
• +unicode-378-3d0-to-iso-8859-7+ (constant)
• +unicode-400-460-to-iso-8859-5+ (constant)
• +unicode-5d0-5f0-to-iso-8859-8+ (constant)
• +unicode-608-658-to-iso-8859-6+ (constant)
• +unicode-a0-100-to-iso-8859-14+ (constant)
• +unicode-a0-100-to-iso-8859-15+ (constant)
• +unicode-a0-100-to-iso-8859-3+ (constant)
• +unicode-a0-180-to-iso-8859-10+ (constant)
• +unicode-a0-180-to-iso-8859-13+ (constant)
• +unicode-a0-180-to-iso-8859-16+ (constant)
• +unicode-a0-180-to-iso-8859-4+ (constant)
• +unicode-a0-b0-to-iso-8859-5+ (constant)
• +unicode-a0-b0-to-iso-8859-6+ (constant)
• +unicode-a0-bf-to-cp1251+ (constant)
• +unicode-a0-c0-to-iso-8859-7+ (constant)
• +unicode-a0-f8-to-iso-8859-8+ (constant)
• +unicode-d0-100-to-iso-8859-9+ (constant)
• +unicode-upto-ac-ebcdic-int+ (special variable)
• +unicode-x04->koi8-r+ (constant)
• +unicode-x04->koi8-u+ (constant)
• +unicode-x25->koi8-r+ (constant)
• +unicode-x25->koi8-u+ (constant)
• abstract-mapping (class)
• code-point (type)
• code-point-counter-factory (generic function)
• code-point-counter-factory (method)
• (setf code-point-counter-factory) (method)
• (setf code-point-counter-factory) (generic function)
• concrete-mapping (class)
• cp932-to-ucs (function)
• decoder-factory (generic function)
• decoder-factory (method)
• (setf decoder-factory) (method)
• (setf decoder-factory) (generic function)
• decoding-error (function)
• define-character-encoding (macro)
• define-code-point-counter (macro)
• define-decoder (macro)
• define-encoder (macro)
• define-octet-counter (macro)
• define-ucs (macro)
• define-unibyte-decoder (macro)
• define-unibyte-encoder (macro)
• define-utf-16 (macro)
• enc-documentation (generic function)
• enc-documentation (method)
• encoder-factory (generic function)
• encoder-factory (method)
• (setf encoder-factory) (method)
• (setf encoder-factory) (generic function)
• encoding-error (function)
• eucjp-to-ucs (function)
• f-ash (macro)
• f-logand (macro)
• f-logior (macro)
• f-logxor (macro)
• get-abstract-mapping (function)
• (setf get-abstract-mapping) (function)
• instantiate-code-point-counter (function)
• instantiate-decoder (function)
• instantiate-encoder (function)
• instantiate-octet-counter (function)
• invalid-gbk-byte (condition)
• invalid-gbk-character (condition)
• make-dummy-coder (function)
• make-fixed-width-counter (function)
• notice-character-encoding (function)
• octet-counter-factory (generic function)
• octet-counter-factory (method)
• (setf octet-counter-factory) (method)
• (setf octet-counter-factory) (generic function)
• ub8 (type)
• ucs-to-cp932 (function)
• ucs-to-eucjp (function)
• utf-16-combine-surrogate-pairs (macro)
• utf16-octet-counter (macro)

6 Definitions

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

6.1 Exported definitions

6.1.1 Constants

Constant: unicode-char-code-limit

An alias for CL:CHAR-CODE-LIMIT which might be lower than #x110000 on some Lisps.

Package

babel

Source

strings.lisp (file)

6.1.2 Special variables

Special Variable: *default-character-encoding*

Special variable used to determine the default character encoding.

Package

babel-encodings

Source

encodings.lisp (file)

Special Variable: *default-eol-style*

The end-of-line style used by external formats if none is explicitly given. Depends on the OS the code is compiled on.

Package

babel

Source

external-format.lisp (file)

Special Variable: *suppress-character-coding-errors*

If non-NIL, encoding or decoding errors are suppressed and the the current character encoding’s default replacement character is used.

Package

babel-encodings

Source

encodings.lisp (file)

6.1.3 Macros

Macro: enable-sharp-backslash-syntax ()

Package

babel

Source

sharp-backslash.lisp (file)

Macro: instantiate-concrete-mappings &key ENCODINGS OPTIMIZE OCTET-SEQ-GETTER OCTET-SEQ-SETTER OCTET-SEQ-TYPE CODE-POINT-SEQ-GETTER CODE-POINT-SEQ-SETTER CODE-POINT-SEQ-TYPE INSTANTIATE-DECODERS

Package

babel-encodings

Source

encodings.lisp (file)

Macro: with-checked-simple-vector ((V VECTOR) (S START) (E END)) &body BODY

Like WITH-SIMPLE-VECTOR but bound-checks START and END.

Package

babel-encodings

Source

strings.lisp (file)

Macro: with-simple-vector ((V VECTOR) (S START) (E END)) &body BODY

If VECTOR is a displaced or adjustable array, binds V to the underlying simple vector, adds an adequate offset to START and END and binds those offset values to S and E. Otherwise, if VECTOR is already a simple array, it’s simply bound to V with no further changes.

START and END are unchecked and assumed to be within bounds.

Note that in some Lisps, a slow copying implementation is necessary to obtain a simple vector thus V will be bound to a copy of VECTOR coerced to a simple-vector. Therefore, you shouldn’t attempt to modify V.

Package

babel-encodings

Source

strings.lisp (file)

6.1.4 Functions

Function: concatenate-strings-to-octets ENCODING &rest STRINGS

Optimized equivalent of
(string-to-octets (apply #’concatenate ’string strings) :encoding encoding)

Package

babel

Source

strings.lisp (file)

Function: ensure-external-format THING

Package

babel

Source

external-format.lisp (file)

Function: external-format-equal EF1 EF2

Package

babel

Source

external-format.lisp (file)

Function: get-character-encoding NAME

Lookups the character encoding denoted by the keyword symbol NAME. Signals an error if one is not found. If NAME is already a CHARACTER-ENCONDING object, it is returned unmodified.

Package

babel-encodings

Source

encodings.lisp (file)

Function: list-character-encodings ()

List of keyword symbols denoting supported character encodings. This list does not include aliases.

Package

babel-encodings

Source

encodings.lisp (file)

Function: lookup-mapping HT ENCODING

HT should be an hashtable created by INSTANTIATE-CONCRETE-MAPPINGS. ENCODING should be either an external format, an encoding object or a keyword symbol denoting a character encoding name or one of its aliases.

Package

babel-encodings

Source

external-format.lisp (file)

Function: make-external-format ENCODING &key EOL-STYLE

Package

babel

Source

external-format.lisp (file)

Function: octets-to-string VECTOR &key START END ERRORP ENCODING

Package

babel

Source

strings.lisp (file)

Function: set-sharp-backslash-syntax-in-readtable ()

Package

babel

Source

sharp-backslash.lisp (file)

Function: string-size-in-octets STRING &key START END MAX ERRORP ENCODING

Package

babel

Source

strings.lisp (file)

Function: string-to-octets STRING &key ENCODING START END USE-BOM ERRORP

Package

babel

Source

strings.lisp (file)

Function: vector-size-in-chars VECTOR &key START END MAX ERRORP ENCODING

Package

babel

Source

strings.lisp (file)

6.1.5 Generic functions

Generic Function: ambiguous-encoding-p OBJECT

Package

babel-encodings

Methods

Method: ambiguous-encoding-p (ENCODING symbol)

Source

encodings.lisp (file)

Method: ambiguous-encoding-p (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: character-coding-error-buffer CONDITION

Package

babel-encodings

Methods

Method: character-coding-error-buffer (CONDITION character-coding-error)

Source

encodings.lisp (file)

Generic Function: character-coding-error-encoding CONDITION

Package

babel-encodings

Methods

Method: character-coding-error-encoding (CONDITION character-coding-error)

Source

encodings.lisp (file)

Generic Function: character-coding-error-position CONDITION

Package

babel-encodings

Methods

Method: character-coding-error-position (CONDITION character-coding-error)

Source

encodings.lisp (file)

Generic Function: character-decoding-error-octets CONDITION

Package

babel-encodings

Methods

Method: character-decoding-error-octets (CONDITION character-decoding-error)

Source

encodings.lisp (file)

Generic Function: character-encoding-error-code CONDITION

Package

babel-encodings

Methods

Method: character-encoding-error-code (CONDITION character-encoding-error)

Source

encodings.lisp (file)

Generic Function: code-point-counter OBJECT

Generic Function: (setf code-point-counter) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: code-point-counter (CONCRETE-MAPPING concrete-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf code-point-counter) NEW-VALUE (CONCRETE-MAPPING concrete-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: decoder OBJECT

Generic Function: (setf decoder) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: decoder (CONCRETE-MAPPING concrete-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf decoder) NEW-VALUE (CONCRETE-MAPPING concrete-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: enc-aliases OBJECT

Package

babel-encodings

Methods

Method: enc-aliases (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-bom-encoding OBJECT

Package

babel-encodings

Methods

Method: enc-bom-encoding (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-code-unit-size OBJECT

Package

babel-encodings

Methods

Method: enc-code-unit-size (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-decode-literal-code-unit-limit OBJECT

Package

babel-encodings

Methods

Method: enc-decode-literal-code-unit-limit (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-default-replacement OBJECT

Package

babel-encodings

Methods

Method: enc-default-replacement (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-encode-literal-code-unit-limit OBJECT

Package

babel-encodings

Methods

Method: enc-encode-literal-code-unit-limit (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-max-units-per-char OBJECT

Package

babel-encodings

Methods

Method: enc-max-units-per-char (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-name OBJECT

Package

babel-encodings

Methods

Method: enc-name (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-native-endianness OBJECT

Package

babel-encodings

Methods

Method: enc-native-endianness (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-nul-encoding OBJECT

Package

babel-encodings

Methods

Method: enc-nul-encoding (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: enc-use-bom OBJECT

Package

babel-encodings

Methods

Method: enc-use-bom (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: encoder OBJECT

Generic Function: (setf encoder) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: encoder (CONCRETE-MAPPING concrete-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf encoder) NEW-VALUE (CONCRETE-MAPPING concrete-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: external-format-encoding OBJECT

Package

babel

Methods

Method: external-format-encoding (EXTERNAL-FORMAT external-format)

automatically generated reader method

Source

external-format.lisp (file)

Generic Function: external-format-eol-style OBJECT

Package

babel

Methods

Method: external-format-eol-style (EXTERNAL-FORMAT external-format)

automatically generated reader method

Source

external-format.lisp (file)

Generic Function: octet-counter OBJECT

Generic Function: (setf octet-counter) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: octet-counter (CONCRETE-MAPPING concrete-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf octet-counter) NEW-VALUE (CONCRETE-MAPPING concrete-mapping)

automatically generated writer method

Source

encodings.lisp (file)

6.1.6 Conditions

Condition: character-coding-error ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

• character-encoding-error (condition)
• character-decoding-error (condition)

Direct methods

• character-coding-error-encoding (method)
• character-coding-error-position (method)
• character-coding-error-buffer (method)

Direct slots

Slot: buffer

Initargs

:buffer

Readers

character-coding-error-buffer (generic function)

Slot: position

Initargs

:position

Readers

character-coding-error-position (generic function)

Slot: encoding

Initargs

:encoding

Readers

character-coding-error-encoding (generic function)

Condition: character-decoding-error ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

character-coding-error (condition)

Direct subclasses

• end-of-input-in-character (condition)
• character-out-of-range (condition)
• invalid-utf8-starter-byte (condition)
• invalid-utf8-continuation-byte (condition)
• overlong-utf8-sequence (condition)
• invalid-gbk-byte (condition)

Direct methods

character-decoding-error-octets (method)

Direct slots

Slot: octets

Initargs

:octets

Readers

character-decoding-error-octets (generic function)

Condition: character-encoding-error ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

character-coding-error (condition)

Direct subclasses

invalid-gbk-character (condition)

Direct methods

character-encoding-error-code (method)

Direct slots

Slot: code

Initargs

:code

Readers

character-encoding-error-code (generic function)

Condition: character-out-of-range ()

Signalled when the character being decoded is out of range.

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

character-decoding-error (condition)

Condition: end-of-input-in-character ()

Signalled by DECODERs or CODE-POINT-COUNTERs of variable-width character encodings.

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

character-decoding-error (condition)

Condition: invalid-utf8-continuation-byte ()

Signalled when an invalid UTF-8 continuation byte is found.

Package

babel-encodings

Source

enc-unicode.lisp (file)

Direct superclasses

character-decoding-error (condition)

Condition: invalid-utf8-starter-byte ()

Signalled when an invalid UTF-8 starter byte is found.

Package

babel-encodings

Source

enc-unicode.lisp (file)

Direct superclasses

character-decoding-error (condition)

Condition: overlong-utf8-sequence ()

Signalled upon overlong UTF-8 sequences.

Package

babel-encodings

Source

enc-unicode.lisp (file)

Direct superclasses

character-decoding-error (condition)

6.1.7 Classes

Class: character-encoding ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• initialize-instance (method)
• ambiguous-encoding-p (method)
• enc-default-replacement (method)
• enc-nul-encoding (method)
• enc-bom-encoding (method)
• enc-use-bom (method)
• enc-encode-literal-code-unit-limit (method)
• enc-decode-literal-code-unit-limit (method)
• enc-native-endianness (method)
• enc-max-units-per-char (method)
• enc-code-unit-size (method)
• enc-aliases (method)
• enc-documentation (method)
• enc-name (method)

Direct slots

Slot: name

Initargs

:name

Initform

(error "must specify a name for this character encoding.")

Readers

enc-name (generic function)

Slot: documentation

Initargs

:documentation

Readers

enc-documentation (generic function)

Slot: aliases

Initargs

:aliases

Readers

enc-aliases (generic function)

Slot: code-unit-size

Initargs

:code-unit-size

Initform

8

Readers

enc-code-unit-size (generic function)

Slot: max-units-per-char

Initargs

:max-units-per-char

Initform

1

Readers

enc-max-units-per-char (generic function)

Slot: native-endianness

Initargs

:native-endianness

Initform

t

Readers

enc-native-endianness (generic function)

Slot: decode-literal-code-unit-limit

Initargs

:decode-literal-code-unit-limit

Initform

0

Readers

enc-decode-literal-code-unit-limit (generic function)

Slot: encode-literal-code-unit-limit

Initargs

:encode-literal-code-unit-limit

Initform

0

Readers

enc-encode-literal-code-unit-limit (generic function)

Slot: use-bom

Initargs

:use-bom

Readers

enc-use-bom (generic function)

Slot: bom-encoding

Initargs

:bom-encoding

Readers

enc-bom-encoding (generic function)

Slot: nul-encoding

Initargs

:nul-encoding

Initform

#(0)

Readers

enc-nul-encoding (generic function)

Slot: default-replacement

Initargs

:default-replacement

Initform

26

Readers

enc-default-replacement (generic function)

Slot: ambiguous

Initargs

:ambiguous

Readers

ambiguous-encoding-p (generic function)

Class: external-format ()

An EXTERNAL-FORMAT consists in a combination of a Babel CHARACTER-ENCODING and an end-of-line style.

Package

babel

Source

external-format.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• external-format-eol-style (method)
• external-format-encoding (method)

Direct slots

Slot: encoding

Type

babel-encodings:character-encoding

Initargs

:encoding

Readers

external-format-encoding (generic function)

Slot: eol-style

Type

babel::eol-style

Initargs

:eol-style

Initform

babel:*default-eol-style*

Readers

external-format-eol-style (generic function)

6.1.8 Types

Type: simple-unicode-string ()

Alias for (SIMPLE-ARRAY UNICODE-CHAR (*)).

Package

babel

Source

strings.lisp (file)

Type: unicode-char ()

This character type can hold any characters whose CHAR-CODEs are less than UNICODE-CHAR-CODE-LIMIT.

Package

babel

Source

strings.lisp (file)

Type: unicode-string ()

Alias for (VECTOR UNICODE-CHAR *).

Package

babel

Source

strings.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: +byte-order-mark-code+

Package

babel-encodings

Source

enc-unicode.lisp (file)

Constant: +cp1251-to-unicode+

Package

babel-encodings

Source

enc-cp1251.lisp (file)

Constant: +cp1252-to-unicode+

Package

babel-encodings

Source

enc-cp1252.lisp (file)

Constant: +default-substitution-code-point+

Default ASCII substitution character code point used in case of an encoding/decoding error.

Package

babel-encodings

Source

encodings.lisp (file)

Constant: +ebcdic-decode-table+

Package

babel-encodings

Source

enc-ebcdic.lisp (file)

Constant: +ebcdic-encode-table+

Package

babel-encodings

Source

enc-ebcdic.lisp (file)

Constant: +gbk1-offset+

Package

babel-encodings

Source

enc-gbk.lisp (file)

Constant: +gbk2-offset+

Package

babel-encodings

Source

enc-gbk.lisp (file)

Constant: +gbk3-offset+

Package

babel-encodings

Source

enc-gbk.lisp (file)

Constant: +gbk4-offset+

Package

babel-encodings

Source

enc-gbk.lisp (file)

Constant: +gbk5-offset+

Package

babel-encodings

Source

enc-gbk.lisp (file)

Constant: +iso-8859-10-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-13-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-14-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-15-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-16-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-2-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-3-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-4-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-5-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-6-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-7-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-8-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +iso-8859-9-to-unicode+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +koi8-r-to-unicode+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +koi8-ru-to-unicode+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +koi8-u-to-unicode+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +repl+

Unicode replacement character code point.

Package

babel-encodings

Source

enc-unicode.lisp (file)

Constant: +swapped-byte-order-mark-code+

Package

babel-encodings

Source

enc-unicode.lisp (file)

Constant: +swapped-byte-order-mark-code-32+

Package

babel-encodings

Source

enc-unicode.lisp (file)

Constant: +unicode-0-97-to-cp1251+

Package

babel-encodings

Source

enc-cp1251.lisp (file)

Constant: +unicode-00a0-0180-to-iso-8859-2+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-0152-017e-cp1252+

Package

babel-encodings

Source

enc-cp1252.lisp (file)

Constant: +unicode-02c0-02e0-to-iso-8859-2+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-04->koi8-ru+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +unicode-10-3f-to-cp1251+

Package

babel-encodings

Source

enc-cp1251.lisp (file)

Constant: +unicode-108-128-to-iso-8859-14+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-108-180-to-iso-8859-3+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-118-160-to-iso-8859-9+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-150-180-to-iso-8859-15+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-170-180-to-iso-8859-14+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-1e00-1e88-to-iso-8859-14+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-1ef0-1ef8-to-iso-8859-14+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2008-2018-to-iso-8859-8+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2010-2020-to-iso-8859-7+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2013-203a-cp1252+

Package

babel-encodings

Source

enc-cp1252.lisp (file)

Constant: +unicode-2018-2020-to-iso-8859-13+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2018-2020-to-iso-8859-16+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-20ac-20b0-to-iso-8859-7+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-218-220-to-iso-8859-16+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2c0-2e0-to-iso-8859-4+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-2d8-2e0-to-iso-8859-3+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-378-3d0-to-iso-8859-7+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-400-460-to-iso-8859-5+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-5d0-5f0-to-iso-8859-8+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-608-658-to-iso-8859-6+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-100-to-iso-8859-14+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-100-to-iso-8859-15+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-100-to-iso-8859-3+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-180-to-iso-8859-10+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-180-to-iso-8859-13+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-180-to-iso-8859-16+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-180-to-iso-8859-4+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-b0-to-iso-8859-5+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-b0-to-iso-8859-6+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-bf-to-cp1251+

Package

babel-encodings

Source

enc-cp1251.lisp (file)

Constant: +unicode-a0-c0-to-iso-8859-7+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-a0-f8-to-iso-8859-8+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-d0-100-to-iso-8859-9+

Package

babel-encodings

Source

enc-iso-8859.lisp (file)

Constant: +unicode-x04->koi8-r+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +unicode-x04->koi8-u+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +unicode-x25->koi8-r+

Package

babel-encodings

Source

enc-koi8.lisp (file)

Constant: +unicode-x25->koi8-u+

Package

babel-encodings

Source

enc-koi8.lisp (file)

6.2.2 Special variables

Special Variable: *abstract-mappings*

Package

babel-encodings

Source

encodings.lisp (file)

Special Variable: *character-encodings*

Package

babel-encodings

Source

encodings.lisp (file)

Special Variable: *cp932-only*

Package

babel-encodings

Source

jpn-table.lisp (file)

Special Variable: *cp932-to-ucs-hash*

Package

babel-encodings

Source

enc-jpn.lisp (file)

Special Variable: *eucjp*

Package

babel-encodings

Source

jpn-table.lisp (file)

Special Variable: *eucjp-only*

Package

babel-encodings

Source

jpn-table.lisp (file)

Special Variable: *eucjp-to-ucs-hash*

Package

babel-encodings

Source

enc-jpn.lisp (file)

Special Variable: *gbk-unicode-mapping*

Package

babel-encodings

Source

gbk-map.lisp (file)

Special Variable: *simple-base-string-vector-mappings*

Package

babel

Source

strings.lisp (file)

Special Variable: *string-vector-mappings*

Package

babel

Source

strings.lisp (file)

Special Variable: *supported-character-encodings*

Package

babel-encodings

Source

encodings.lisp (file)

Special Variable: *ucs-to-cp932-hash*

Package

babel-encodings

Source

enc-jpn.lisp (file)

Special Variable: *ucs-to-eucjp-hash*

Package

babel-encodings

Source

enc-jpn.lisp (file)

Special Variable: +ebcdic-int-to-unicode+

Package

babel-encodings

Source

enc-ebcdic-int.lisp (file)

Special Variable: +unicode-0410-0450-ebcdic-int+

Package

babel-encodings

Source

enc-ebcdic-int.lisp (file)

Special Variable: +unicode-upto-ac-ebcdic-int+

Package

babel-encodings

Source

enc-ebcdic-int.lisp (file)

6.2.3 Macros

Macro: define-character-encoding NAME DOCSTRING &body OPTIONS

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-code-point-counter ENCODING (ACC TYPE) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-decoder ENCODING (SA ST DA DT) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-encoder ENCODING (SA ST DA DT) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-octet-counter ENCODING (ACC TYPE) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-ucs NAME BYTES &optional ENDIANNESS LIMIT

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: define-unibyte-decoder ENCODING (OCTET) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-unibyte-encoder ENCODING (CODE) &body BODY

Package

babel-encodings

Source

encodings.lisp (file)

Macro: define-utf-16 NAME &optional ENDIANNESS

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: f-ash INTEGER COUNT

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: f-logand &rest INTEGERS

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: f-logior &rest INTEGERS

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: f-logxor &rest INTEGERS

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: string-get STRING INDEX

Package

babel

Source

strings.lisp (file)

Macro: string-set CODE STRING INDEX

Package

babel

Source

strings.lisp (file)

Macro: ub-get VECTOR INDEX &optional BYTES ENDIANNESS

Package

babel

Source

strings.lisp (file)

Macro: ub-set VALUE VECTOR INDEX &optional BYTES ENDIANNESS

Package

babel

Source

strings.lisp (file)

Macro: utf-16-combine-surrogate-pairs U1 U2

Package

babel-encodings

Source

enc-unicode.lisp (file)

Macro: utf16-octet-counter GETTER TYPE

Package

babel-encodings

Source

enc-unicode.lisp (file)

6.2.4 Functions

Function: %register-mapping-part ENCODING SLOT-NAME FN

Package

babel-encodings

Source

encodings.lisp (file)

Function: bom-vector ENCODING USE-BOM

Package

babel

Source

strings.lisp (file)

Function: check-vector-bounds VECTOR START END

Package

babel

Source

strings.lisp (file)

Function: cp932-to-ucs CODE

Package

babel-encodings

Source

enc-jpn.lisp (file)

Function: decoding-error OCTETS ENC BUF POS &optional SUB E

Package

babel-encodings

Source

encodings.lisp (file)

Function: encoding-error CODE ENC BUF POS &optional SUB E

Package

babel-encodings

Source

encodings.lisp (file)

Function: eucjp-to-ucs CODE

Package

babel-encodings

Source

enc-jpn.lisp (file)

Function: get-abstract-mapping ENCODING

Function: (setf get-abstract-mapping) VALUE ENCODING

Package

babel-encodings

Source

encodings.lisp (file)

Function: instantiate-code-point-counter ENCODING AM OCTET-SEQ-GETTER OCTET-SEQ-TYPE

Package

babel-encodings

Source

encodings.lisp (file)

Function: instantiate-decoder ENCODING AM OCTET-SEQ-GETTER OCTET-SEQ-TYPE CODE-POINT-SEQ-SETTER CODE-POINT-SEQ-TYPE

Package

babel-encodings

Source

encodings.lisp (file)

Function: instantiate-encoder ENCODING AM OCTET-SEQ-GETTER OCTET-SEQ-TYPE CODE-POINT-SEQ-SETTER CODE-POINT-SEQ-TYPE

Package

babel-encodings

Source

encodings.lisp (file)

Function: instantiate-octet-counter ENCODING AM CODE-POINT-SEQ-GETTER CODE-POINT-SEQ-TYPE

Package

babel-encodings

Source

encodings.lisp (file)

Function: make-dummy-coder SG ST DS DT

Package

babel-encodings

Source

encodings.lisp (file)

Function: make-fixed-width-counter GETTER TYPE &optional UNIT-SIZE-IN-BITS

Package

babel-encodings

Source

encodings.lisp (file)

Function: make-sharp-backslash-reader ()

Package

babel

Source

sharp-backslash.lisp (file)

Function: notice-character-encoding ENC

Package

babel-encodings

Source

encodings.lisp (file)

Function: sharp-backslash-reader ORIGINAL-READER STREAM CHAR NUMARG

Package

babel

Source

sharp-backslash.lisp (file)

Function: ucs-to-cp932 CODE

Package

babel-encodings

Source

enc-jpn.lisp (file)

Function: ucs-to-eucjp CODE

Package

babel-encodings

Source

enc-jpn.lisp (file)

6.2.5 Generic functions

Generic Function: code-point-counter-factory OBJECT

Generic Function: (setf code-point-counter-factory) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: code-point-counter-factory (ABSTRACT-MAPPING abstract-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf code-point-counter-factory) NEW-VALUE (ABSTRACT-MAPPING abstract-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: decoder-factory OBJECT

Generic Function: (setf decoder-factory) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: decoder-factory (ABSTRACT-MAPPING abstract-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf decoder-factory) NEW-VALUE (ABSTRACT-MAPPING abstract-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: enc-documentation OBJECT

Package

babel-encodings

Methods

Method: enc-documentation (CHARACTER-ENCODING character-encoding)

automatically generated reader method

Source

encodings.lisp (file)

Generic Function: encoder-factory OBJECT

Generic Function: (setf encoder-factory) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: encoder-factory (ABSTRACT-MAPPING abstract-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf encoder-factory) NEW-VALUE (ABSTRACT-MAPPING abstract-mapping)

automatically generated writer method

Source

encodings.lisp (file)

Generic Function: octet-counter-factory OBJECT

Generic Function: (setf octet-counter-factory) NEW-VALUE OBJECT

Package

babel-encodings

Methods

Method: octet-counter-factory (ABSTRACT-MAPPING abstract-mapping)

automatically generated reader method

Source

encodings.lisp (file)

Method: (setf octet-counter-factory) NEW-VALUE (ABSTRACT-MAPPING abstract-mapping)

automatically generated writer method

Source

encodings.lisp (file)

6.2.6 Conditions

Condition: invalid-gbk-byte ()

Signalled when an invalid GBK byte is found.

Package

babel-encodings

Source

enc-gbk.lisp (file)

Direct superclasses

character-decoding-error (condition)

Condition: invalid-gbk-character ()

Signalled when an invalid GBK character is found.

Package

babel-encodings

Source

enc-gbk.lisp (file)

Direct superclasses

character-encoding-error (condition)

6.2.7 Classes

Class: abstract-mapping ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• code-point-counter-factory (method)
• code-point-counter-factory (method)
• octet-counter-factory (method)
• octet-counter-factory (method)
• decoder-factory (method)
• decoder-factory (method)
• encoder-factory (method)
• encoder-factory (method)

Direct slots

Slot: encoder-factory

Initform

(quote babel-encodings::make-dummy-coder)

Readers

encoder-factory (generic function)

Writers

(setf encoder-factory) (generic function)

Slot: decoder-factory

Initform

(quote babel-encodings::make-dummy-coder)

Readers

decoder-factory (generic function)

Writers

(setf decoder-factory) (generic function)

Slot: octet-counter-factory

Initform

(quote babel-encodings::make-fixed-width-counter)

Readers

octet-counter-factory (generic function)

Writers

(setf octet-counter-factory) (generic function)

Slot: code-point-counter-factory

Initform

(quote babel-encodings::make-fixed-width-counter)

Readers

code-point-counter-factory (generic function)

Writers

(setf code-point-counter-factory) (generic function)

Class: concrete-mapping ()

Package

babel-encodings

Source

encodings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• code-point-counter (method)
• code-point-counter (method)
• octet-counter (method)
• octet-counter (method)
• decoder (method)
• decoder (method)
• encoder (method)
• encoder (method)

Direct slots

Slot: encoder

Readers

encoder (generic function)

Writers

(setf encoder) (generic function)

Slot: decoder

Readers

decoder (generic function)

Writers

(setf decoder) (generic function)

Slot: octet-counter

Readers

octet-counter (generic function)

Writers

(setf octet-counter) (generic function)

Slot: code-point-counter

Readers

code-point-counter (generic function)

Writers

(setf code-point-counter) (generic function)