The gettext Reference Manual

This is the gettext Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:32:37 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 gettext

An pure Common Lisp implementation of gettext runtime. gettext is an internationalization and localization (i18n) system commonly used for writing multilingual programs on Unix-like computer operating systems.

Author

Thomas Bakketun <>

License

GNU Lesser General Public Licence 3.0

Dependencies
  • split-sequence (system).
  • yacc (system).
  • flexi-streams (system).
Source

gettext.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 gettext/gettext.asd

Source

gettext.asd.

Parent Component

gettext (system).

ASDF Systems

gettext.


3.1.2 gettext/packages.lisp

Source

gettext.asd.

Parent Component

gettext (system).

Packages

gettext.


3.1.3 gettext/plurals-0.lisp

Dependency

packages.lisp (file).

Source

gettext.asd.

Parent Component

gettext (system).

Internals

op2 (function).


3.1.4 gettext/plurals.lisp

Dependency

plurals-0.lisp (file).

Source

gettext.asd.

Parent Component

gettext (system).

Internals

3.1.5 gettext/gettext.lisp

Dependency

plurals.lisp (file).

Source

gettext.asd.

Parent Component

gettext (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 gettext

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *current-locale*
Package

gettext.

Source

gettext.lisp.


5.1.2 Macros

Macro: preload-catalogs (textdomaindir)
Package

gettext.

Source

gettext.lisp.

Macro: setup-gettext (package default-domain)
Package

gettext.

Source

gettext.lisp.


5.1.3 Ordinary functions

Function: catalog-meta* (&optional domain catergory locale)
Package

gettext.

Source

gettext.lisp.

Function: gettext* (msgid &optional domain category locale)
Package

gettext.

Source

gettext.lisp.

Function: gettext-noop (msgid)
Package

gettext.

Source

gettext.lisp.

Function: ngettext* (msgid1 msgid2 n &optional domain category locale)
Package

gettext.

Source

gettext.lisp.

Function: textdomain ()
Package

gettext.

Source

gettext.lisp.

Function: (setf textdomain) ()
Package

gettext.

Source

gettext.lisp.

Function: textdomaindir (domain)
Package

gettext.

Source

gettext.lisp.

Function: (setf textdomaindir) (domain)
Package

gettext.

Source

gettext.lisp.


5.1.4 Types

Type: lc-category ()
Package

gettext.

Source

gettext.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *catalog-cache*
Package

gettext.

Source

gettext.lisp.

Special Variable: *plural-expression-parser*
Package

gettext.

Source

plurals.lisp.

Special Variable: *textdomain*
Package

gettext.

Source

gettext.lisp.

Special Variable: *textdomaindirs*
Package

gettext.

Source

gettext.lisp.


5.2.2 Ordinary functions

Reader: catalog-headers (instance)
Writer: (setf catalog-headers) (instance)
Package

gettext.

Source

gettext.lisp.

Target Slot

headers.

Reader: catalog-key (instance)
Writer: (setf catalog-key) (instance)
Package

gettext.

Source

gettext.lisp.

Target Slot

key.

Reader: catalog-messages (instance)
Writer: (setf catalog-messages) (instance)
Package

gettext.

Source

gettext.lisp.

Target Slot

messages.

Reader: catalog-nplurals (instance)
Writer: (setf catalog-nplurals) (instance)
Package

gettext.

Source

gettext.lisp.

Target Slot

nplurals.

Function: catalog-p (object)
Package

gettext.

Source

gettext.lisp.

Function: catalog-pathname (key)
Package

gettext.

Source

gettext.lisp.

Reader: catalog-plurals-function (instance)
Writer: (setf catalog-plurals-function) (instance)
Package

gettext.

Source

gettext.lisp.

Target Slot

plurals-function.

Function: compile-plural (expr)
Package

gettext.

Source

plurals.lisp.

Function: construct-catalog (key messages)
Package

gettext.

Source

gettext.lisp.

Function: copy-catalog (instance)
Package

gettext.

Source

gettext.lisp.

Function: decode-catalog-pathname (pathname)
Package

gettext.

Source

gettext.lisp.

Function: define-catalog (key &optional messages)
Package

gettext.

Source

gettext.lisp.

Function: digitp (c)
Package

gettext.

Source

plurals.lisp.

Function: get-catalog (locale category domain)
Package

gettext.

Source

gettext.lisp.

Function: lexer (stream)
Package

gettext.

Source

plurals.lisp.

Function: lookup (msgid domain category locale)
Package

gettext.

Source

gettext.lisp.

Function: make-catalog (&key key headers nplurals plurals-function messages)
Package

gettext.

Source

gettext.lisp.

Function: null-split (string)
Package

gettext.

Source

gettext.lisp.

Function: op2 (a b c)
Package

gettext.

Source

plurals-0.lisp.

Function: parse-headers (string)
Package

gettext.

Source

gettext.lisp.

Function: parse-plural (string)
Package

gettext.

Source

plurals.lisp.

Function: parse-plurals-form (string)
Package

gettext.

Source

plurals.lisp.

Function: read-mo (pathname)
Package

gettext.

Source

gettext.lisp.

Function: transform (expr)
Package

gettext.

Source

plurals.lisp.


5.2.3 Structures

Structure: catalog
Package

gettext.

Source

gettext.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: key
Readers

catalog-key.

Writers

(setf catalog-key).

Slot: headers
Readers

catalog-headers.

Writers

(setf catalog-headers).

Slot: nplurals
Readers

catalog-nplurals.

Writers

(setf catalog-nplurals).

Slot: plurals-function
Readers

catalog-plurals-function.

Writers

(setf catalog-plurals-function).

Slot: messages
Readers

catalog-messages.

Writers

(setf catalog-messages).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   F   G   L   M   N   O   P   R   S   T  
Index Entry  Section

(
(setf catalog-headers): Private ordinary functions
(setf catalog-key): Private ordinary functions
(setf catalog-messages): Private ordinary functions
(setf catalog-nplurals): Private ordinary functions
(setf catalog-plurals-function): Private ordinary functions
(setf textdomain): Public ordinary functions
(setf textdomaindir): Public ordinary functions

C
catalog-headers: Private ordinary functions
catalog-key: Private ordinary functions
catalog-messages: Private ordinary functions
catalog-meta*: Public ordinary functions
catalog-nplurals: Private ordinary functions
catalog-p: Private ordinary functions
catalog-pathname: Private ordinary functions
catalog-plurals-function: Private ordinary functions
compile-plural: Private ordinary functions
construct-catalog: Private ordinary functions
copy-catalog: Private ordinary functions

D
decode-catalog-pathname: Private ordinary functions
define-catalog: Private ordinary functions
digitp: Private ordinary functions

F
Function, (setf catalog-headers): Private ordinary functions
Function, (setf catalog-key): Private ordinary functions
Function, (setf catalog-messages): Private ordinary functions
Function, (setf catalog-nplurals): Private ordinary functions
Function, (setf catalog-plurals-function): Private ordinary functions
Function, (setf textdomain): Public ordinary functions
Function, (setf textdomaindir): Public ordinary functions
Function, catalog-headers: Private ordinary functions
Function, catalog-key: Private ordinary functions
Function, catalog-messages: Private ordinary functions
Function, catalog-meta*: Public ordinary functions
Function, catalog-nplurals: Private ordinary functions
Function, catalog-p: Private ordinary functions
Function, catalog-pathname: Private ordinary functions
Function, catalog-plurals-function: Private ordinary functions
Function, compile-plural: Private ordinary functions
Function, construct-catalog: Private ordinary functions
Function, copy-catalog: Private ordinary functions
Function, decode-catalog-pathname: Private ordinary functions
Function, define-catalog: Private ordinary functions
Function, digitp: Private ordinary functions
Function, get-catalog: Private ordinary functions
Function, gettext*: Public ordinary functions
Function, gettext-noop: Public ordinary functions
Function, lexer: Private ordinary functions
Function, lookup: Private ordinary functions
Function, make-catalog: Private ordinary functions
Function, ngettext*: Public ordinary functions
Function, null-split: Private ordinary functions
Function, op2: Private ordinary functions
Function, parse-headers: Private ordinary functions
Function, parse-plural: Private ordinary functions
Function, parse-plurals-form: Private ordinary functions
Function, read-mo: Private ordinary functions
Function, textdomain: Public ordinary functions
Function, textdomaindir: Public ordinary functions
Function, transform: Private ordinary functions

G
get-catalog: Private ordinary functions
gettext*: Public ordinary functions
gettext-noop: Public ordinary functions

L
lexer: Private ordinary functions
lookup: Private ordinary functions

M
Macro, preload-catalogs: Public macros
Macro, setup-gettext: Public macros
make-catalog: Private ordinary functions

N
ngettext*: Public ordinary functions
null-split: Private ordinary functions

O
op2: Private ordinary functions

P
parse-headers: Private ordinary functions
parse-plural: Private ordinary functions
parse-plurals-form: Private ordinary functions
preload-catalogs: Public macros

R
read-mo: Private ordinary functions

S
setup-gettext: Public macros

T
textdomain: Public ordinary functions
textdomaindir: Public ordinary functions
transform: Private ordinary functions