Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-locale Reference Manual

This is the cl-locale Reference Manual, version 0.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:21:40 2023 GMT+0.

Next: Systems, Previous: The cl-locale Reference Manual, Up: The cl-locale Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-locale Reference Manual [Contents][Index]

2 Systems

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

cl-locale

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-locale`

Simple i18n library for Common Lisp

Author

Eitarow Fukamachi

License

LLGPL

Long Description

# CL-Locale - Simple i18n library for Common Lisp
[![Build Status](https://travis-ci.org/fukamachi/cl-locale.svg?branch=master)](https://travis-ci.org/fukamachi/cl-locale)
[![Coverage Status](https://coveralls.io/repos/fukamachi/cl-locale/badge.svg?branch=master)](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

Version

0.1.1

Dependencies

anaphora (system).
arnesi (system).
cl-annot (system).
cl-syntax (system).
cl-syntax-annot (system).

Source

cl-locale.asd.

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-locale Reference Manual [Contents][Index]

3 Modules

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

cl-locale/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-locale/src`

Source

cl-locale.asd.

Parent Component

cl-locale (system).

Child Components

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

Next: Packages, Previous: Modules, Up: The cl-locale Reference Manual [Contents][Index]

4 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-locale/src/locale.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-locale/cl-locale.asd`

Source: cl-locale.asd.
Parent Component: cl-locale (system).
ASDF Systems: cl-locale.
Packages: cl-locale-asd.

Next: cl-locale/src/core.lisp, Previous: cl-locale/cl-locale.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-locale/src/locale.lisp`

Dependencies

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

Source

cl-locale.asd.

Parent Component

src (module).

Packages

cl-locale.

Next: cl-locale/src/reader.lisp, Previous: cl-locale/src/locale.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-locale/src/core.lisp`

Source

cl-locale.asd.

Parent Component

src (module).

Packages

cl-locale.core.

Public Interface

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

Internals

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

Next: cl-locale/src/syntax.lisp, Previous: cl-locale/src/core.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-locale/src/reader.lisp`

Dependency

core.lisp (file).

Source

cl-locale.asd.

Parent Component

src (module).

Packages

cl-locale.reader.

Public Interface

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

Internals

%enable-locale-syntax (function).

Previous: cl-locale/src/reader.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-locale/src/syntax.lisp`

Dependency: reader.lisp (file).
Source: cl-locale.asd.
Parent Component: src (module).
Packages: cl-locale.syntax.
Public Interface: locale-syntax (special variable).

Next: Definitions, Previous: Files, Up: The cl-locale Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-locale
cl-locale-asd
cl-locale.syntax
cl-locale.core
cl-locale.reader

Next: cl-locale-asd, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-locale`

Source

locale.lisp.

Nickname

locale

Use List

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

Next: cl-locale.syntax, Previous: cl-locale, Up: Packages [Contents][Index]

5.2 `cl-locale-asd`

Source

cl-locale.asd.

Use List

asdf/interface.
common-lisp.

Next: cl-locale.core, Previous: cl-locale-asd, Up: Packages [Contents][Index]

5.3 `cl-locale.syntax`

Source: syntax.lisp.
Use List: common-lisp.
Used By List: cl-locale.
Public Interface: locale-syntax (special variable).

Next: cl-locale.reader, Previous: cl-locale.syntax, Up: Packages [Contents][Index]

5.4 `cl-locale.core`

Source

core.lisp.

Use List

anaphora.
cl-syntax.
common-lisp.

Used By List

cl-locale.
cl-locale.reader.

Public Interface

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

Internals

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

Previous: cl-locale.core, Up: Packages [Contents][Index]

5.5 `cl-locale.reader`

Source

reader.lisp.

Use List

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

Used By List

cl-locale.

Public Interface

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

Internals

%enable-locale-syntax (function).

Next: Indexes, Previous: Packages, Up: The cl-locale Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *default-locale* ¶

Package: cl-locale.core.
Source: core.lisp.

Special Variable: *dictionary-tables* ¶

Package: cl-locale.core.
Source: core.lisp.

Special Variable: *locale* ¶

Package: cl-locale.core.
Source: core.lisp.

Special Variable: locale-syntax ¶

Package: cl-locale.syntax.
Source: syntax.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Macros

Macro: define-dictionary (name &body msg-clauses) ¶

Package: cl-locale.core.
Source: core.lisp.

Macro: enable-locale-syntax () ¶

Package: cl-locale.reader.
Source: reader.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.3 Ordinary functions

Function: current-dictionary () ¶

Package: cl-locale.core.
Source: core.lisp.

Function: (setf current-dictionary) () ¶

Package: cl-locale.core.
Source: core.lisp.

Function: i18n (string &key params locale dictionary) ¶

Package: cl-locale.core.
Source: core.lisp.

Function: i18n-reader (stream char numarg) ¶

Package: cl-locale.reader.
Source: reader.lisp.

Function: i18n-unformatted (string &key locale dictionary) ¶

Package: cl-locale.core.
Source: core.lisp.

Function: i18n-unformatted-reader (stream char numarg) ¶

Package: cl-locale.reader.
Source: reader.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

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.

Method: register-dictionary (name (dict cons) &key locale) ¶

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

Source: core.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Special variables

Special Variable: *dictionary* ¶

Package: cl-locale.core.
Source: core.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: %define-dictionary (name &rest msg-clauses) ¶

Package: cl-locale.core.
Source: core.lisp.

Function: %enable-locale-syntax () ¶

Package: cl-locale.reader.
Source: reader.lisp.

Function: ensure-dictionary (name) ¶

Package: cl-locale.core.
Source: core.lisp.

Function: ensure-hash-table (key hash) ¶

Package: cl-locale.core.
Source: core.lisp.

Function: slurp-file (path) ¶

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

Package: cl-locale.core.
Source: core.lisp.

Previous: Definitions, Up: The cl-locale Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% ( C D E F G I M R S

	Index Entry	Section

%
	`%define-dictionary`:	Private ordinary functions
	`%enable-locale-syntax`:	Private ordinary functions

(
	`(setf current-dictionary)`:	Public ordinary functions

C
	`current-dictionary`:	Public ordinary functions

D
	`define-dictionary`:	Public macros

E
	`enable-locale-syntax`:	Public macros
	`ensure-dictionary`:	Private ordinary functions
	`ensure-hash-table`:	Private ordinary functions

F
	`Function, %define-dictionary`:	Private ordinary functions
	`Function, %enable-locale-syntax`:	Private ordinary functions
	`Function, (setf current-dictionary)`:	Public ordinary functions
	`Function, current-dictionary`:	Public ordinary functions
	`Function, ensure-dictionary`:	Private ordinary functions
	`Function, ensure-hash-table`:	Private ordinary functions
	`Function, i18n`:	Public ordinary functions
	`Function, i18n-reader`:	Public ordinary functions
	`Function, i18n-unformatted`:	Public ordinary functions
	`Function, i18n-unformatted-reader`:	Public ordinary functions
	`Function, slurp-file`:	Private ordinary functions

G
	`Generic Function, register-dictionary`:	Public generic functions

I
	`i18n`:	Public ordinary functions
	`i18n-reader`:	Public ordinary functions
	`i18n-unformatted`:	Public ordinary functions
	`i18n-unformatted-reader`:	Public ordinary functions

M
	`Macro, define-dictionary`:	Public macros
	`Macro, enable-locale-syntax`:	Public macros
	`Method, register-dictionary`:	Public generic functions
	`Method, register-dictionary`:	Public generic functions

R
	`register-dictionary`:	Public generic functions
	`register-dictionary`:	Public generic functions
	`register-dictionary`:	Public generic functions

S
	`slurp-file`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* L S

	Index Entry	Section

*
	`default-locale`:	Public special variables
	`dictionary`:	Private special variables
	`dictionary-tables`:	Public special variables
	`locale`:	Public special variables

L
	`locale-syntax`:	Public special variables

S
	`Special Variable, default-locale`:	Public special variables
	`Special Variable, dictionary`:	Private special variables
	`Special Variable, dictionary-tables`:	Public special variables
	`Special Variable, locale`:	Public special variables
	`Special Variable, locale-syntax`:	Public special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F L M P R S

	Index Entry	Section

C
	`cl-locale`:	The cl-locale system
	`cl-locale`:	The cl-locale package
	`cl-locale-asd`:	The cl-locale-asd package
	`cl-locale.asd`:	The cl-locale/cl-locale․asd file
	`cl-locale.core`:	The cl-locale․core package
	`cl-locale.reader`:	The cl-locale․reader package
	`cl-locale.syntax`:	The cl-locale․syntax package
	`core.lisp`:	The cl-locale/src/core․lisp file

F
	`File, cl-locale.asd`:	The cl-locale/cl-locale․asd file
	`File, core.lisp`:	The cl-locale/src/core․lisp file
	`File, locale.lisp`:	The cl-locale/src/locale․lisp file
	`File, reader.lisp`:	The cl-locale/src/reader․lisp file
	`File, syntax.lisp`:	The cl-locale/src/syntax․lisp file

L
	`locale.lisp`:	The cl-locale/src/locale․lisp file

M
	`Module, src`:	The cl-locale/src module

P
	`Package, cl-locale`:	The cl-locale package
	`Package, cl-locale-asd`:	The cl-locale-asd package
	`Package, cl-locale.core`:	The cl-locale․core package
	`Package, cl-locale.reader`:	The cl-locale․reader package
	`Package, cl-locale.syntax`:	The cl-locale․syntax package

R
	`reader.lisp`:	The cl-locale/src/reader․lisp file

S
	`src`:	The cl-locale/src module
	`syntax.lisp`:	The cl-locale/src/syntax․lisp file
	`System, cl-locale`:	The cl-locale system

The cl-locale Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-locale

3 Modules

3.1 cl-locale/src

4 Files

4.1 Lisp

4.1.1 cl-locale/cl-locale.asd

4.1.2 cl-locale/src/locale.lisp

4.1.3 cl-locale/src/core.lisp

4.1.4 cl-locale/src/reader.lisp

4.1.5 cl-locale/src/syntax.lisp

5 Packages

5.1 cl-locale

5.2 cl-locale-asd

5.3 cl-locale.syntax

5.4 cl-locale.core

5.5 cl-locale.reader

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Ordinary functions

6.1.4 Generic functions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-locale`

3.1 `cl-locale/src`

4.1.1 `cl-locale/cl-locale.asd`

4.1.2 `cl-locale/src/locale.lisp`

4.1.3 `cl-locale/src/core.lisp`

4.1.4 `cl-locale/src/reader.lisp`

4.1.5 `cl-locale/src/syntax.lisp`

5.1 `cl-locale`

5.2 `cl-locale-asd`

5.3 `cl-locale.syntax`

5.4 `cl-locale.core`

5.5 `cl-locale.reader`