The babel Reference Manual

4.1.1 babel/babel.asd

Source

babel.asd.

Parent Component

babel (system).

ASDF Systems

babel.

---

4.1.2 babel/src/packages.lisp

Source

babel.asd.

Parent Component

src (module).

Packages

• babel-encodings.
• babel.

---

4.1.3 babel/src/encodings.lisp

Dependency

packages.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Public Interface

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

Internals

• %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 (reader method).
• (setf code-point-counter-factory) (writer method).
• concrete-mapping (class).
• decoder-factory (reader method).
• (setf decoder-factory) (writer 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 (reader method).
• encoder-factory (reader method).
• (setf encoder-factory) (writer 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 (reader method).
• (setf octet-counter-factory) (writer method).
• ub8 (type).

---

4.1.4 babel/src/enc-ascii.lisp

Dependency

encodings.lisp (file).

Source

babel.asd.

Parent Component

src (module).

---

4.1.5 babel/src/enc-ebcdic.lisp

Dependency

enc-ascii.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

• +ebcdic-decode-table+ (constant).
• +ebcdic-encode-table+ (constant).
• ebcdic-fi-decoder (function).
• ebcdic-fi-encoder (function).

---

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

Dependency

enc-ebcdic.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

• +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).

Source

babel.asd.

Parent Component

src (module).

Internals

• +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).

Source

babel.asd.

Parent Component

src (module).

Public Interface

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

Internals

• +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-cp437.lisp

Dependency

enc-unicode.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

+cp437-to-unicode+ (constant).

---

4.1.10 babel/src/enc-cp1251.lisp

Dependency

enc-cp437.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

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

---

4.1.11 babel/src/enc-cp1252.lisp

Dependency

enc-cp1251.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

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

---

4.1.12 babel/src/jpn-table.lisp

Dependency

enc-cp1252.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

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

---

4.1.13 babel/src/enc-jpn.lisp

Dependency

jpn-table.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

• *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.14 babel/src/enc-gbk.lisp

Dependency

enc-jpn.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

• +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.15 babel/src/enc-koi8.lisp

Dependency

enc-gbk.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

• +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.16 babel/src/external-format.lisp

Dependency

enc-koi8.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Public Interface

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

Internals

eol-style (type).

---

4.1.17 babel/src/strings.lisp

Dependency

external-format.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Public Interface

• 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).

Internals

• *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.18 babel/src/gbk-map.lisp

Dependency

strings.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Internals

*gbk-unicode-mapping* (special variable).

---

4.1.19 babel/src/sharp-backslash.lisp

Dependency

gbk-map.lisp (file).

Source

babel.asd.

Parent Component

src (module).

Public Interface

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

Internals

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

---

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.

---

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.

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.

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.

---

6.1.3 Macros

Macro: enable-sharp-backslash-syntax () ¶

Package

babel.

Source

sharp-backslash.lisp.

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.

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.

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.

---

6.1.4 Ordinary 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.

Function: ensure-external-format (thing) ¶

Package

babel.

Source

external-format.lisp.

Function: external-format-equal (ef1 ef2) ¶

Package

babel.

Source

external-format.lisp.

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.

Function: list-character-encodings () ¶

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

Package

babel-encodings.

Source

encodings.lisp.

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.

Function: make-external-format (encoding &key eol-style) ¶

Package

babel.

Source

external-format.lisp.

Function: octets-to-string (vector &key start end errorp encoding) ¶

Package

babel.

Source

strings.lisp.

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

Package

babel.

Source

sharp-backslash.lisp.

Function: string-size-in-octets (string &key start end max errorp encoding) ¶

Package

babel.

Source

strings.lisp.

Function: string-to-octets (string &key encoding start end use-bom errorp) ¶

Package

babel.

Source

strings.lisp.

Function: vector-size-in-chars (vector &key start end max errorp encoding) ¶

Package

babel.

Source

strings.lisp.

---

6.1.5 Generic functions

Generic Function: ambiguous-encoding-p (object) ¶

Package

babel-encodings.

Methods

Method: ambiguous-encoding-p ((encoding symbol)) ¶

Source

encodings.lisp.

Reader Method: ambiguous-encoding-p ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

ambiguous.

Generic Reader: character-coding-error-buffer (condition) ¶

Package

babel-encodings.

Methods

Reader Method: character-coding-error-buffer ((condition character-coding-error)) ¶

Source

encodings.lisp.

Target Slot

buffer.

Generic Reader: character-coding-error-encoding (condition) ¶

Package

babel-encodings.

Methods

Reader Method: character-coding-error-encoding ((condition character-coding-error)) ¶

Source

encodings.lisp.

Target Slot

encoding.

Generic Reader: character-coding-error-position (condition) ¶

Package

babel-encodings.

Methods

Reader Method: character-coding-error-position ((condition character-coding-error)) ¶

Source

encodings.lisp.

Target Slot

position.

Generic Reader: character-decoding-error-octets (condition) ¶

Package

babel-encodings.

Methods

Reader Method: character-decoding-error-octets ((condition character-decoding-error)) ¶

Source

encodings.lisp.

Target Slot

octets.

Generic Reader: character-encoding-error-code (condition) ¶

Package

babel-encodings.

Methods

Reader Method: character-encoding-error-code ((condition character-encoding-error)) ¶

Source

encodings.lisp.

Target Slot

code.

Generic Reader: code-point-counter (object) ¶

Package

babel-encodings.

Methods

Reader Method: code-point-counter ((concrete-mapping concrete-mapping)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

code-point-counter.

Generic Writer: (setf code-point-counter) (object) ¶

Package

babel-encodings.

Methods

Writer Method: (setf code-point-counter) ((concrete-mapping concrete-mapping)) ¶

automatically generated writer method

Source

encodings.lisp.

Target Slot

code-point-counter.

Generic Reader: decoder (object) ¶

Package

babel-encodings.

Methods

Reader Method: decoder ((concrete-mapping concrete-mapping)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

decoder.

Generic Writer: (setf decoder) (object) ¶

Package

babel-encodings.

Methods

Writer Method: (setf decoder) ((concrete-mapping concrete-mapping)) ¶

automatically generated writer method

Source

encodings.lisp.

Target Slot

decoder.

Generic Reader: enc-aliases (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-aliases ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

aliases.

Generic Reader: enc-bom-encoding (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-bom-encoding ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

bom-encoding.

Generic Reader: enc-code-unit-size (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-code-unit-size ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

code-unit-size.

Generic Reader: enc-decode-literal-code-unit-limit (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-decode-literal-code-unit-limit ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

decode-literal-code-unit-limit.

Generic Reader: enc-default-replacement (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-default-replacement ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

default-replacement.

Generic Reader: enc-encode-literal-code-unit-limit (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-encode-literal-code-unit-limit ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

encode-literal-code-unit-limit.

Generic Reader: enc-max-units-per-char (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-max-units-per-char ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

max-units-per-char.

Generic Reader: enc-name (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-name ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

name.

Generic Reader: enc-native-endianness (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-native-endianness ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

native-endianness.

Generic Reader: enc-nul-encoding (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-nul-encoding ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

nul-encoding.

Generic Reader: enc-use-bom (object) ¶

Package

babel-encodings.

Methods

Reader Method: enc-use-bom ((character-encoding character-encoding)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

use-bom.

Generic Reader: encoder (object) ¶

Package

babel-encodings.

Methods

Reader Method: encoder ((concrete-mapping concrete-mapping)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

encoder.

Generic Writer: (setf encoder) (object) ¶

Package

babel-encodings.

Methods

Writer Method: (setf encoder) ((concrete-mapping concrete-mapping)) ¶

automatically generated writer method

Source

encodings.lisp.

Target Slot

encoder.

Generic Reader: external-format-encoding (object) ¶

Package

babel.

Methods

Reader Method: external-format-encoding ((external-format external-format)) ¶

automatically generated reader method

Source

external-format.lisp.

Target Slot

encoding.

Generic Reader: external-format-eol-style (object) ¶

Package

babel.

Methods

Reader Method: external-format-eol-style ((external-format external-format)) ¶

automatically generated reader method

Source

external-format.lisp.

Target Slot

eol-style.

Generic Reader: octet-counter (object) ¶

Package

babel-encodings.

Methods

Reader Method: octet-counter ((concrete-mapping concrete-mapping)) ¶

automatically generated reader method

Source

encodings.lisp.

Target Slot

octet-counter.

Generic Writer: (setf octet-counter) (object) ¶

Package

babel-encodings.

Methods

Writer Method: (setf octet-counter) ((concrete-mapping concrete-mapping)) ¶

automatically generated writer method

Source

encodings.lisp.

Target Slot

octet-counter.

---

6.1.6 Standalone methods

Method: initialize-instance :after ((enc character-encoding) &key literal-char-code-limit) ¶

Source

encodings.lisp.

Method: print-object ((ef external-format) stream) ¶

Source

external-format.lisp.

---

6.1.7 Conditions

Condition: character-coding-error ¶

Package

babel-encodings.

Source

encodings.lisp.

Direct superclasses

error.

Direct subclasses

• character-decoding-error.
• character-encoding-error.

Direct methods

• character-coding-error-buffer.
• character-coding-error-encoding.
• character-coding-error-position.

Direct slots

Slot: buffer ¶

Initargs

:buffer

Readers

character-coding-error-buffer.

Writers

This slot is read-only.

Slot: position ¶

Package

common-lisp.

Initargs

:position

Readers

character-coding-error-position.

Writers

This slot is read-only.

Slot: encoding ¶

Initargs

:encoding

Readers

character-coding-error-encoding.

Writers

This slot is read-only.

Condition: character-decoding-error ¶

Package

babel-encodings.

Source

encodings.lisp.

Direct superclasses

character-coding-error.

Direct subclasses

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

Direct methods

character-decoding-error-octets.

Direct slots

Slot: octets ¶

Initargs

:octets

Readers

character-decoding-error-octets.

Writers

This slot is read-only.

Condition: character-encoding-error ¶

Package

babel-encodings.

Source

encodings.lisp.

Direct superclasses

character-coding-error.

Direct subclasses

invalid-gbk-character.

Direct methods

character-encoding-error-code.

Direct slots

Slot: code ¶

Initargs

:code

Readers

character-encoding-error-code.

Writers

This slot is read-only.

Condition: character-out-of-range ¶

Signalled when the character being decoded is out of range.

Package

babel-encodings.

Source

encodings.lisp.

Direct superclasses

character-decoding-error.

Condition: end-of-input-in-character ¶

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

Package

babel-encodings.

Source

encodings.lisp.

Direct superclasses

character-decoding-error.

Condition: invalid-utf8-continuation-byte ¶

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

Package

babel-encodings.

Source

enc-unicode.lisp.

Direct superclasses

character-decoding-error.

Condition: invalid-utf8-starter-byte ¶

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

Package

babel-encodings.

Source

enc-unicode.lisp.

Direct superclasses

character-decoding-error.

Condition: overlong-utf8-sequence ¶

Signalled upon overlong UTF-8 sequences.

Package

babel-encodings.

Source

enc-unicode.lisp.

Direct superclasses

character-decoding-error.

---

6.1.8 Classes

Class: character-encoding ¶

Package

babel-encodings.

Source

encodings.lisp.

Direct methods

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

Direct slots

Slot: name ¶

Initform

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

Initargs

:name

Readers

enc-name.

Writers

This slot is read-only.

Slot: documentation ¶

Package

common-lisp.

Initargs

:documentation

Readers

enc-documentation.

Writers

This slot is read-only.

Slot: aliases ¶

Initargs

:aliases

Readers

enc-aliases.

Writers

This slot is read-only.

Slot: code-unit-size ¶

Initform

8

Initargs

:code-unit-size

Readers

enc-code-unit-size.

Writers

This slot is read-only.

Slot: max-units-per-char ¶

Initform

1

Initargs

:max-units-per-char

Readers

enc-max-units-per-char.

Writers

This slot is read-only.

Slot: native-endianness ¶

Initform

t

Initargs

:native-endianness

Readers

enc-native-endianness.

Writers

This slot is read-only.

Slot: decode-literal-code-unit-limit ¶

Initform

0

Initargs

:decode-literal-code-unit-limit

Readers

enc-decode-literal-code-unit-limit.

Writers

This slot is read-only.

Slot: encode-literal-code-unit-limit ¶

Initform

0

Initargs

:encode-literal-code-unit-limit

Readers

enc-encode-literal-code-unit-limit.

Writers

This slot is read-only.

Slot: use-bom ¶

Initargs

:use-bom

Readers

enc-use-bom.

Writers

This slot is read-only.

Slot: bom-encoding ¶

Initargs

:bom-encoding

Readers

enc-bom-encoding.

Writers

This slot is read-only.

Slot: nul-encoding ¶

Initform

#(0)

Initargs

:nul-encoding

Readers

enc-nul-encoding.

Writers

This slot is read-only.

Slot: default-replacement ¶

Initform

26

Initargs

:default-replacement

Readers

enc-default-replacement.

Writers

This slot is read-only.

Slot: ambiguous ¶

Initargs

:ambiguous

Readers

ambiguous-encoding-p.

Writers

This slot is read-only.

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.

Direct methods

• external-format-encoding.
• external-format-eol-style.
• print-object.

Direct slots

Slot: encoding ¶

Type

babel-encodings:character-encoding

Initargs

:encoding

Readers

external-format-encoding.

Writers

This slot is read-only.

Slot: eol-style ¶

Type

babel::eol-style

Initform

babel:*default-eol-style*

Initargs

:eol-style

Readers

external-format-eol-style.

Writers

This slot is read-only.

---

6.1.9 Types

Type: simple-unicode-string () ¶

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

Package

babel.

Source

strings.lisp.

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.

Type: unicode-string () ¶

Alias for (VECTOR UNICODE-CHAR *).

Package

babel.

Source

strings.lisp.

---

6.2.1 Constants

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

Package

babel-encodings.

Source

enc-unicode.lisp.

Constant: +cp1251-to-unicode+ ¶

Package

babel-encodings.

Source

enc-cp1251.lisp.

Constant: +cp1252-to-unicode+ ¶

Package

babel-encodings.

Source

enc-cp1252.lisp.

Constant: +cp437-to-unicode+ ¶

Package

babel-encodings.

Source

enc-cp437.lisp.

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.

Constant: +ebcdic-decode-table+ ¶

Package

babel-encodings.

Source

enc-ebcdic.lisp.

Constant: +ebcdic-encode-table+ ¶

Package

babel-encodings.

Source

enc-ebcdic.lisp.

Constant: +gbk1-offset+ ¶

Package

babel-encodings.

Source

enc-gbk.lisp.

Constant: +gbk2-offset+ ¶

Package

babel-encodings.

Source

enc-gbk.lisp.

Constant: +gbk3-offset+ ¶

Package

babel-encodings.

Source

enc-gbk.lisp.

Constant: +gbk4-offset+ ¶

Package

babel-encodings.

Source

enc-gbk.lisp.

Constant: +gbk5-offset+ ¶

Package

babel-encodings.

Source

enc-gbk.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

Constant: +koi8-r-to-unicode+ ¶

Package

babel-encodings.

Source

enc-koi8.lisp.

Constant: +koi8-ru-to-unicode+ ¶

Package

babel-encodings.

Source

enc-koi8.lisp.

Constant: +koi8-u-to-unicode+ ¶

Package

babel-encodings.

Source

enc-koi8.lisp.

Constant: +repl+ ¶

Unicode replacement character code point.

Package

babel-encodings.

Source

enc-unicode.lisp.

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

Package

babel-encodings.

Source

enc-unicode.lisp.

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

Package

babel-encodings.

Source

enc-unicode.lisp.

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

Package

babel-encodings.

Source

enc-cp1251.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-cp1252.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-koi8.lisp.

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

Package

babel-encodings.

Source

enc-cp1251.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-cp1252.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-cp1251.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-iso-8859.lisp.

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

Package

babel-encodings.

Source

enc-koi8.lisp.

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

Package

babel-encodings.

Source

enc-koi8.lisp.

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

Package

babel-encodings.

Source

enc-koi8.lisp.

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

Package

babel-encodings.

Source

enc-koi8.lisp.

---

6.2.2 Special variables

Special Variable: *abstract-mappings* ¶

Package

babel-encodings.

Source

encodings.lisp.

Special Variable: *character-encodings* ¶

Package

babel-encodings.

Source

encodings.lisp.

Special Variable: *cp932-only* ¶

Package

babel-encodings.

Source

jpn-table.lisp.

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

Package

babel-encodings.

Source

enc-jpn.lisp.

Special Variable: *eucjp* ¶

Package

babel-encodings.

Source

jpn-table.lisp.

Special Variable: *eucjp-only* ¶

Package

babel-encodings.

Source

jpn-table.lisp.

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

Package

babel-encodings.

Source

enc-jpn.lisp.

Special Variable: *gbk-unicode-mapping* ¶

Package

babel-encodings.

Source

gbk-map.lisp.

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

Package

babel.

Source

strings.lisp.

Special Variable: *string-vector-mappings* ¶

Package

babel.

Source

strings.lisp.

Special Variable: *supported-character-encodings* ¶

Package

babel-encodings.

Source

encodings.lisp.

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

Package

babel-encodings.

Source

enc-jpn.lisp.

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

Package

babel-encodings.

Source

enc-jpn.lisp.

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

Package

babel-encodings.

Source

enc-ebcdic-int.lisp.

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

Package

babel-encodings.

Source

enc-ebcdic-int.lisp.

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

Package

babel-encodings.

Source

enc-ebcdic-int.lisp.

---

6.2.3 Macros

Macro: define-character-encoding (name docstring &body options) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-code-point-counter (encoding (acc type) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-decoder (encoding (sa st da dt) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-encoder (encoding (sa st da dt) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-octet-counter (encoding (acc type) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-ucs (name bytes &optional endianness limit) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: define-unibyte-decoder (encoding (octet) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-unibyte-encoder (encoding (code) &body body) ¶

Package

babel-encodings.

Source

encodings.lisp.

Macro: define-utf-16 (name &optional endianness) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: f-ash (integer count) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: f-logand (&rest integers) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: f-logior (&rest integers) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: f-logxor (&rest integers) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: string-get (string index) ¶

Package

babel.

Source

strings.lisp.

Macro: string-set (code string index) ¶

Package

babel.

Source

strings.lisp.

Macro: ub-get (vector index &optional bytes endianness) ¶

Package

babel.

Source

strings.lisp.

Macro: ub-set (value vector index &optional bytes endianness) ¶

Package

babel.

Source

strings.lisp.

Macro: utf-16-combine-surrogate-pairs (u1 u2) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

Macro: utf16-octet-counter (getter type) ¶

Package

babel-encodings.

Source

enc-unicode.lisp.

---

6.2.4 Ordinary functions

Function: %register-mapping-part (encoding slot-name fn) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: bom-vector (encoding use-bom) ¶

Package

babel.

Source

strings.lisp.

Function: check-vector-bounds (vector start end) ¶

Package

babel.

Source

strings.lisp.

Function: cp932-to-ucs (code) ¶

Package

babel-encodings.

Source

enc-jpn.lisp.

Function: decoding-error (octets enc buf pos &optional sub e) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: ebcdic-fi-decoder (octet) ¶

Package

babel-encodings.

Source

enc-ebcdic.lisp.

Function: ebcdic-fi-encoder (code) ¶

Package

babel-encodings.

Source

enc-ebcdic.lisp.

Function: encoding-error (code enc buf pos &optional sub e) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: eucjp-to-ucs (code) ¶

Package

babel-encodings.

Source

enc-jpn.lisp.

Function: get-abstract-mapping (encoding) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: (setf get-abstract-mapping) (encoding) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: instantiate-code-point-counter (encoding am octet-seq-getter octet-seq-type) ¶

Package

babel-encodings.

Source

encodings.lisp.

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.

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.

Function: instantiate-octet-counter (encoding am code-point-seq-getter code-point-seq-type) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: make-dummy-coder (sg st ds dt) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: make-fixed-width-counter (getter type &optional unit-size-in-bits) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: make-sharp-backslash-reader () ¶

Package

babel.

Source

sharp-backslash.lisp.

Function: notice-character-encoding (enc) ¶

Package

babel-encodings.

Source

encodings.lisp.

Function: sharp-backslash-reader (original-reader stream char numarg) ¶

Package

babel.

Source

sharp-backslash.lisp.

Function: ucs-to-cp932 (code) ¶

Package

babel-encodings.

Source

enc-jpn.lisp.

Function: ucs-to-eucjp (code) ¶

Package

babel-encodings.

Source

enc-jpn.lisp.

---