The cl-i18n Reference Manual

3.1.1 cl-i18n/cl-i18n.asd

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

ASDF Systems

cl-i18n.

Packages

cl-i18n-asd.

---

3.1.2 cl-i18n/package.lisp

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Packages

• cl-i18n-utils.
• i18n-conditions.
• cl-i18n.
• utx-file.

---

3.1.3 cl-i18n/function-name.lisp

Dependency

package.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Internals

• *sbcl-readtable* (special variable).
• get-function-name (function).
• parse-name (function).

---

3.1.4 cl-i18n/utils.lisp

Dependency

package.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• *directory-sep* (special variable).
• *directory-sep-regexp* (special variable).
• search-mo-repository (function).
• slurp-file (function).

Internals

• *mofile-repo-exclude-path* (special variable).
• *valid-dir-average-mofile-repo* (special variable).
• *valid-dir-mofile-repo* (special variable).
• *valid-dir-rate-mofile-repo* (special variable).
• *well-known-mofile-path* (special variable).
• +lisp-table-ext-re+ (constant).
• +lisp-table-extension+ (constant).
• +mo-file-magic-number+ (constant).
• +mofile-ext-re+ (constant).
• +mofile-extension+ (constant).
• +pofile-ext-re+ (constant).
• +pofile-extension+ (constant).
• +utx-ext-re+ (constant).
• +utx-extension+ (constant).
• cat-parent-dir (function).
• count-mo-files (function).
• count-mo-files-direct-children (function).
• create-brand-new-file (function).
• directoryp (function).
• do-directory (macro).
• equals-path-fn (function).
• excluded-path-p (function).
• file-does-not-exists-p (function).
• file-exists-p (function).
• file-extension (function).
• file-has-mo-magic-number-p (function).
• file-size (function).
• is-mo-file-p (function).
• list-directory-entries (function).
• mo-repository-p (function).
• pathname->string (function).
• remove-regular-files (function).
• scan-mo-files (function).
• uchar-length (function).
• utf8-encoded-p (function).
• when-debug (macro).

---

3.1.5 cl-i18n/conditions.lisp

Dependency

package.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• no-translation (condition).
• no-translation-table-error (condition).
• out-of-bounds (condition).
• parsing-mofile-error (condition).
• parsing-pofile-error (condition).
• parsing-utxfile-error (condition).

Internals

• defcond (macro).
• idx (reader method).
• not-implemented-error (condition).
• null-reference (condition).
• seq (reader method).
• text (reader method).
• text (reader method).
• text-error (condition).
• text-warning (condition).

---

3.1.6 cl-i18n/buffered-input-file.lisp

Dependencies

• utils.lisp (file).
• conditions.lisp (file).
• package.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• get-line (generic function).
• initialize-instance (method).
• print-object (method).
• seek (generic function).

Internals

• +default-buffer-size+ (constant).
• +default-element-type+ (constant).
• actual-file-position (generic function).
• adjust-buffer (generic function).
• adjust-buffer-backward (generic function).
• buffer (reader method).
• (setf buffer) (writer method).
• buffer-position (reader method).
• (setf buffer-position) (writer method).
• buffer-uchar-length (function).
• buffered-input-file (class).
• cached-string (reader method).
• (setf cached-string) (writer method).
• close-file (generic function).
• decrement-pointer (generic function).
• enlarge-buffer (generic function).
• filename (reader method).
• (setf filename) (writer method).
• get-char (generic function).
• get-char-then-increment-pointer (generic function).
• increment-pointer (generic function).
• increment-pointer-then-get-char (generic function).
• inner-stream (reader method).
• (setf inner-stream) (writer method).
• inside-buffer-p (generic function).
• line-mode (reader method).
• (setf line-mode) (writer method).
• logical-file-position (reader method).
• (setf logical-file-position) (writer method).
• make-buffer (function).
• outside-buffer-p (generic function).
• read-adjust-buffer (generic function).
• regex-scan (generic function).
• regex-scan-line-mode (generic function).
• regex-scan-line-simple (generic function).
• replace-buffer (generic function).
• replace-buffer-backward (generic function).
• replace-buffer-forward (generic function).
• statistics (reader method).
• (setf statistics) (writer method).
• stream-length (generic function).
• truncate-buffer (generic function).
• uchars-count (reader method).
• (setf uchars-count) (writer method).
• unget-char (generic function).
• valid-stream-p (generic function).
• with-file-position (macro).
• with-ustring (macro).

---

3.1.7 cl-i18n/plural-forms.lisp

Dependency

package.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• brazilian-plural-form (function).
• bulgarian-plural-form (function).
• croatian-plural-form (function).
• czech-plural-form (function).
• danish-plural-form (function).
• define-plural-form (macro).
• dutch-plural-form (function).
• english-plural-form (function).
• esperanto-plural-form (function).
• estonian-plural-form (function).
• faroese-plural-form (function).
• finnish-plural-form (function).
• french-plural-form (function).
• gaeilge-plural-form (function).
• german-plural-form (function).
• greek-plural-form (function).
• hebrew-plural-form (function).
• hungarian-plural-form (function).
• irish-plural-form (function).
• italian-plural-form (function).
• latvian-plural-form (function).
• lithuanian-plural-form (function).
• n/=1-plural-form (function).
• norwegian-plural-form (function).
• polish-plural-form (function).
• portuguese-plural-form (function).
• romanian-plural-form (function).
• russian-plural-form (function).
• serbian-plural-form (function).
• slovak-plural-form (function).
• slovenian-plural-form (function).
• spanish-plural-form (function).
• swedish-plural-form (function).
• turkish-plural-form (function).
• ukrainian-plural-form (function).

---

3.1.8 cl-i18n/translation-class.lisp

Dependency

plural-forms.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• +fuzzy-flag+ (constant).
• +id+ (constant).
• +plurals+ (constant).
• +plurals-form+ (constant).
• +status+ (constant).
• +translated-flag+ (constant).
• +translation+ (constant).
• +untranslated-flag+ (constant).
• flag (reader method).
• (setf flag) (writer method).
• make-load-form (method).
• make-translation (function).
• print-object (method).
• translated (reader method).
• (setf translated) (writer method).
• translation (class).
• translation-hash-table->list (function).
• translation-list->hash-table (generic function).

Internals

• copy-translation (generic function).
• plural-form (reader method).
• (setf plural-form) (writer method).
• plural-translated (reader method).
• (setf plural-translated) (writer method).

---

3.1.9 cl-i18n/parser.lisp

Dependency

buffered-input-file.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• *file* (special variable).
• *has-errors* (special variable).
• *parsing-errors* (special variable).
• comment-line (reader method).
• (setf comment-line) (writer method).
• define-parser-skeleton (macro).
• define-tokenizer (macro).
• defnocfun (macro).
• is-comment-line-p (generic function).
• next-token (generic function).
• parse-comment-line (generic function).
• parsed-file (class).
• peek-token (generic function).
• peek-token-suppress-errors (generic function).
• peek-valid-stream (function).
• with-error (macro).
• with-no-errors (macro).
• with-no-errors* (macro).

Internals

• *blank-space* (special variable).
• *string-pos* (special variable).
• +peek-length-tokenizer-on-error+ (constant).
• 1+char@ (function).
• char@ (function).
• char@1+ (function).
• concatenate-regexps (function).
• define-is-stuff-p (macro).
• define-parser-skeleton* (macro).
• define-tokenizer-simple (macro).
• let-noerr (macro).
• let-noerr* (macro).
• multiple-increment (macro).
• next-token-simple (generic function).
• peek-end-stream (function).
• scanner-re (macro).
• with-valid-stream (macro).

---

3.1.10 cl-i18n/utx-file.lisp

Dependencies

• parser.lisp (file).
• translation-class.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• initialize-instance (method).
• next-token (method).
• parse-comment-line (method).
• parse-utx-file (function).
• peek-token (method).
• utx-parsed-file (class).
• with-utx-file (macro).

Internals

• *fields-position* (special variable).
• +column+ (constant).
• +column-id+ (constant).
• +line-stopper+ (constant).
• +plural-field+ (constant).
• +status-accepted+ (constant).
• +status-field+ (constant).
• +status-forbidden+ (constant).
• +utx-ignored-line+ (constant).
• get-field (macro).
• last-column-p (function).
• last-comment-line-p (generic function).
• min-column-number-p (function).
• parse-utx-column (function).
• parse-utx-column-description (function).
• parse-utx-line (function).
• parse-utx-lines (function).
• row-plural (function).
• row-src (function).
• row-status (function).
• row-target (function).
• status-forbidden-p (function).
• status-translated-p (function).
• trim-rows (function).

---

3.1.11 cl-i18n/pofile.lisp

Dependencies

• parser.lisp (file).
• translation-class.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• initialize-instance (method).
• next-token (method).
• with-po-file (macro).

Internals

• != (function).
• % (function).
• && (function).
• *aritm-op* (special variable).
• *boolean-op* (special variable).
• *compar-op* (special variable).
• *n* (special variable).
• +!=+ (constant).
• +%+ (constant).
• +<+ (constant).
• +<=+ (constant).
• +==+ (constant).
• +>+ (constant).
• +>=+ (constant).
• +?+ (constant).
• +?-regex+ (constant).
• +agnostic-comment+ (constant).
• +and-op+ (constant).
• +close-paren+ (constant).
• +close-paren-regex+ (constant).
• +colon+ (constant).
• +end-expression+ (constant).
• +escape-newline+ (constant).
• +escape-string-escape-char+ (constant).
• +escape-string-escaped-newline+ (constant).
• +escaped-string-delim+ (constant).
• +flag-fuzzy+ (constant).
• +flag-line+ (constant).
• +msgid+ (constant).
• +msgid-plural+ (constant).
• +msgid-regexp+ (constant).
• +msgstr+ (constant).
• +msgstr-regexp+ (constant).
• +msgstr[]+ (constant).
• +msgstr[]-regexp+ (constant).
• +newline+ (constant).
• +nplurals-label+ (constant).
• +number+ (constant).
• +open-paren+ (constant).
• +open-paren-regex+ (constant).
• +or-op+ (constant).
• +or-op-regex+ (constant).
• +plural-expression-label+ (constant).
• +plural-form-label+ (constant).
• +po-comment-line+ (constant).
• +var+ (constant).
• <* (function).
• <=* (function).
• == (function).
• >* (function).
• >=* (function).
• bool-or (function).
• define-parse-operators (macro).
• execute-expression (function).
• extract-plural-function (function).
• is-!=-p (function).
• is-%-p (function).
• is-<-p (function).
• is-<=-p (function).
• is-==-p (function).
• is->-p (function).
• is->=-p (function).
• is-?-p (function).
• is-and-op-p (function).
• is-binary-operator (function).
• is-bool-op-p (function).
• is-close-paren-p (function).
• is-colon-p (function).
• is-end-expression-p (function).
• is-flag-line-p (function).
• is-fuzzy-flag-p (function).
• is-msgid-plural-p (function).
• is-msgid-regexp-p (function).
• is-msgstr-regexp-p (function).
• is-msgstr[]-regexp-p (function).
• is-number-p (function).
• is-open-paren-p (function).
• is-or-op-p (function).
• is-ternary-operator (function).
• is-var-p (function).
• parse-any-operator (function).
• parse-arithmetic-expression (function).
• parse-arithmetic-operator (function).
• parse-boolean-expression (function).
• parse-boolean-operator (function).
• parse-close-parent (function).
• parse-comparision-operator (function).
• parse-entries (function).
• parse-escaped-string (function).
• parse-expression (function).
• parse-header (function).
• parse-if-symbol (function).
• parse-msgid (function).
• parse-msgid-group (function).
• parse-msgid-plural (function).
• parse-msgid-plural-group (function).
• parse-msgstr (function).
• parse-msgstr-group (function).
• parse-msgstr-plural (function).
• parse-msgstr-plural-group (function).
• parse-number (function).
• parse-open-parent (function).
• parse-plural-expression (function).
• parse-po-file (function).
• parse-ternary-expression (function).
• parse-then-symbol (function).
• parse-token (macro).
• po-parsed-file (class).
• pop-apply-binary-operator (macro).
• pop-apply-ternary-operator (macro).
• stack-if (function).
• string->function (function).
• unescaped-char (function).
• with-line-mode (macro).

---

3.1.12 cl-i18n/mofile.lisp

Dependency

pofile.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• mo-magic-number-p (function).
• print-object (method).
• with-mo-file (macro).

Internals

• +hashing-table-offset-byte-size+ (constant).
• +hashing-table-size-byte-size+ (constant).
• +offset-original-byte-size+ (constant).
• +offset-translation-byte-size+ (constant).
• +original-strings-length-chunk-size+ (constant).
• +original-strings-offset-chunk-size+ (constant).
• +original-strings-offset-size-chunk-size+ (constant).
• +stream-element-type+ (constant).
• +string-num-byte-size+ (constant).
• +string-num-byte-version-number+ (constant).
• +translated-strings-length-chunk-size+ (constant).
• +translated-strings-offset-chunk-size+ (constant).
• +translated-strings-offset-size-chunk-size+ (constant).
• 2byte->word (function).
• 2word->int (function).
• byte->int (function).
• define-parse-header-chunk (macro).
• hashing-table-offset (reader method).
• (setf hashing-table-offset) (writer method).
• hashing-table-size (reader method).
• (setf hashing-table-size) (writer method).
• magic-number (reader method).
• (setf magic-number) (writer method).
• mofile (reader method).
• (setf mofile) (writer method).
• mofile (class).
• mofile->pofile (generic function).
• mofile->translation (generic function).
• offset-original (reader method).
• (setf offset-original) (writer method).
• offset-translations (reader method).
• (setf offset-translations) (writer method).
• original-strings (reader method).
• (setf original-strings) (writer method).
• parse-hashing-table-offset (generic function).
• parse-hashing-table-size (generic function).
• parse-magic-number (generic function).
• parse-mofile (generic function).
• parse-offset-original (generic function).
• parse-offset-translations (generic function).
• parse-original-string-length (generic function).
• parse-original-string-offset (generic function).
• parse-original-strings (generic function).
• parse-string-number (generic function).
• parse-translated-string-length (generic function).
• parse-translated-string-offset (generic function).
• parse-translated-strings (generic function).
• parse-version-number (generic function).
• parsing-errors (reader method).
• (setf parsing-errors) (writer method).
• pofile (reader method).
• (setf pofile) (writer method).
• split-escape (function).
• string-number (reader method).
• (setf string-number) (writer method).
• translated-strings (reader method).
• (setf translated-strings) (writer method).
• version-number (reader method).
• (setf version-number) (writer method).
• with-parse-strings-chunks (macro).

---

3.1.13 cl-i18n/extraction-translatable-strings.lisp

Dependency

parser.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• *extr-function-re* (special variable).
• next-token (method).
• parse-extract-parsed-file (function).
• with-extract-parsed-file (macro).

Internals

• %next-token (function).
• +extr-escaped-stopper (constant).
• +extr-string-re+ (constant).
• escaped-stopper-p (function).
• extract-parsed-file (class).
• is-extr-function-re-p (function).
• is-extr-string-re-p (function).
• just-peek-token (function).
• parse-delimited-string (function).
• parse-function (function).
• parse-function-prefix (function).

---

3.1.14 cl-i18n/base.lisp

Dependencies

• plural-forms.lisp (file).
• translation-class.lisp (file).
• utx-file.lisp (file).
• mofile.lisp (file).
• extraction-translatable-strings.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• *categories* (special variable).
• *plural-form-function* (special variable).
• *translation-collect* (special variable).
• *translation-file-root* (special variable).
• find-locale (function).
• init-translation-table (function).
• load-language (function).
• ntranslate (function).
• print-object (method).
• random-string (function).
• save-language (function).
• translate (function).
• translation-table (function).
• with-translation (macro).

Internals

• %translate (generic function).
• *locale* (special variable).
• *locale-files-extensions* (special variable).
• *translation-table* (special variable).
• all-possible-locale-dir (generic function).
• codeset (reader method).
• (setf codeset) (writer method).
• fittest-actual-locale-dir (generic function).
• fittest-actual-locale-file (generic function).
• if-not-utf8-read-whole (macro).
• language (reader method).
• (setf language) (writer method).
• locale-definition (class).
• modifier (reader method).
• (setf modifier) (writer method).
• read-lisp-string (function).
• territory (reader method).
• (setf territory) (writer method).

---

3.1.15 cl-i18n/i18n-utils.lisp

Dependency

base.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

• convert-dictionary-format (function).
• convert-save-dictionary (function).
• gen-translation-file (function).
• generate-i18n-file (function).
• levenshtein-distance (function).

Internals

• get-strings (function).
• read-i18n-file (function).
• similar-phrase (function).

---

3.1.16 cl-i18n/fuzzy-matching.lisp

Dependency

base.lisp (file).

Source

cl-i18n.asd.

Parent Component

cl-i18n (system).

Public Interface

fuzzy-match (function).

---

5.1.1 Constants

Constant: +fuzzy-flag+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +id+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +plurals+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +plurals-form+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +status+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +translated-flag+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +translation+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

Constant: +untranslated-flag+ ¶

Package

cl-i18n.

Source

translation-class.lisp.

---

5.1.2 Special variables

Special Variable: *categories* ¶

Package

cl-i18n.

Source

base.lisp.

Special Variable: *directory-sep* ¶

Package

cl-i18n.

Source

utils.lisp.

Special Variable: *directory-sep-regexp* ¶

Package

cl-i18n.

Source

utils.lisp.

Special Variable: *extr-function-re* ¶

Package

cl-i18n.

Source

extraction-translatable-strings.lisp.

Special Variable: *file* ¶

Package

cl-i18n.

Source

parser.lisp.

Special Variable: *has-errors* ¶

Package

cl-i18n.

Source

parser.lisp.

Special Variable: *parsing-errors* ¶

Package

cl-i18n.

Source

parser.lisp.

Special Variable: *plural-form-function* ¶

This is the function used by the library to figure out the right plural form

Package

cl-i18n.

Source

base.lisp.

Special Variable: *translation-collect* ¶

Package

cl-i18n.

Source

base.lisp.

Special Variable: *translation-file-root* ¶

The directory where translation files are stored. Defaults to current directory.

Package

cl-i18n.

Source

base.lisp.

---

5.1.3 Macros

Macro: define-parser-skeleton (name classname &rest other-vars) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: define-plural-form ((lang) &body body) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Macro: define-tokenizer ((classname &rest regexps) &body other-cond-clause) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: defnocfun (name args &body body) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: with-error ((predicate msg &rest arg-predicate) &body body) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: with-extract-parsed-file ((&key buffer filename) &rest body) ¶

Package

cl-i18n.

Source

extraction-translatable-strings.lisp.

Macro: with-mo-file ((stream moclass mofile) &rest body) ¶

Package

cl-i18n.

Source

mofile.lisp.

Macro: with-no-errors (&body body) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: with-no-errors* (&body forms) ¶

Package

cl-i18n.

Source

parser.lisp.

Macro: with-po-file ((&key buffer filename) &rest body) ¶

Package

cl-i18n.

Source

pofile.lisp.

Macro: with-translation ((translations plural-function) &body body) ¶

Macro to switch between language at runtime

Package

cl-i18n.

Source

base.lisp.

Macro: with-utx-file ((&key buffer filename) &rest body) ¶

Package

utx-file.

Source

utx-file.lisp.

---

5.1.4 Ordinary functions

Function: brazilian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: bulgarian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: convert-dictionary-format (old &key plural-function) ¶

Convert an 0.4 translation table file format to the new one

Package

cl-i18n-utils.

Source

i18n-utils.lisp.

Function: convert-save-dictionary (old new) ¶

Convert an 0.4 translation table file format to the new one and save in a new file

Package

cl-i18n-utils.

Source

i18n-utils.lisp.

Function: croatian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: czech-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: danish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: dutch-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: english-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: esperanto-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: estonian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: faroese-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: find-locale () ¶

Package

cl-i18n.

Source

base.lisp.

Function: finnish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: french-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: fuzzy-match (template sequence &key similarity-match similarity-mismatch penalty-weight char-comparison-fn) ¶

Performs a Smith-Waterman affinity search.
See: https://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm

Returns multiple values, first a list of index in ‘sequence’ that matches ‘template’ (even if some deletion must be performed to get a perfect match.

The other three return values are matrix cost and traceback costs, useful to perform additional searches.

The list is sorted in ascending order and null values means a gap is present to match ‘template’

Example:

(fuzzy-match "TAB" "TUUUAB") -> (0 NIL NIL NIL 4 5)

T AB
| ||
T—AB

Note: length of ‘template’ must be shorter or equal to ‘sequence’.

Package

cl-i18n-utils.

Source

fuzzy-matching.lisp.

Function: gaeilge-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: gen-translation-file (path output &key ext prefix-re) ¶

Scan a directory for sources files and collect all translatable strings. The strings are merged with a translation file (if exists)

Package

cl-i18n-utils.

Source

i18n-utils.lisp.

Function: generate-i18n-file (source-filename localization-filename &key fuzziness plural-function prefix-re) ¶

Reads a Lisp source file, get all strings and generate the translation resource, or merge with it if the translation resource already exists. Untranslated strings that show levenshtein distance less than :fuzziness with a translated one get the translation of the latter; such translation are marked as "fuzzy" in the output file

Package

cl-i18n-utils.

Source

i18n-utils.lisp.

Function: german-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: greek-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: hebrew-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: hungarian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: init-translation-table (filename &key store-hashtable store-plural-function update-translation-table) ¶

Load translations from a file (*translation-file-root* is used as a prefix for the actual path), storing them in a hash table. if store-hashtable is t *translation-table* is setf’d to the loaded table, if store-plural-function is t *plural-form-function* is setf’d too. The *plural-form-function* is setf’d too

Package

cl-i18n.

Source

base.lisp.

Function: irish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: italian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: latvian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: levenshtein-distance (string1 string2) ¶

Compute the levenshtein distance (i. e. how much are similars) between two strings

Package

cl-i18n-utils.

Source

i18n-utils.lisp.

Function: lithuanian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: load-language (catalog &key locale categories store-plural-function store-hashtable update-translation-table) ¶

Load a language that will be used for all subsequent translations.
Pass the evaluation results of (find-locale) to let the library guess the current locale. Use a locale string to explicitly set a locale instead.

Package

cl-i18n.

Source

base.lisp.

Function: make-translation (translation &optional flag plural-form plural-translated) ¶

Create an instance of a translation class

Package

cl-i18n.

Source

translation-class.lisp.

Function: mo-magic-number-p (seq) ¶

Package

cl-i18n.

Source

mofile.lisp.

Function: n/=1-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: norwegian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: ntranslate (str1 str2 n) ¶

Translate a string guessing a plural form.
str1 is the string to be translated
str2 is the fallback plural form
n is the number of the objects
First str1 is checked to get the translated object, if found
the nth element (as computed by the function *plural-form-function*) of its plural-translated slot is used as plural form.
If this index is less than 0 or more than the length of plural-translated ntranslate return str2.
If the translation object does not exists str2 is returned

Package

cl-i18n.

Source

base.lisp.

Function: parse-extract-parsed-file (&optional accum) ¶

Package

cl-i18n.

Source

extraction-translatable-strings.lisp.

Function: parse-utx-file () ¶

Package

utx-file.

Source

utx-file.lisp.

Function: peek-valid-stream () ¶

Package

cl-i18n.

Source

parser.lisp.

Function: polish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: portuguese-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: random-string (strings) ¶

Package

cl-i18n.

Source

base.lisp.

Function: romanian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: russian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: save-language (lang &optional destination translation-table plural-function) ¶

Save a translation table to a file, default path is *translation-file-root* "/" lang

Package

cl-i18n.

Source

base.lisp.

Function: search-mo-repository (root &key max-path-depth) ¶

Package

cl-i18n.

Source

utils.lisp.

Function: serbian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: slovak-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: slovenian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: slurp-file (filename &key convert-to-string) ¶

A simple way to slurp a file.

Package

cl-i18n.

Source

utils.lisp.

Function: spanish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: swedish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: translate (str) ¶

Translate a string. This will raise an error if the translation table has not been initialized beforehand. If the string doesn’t have a translation a warning is emitted as well and the original string returned.

Package

cl-i18n.

Source

base.lisp.

Function: translation-hash-table->list (ht) ¶

Convert a translation table to a list with the format used to store the table in a file

Package

cl-i18n.

Source

translation-class.lisp.

Function: translation-table () ¶

Package

cl-i18n.

Source

base.lisp.

Function: turkish-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

Function: ukrainian-plural-form (n) ¶

Package

cl-i18n.

Source

plural-forms.lisp.

---

5.1.5 Generic functions

Generic Reader: comment-line (object) ¶

Package

cl-i18n.

Methods

Reader Method: comment-line ((parsed-file parsed-file)) ¶

automatically generated reader method

Source

parser.lisp.

Target Slot

comment-line.

Generic Writer: (setf comment-line) (object) ¶

Package

cl-i18n.

Methods

Writer Method: (setf comment-line) ((parsed-file parsed-file)) ¶

automatically generated writer method

Source

parser.lisp.

Target Slot

comment-line.

Generic Reader: flag (object) ¶

Generic Writer: (setf flag) (object) ¶

Package

cl-i18n.

Methods

Reader Method: flag ((translation translation)) ¶

Writer Method: (setf flag) ((translation translation)) ¶

The status of the translation, can be one of +fuzzy-flag+ +untranslated-flag+ or +translation+

Source

translation-class.lisp.

Target Slot

flag.

Generic Function: get-line (object &key line-separator) ¶

Package

cl-i18n.

Source

buffered-input-file.lisp.

Methods

Method: get-line (object &key line-separator) ¶

Generic Function: is-comment-line-p (object line) ¶

Package

cl-i18n.

Source

parser.lisp.

Methods

Method: is-comment-line-p ((object parsed-file) line) ¶

Generic Function: next-token (object &key hook-to-stringpos return-first-match predicate-sort-tokens no-more-token-error) ¶

Package

cl-i18n.

Source

parser.lisp.

Methods

Method: next-token ((object extract-parsed-file) &key hook-to-stringpos return-first-match predicate-sort-tokens no-more-token-error) ¶

Source

extraction-translatable-strings.lisp.

Method: next-token ((object po-parsed-file) &key hook-to-stringpos return-first-match predicate-sort-tokens no-more-token-error) ¶

Source

pofile.lisp.

Method: next-token ((object utx-parsed-file) &key hook-to-stringpos return-first-match predicate-sort-tokens no-more-token-error) ¶

Source

utx-file.lisp.

Generic Function: parse-comment-line (object) ¶

Package

cl-i18n.

Source

parser.lisp.

Methods

Method: parse-comment-line ((object utx-parsed-file)) ¶

Source

utx-file.lisp.

Method: parse-comment-line ((object parsed-file)) ¶

Generic Function: peek-token (object &optional test) ¶

Package

cl-i18n.

Source

parser.lisp.

Methods

Method: peek-token ((object utx-parsed-file) &optional test) ¶

Source

utx-file.lisp.

Method: peek-token ((object parsed-file) &optional test) ¶

Generic Function: peek-token-suppress-errors (object &optional test) ¶

Package

cl-i18n.

Source

parser.lisp.

Methods

Method: peek-token-suppress-errors ((object parsed-file) &optional test) ¶

Generic Function: seek (object pos) ¶

Package

cl-i18n.

Source

buffered-input-file.lisp.

Methods

Method: seek ((object buffered-input-file) pos) ¶

Generic Reader: translated (object) ¶

Generic Writer: (setf translated) (object) ¶

Package

cl-i18n.

Methods

Reader Method: translated ((translation translation)) ¶

Writer Method: (setf translated) ((translation translation)) ¶

The translated string

Source

translation-class.lisp.

Target Slot

translated.

Generic Function: translation-list->hash-table (source dest) ¶

Package

cl-i18n.

Source

translation-class.lisp.

Methods

Method: translation-list->hash-table ((list list) (ht hash-table)) ¶

Parse a list into a translation table.

---

5.1.6 Standalone methods

Method: initialize-instance :after ((object po-parsed-file) &key &allow-other-keys) ¶

Source

pofile.lisp.

Method: initialize-instance :after ((object buffered-input-file) &key &allow-other-keys) ¶

Source

buffered-input-file.lisp.

Method: initialize-instance :after ((object utx-parsed-file) &key &allow-other-keys) ¶

Source

utx-file.lisp.

Method: make-load-form ((object translation) &optional environment) ¶

Source

translation-class.lisp.

Method: print-object ((object translation) stream) ¶

Source

translation-class.lisp.

Method: print-object :after ((object mofile) stream) ¶

Source

mofile.lisp.

Method: print-object ((object locale-definition) stream) ¶

Source

base.lisp.

Method: print-object ((object buffered-input-file) stream) ¶

Source

buffered-input-file.lisp.

---

5.1.7 Conditions

Condition: no-translation ¶

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

text-warning.

Condition: no-translation-table-error ¶

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

text-error.

Condition: out-of-bounds ¶

Error when you go out of bound

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods

• idx.
• seq.

Direct slots

Slot: seq ¶

Initargs

:seq

Readers

seq.

Writers

This slot is read-only.

Slot: idx ¶

Initargs

:idx

Readers

idx.

Writers

This slot is read-only.

Condition: parsing-mofile-error ¶

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

text-error.

Condition: parsing-pofile-error ¶

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

text-error.

Condition: parsing-utxfile-error ¶

Package

i18n-conditions.

Source

conditions.lisp.

Direct superclasses

text-error.

---

5.1.8 Classes

Class: parsed-file ¶

Package

cl-i18n.

Source

parser.lisp.

Direct superclasses

buffered-input-file.

Direct subclasses

• extract-parsed-file.
• po-parsed-file.
• utx-parsed-file.

Direct methods

• (setf comment-line).
• comment-line.
• is-comment-line-p.
• parse-comment-line.
• peek-token.
• peek-token-suppress-errors.

Direct slots

Slot: comment-line ¶

Initargs

:comment-line

Readers

comment-line.

Writers

(setf comment-line).

Class: translation ¶

The class that holds a translated string, its plural form and the translation status

Package

cl-i18n.

Source

translation-class.lisp.

Direct methods

• %translate.
• copy-translation.
• (setf flag).
• flag.
• make-load-form.
• (setf plural-form).
• plural-form.
• (setf plural-translated).
• plural-translated.
• print-object.
• (setf translated).
• translated.

Direct slots

Slot: translated ¶

The translated string

Type

string

Initform

""

Initargs

:translated

Readers

translated.

Writers

(setf translated).

Slot: plural-form ¶

Type

string

Initform

""

Initargs

:plural-form

Readers

plural-form.

Writers

(setf plural-form).

Slot: plural-translated ¶

a list of string for each valid plural form

Type

list

Initform

(quote nil)

Initargs

:plural-translated

Readers

plural-translated.

Writers

(setf plural-translated).

Slot: flag ¶

The status of the translation, can be one of +fuzzy-flag+ +untranslated-flag+ or +translation+

Initform

cl-i18n:+untranslated-flag+

Initargs

:flag

Readers

flag.

Writers

(setf flag).

Class: utx-parsed-file ¶

Package

utx-file.

Source

utx-file.lisp.

Direct superclasses

parsed-file.

Direct methods

• initialize-instance.
• last-comment-line-p.
• next-token.
• parse-comment-line.
• peek-token.

---

5.2.1 Constants

Constant: +!=+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +%+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +<+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +<=+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +==+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +>+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +>=+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +?+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +?-regex+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +agnostic-comment+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +and-op+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +close-paren+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +close-paren-regex+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +colon+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +column+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +column-id+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +default-buffer-size+ ¶

Package

cl-i18n.

Source

buffered-input-file.lisp.

Constant: +default-element-type+ ¶

Package

cl-i18n.

Source

buffered-input-file.lisp.

Constant: +end-expression+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +escape-newline+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +escape-string-escape-char+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +escape-string-escaped-newline+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +escaped-string-delim+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +extr-escaped-stopper ¶

Package

cl-i18n.

Source

extraction-translatable-strings.lisp.

Constant: +extr-string-re+ ¶

Package

cl-i18n.

Source

extraction-translatable-strings.lisp.

Constant: +flag-fuzzy+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +flag-line+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +hashing-table-offset-byte-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +hashing-table-size-byte-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +line-stopper+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +lisp-table-ext-re+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +lisp-table-extension+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +mo-file-magic-number+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +mofile-ext-re+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +mofile-extension+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +msgid+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgid-plural+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgid-regexp+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgstr+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgstr-regexp+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgstr[]+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +msgstr[]-regexp+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +newline+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +nplurals-label+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +number+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +offset-original-byte-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +offset-translation-byte-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +open-paren+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +open-paren-regex+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +or-op+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +or-op-regex+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +original-strings-length-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +original-strings-offset-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +original-strings-offset-size-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +peek-length-tokenizer-on-error+ ¶

Package

cl-i18n.

Source

parser.lisp.

Constant: +plural-expression-label+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +plural-field+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +plural-form-label+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +po-comment-line+ ¶

Package

cl-i18n.

Source

pofile.lisp.

Constant: +pofile-ext-re+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +pofile-extension+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +status-accepted+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +status-field+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +status-forbidden+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +stream-element-type+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +string-num-byte-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +string-num-byte-version-number+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +translated-strings-length-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +translated-strings-offset-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +translated-strings-offset-size-chunk-size+ ¶

Package

cl-i18n.

Source

mofile.lisp.

Constant: +utx-ext-re+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +utx-extension+ ¶

Package

cl-i18n.

Source

utils.lisp.

Constant: +utx-ignored-line+ ¶

Package

utx-file.

Source

utx-file.lisp.

Constant: +var+ ¶

Package

cl-i18n.

Source

pofile.lisp.

---