The cl-locale Reference Manual

Table of Contents

The cl-locale Reference Manual

This is the cl-locale Reference Manual, version 0.1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:21:10 2020 GMT+0.

1 Introduction

CL-Locale - Simple i18n library for Common Lisp

Usage

(cl-locale:enable-locale-syntax)

(define-dictionary schedule
  (:ja-JP #p"i18n/ja_JP/message.lisp")
  (:fr-FR #p"i18n/fr_FR/message.lisp"))

(define-dictionary lisp
  (:ja-JP #p"i18n/ja_JP/message.lisp"))

(setf (current-dictionary) :schedule)

#i"Schedule"
;=> "Schedule"

(i18n "Schedule" :locale :ja-JP)
;=> "予定"

(let ((*locale* :fr-FR))
  #i"Schedule")
;=> "Calendrier"

#i("Comments: ~A" 10)
;=> "コメント: 10個"

What the difference

• cl-i18n: Does nit support loading multiple locales at the same time.
• cl-l10n: No reader macro predefined. No tools to automatically generate localizable files / language files.

Dictionary Resource

; ja_JP/message.lisp
(("Schedule" . "予定")
 ("Lisping" . "舌足らず"))

; fr_FR/message.lisp
(("Schedule" . "Calendrier"))

License

Copyright (c) 2011 Eitarow Fukamachi
Licensed

2 Systems

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

2.1 cl-locale

Author

Eitarow Fukamachi

License

LLGPL

Description

Simple i18n library for Common Lisp

Long Description

# CL-Locale - Simple i18n library for Common Lisp
[](https://travis-ci.org/fukamachi/cl-locale)
[](https://coveralls.io/r/fukamachi/cl-locale?branch=master)

## Usage

(cl-locale:enable-locale-syntax)

(define-dictionary schedule
(:ja-JP #p"i18n/ja_JP/message.lisp")
(:fr-FR #p"i18n/fr_FR/message.lisp"))

(define-dictionary lisp
(:ja-JP #p"i18n/ja_JP/message.lisp"))

(setf (current-dictionary) :schedule)

#i"Schedule"
;=> "Schedule"

(i18n "Schedule" :locale :ja-JP)
;=> "予定"

(let ((*locale* :fr-FR))
#i"Schedule")
;=> "Calendrier"

#i("Comments: ~A" 10)
;=> "コメント: 10個"

## What the difference

* cl-i18n: Does nit support loading multiple locales at the same time.
* cl-l10n: No reader macro predefined. No tools to automatically generate localizable files / language files.

## Dictionary Resource

; ja_JP/message.lisp
(("Schedule" . "予定")
("Lisping" . "舌足らず"))

; fr_FR/message.lisp
(("Schedule" . "Calendrier"))

## License

Copyright (c) 2011 Eitarow Fukamachi
Licensed under the LLGPL License.

Version

0.1.1

Dependencies

• anaphora
• arnesi
• cl-annot
• cl-syntax
• cl-syntax-annot

Source

cl-locale.asd (file)

Component

src (module)

3 Modules

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

3.1 cl-locale/src

Parent

cl-locale (system)

Location

src/

Components

• locale.lisp (file)
• core.lisp (file)
• reader.lisp (file)
• syntax.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 cl-locale.asd

Location

cl-locale.asd

Systems

cl-locale (system)

Packages

cl-locale-asd

4.1.2 cl-locale/src/locale.lisp

Dependencies

• core.lisp (file)
• reader.lisp (file)
• syntax.lisp (file)

Parent

src (module)

Location

src/locale.lisp

Packages

cl-locale

4.1.3 cl-locale/src/core.lisp

Parent

src (module)

Location

src/core.lisp

Packages

cl-locale.core

Exported Definitions

• *default-locale* (special variable)
• *dictionary-tables* (special variable)
• *locale* (special variable)
• current-dictionary (function)
• (setf current-dictionary) (function)
• define-dictionary (macro)
• i18n (function)
• i18n-unformatted (function)
• register-dictionary (method)
• register-dictionary (method)

Internal Definitions

• %define-dictionary (function)
• *dictionary* (special variable)
• ensure-dictionary (function)
• ensure-hash-table (function)
• slurp-file (function)

4.1.4 cl-locale/src/reader.lisp

Dependency

core.lisp (file)

Parent

src (module)

Location

src/reader.lisp

Packages

cl-locale.reader

Exported Definitions

• enable-locale-syntax (macro)
• i18n-reader (function)
• i18n-unformatted-reader (function)

Internal Definitions

%enable-locale-syntax (function)

4.1.5 cl-locale/src/syntax.lisp

Dependency

reader.lisp (file)

Parent

src (module)

Location

src/syntax.lisp

Packages

cl-locale.syntax

Exported Definitions

locale-syntax (special variable)

5 Packages

Packages are listed by definition order.

5.1 cl-locale-asd

Source

cl-locale.asd

Use List

• asdf/interface
• common-lisp

5.2 cl-locale

Source

locale.lisp (file)

Nickname

locale

Use List

• cl-locale.syntax
• cl-locale.reader
• cl-locale.core
• common-lisp

5.3 cl-locale.core

Source

core.lisp (file)

Use List

• anaphora
• cl-syntax
• common-lisp

Used By List

• cl-locale
• cl-locale.reader

Exported Definitions

• *default-locale* (special variable)
• *dictionary-tables* (special variable)
• *locale* (special variable)
• current-dictionary (function)
• (setf current-dictionary) (function)
• define-dictionary (macro)
• i18n (function)
• i18n-unformatted (function)
• register-dictionary (generic function)
• register-dictionary (method)
• register-dictionary (method)

Internal Definitions

• %define-dictionary (function)
• *dictionary* (special variable)
• ensure-dictionary (function)
• ensure-hash-table (function)
• slurp-file (function)

5.4 cl-locale.reader

Source

reader.lisp (file)

Use List

• cl-locale.core
• cl-syntax
• common-lisp

Used By List

cl-locale

Exported Definitions

• enable-locale-syntax (macro)
• i18n-reader (function)
• i18n-unformatted-reader (function)

Internal Definitions

%enable-locale-syntax (function)

5.5 cl-locale.syntax

Source

syntax.lisp (file)

Use List

common-lisp

Used By List

cl-locale

Exported Definitions

locale-syntax (special variable)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *default-locale*

Package

cl-locale.core

Source

core.lisp (file)

Special Variable: *dictionary-tables*

Package

cl-locale.core

Source

core.lisp (file)

Special Variable: *locale*

Package

cl-locale.core

Source

core.lisp (file)

Special Variable: locale-syntax

Package

cl-locale.syntax

Source

syntax.lisp (file)

6.1.2 Macros

Macro: define-dictionary NAME &body MSG-CLAUSES

Package

cl-locale.core

Source

core.lisp (file)

Macro: enable-locale-syntax ()

Package

cl-locale.reader

Source

reader.lisp (file)

6.1.3 Functions

Function: current-dictionary ()

Function: (setf current-dictionary) NAME

Package

cl-locale.core

Source

core.lisp (file)

Function: i18n STRING &key PARAMS LOCALE DICTIONARY

Package

cl-locale.core

Source

core.lisp (file)

Function: i18n-reader STREAM CHAR NUMARG

Package

cl-locale.reader

Source

reader.lisp (file)

Function: i18n-unformatted STRING &key LOCALE DICTIONARY

Package

cl-locale.core

Source

core.lisp (file)

Function: i18n-unformatted-reader STREAM CHAR NUMARG

Package

cl-locale.reader

Source

reader.lisp (file)

6.1.4 Generic functions

Generic Function: register-dictionary NAME DICT &key LOCALE

Package

cl-locale.core

Methods

Method: register-dictionary NAME (DICT pathname) &key LOCALE

Source

core.lisp (file)

Method: register-dictionary NAME (DICT cons) &key LOCALE

Example: (register-dictionary :schedule ’(("Schedule" . "予定")) :locale :ja-JP)

Source

core.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *dictionary*

Package

cl-locale.core

Source

core.lisp (file)

6.2.2 Functions

Function: %define-dictionary NAME &rest MSG-CLAUSES

Package

cl-locale.core

Source

core.lisp (file)

Function: %enable-locale-syntax ()

Package

cl-locale.reader

Source

reader.lisp (file)

Function: ensure-dictionary NAME

Package

cl-locale.core

Source

core.lisp (file)

Function: ensure-hash-table KEY HASH

Package

cl-locale.core

Source

core.lisp (file)

Function: slurp-file PATH

Read a specified file and return the content as a sequence.

Package

cl-locale.core

Source

core.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types