This is the uax-14 Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 07:48:56 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
uax-14Implementation of the Unicode Standards Annex #14’s line breaking algorithm
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/uax-14.git)
zlib
1.0.0
documentation-utils (system).
package.lisp (file).
database.lisp (file).
uax-14.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
uax-14/uax-14.asduax-14/package.lispuax-14/database.lispuax-14/uax-14.lispuax-14/documentation.lispuax-14/database.lisppackage.lisp (file).
uax-14 (system).
*line-break-database-file* (special variable).
*pair-table-file* (special variable).
compile-databases (function).
load-databases (function).
no-database-files (condition).
*here* (special variable).
char-line-break-type (function).
code (type).
defglobal (macro).
idx (type).
line-break-id (function).
load-line-break-database (function).
load-pair-table (function).
pair-id (compiler macro).
pair-id (function).
pair-type (function).
pair-type-id (function).
type-id (compiler macro).
type-id (function).
uax-14/uax-14.lispdatabase.lisp (file).
uax-14 (system).
break-string (function).
breaker (structure).
list-breaks (function).
make-breaker (function).
next-break (function).
print-object (method).
%make-breaker (function).
breaker-cur-class (reader).
(setf breaker-cur-class) (writer).
breaker-last-pos (reader).
(setf breaker-last-pos) (writer).
breaker-lb21a (reader).
(setf breaker-lb21a) (writer).
breaker-lb30a (reader).
(setf breaker-lb30a) (writer).
breaker-lb8a (reader).
(setf breaker-lb8a) (writer).
breaker-next-class (reader).
(setf breaker-next-class) (writer).
breaker-p (function).
breaker-pos (reader).
(setf breaker-pos) (writer).
breaker-string (reader).
(setf breaker-string) (writer).
code-point-at (function).
copy-breaker (function).
handle-simple-break (function).
normalize-break-id (function).
normalize-first-break (function).
uax-14/documentation.lispuax-14.lisp (file).
uax-14 (system).
Packages are listed by definition order.
org.shirakumo.alloy.uax-14common-lisp.
*line-break-database-file* (special variable).
*pair-table-file* (special variable).
break-string (function).
breaker (structure).
compile-databases (function).
list-breaks (function).
load-databases (function).
make-breaker (function).
next-break (function).
no-database-files (condition).
%make-breaker (function).
*here* (special variable).
breaker-cur-class (reader).
(setf breaker-cur-class) (writer).
breaker-last-pos (reader).
(setf breaker-last-pos) (writer).
breaker-lb21a (reader).
(setf breaker-lb21a) (writer).
breaker-lb30a (reader).
(setf breaker-lb30a) (writer).
breaker-lb8a (reader).
(setf breaker-lb8a) (writer).
breaker-next-class (reader).
(setf breaker-next-class) (writer).
breaker-p (function).
breaker-pos (reader).
(setf breaker-pos) (writer).
breaker-string (reader).
(setf breaker-string) (writer).
char-line-break-type (function).
code (type).
code-point-at (function).
copy-breaker (function).
defglobal (macro).
handle-simple-break (function).
idx (type).
line-break-id (function).
load-line-break-database (function).
load-pair-table (function).
normalize-break-id (function).
normalize-first-break (function).
pair-id (compiler macro).
pair-id (function).
pair-type (function).
pair-type-id (function).
type-id (compiler macro).
type-id (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Variable containing the absolute path of the line break database file.
See LOAD-DATABASES
See COMPILE-DATABASES
Variable containing the absolute path of the pair table file.
See LOAD-DATABASES
See COMPILE-DATABASES
Returns a list of all the pieces of the string, broken.
If MANDATORY-ONLY is T, the string is only split at mandatory line break opportunities, otherwise it is split at every opportunity.
See MAKE-BREAKER
See NEXT-BREAK
Compiles the database files from their sources.
This will load an optional part of the system and compile the database
files to an efficient byte representation. If the compilation is
successful, LOAD-DATABASES is called automatically.
See *LINE-BREAK-DATABASE-FILE*
See *PAIR-TABLE-FILE*
See LOAD-DATABASES
Returns a list of all line break opportunities in the string.
The list has the following form:
LIST ::= ENTRY+
ENTRY ::= (position mandatory)
This is equivalent to constructing a breaker and collecting the values
of NEXT-BREAK in a loop.
See MAKE-BREAKER
See NEXT-BREAK
Loads the databases from their files into memory.
If one of the files is missing, a warning of type NO-DATABASE-FILES is
signalled. If the loading succeeds, T is returned.
See *LINE-BREAK-DATABASE-FILE*
See *PAIR-TABLE-FILE*
See NO-DATABASE-FILES
Returns a breaker that can find line break opportunities in the given string.
If the optional breaker argument is supplied, the supplied breaker is
modified and reset to work with the new string instead. This allows
you to re-use a breaker.
Note that while you may pass a non-simple string, modifying this
string without resetting any breaker using it will result in undefined
behaviour.
See BREAKER
Returns the next line breaking opportunity of the breaker, if any.
Returns two values:
POSITION — The character index in the string at which the break
is located, or NIL if no further breaks are possible.
MANDATORY — Whether the break must be made at this location.
Note that there is always in the very least one break opportunity,
namely at the end of the string. However, after consuming this break
opportunity, NEXT-BREAK will return NIL.
Note that you may have to insert additional line breaks as required by
the layout constraints.
See BREAKER
Warning signalled when LOAD-DATABASES is called and the files are not present.
Two restarts must be active when this condition is signalled:
COMPILE — Call COMPILE-DATABASES
ABORT — Abort loading the databases, leaving them at their
previous state.
See LOAD-DATABASES
warning.
Contains line breaking state.
An instance of this is only useful for passing to MAKE-BREAKER and
NEXT-BREAK. It contains internal state that manages the line breaking
algorithm.
See MAKE-BREAKER
See NEXT-BREAK
structure-object.
common-lisp.
string
org.shirakumo.alloy.uax-14::idx
0
org.shirakumo.alloy.uax-14::idx
0
(unsigned-byte 8)
0
(unsigned-byte 8)
0
boolean
boolean
org.shirakumo.alloy.uax-14::idx
0
lb8a.
pos.
| Jump to: | %
(
B C D F H L M N P T |
|---|
| Jump to: | %
(
B C D F H L M N P T |
|---|
| Jump to: | *
C L N P S |
|---|
| Jump to: | *
C L N P S |
|---|
| Jump to: | B C D F I N O P S T U |
|---|
| Jump to: | B C D F I N O P S T U |
|---|