The cl-unicode Reference Manual

2.1.1 cl-unicode/cl-unicode.asd

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

ASDF Systems

• cl-unicode.
• cl-unicode/base.

---

2.1.2 cl-unicode/conditions.lisp

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Public Interface

unicode-error (condition).

Internals

• character-not-found (condition).
• signal-unicode-error (function).
• simple-unicode-error (condition).

---

2.1.3 cl-unicode/lists.lisp

Dependency

conditions.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

---

2.1.4 cl-unicode/hash-tables.lisp

Dependency

lists.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

---

2.1.5 cl-unicode/api.lisp

Dependency

hash-tables.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Public Interface

• age (generic function).
• bidi-class (generic function).
• bidi-classes (function).
• bidi-mirroring-glyph (function).
• binary-properties (function).
• canonical-decomposition (generic function).
• case-fold-mapping (function).
• character-named (function).
• code-block (generic function).
• code-blocks (function).
• combining-class (generic function).
• disable-alternative-character-syntax (macro).
• enable-alternative-character-syntax (macro).
• general-categories (function).
• general-category (generic function).
• has-binary-property (generic function).
• has-property (function).
• list-all-characters (function).
• lowercase-mapping (function).
• normalization-form-c (generic function).
• normalization-form-d (generic function).
• normalization-form-k-c (generic function).
• normalization-form-k-d (generic function).
• numeric-type (generic function).
• numeric-value (generic function).
• property-test (generic function).
• recognized-properties (function).
• script (generic function).
• scripts (function).
• titlecase-mapping (function).
• unicode-name (generic function).
• unicode1-name (generic function).
• uppercase-mapping (function).
• word-break (generic function).

Internals

• %disable-alternative-character-syntax (function).
• %enable-alternative-character-syntax (function).
• compatibility-decomposition (generic function).
• try-abbreviations (function).
• unicode-name-reader (function).

---

2.1.6 cl-unicode/methods.lisp

Dependency

api.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Public Interface

• age (method).
• bidi-class (method).
• code-block (method).
• combining-class (method).
• general-category (method).
• idna-mapping (method).
• numeric-type (method).
• numeric-value (method).
• script (method).
• word-break (method).

Internals

• bidi-mirroring-glyph% (method).
• binary-props (method).
• case-folding-mapping (method).
• decomposition-mapping (method).

---

2.1.7 cl-unicode/test-functions.lisp

Dependency

methods.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Internals

• install-bidi-class-tests (function).
• install-binary-properties-tests (function).
• install-code-block-tests (function).
• install-general-category-tests (function).
• install-miscellaneous-tests (function).
• install-one-test (function).
• install-script-tests (function).
• install-tests (function).

---

2.1.8 cl-unicode/derived.lisp

Dependency

test-functions.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Internals

• *derived-map* (special variable).
• +xid-difference+ (constant).
• build-derived-test-function (function).
• build-derived-test-functions (function).

---

2.1.9 cl-unicode/alias.lisp

Dependency

derived.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode (system).

Internals

• *alias-map* (special variable).
• *bidi-alias-map* (special variable).
• build-all-property-tests (function).
• create-alias (function).
• create-aliases (function).

---

2.1.10 cl-unicode/base/packages.lisp

Source

cl-unicode.asd.

Parent Component

cl-unicode/base (system).

Packages

• cl-unicode-names.
• cl-unicode.

---

2.1.11 cl-unicode/base/specials.lisp

Dependency

packages.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode/base (system).

Public Interface

• *scripts-to-try* (special variable).
• *try-abbreviations-p* (special variable).
• *try-hex-notation-p* (special variable).
• *try-lisp-names-p* (special variable).
• *try-unicode1-names-p* (special variable).
• +code-point-limit+ (constant).

Internals

• *bidi-classes* (special variable).
• *binary-properties* (special variable).
• *canonical-names* (special variable).
• *case-mappings* (special variable).
• *code-blocks* (special variable).
• *code-points-to-names* (special variable).
• *code-points-to-unicode1-names* (special variable).
• *compatibility-formatting-tags* (special variable).
• *composition-mappings* (special variable).
• *general-categories* (special variable).
• *hangul-syllables-to-code-points* (special variable).
• *hyperdoc-base-uri* (special variable).
• *jamo-short-names* (special variable).
• *names-to-code-points* (special variable).
• *previous-readtables* (special variable).
• *property-aliases* (special variable).
• *property-map* (special variable).
• *property-tests* (special variable).
• *scripts* (special variable).
• *special-case-mappings* (special variable).
• *unicode1-names-to-code-points* (special variable).
• hyperdoc-lookup (function).

---

2.1.12 cl-unicode/base/util.lisp

Dependency

specials.lisp (file).

Source

cl-unicode.asd.

Parent Component

cl-unicode/base (system).

Public Interface

• canonicalize-name (function).
• property-name (function).
• property-symbol (function).

Internals

• +first-hangul-syllable+ (constant).
• +l-base+ (constant).
• +last-hangul-syllable+ (constant).
• +n-count+ (constant).
• +s-base+ (constant).
• +t-base+ (constant).
• +t-count+ (constant).
• +v-base+ (constant).
• +v-count+ (constant).
• add-hangul-names (function).
• canonical-composition (function).
• canonical-sort (function).
• case-folding (generic function).
• cjk-unified-ideograph-p (function).
• compute-hangul-decomposition (function).
• compute-hangul-name (function).
• define-hangul-constant (macro).
• ensure-code-point (macro).
• evaluate-casing-condition (function).
• hangul-syllable-p (function).
• lookup-property-alias (function).
• mapping (generic function).
• maybe-compute-cjk-name (function).
• maybe-compute-hangul-syllable-name (function).
• maybe-find-cjk-code-point (function).
• maybe-find-hangul-syllable-code-point (function).
• parse-hex (function).
• register-property-symbol (function).
• special-mapping (generic function).
• tree-lookup (function).

---

4.1.1 Constants

Constant: +code-point-limit+ ¶

The smallest integer which is not a code point in the Unicode codespace.

Package

cl-unicode.

Source

specials.lisp.

---

4.1.2 Special variables

Special Variable: *scripts-to-try* ¶

This is the default value for the :SCRIPTS-TO-TRY keyword argument to CHARACTER-NAMED.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *try-abbreviations-p* ¶

This is the default value for the :TRY-ABBREVIATIONS-P keyword argument to CHARACTER-NAMED.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *try-hex-notation-p* ¶

This is the default value for the :TRY-HEX-NOTATION-P keyword argument to CHARACTER-NAMED.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *try-lisp-names-p* ¶

This is the default value for the :TRY-LISP-NAMES-P keyword argument to CHARACTER-NAMED.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *try-unicode1-names-p* ¶

This is the default value for the :TRY-UNICODE1-NAMES-P keyword argument to CHARACTER-NAMED.

Package

cl-unicode.

Source

specials.lisp.

---

4.1.3 Macros

Macro: disable-alternative-character-syntax () ¶

Restores the readtable which was active before the last call to ENABLE-ALTERNATIVE-CHARACTER-SYNTAX. If there was no such call, the standard readtable is used.

This macro expands into an EVAL-WHEN so that if you use it as a top-level form in a file to be loaded and/or compiled it’ll do what you expect. Technically, this’ll pop a readtable from the stack described in ENABLE-ALTERNATIVE-CHARACTER-SYNTAX so that matching calls of these macros can be nested.

Package

cl-unicode.

Source

api.lisp.

Macro: enable-alternative-character-syntax () ¶

Enables an alternative Lisp character syntax which /replaces/ the usual syntax: After a sharpsign and a backslash have been read, at least one more character is read. Reading then continues as long as ASCII letters, digits, underlines, hyphens, colons, or plus signs are read. The resulting string is then used as input to CHARACTER-NAMED to produce a character.

This macro expands into an EVAL-WHEN so that if you use it as a top-level form in a file to be loaded and/or compiled it’ll do what you expect. Technically, this’ll push the current readtable on a stack so that matching calls of this macro and DISABLE-ALTERNATIVE-CHARACTER-SYNTAX can be nested.

Note that by default the alternative character syntax is not enabled after loading CL-UNICODE.

Package

cl-unicode.

Source

api.lisp.

---

4.1.4 Ordinary functions

Function: bidi-classes () ¶

Returns a sorted list of all Bidi classes known to CL-UNICODE. These are the possible return values of BIDI-CLASS.

Package

cl-unicode.

Source

api.lisp.

Function: bidi-mirroring-glyph (c &key want-code-point-p) ¶

Returns the Bidi mirroring glyph for a character if the character has the "BidiMirrored" property and an appropriate mirroring glyph is defined. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Returns the code point instead of the character if WANT-CODE-POINT-P is true. This can be especially useful for Lisp implementations where CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+.

Package

cl-unicode.

Source

api.lisp.

Function: binary-properties () ¶

Returns a sorted list of all binary properties known to CL-UNICODE. These are the allowed second arguments (modulo canonicalization) to HAS-BINARY-PROPERTY.

Package

cl-unicode.

Source

api.lisp.

Function: canonicalize-name (name) ¶

Converts the string NAME into a "canonicalized" name which can be used for unambiguous look-ups by removing all whitespace, hyphens, and underline characters.

Tries not to remove hyphens preceded by spaces if this could lead to ambiguities as described in <http://unicode.org/unicode/reports/tr18/#Name_Properties>.

All CL-UNICODE functions which accept string "names" for characters or properties will canonicalize the name first using this function and will then look up the name case-insensitively.

Package

cl-unicode.

Source

util.lisp.

Function: case-fold-mapping (c &key want-code-point-p) ¶

Package

cl-unicode.

Source

api.lisp.

Function: character-named (name &key want-code-point-p try-unicode1-names-p try-abbreviations-p scripts-to-try try-hex-notation-p try-lisp-names-p) ¶

Returns the character which has the name NAME (a string) by looking up the Unicode name (see UNICODE-NAME).

If TRY-UNICODE1-NAMES is true, the Unicode 1.0 name (see UNICODE1-NAME) will be used as a fallback.

If TRY-ABBREVIATIONS-P is true, NAME is treated as an abbreviation as follows: If NAME contains a colon, it is interpreted as "<script>:<short-name>" and the function tries to look up, in turn, the characters named "<script> <size> LETTER <short-name>", "<script> LETTER <short-name>", and "<script> <short-name>" where <size> is "SMALL" if none of the characters in <short-name> is uppercase, "CAPITAL" otherwise. If NAME does not contain a colon, the same algorithm as above is tried with NAME instead of <short-name> and each element of the list of strings SCRIPTS-TO-TRY as <string>. (SCRIPTS-TO-TRY can also be a single string which is interpreted as a one-element list.)

If TRY-HEX-NOTATION-P is true, NAME can be of the form "U+<x>" where <x> is a hexadecimal number with four to six digits with the obvious meaning.

If TRY-LISP-NAMES-P is true, the function returns the character with the character name NAME (if there is one) or, if NAME is exactly one character, it returns this character.

All the keyword-governed alternatives are tried in the order they’re described here.

See also *TRY-UNICODE1-NAMES-P*, *TRY-ABBREVIATIONS-P*, *SCRIPTS-TO-TRY*, *TRY-HEX-NOTATION-P*, and *TRY-LISP-NAMES-P*.

Returns the code point instead of the character if WANT-CODE-POINT-P is true. This can be especially useful for Lisp implementations where CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+.

Package

cl-unicode.

Source

api.lisp.

Function: code-blocks () ¶

Returns a sorted list of all blocks known to CL-UNICODE. These are the possible return values of CODE-BLOCK.

Package

cl-unicode.

Source

api.lisp.

Function: general-categories () ¶

Returns a sorted list of all general categories known to CL-UNICODE. These are the possible return values of GENERAL-CATEGORY.

Package

cl-unicode.

Source

api.lisp.

Function: has-property (c property) ¶

Checks whether a character has the named property PROPERTY. PROPERTY can be a string naming a property (which will be used for look-up after canonicalization) or it can be a property symbol (see PROPERTY-SYMBOL). C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

"Properties" in the sense of CL-UNICODE can be names of general categories, scripts, blocks, binary properties, or Bidi classes, amongst other things. If there are a block and a script with the same name (like, say, "Cyrillic"), the bare name denotes the script. Prepend "Block:" to the name to refer to the block. (You can also prepend "Script:" to refer to the script unambiguously.) Names of Bidi classes must be prepended with "BidiClass:" if there’s a potential for ambiguity.

This function also recognizes several aliases for properties (like "Symbol" for "S") and you can, as in Perl, prepend block names with "In" instead of "Block:" and most other properties with
"Is". See RECOGNIZED-PROPERTIES.

See also PROPERTY-TEST.

Package

cl-unicode.

Source

api.lisp.

Function: list-all-characters (property &key want-code-point-p) ¶

Lists all character (ordered by code point) which have the property PROPERTY where PROPERTY is interpreted as in HAS-PROPERTY. If WANT-CODE-POINT-P is true, a list of code points instead of a list of characters is returned. (If CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+ in your Lisp implementation, the list of code points can actually be longer than the list of characters.).

Package

cl-unicode.

Source

api.lisp.

Function: lowercase-mapping (c &key want-code-point-p want-special-p context) ¶

Returns the lowercase mapping of a character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. Returns the character itself if no such mapping is explicitly defined. Note that case mapping only makes sense for characters with the "LC" property.

Returns the code point instead of the character if WANT-CODE-POINT-P is true. Returns a list of code points if WANT-SPECIAL-P is true. This can be especially useful for Lisp implementations where CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+.

Package

cl-unicode.

Source

api.lisp.

Function: property-name (symbol) ¶

Returns a name (not "the" name) for a property symbol SYMBOL if it is known to CL-UNICODE. Note that

(STRING= (PROPERTY-NAME (PROPERTY-SYMBOL <string>)) <string>)

is not necessarily true even if the property name is not NIL while

(EQ (PROPERTY-SYMBOL (PROPERTY-NAME <symbol>)) <symbol>)

always holds if there is a property name for <symbol>.

See also PROPERTY-SYMBOL.

Package

cl-unicode.

Source

util.lisp.

Function: property-symbol (name) ¶

Returns a symbol in the CL-UNICODE-NAMES package (which is only used for this purpose) which can stand in for the string NAME in look-ups. The symbol’s name is the result of "canonicalizing" and then upcasing NAME.

A symbol returned by this function is only really useful and only actually a property symbol if the second return value is true.

All exported functions of CL-UNICODE which return strings which are property names return the corresponding property symbol as their second return value. All exported functions of CL-UNICODE which accept property names as arguments will also accept property symbols.

See also PROPERTY-NAME.

Package

cl-unicode.

Source

util.lisp.

Function: recognized-properties (&optional all) ¶

Returns a list of all property names known to CL-UNICODE. These are the allowed second arguments (modulo canonicalization) to HAS-PROPERTY. If ALL is true, known aliases (like "Letter" for "L") are also included.

Package

cl-unicode.

Source

api.lisp.

Function: scripts () ¶

Returns a sorted list of all scripts known to CL-UNICODE. These are the possible return values of SCRIPT.

Package

cl-unicode.

Source

api.lisp.

Function: titlecase-mapping (c &key want-code-point-p want-special-p context) ¶

Returns the titlecase mapping of a character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. Returns the character itself if no such mapping is explicitly defined. Note that case mapping only makes sense for characters with the "LC" property.

Returns the code point instead of the character if WANT-CODE-POINT-P is true. Returns a list of code points if WANT-SPECIAL-P is true. This can be especially useful for Lisp implementations where CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+.

Package

cl-unicode.

Source

api.lisp.

Function: uppercase-mapping (c &key want-code-point-p want-special-p context) ¶

Returns the simple uppercase mapping of a character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. Returns the character itself if no such mapping is explicitly defined. Note that case mapping only makes sense for characters with the "LC" property.

Returns the code point instead of the character if WANT-CODE-POINT-P is true. Returns a list of code points if WANT-SPECIAL-P is true. This can be especially useful for Lisp implementations where CHAR-CODE-LIMIT is smaller than +CODE-POINT-LIMIT+.

Package

cl-unicode.

Source

api.lisp.

---

4.1.5 Generic functions

Generic Function: age (c) ¶

Returns the "age" of a character or NIL if there
is no age entry for that particular character. The age of a character is a list of two integers denoting the major and minor number of the Unicode version where the character first appeared. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: age ((code-point integer)) ¶

Source

methods.lisp.

Method: age ((char character)) ¶

Generic Function: bidi-class (c) ¶

Returns the bidirectional ("Bidi") class of a
character as a string or NIL if there is no bidirectional class for that particular character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value (if there is one) is the property symbol of the class.

See also BIDI-CLASSES

Package

cl-unicode.

Source

api.lisp.

Methods

Method: bidi-class ((code-point integer)) ¶

Source

methods.lisp.

Method: bidi-class ((char character)) ¶

Generic Function: canonical-decomposition (c) ¶

Decomposes input according to Unicode Canonical Decomposition rules.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: canonical-decomposition ((char character)) ¶

Method: canonical-decomposition ((code-point integer)) ¶

Generic Function: code-block (c) ¶

Returns the block of a character as a string or NIL
if there is no block for that particular character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value (if there is one) is the property symbol of the block.

See also CODE-BLOCKS.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: code-block ((code-point integer)) ¶

Source

methods.lisp.

Method: code-block ((char character)) ¶

Generic Function: combining-class (c) ¶

Returns the combining class of a character as a
non-negative integer. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: combining-class ((code-point integer)) ¶

Source

methods.lisp.

Method: combining-class :around (c) ¶

Method: combining-class ((char character)) ¶

Generic Function: general-category (c) ¶

Returns the general category of a character as a
string. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value is the property symbol of the category.

See also GENERAL-CATEGORIES.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: general-category ((code-point integer)) ¶

Source

methods.lisp.

Method: general-category :around (c) ¶

Method: general-category ((char character)) ¶

Generic Function: has-binary-property (c property) ¶

Checks whether a character has the binary property
PROPERTY. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. PROPERTY can be a string naming the property or the corresponding property symbol. If a true value is returned, it is the property symbol.

See also BINARY-PROPERTIES.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: has-binary-property ((char character) property) ¶

Method: has-binary-property (char (property-name string)) ¶

Method: has-binary-property ((code-point integer) (property-symbol symbol)) ¶

Generic Function: idna-mapping (code-point) ¶

Package

cl-unicode.

Methods

Method: idna-mapping ((code-point integer)) ¶

Source

methods.lisp.

Generic Function: normalization-form-c (s) ¶

NFC normalization - per character canonical decomposition followed by canonical sort and canonical composition. Returns list of code points.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: normalization-form-c ((char character)) ¶

Method: normalization-form-c ((code-point integer)) ¶

Method: normalization-form-c (chars) ¶

Generic Function: normalization-form-d (s) ¶

NFD decomposition - per character canonical decomposition followed by canonical sort. Returns list of code points.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: normalization-form-d ((char character)) ¶

Method: normalization-form-d ((code-point integer)) ¶

Method: normalization-form-d ((chars list)) ¶

Method: normalization-form-d ((chars string)) ¶

Generic Function: normalization-form-k-c (s) ¶

NFKC normalization - per character compatibility decomposition followed by canonical sort and canonical composition. Returns list of code points.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: normalization-form-k-c ((char character)) ¶

Method: normalization-form-k-c ((code-point integer)) ¶

Method: normalization-form-k-c (chars) ¶

Generic Function: normalization-form-k-d (s) ¶

NFKD decomposition - per character compatibility decomposition followed by canonical sort. Returns list of code points.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: normalization-form-k-d ((char character)) ¶

Method: normalization-form-k-d ((code-point integer)) ¶

Method: normalization-form-k-d ((chars list)) ¶

Method: normalization-form-k-d ((chars string)) ¶

Generic Function: numeric-type (c) ¶

Returns the numeric type of a character as a string
or NIL if that particular character has no numeric type. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value (if there is one) is the property symbol of the numeric type.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: numeric-type ((code-point integer)) ¶

Source

methods.lisp.

Method: numeric-type ((char character)) ¶

Generic Function: numeric-value (c) ¶

Returns the numeric value of a character as a Lisp
rational or NIL (for NaN). C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: numeric-value ((code-point integer)) ¶

Source

methods.lisp.

Method: numeric-value ((char character)) ¶

Generic Function: property-test (property &key errorp) ¶

Returns a unary function which can test code points
or Lisp characters for the property PROPERTY. PROPERTY is interpreted as in HAS-PROPERTY and PROPERTY-TEST is actually used internally by HAS-PROPERTY but might come in handy if you need a faster way to test for PROPERTY (as you’re saving the time to look up the property).

Returns NIL if no property named PROPERTY was found or signals an error if ERRORP is true.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: property-test ((property-name string) &key errorp) ¶

Method: property-test ((property-symbol symbol) &key errorp) ¶

Generic Function: script (c) ¶

Returns the script of a character as a string or
NIL if there is no script for that particular character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value (if there is one) is the property symbol of the script.

See also SCRIPTS.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: script ((code-point integer)) ¶

Source

methods.lisp.

Method: script ((char character)) ¶

Generic Function: unicode-name (c) ¶

Returns the Unicode name of a character as a string
or NIL if there is no name for that particular character. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: unicode-name ((char character)) ¶

Method: unicode-name ((code-point integer)) ¶

Generic Function: unicode1-name (c) ¶

Returns the Unicode 1.0 name of a character as a
string or NIL if there is no name for that particular character. This name is only non-NIL if it is significantly different from the Unicode name (see UNICODE-NAME). For control characters, sometimes the ISO 6429 name is returned instead.

C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: unicode1-name ((char character)) ¶

Method: unicode1-name ((code-point integer)) ¶

Generic Function: word-break (c) ¶

Returns the Word_Break property of a character as a
string. C can be the character’s code point (a positive integer) or a (Lisp) character assuming its character code is also its Unicode code point. The second return value (if there is one) is the property symbol of the word break.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: word-break ((code-point integer)) ¶

Source

methods.lisp.

Method: word-break ((char character)) ¶

---

4.1.6 Conditions

Condition: unicode-error ¶

All errors signalled by CL-UNICODE are of this type.

Package

cl-unicode.

Source

conditions.lisp.

Direct superclasses

error.

Direct subclasses

• character-not-found.
• simple-unicode-error.

---

4.2.1 Constants

Constant: +first-hangul-syllable+ ¶

The code point of the first Hangul syllable the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Constant: +l-base+ ¶

The constant ‘LBase’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +last-hangul-syllable+ ¶

The code point of the last Hangul syllable the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Constant: +n-count+ ¶

The constant ‘NCount’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +s-base+ ¶

The constant ‘SBase’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +t-base+ ¶

The constant ‘TBase’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +t-count+ ¶

The constant ‘TCount’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +v-base+ ¶

The constant ‘VBase’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +v-count+ ¶

The constant ‘VCount’ from chapter 3 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Constant: +xid-difference+ ¶

Package

cl-unicode.

Source

derived.lisp.

---

4.2.2 Special variables

Special Variable: *alias-map* ¶

Package

cl-unicode.

Source

alias.lisp.

Special Variable: *bidi-alias-map* ¶

Package

cl-unicode.

Source

alias.lisp.

Special Variable: *bidi-classes* ¶

A list of all property symbols which denote Bidi classes.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *binary-properties* ¶

A list of all property symbols which denote binary properties.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *canonical-names* ¶

A hash tables which maps property symbols (see PROPERTY-SYMBOL) to their "canonical names", i.e. to strings.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *case-mappings* ¶

A hash table which maps code points to three-element lists containing the lowercase, uppercase, and titlecasse mapping of the corresponding character (unless all of them are NIL).

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *code-blocks* ¶

A list of all property symbols which denote blocks.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *code-points-to-names* ¶

A hash table which maps code points to the corresponding character names.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *code-points-to-unicode1-names* ¶

A hash table which maps code points to the corresponding Unicode 1.0 character names.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *compatibility-formatting-tags* ¶

A list of Character Decomposition compatibility formatting tags.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *composition-mappings* ¶

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *derived-map* ¶

Package

cl-unicode.

Source

derived.lisp.

Special Variable: *general-categories* ¶

A list of all property symbols which denote general categories.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *hangul-syllables-to-code-points* ¶

A hash table which (case-insensitively) maps Hangul syllable name parts to their code points.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *hyperdoc-base-uri* ¶

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *jamo-short-names* ¶

A hash table which maps code points to their Jamo short names. Needed to compute Hangul syllable names - see COMPUTE-HANGUL-NAME.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *names-to-code-points* ¶

A hash table which (case-insensitively) maps "canonicalized" character names to their code points.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *previous-readtables* ¶

A stack which holds the previous readtables that have been pushed here by ENABLE-ALTERNATIVE-CHARACTER-SYNTAX.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *property-aliases* ¶

A hash table which maps property names to the long name for the property.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *property-map* ¶

A hash table which (case-insensitively) maps "canonicalized" property names (including aliases) to the corresponding property symbols.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *property-tests* ¶

A hash table which maps property symbols to a test function which tests for the corresponding property.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *scripts* ¶

A list of all property symbols which denote scripts.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *special-case-mappings* ¶

A hash table which maps code points to a list of special case mapping rules.

Package

cl-unicode.

Source

specials.lisp.

Special Variable: *unicode1-names-to-code-points* ¶

A hash table which (case-insensitively) maps "canonicalized" Unicode 1.0 character names to their code points.

Package

cl-unicode.

Source

specials.lisp.

---

4.2.3 Macros

Macro: define-hangul-constant (name value) ¶

Simple helper macro to define some constants needed for the Hangul algorithm below.

Package

cl-unicode.

Source

util.lisp.

Macro: ensure-code-point (c) ¶

Helper macro so that C can be treated like a code point even if it is a Lisp character.

Package

cl-unicode.

Source

util.lisp.

---

4.2.4 Ordinary functions

Function: %disable-alternative-character-syntax () ¶

Internal function used to restore previous readtable.

Package

cl-unicode.

Source

api.lisp.

Function: %enable-alternative-character-syntax () ¶

Internal function used to enable alternative character syntax and store current readtable on stack.

Package

cl-unicode.

Source

api.lisp.

Function: add-hangul-names () ¶

Computes the names for all Hangul syllables and registers them in the *HANGUL-SYLLABLES-TO-CODE-POINTS* hash table. Used for CHARACTER-NAMED.

Package

cl-unicode.

Source

util.lisp.

Function: build-all-property-tests () ¶

Package

cl-unicode.

Source

alias.lisp.

Function: build-derived-test-function (property-designators) ¶

Package

cl-unicode.

Source

derived.lisp.

Function: build-derived-test-functions () ¶

Package

cl-unicode.

Source

derived.lisp.

Function: canonical-composition (code-points) ¶

Unicode Canonical Composition algorithm. See: https://dev.w3.org/cvsweb/~checkout~/charlint/charlint.pl?rev=1.28;content-type=text%2Fx-perl

Package

cl-unicode.

Source

util.lisp.

Function: canonical-sort (code-points) ¶

Unicode Canonical Sort algorithm

Package

cl-unicode.

Source

util.lisp.

Function: cjk-unified-ideograph-p (code-point) ¶

Returns a true value if CODE-POINT is the code point of a CJK unified ideograph for which we can algorithmically derive the name.

Package

cl-unicode.

Source

util.lisp.

Function: compute-hangul-decomposition (code-point) ¶

Algorithmically derives the Hangul syllable canonical decomposition.

Package

cl-unicode.

Source

util.lisp.

Function: compute-hangul-name (code-point) ¶

Algorithmically derives the Hangul syllable name (the part behind "HANGUL SYLLABLE ") of the character with code point CODE-POINT as described in section 3.12 of the Unicode book.

Package

cl-unicode.

Source

util.lisp.

Function: create-alias (new-name old-name &optional only-if-unambiguous) ¶

Package

cl-unicode.

Source

alias.lisp.

Function: create-aliases () ¶

Package

cl-unicode.

Source

alias.lisp.

Function: evaluate-casing-condition (context condition) ¶

Evaluates casing condition. Requires proper implementation. Currently handles unconditional cases.

Package

cl-unicode.

Source

util.lisp.

Function: hangul-syllable-p (code-point) ¶

Returns a true value if CODE-POINT is the code point of a Hangul syllable for which we can algorithmically derive the name.

Package

cl-unicode.

Source

util.lisp.

Function: hyperdoc-lookup (symbol type) ¶

Package

cl-unicode.

Source

specials.lisp.

Function: install-bidi-class-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-binary-properties-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-code-block-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-general-category-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-miscellaneous-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-one-test (property-symbol test-function) ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-script-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: install-tests () ¶

Package

cl-unicode.

Source

test-functions.lisp.

Function: lookup-property-alias (name) ¶

Returns the long-name of the given property alias

Package

cl-unicode.

Source

util.lisp.

Function: maybe-compute-cjk-name (code-point) ¶

Computes the name for CODE-POINT if CODE-POINT denotes a CJK unified ideograph the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Function: maybe-compute-hangul-syllable-name (code-point) ¶

Computes the name for CODE-POINT if CODE-POINT denotes a Hangul syllable the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Function: maybe-find-cjk-code-point (name) ¶

Computes the code point for NAME if NAME is the name of a CJK unified ideograph the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Function: maybe-find-hangul-syllable-code-point (name) ¶

Computes the code point for NAME if NAME is the name of a Hangul syllable the name of which can be algorithmically derived.

Package

cl-unicode.

Source

util.lisp.

Function: parse-hex (string) ¶

Parses STRING as a hexadecimal number.

Package

cl-unicode.

Source

util.lisp.

Function: register-property-symbol (name) ¶

Converts NAME to a property symbol using PROPERTY-SYMBOL and "registers" it in the *CANONICAL-NAMES* hash table.

Package

cl-unicode.

Source

util.lisp.

Function: signal-unicode-error (format-control &rest format-arguments) ¶

Utility function to signal conditions of type SIMPLE-UNICODE-ERROR.

Package

cl-unicode.

Source

conditions.lisp.

Function: tree-lookup (code-point tree) ¶

Looks up an attribute for CODE-POINT in the binary search tree TREE. TREE is a tree as created by BUILD-TREE.

Package

cl-unicode.

Source

util.lisp.

Function: try-abbreviations (name scripts-to-try) ¶

Helper function called by CHARACTER-NAMED when the :TRY-ABBREVIATIONS-P keyword argument is true. Tries to interpret NAME as an abbreviation for a longer Unicode name and returns the corresponding code point if it succeeds.

Package

cl-unicode.

Source

api.lisp.

Function: unicode-name-reader (stream char arg) ¶

The reader function used when the alternative character syntax is enabled.

Package

cl-unicode.

Source

api.lisp.

---

4.2.5 Generic functions

Generic Function: bidi-mirroring-glyph% (code-point) ¶

Package

cl-unicode.

Methods

Method: bidi-mirroring-glyph% ((code-point integer)) ¶

Source

methods.lisp.

Generic Function: binary-props (code-point) ¶

Package

cl-unicode.

Methods

Method: binary-props ((code-point integer)) ¶

Source

methods.lisp.

Generic Function: case-folding (c want-code-point-p) ¶

Return case folding for a character or list of characters.

Package

cl-unicode.

Source

util.lisp.

Methods

Method: case-folding ((char character) want-code-point-p) ¶

Method: case-folding ((code-point integer) want-code-point-p) ¶

Method: case-folding ((chars list) want-code-point-p) ¶

Generic Function: case-folding-mapping (code-point) ¶

Package

cl-unicode.

Methods

Method: case-folding-mapping ((code-point integer)) ¶

Source

methods.lisp.

Generic Function: compatibility-decomposition (c) ¶

Decomposes input according to Unicode Compatibility Decomposition rules.

Package

cl-unicode.

Source

api.lisp.

Methods

Method: compatibility-decomposition ((char character)) ¶

Method: compatibility-decomposition ((code-point integer)) ¶

Generic Function: decomposition-mapping (code-point) ¶

Package

cl-unicode.

Methods

Method: decomposition-mapping ((code-point integer)) ¶

Source

methods.lisp.

Generic Function: mapping (c position want-code-point-p) ¶

Returns the simple case mapping for the character C
(a code point or a Lisp character) in position POSITION where 0 means lowercase, 1 uppercase, and 2 titlecase. Returns a character if WANT-CODE-POINT-P is NIL and a code point otherwise.

Package

cl-unicode.

Source

util.lisp.

Methods

Method: mapping ((char character) position want-code-point-p) ¶

Method: mapping ((code-point integer) position want-code-point-p) ¶

Method: mapping ((code-points list) position want-code-point-p) ¶

Generic Function: special-mapping (c position context) ¶

Returns the special case mapping for the character C
(a code point or a Lisp character) in position POSITION where 0 means lowercase, 1 uppercase, and 2 titlecase. Returns a code point list.

Package

cl-unicode.

Source

util.lisp.

Methods

Method: special-mapping ((char character) position context) ¶

Method: special-mapping ((code-point integer) position context) ¶

Method: special-mapping ((code-points list) position context) ¶

---

4.2.6 Conditions

Condition: character-not-found ¶

Error signalled by UNICODE-NAME-READER if a character wasn’t found.

Package

cl-unicode.

Source

conditions.lisp.

Direct superclasses

• reader-error.
• unicode-error.

Direct slots

Slot: name ¶

Initargs

:name

Condition: simple-unicode-error ¶

A subclass of UNICODE-ERROR where the caller can supply a format control and format arguments.

Package

cl-unicode.

Source

conditions.lisp.

Direct superclasses

• simple-condition.
• unicode-error.

---