The cl-i18n Reference Manual

Table of Contents

The cl-i18n Reference Manual

This is the cl-i18n Reference Manual, version 0.5.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:10:52 2018 GMT+0.

1 Introduction

[[http://quickdocs.org/cl-i18n/][http://quickdocs.org/badge/cl-i18n.svg]]

* Prerequisites:
- ASDF
- uiop (if your ASDF version is < 3)
- cl-ppcre
- alexandria
- babel

* Installation:

The  best  way   to  get  cl-i18n  working  is   using  the  excellent
[[http://www.quicklisp.org/][quicklisp]]

#+BEGIN_SRC common-lisp
(ql:quickload "cl-i18n")
#+END_SRC

* Usage
  This library can load translations from file formats of the following types:
- [[https://www.gnu.org/software/gettext/][GNU gettext]] text file (AKA PO files);
- [[https://www.gnu.org/software/gettext/][GNU gettext]] binary file (AKA MO files);
- its native file formats (essentially a Common lisp S-exp).

Check the examples/ directory for an usage example.

** Extracting translatable strings:

#+BEGIN_SRC common-lisp
(cl-i18n-utils:gen-translation-file ("/src/" "klingon.lisp"
                                     :ext "lisp$"
                                     :prefix-re "#!\""))
#+END_SRC

   Will extract  all #!   strings[fn:re-extract-example] from  all the
   files in directory  "/src/" which name ends in "lisp"  and set up a
   basic translation resource in  klingon.lisp (*Note: the output file
   if exists will be overwritten*).

   To make it work with CL-WHO, use the “str” directive, as in
#+BEGIN_SRC common-lisp
    (with-html-output *out*
      (:p (str #!"Blood and honour!")))
#+END_SRC

   Please note that the library can accept gettext MO or PO files so
   nothing prevents you using GNU xgettext to extracts strings that needs to
   be translated and use its output as translation file.

** Locating GNU message catalog files

According to
[[https://www.gnu.org/software/gettext/manual/gettext.html#Locating-Catalogs][GNU
gettext  manual]] the  path to  the catalog  is system  dipendent, the
function  /search-mo-repository/ will  try  to figure  out where  that
catalog  *could*  be;  but  its  implementation  is  slow,  memory
consuming and sometimes fails (i.e. crash).

** Simple example

Here is  a way similar  to GNU gettext  style API; please note  we are
assuming  "/usr/share/locale/" as the  path where  the catalog  can be
found and foo.mo is there...

We also let the library guess the right locale with /find-locale/.

#+BEGIN_SRC common-lisp
(let ((*translation-file-root* "/usr/share/locale/"))
   (load-language "foo" :locale (find-locale))
   (format t "~a~%"  #!"Browse")
   (format t "~a~%" #!"Save as..."))
#+END_SRC

* Old version incompatibility

This version deeply changed the  file format of the translation table,
however you can convert from the old format to the new one with:

#+BEGIN_SRC common-lisp
(cl-i18n-utils:convert-save-dictionary oldfile-path new-filepath)
#+END_SRC

*Note: the output file if exists will be overwritten*

* Bugs and issues

  Please send all bugs reports to cage@katamail.com

** Known issues
- Documentation is missing;
- Source code is mostly undocumented;
- PO file parser is slow.

* License
  This library is released under Lisp Lesser General Public license (see
  COPYING.LESSER file)

  Examples are released under GPL version 3 or later

  =doc/internals/pofiles_grammar=  is ©  2012 cage  and is  licensed under
  Creative Commons Attribution-ShareAlike 3.0 Unported

  File /function-name.lisp/ was got from
  [[http://common-lisp.net/project/cl-store/][cl-store]] © 2004 Sean Ross and
  included here with the original license stated below.

  Copyright (c) 2004 Sean Ross
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:
  1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
  3. The names of the authors and contributors may not be used to endorse
    or promote products derived from this software without specific prior
    written permission.

  THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  SUCH DAMAGE.

* NO WARRANTY

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

* Contributors:

- Leslie P. Polzer  (base)
- Vilson Vieira  (string extractor)
- Cage  (developer and maintainer)

[fn:re-extract-example] If you use a function like:

#+BEGIN_SRC common-lisp
  (defun _ (a) (translate a))
#+END_SRC

You can use "=\\(_\\p{white_space}+=\"" as :prefix-re argument.

2 Systems

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

2.1 cl-i18n

Maintainer

cage <cage@katamail.com>

Author

Leslie P. Polzer <polzer@stardawn.org>

License

LLGPL

Description

A gettext-style internationalisation framework for Common Lisp.

Version

0.5.0

Dependencies

• alexandria
• cl-ppcre-unicode
• babel

Source

cl-i18n.asd (file)

Components

• package.lisp (file)
• function-name.lisp (file)
• utils.lisp (file)
• conditions.lisp (file)
• buffered-input-file.lisp (file)
• plural-forms.lisp (file)
• translation-class.lisp (file)
• parser.lisp (file)
• utx-file.lisp (file)
• pofile.lisp (file)
• mofile.lisp (file)
• extraction-translatable-strings.lisp (file)
• base.lisp (file)
• i18n-utils.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-i18n.asd

Location

cl-i18n.asd

Systems

cl-i18n (system)

Packages

cl-i18n-asd

3.1.2 cl-i18n/package.lisp

Parent

cl-i18n (system)

Location

package.lisp

Packages

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

3.1.3 cl-i18n/function-name.lisp

Dependency

package.lisp (file)

Parent

cl-i18n (system)

Location

function-name.lisp

Internal Definitions

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

3.1.4 cl-i18n/utils.lisp

Dependency

package.lisp (file)

Parent

cl-i18n (system)

Location

utils.lisp

Exported Definitions

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

Internal Definitions

• *debug* (special variable)
• *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+ (constant)
• +pofile-ext+ (constant)
• +utx-ext+ (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)
• 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)

Parent

cl-i18n (system)

Location

conditions.lisp

Exported Definitions

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

Internal Definitions

• defcond (macro)
• idx (method)
• not-implemented-error (condition)
• null-reference (condition)
• seq (method)
• text (method)
• text (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)

Parent

cl-i18n (system)

Location

buffered-input-file.lisp

Exported Definitions

• get-line (generic function)
• get-line (method)
• seek (generic function)
• seek (method)

Internal Definitions

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

3.1.7 cl-i18n/plural-forms.lisp

Dependency

package.lisp (file)

Parent

cl-i18n (system)

Location

plural-forms.lisp

Exported Definitions

• 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)

Parent

cl-i18n (system)

Location

translation-class.lisp

Exported Definitions

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

Internal Definitions

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

3.1.9 cl-i18n/parser.lisp

Dependency

buffered-input-file.lisp (file)

Parent

cl-i18n (system)

Location

parser.lisp

Exported Definitions

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

Internal Definitions

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

Parent

cl-i18n (system)

Location

utx-file.lisp

Exported Definitions

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

Internal Definitions

• *fields-position* (special variable)
• +column+ (constant)
• +column-id+ (constant)
• +line-stopper+ (constant)
• +plural-field+ (constant)
• +status-field+ (constant)
• +status-forbidden+ (constant)
• +utx-ignored-line+ (constant)
• get-field (macro)
• last-column-p (function)
• last-comment-line-p (generic function)
• last-comment-line-p (method)
• 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)
• trim-rows (function)

3.1.11 cl-i18n/pofile.lisp

Dependencies

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

Parent

cl-i18n (system)

Location

pofile.lisp

Exported Definitions

• next-token (method)
• with-po-file (macro)

Internal Definitions

• != (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)

Parent

cl-i18n (system)

Location

mofile.lisp

Exported Definitions

with-mo-file (macro)

Internal Definitions

• +hashing-table-offset-byte-size+ (constant)
• +hashing-table-size-byte-size+ (constant)
• +mo-magic-number+ (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 (method)
• (setf hashing-table-offset) (method)
• hashing-table-size (method)
• (setf hashing-table-size) (method)
• magic-number (method)
• (setf magic-number) (method)
• mofile (method)
• (setf mofile) (method)
• mofile (class)
• mofile->pofile (generic function)
• mofile->pofile (method)
• mofile->translation (generic function)
• mofile->translation (method)
• offset-original (method)
• (setf offset-original) (method)
• offset-translations (method)
• (setf offset-translations) (method)
• original-strings (method)
• (setf original-strings) (method)
• parse-hashing-table-offset (generic function)
• parse-hashing-table-offset (method)
• parse-hashing-table-size (generic function)
• parse-hashing-table-size (method)
• parse-magic-number (generic function)
• parse-magic-number (method)
• parse-mofile (generic function)
• parse-mofile (method)
• parse-offset-original (generic function)
• parse-offset-original (method)
• parse-offset-translations (generic function)
• parse-offset-translations (method)
• parse-original-string-length (generic function)
• parse-original-string-length (method)
• parse-original-string-offset (generic function)
• parse-original-string-offset (method)
• parse-original-strings (generic function)
• parse-original-strings (method)
• parse-string-number (generic function)
• parse-string-number (method)
• parse-translated-string-length (generic function)
• parse-translated-string-length (method)
• parse-translated-string-offset (generic function)
• parse-translated-string-offset (method)
• parse-translated-strings (generic function)
• parse-translated-strings (method)
• parse-version-number (generic function)
• parse-version-number (method)
• parsing-errors (method)
• (setf parsing-errors) (method)
• pofile (method)
• (setf pofile) (method)
• split-escape (function)
• string-number (method)
• (setf string-number) (method)
• translated-strings (method)
• (setf translated-strings) (method)
• version-number (method)
• (setf version-number) (method)
• with-parse-strings-chunks (macro)

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

Dependency

parser.lisp (file)

Parent

cl-i18n (system)

Location

extraction-translatable-strings.lisp

Exported Definitions

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

Internal Definitions

• %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)

Parent

cl-i18n (system)

Location

base.lisp

Exported Definitions

• *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)
• random-string (function)
• save-language (function)
• translate (function)
• translation-table (function)
• with-translation (macro)

Internal Definitions

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

3.1.15 cl-i18n/i18n-utils.lisp

Dependency

base.lisp (file)

Parent

cl-i18n (system)

Location

i18n-utils.lisp

Exported Definitions

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

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 cl-i18n-asd

Source

cl-i18n.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-i18n-utils

Source

package.lisp (file)

Use List

• cl-ppcre
• alexandria.0.dev
• common-lisp

Exported Definitions

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

Internal Definitions

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

4.3 utx-file

Source

package.lisp (file)

Use List

• cl-ppcre
• alexandria.0.dev
• common-lisp

Exported Definitions

• parse-utx-file (function)
• utx-parsed-file (class)
• with-utx-file (macro)

Internal Definitions

• *fields-position* (special variable)
• +column+ (constant)
• +column-id+ (constant)
• +line-stopper+ (constant)
• +plural-field+ (constant)
• +status-field+ (constant)
• +status-forbidden+ (constant)
• +utx-ignored-line+ (constant)
• get-field (macro)
• last-column-p (function)
• last-comment-line-p (generic function)
• last-comment-line-p (method)
• 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)
• trim-rows (function)

4.4 cl-i18n

An internationalisation framework for Common Lisp

Source

package.lisp (file)

Use List

• cl-ppcre
• alexandria.0.dev
• common-lisp

Exported Definitions

• *categories* (special variable)
• *directory-sep* (special variable)
• *directory-sep-regexp* (special variable)
• *extr-function-re* (special variable)
• *file* (special variable)
• *has-errors* (special variable)
• *parsing-errors* (special variable)
• *plural-form-function* (special variable)
• *translation-collect* (special variable)
• *translation-file-root* (special variable)
• +fuzzy-flag+ (constant)
• +id+ (constant)
• +plurals+ (constant)
• +plurals-form+ (constant)
• +status+ (constant)
• +translated-flag+ (constant)
• +translation+ (constant)
• +untranslated-flag+ (constant)
• brazilian-plural-form (function)
• bulgarian-plural-form (function)
• comment-line (generic function)
• comment-line (method)
• (setf comment-line) (method)
• (setf comment-line) (generic function)
• croatian-plural-form (function)
• czech-plural-form (function)
• danish-plural-form (function)
• define-parser-skeleton (macro)
• define-plural-form (macro)
• define-tokenizer (macro)
• defnocfun (macro)
• dutch-plural-form (function)
• english-plural-form (function)
• esperanto-plural-form (function)
• estonian-plural-form (function)
• faroese-plural-form (function)
• find-locale (function)
• finnish-plural-form (function)
• flag (generic function)
• flag (method)
• (setf flag) (method)
• (setf flag) (generic function)
• french-plural-form (function)
• gaeilge-plural-form (function)
• german-plural-form (function)
• get-line (generic function)
• get-line (method)
• greek-plural-form (function)
• hebrew-plural-form (function)
• hungarian-plural-form (function)
• init-translation-table (function)
• irish-plural-form (function)
• is-comment-line-p (generic function)
• is-comment-line-p (method)
• italian-plural-form (function)
• latvian-plural-form (function)
• lithuanian-plural-form (function)
• load-language (function)
• make-translation (function)
• n/=1-plural-form (function)
• next-token (generic function)
• next-token (method)
• next-token (method)
• next-token (method)
• norwegian-plural-form (function)
• ntranslate (function)
• parse-comment-line (generic function)
• parse-comment-line (method)
• parse-comment-line (method)
• parse-extract-parsed-file (function)
• parsed-file (class)
• peek-token (generic function)
• peek-token (method)
• peek-token (method)
• peek-token-suppress-errors (generic function)
• peek-token-suppress-errors (method)
• peek-valid-stream (function)
• polish-plural-form (function)
• portuguese-plural-form (function)
• random-string (function)
• romanian-plural-form (function)
• russian-plural-form (function)
• save-language (function)
• search-mo-repository (function)
• seek (generic function)
• seek (method)
• serbian-plural-form (function)
• slovak-plural-form (function)
• slovenian-plural-form (function)
• slurp-file (function)
• spanish-plural-form (function)
• swedish-plural-form (function)
• translate (function)
• translated (generic function)
• translated (method)
• (setf translated) (method)
• (setf translated) (generic function)
• translation (class)
• translation-hash-table->list (function)
• translation-list->hash-table (generic function)
• translation-list->hash-table (method)
• translation-table (function)
• turkish-plural-form (function)
• ukrainian-plural-form (function)
• with-error (macro)
• with-extract-parsed-file (macro)
• with-mo-file (macro)
• with-no-errors (macro)
• with-no-errors* (macro)
• with-po-file (macro)
• with-translation (macro)

Internal Definitions

• != (function)
• % (function)
• %next-token (function)
• && (function)
• *aritm-op* (special variable)
• *blank-space* (special variable)
• *boolean-op* (special variable)
• *compar-op* (special variable)
• *debug* (special variable)
• *locale* (special variable)
• *mofile-repo-exclude-path* (special variable)
• *n* (special variable)
• *sbcl-readtable* (special variable)
• *string-pos* (special variable)
• *translation-table* (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)
• +!=+ (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)
• +default-buffer-size+ (constant)
• +default-element-type+ (constant)
• +end-expression+ (constant)
• +escape-newline+ (constant)
• +escape-string-escape-char+ (constant)
• +escape-string-escaped-newline+ (constant)
• +escaped-string-delim+ (constant)
• +extr-escaped-stopper (constant)
• +extr-string-re+ (constant)
• +flag-fuzzy+ (constant)
• +flag-line+ (constant)
• +hashing-table-offset-byte-size+ (constant)
• +hashing-table-size-byte-size+ (constant)
• +lisp-table-ext+ (constant)
• +mo-magic-number+ (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)
• +offset-original-byte-size+ (constant)
• +offset-translation-byte-size+ (constant)
• +open-paren+ (constant)
• +open-paren-regex+ (constant)
• +or-op+ (constant)
• +or-op-regex+ (constant)
• +original-strings-length-chunk-size+ (constant)
• +original-strings-offset-chunk-size+ (constant)
• +original-strings-offset-size-chunk-size+ (constant)
• +peek-length-tokenizer-on-error+ (constant)
• +plural-expression-label+ (constant)
• +plural-form-label+ (constant)
• +po-comment-line+ (constant)
• +pofile-ext+ (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)
• +utx-ext+ (constant)
• +var+ (constant)
• 1+char@ (function)
• 2byte->word (function)
• 2word->int (function)
• <* (function)
• <=* (function)
• == (function)
• >* (function)
• >=* (function)
• actual-file-position (generic function)
• actual-file-position (method)
• adjust-buffer (generic function)
• adjust-buffer (method)
• adjust-buffer-backward (generic function)
• adjust-buffer-backward (method)
• all-possible-locale-dir (generic function)
• all-possible-locale-dir (method)
• bool-or (function)
• buffer (generic function)
• buffer (method)
• (setf buffer) (method)
• (setf buffer) (generic function)
• buffer-position (generic function)
• buffer-position (method)
• (setf buffer-position) (method)
• (setf buffer-position) (generic function)
• buffer-uchar-length (function)
• buffered-input-file (class)
• byte->int (function)
• cached-string (generic function)
• cached-string (method)
• (setf cached-string) (method)
• (setf cached-string) (generic function)
• cat-parent-dir (function)
• char@ (function)
• char@1+ (function)
• close-file (generic function)
• close-file (method)
• codeset (generic function)
• codeset (method)
• (setf codeset) (method)
• (setf codeset) (generic function)
• concatenate-regexps (function)
• copy-translation (generic function)
• copy-translation (method)
• count-mo-files (function)
• count-mo-files-direct-children (function)
• create-brand-new-file (function)
• decrement-pointer (generic function)
• decrement-pointer (method)
• define-is-stuff-p (macro)
• define-parse-header-chunk (macro)
• define-parse-operators (macro)
• define-parser-skeleton* (macro)
• define-tokenizer-simple (macro)
• directoryp (function)
• do-directory (macro)
• enlarge-buffer (generic function)
• enlarge-buffer (method)
• equals-path-fn (function)
• escaped-stopper-p (function)
• excluded-path-p (function)
• execute-expression (function)
• extract-parsed-file (class)
• extract-plural-function (function)
• filename (generic function)
• filename (method)
• (setf filename) (method)
• (setf filename) (generic function)
• fittest-actual-locale-dir (generic function)
• fittest-actual-locale-dir (method)
• fittest-actual-locale-file (generic function)
• fittest-actual-locale-file (method)
• get-char (generic function)
• get-char (method)
• get-char-then-increment-pointer (generic function)
• get-char-then-increment-pointer (method)
• get-function-name (function)
• hashing-table-offset (generic function)
• hashing-table-offset (method)
• (setf hashing-table-offset) (method)
• (setf hashing-table-offset) (generic function)
• hashing-table-size (generic function)
• hashing-table-size (method)
• (setf hashing-table-size) (method)
• (setf hashing-table-size) (generic function)
• if-not-utf8-read-whole (macro)
• increment-pointer (generic function)
• increment-pointer (method)
• increment-pointer-then-get-char (generic function)
• increment-pointer-then-get-char (method)
• inner-stream (generic function)
• inner-stream (method)
• (setf inner-stream) (method)
• (setf inner-stream) (generic function)
• inside-buffer-p (generic function)
• inside-buffer-p (method)
• 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-extr-function-re-p (function)
• is-extr-string-re-p (function)
• is-flag-line-p (function)
• is-fuzzy-flag-p (function)
• is-mo-file-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)
• just-peek-token (function)
• language (generic function)
• language (method)
• (setf language) (method)
• (setf language) (generic function)
• let-noerr (macro)
• let-noerr* (macro)
• line-mode (generic function)
• line-mode (method)
• (setf line-mode) (method)
• (setf line-mode) (generic function)
• list-directory-entries (function)
• locale-definition (class)
• logical-file-position (generic function)
• logical-file-position (method)
• (setf logical-file-position) (method)
• (setf logical-file-position) (generic function)
• magic-number (generic function)
• magic-number (method)
• (setf magic-number) (method)
• (setf magic-number) (generic function)
• make-buffer (function)
• mo-repository-p (function)
• modifier (generic function)
• modifier (method)
• (setf modifier) (method)
• (setf modifier) (generic function)
• mofile (generic function)
• mofile (method)
• (setf mofile) (method)
• (setf mofile) (generic function)
• mofile (class)
• mofile->pofile (generic function)
• mofile->pofile (method)
• mofile->translation (generic function)
• mofile->translation (method)
• multiple-increment (macro)
• next-token-simple (generic function)
• offset-original (generic function)
• offset-original (method)
• (setf offset-original) (method)
• (setf offset-original) (generic function)
• offset-translations (generic function)
• offset-translations (method)
• (setf offset-translations) (method)
• (setf offset-translations) (generic function)
• original-strings (generic function)
• original-strings (method)
• (setf original-strings) (method)
• (setf original-strings) (generic function)
• outside-buffer-p (generic function)
• outside-buffer-p (method)
• 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-delimited-string (function)
• parse-entries (function)
• parse-escaped-string (function)
• parse-expression (function)
• parse-function (function)
• parse-function-prefix (function)
• parse-hashing-table-offset (generic function)
• parse-hashing-table-offset (method)
• parse-hashing-table-size (generic function)
• parse-hashing-table-size (method)
• parse-header (function)
• parse-if-symbol (function)
• parse-magic-number (generic function)
• parse-magic-number (method)
• parse-mofile (generic function)
• parse-mofile (method)
• 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-name (function)
• parse-number (function)
• parse-offset-original (generic function)
• parse-offset-original (method)
• parse-offset-translations (generic function)
• parse-offset-translations (method)
• parse-open-parent (function)
• parse-original-string-length (generic function)
• parse-original-string-length (method)
• parse-original-string-offset (generic function)
• parse-original-string-offset (method)
• parse-original-strings (generic function)
• parse-original-strings (method)
• parse-plural-expression (function)
• parse-po-file (function)
• parse-string-number (generic function)
• parse-string-number (method)
• parse-ternary-expression (function)
• parse-then-symbol (function)
• parse-token (macro)
• parse-translated-string-length (generic function)
• parse-translated-string-length (method)
• parse-translated-string-offset (generic function)
• parse-translated-string-offset (method)
• parse-translated-strings (generic function)
• parse-translated-strings (method)
• parse-version-number (generic function)
• parse-version-number (method)
• parsing-errors (generic function)
• parsing-errors (method)
• (setf parsing-errors) (method)
• (setf parsing-errors) (generic function)
• pathname->string (function)
• peek-end-stream (function)
• plural-form (generic function)
• plural-form (method)
• (setf plural-form) (method)
• (setf plural-form) (generic function)
• plural-translated (generic function)
• plural-translated (method)
• (setf plural-translated) (method)
• (setf plural-translated) (generic function)
• po-parsed-file (class)
• pofile (generic function)
• pofile (method)
• (setf pofile) (method)
• (setf pofile) (generic function)
• pop-apply-binary-operator (macro)
• pop-apply-ternary-operator (macro)
• read-adjust-buffer (generic function)
• read-adjust-buffer (method)
• read-lisp-string (function)
• regex-scan (generic function)
• regex-scan (method)
• regex-scan-line-mode (generic function)
• regex-scan-line-mode (method)
• regex-scan-line-simple (generic function)
• regex-scan-line-simple (method)
• remove-regular-files (function)
• replace-buffer (generic function)
• replace-buffer (method)
• replace-buffer-backward (generic function)
• replace-buffer-backward (method)
• replace-buffer-forward (generic function)
• replace-buffer-forward (method)
• scan-mo-files (function)
• scanner-re (macro)
• split-escape (function)
• stack-if (function)
• statistics (generic function)
• statistics (method)
• (setf statistics) (method)
• (setf statistics) (generic function)
• stream-length (generic function)
• stream-length (method)
• string->function (function)
• string-number (generic function)
• string-number (method)
• (setf string-number) (method)
• (setf string-number) (generic function)
• territory (generic function)
• territory (method)
• (setf territory) (method)
• (setf territory) (generic function)
• translated-strings (generic function)
• translated-strings (method)
• (setf translated-strings) (method)
• (setf translated-strings) (generic function)
• truncate-buffer (generic function)
• truncate-buffer (method)
• uchar-length (function)
• uchars-count (generic function)
• uchars-count (method)
• (setf uchars-count) (method)
• (setf uchars-count) (generic function)
• unescaped-char (function)
• unget-char (generic function)
• unget-char (method)
• utf8-encoded-p (function)
• valid-stream-p (generic function)
• valid-stream-p (method)
• version-number (generic function)
• version-number (method)
• (setf version-number) (method)
• (setf version-number) (generic function)
• when-debug (macro)
• with-file-position (macro)
• with-line-mode (macro)
• with-parse-strings-chunks (macro)
• with-ustring (macro)
• with-valid-stream (macro)

4.5 i18n-conditions

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

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

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Constants

Constant: +fuzzy-flag+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +id+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +plurals+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +plurals-form+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +status+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +translated-flag+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +translation+

Package

cl-i18n

Source

translation-class.lisp (file)

Constant: +untranslated-flag+

Package

cl-i18n

Source

translation-class.lisp (file)

5.1.2 Special variables

Special Variable: *categories*

Package

cl-i18n

Source

base.lisp (file)

Special Variable: *directory-sep*

Package

cl-i18n

Source

utils.lisp (file)

Special Variable: *directory-sep-regexp*

Package

cl-i18n

Source

utils.lisp (file)

Special Variable: *extr-function-re*

Package

cl-i18n

Source

extraction-translatable-strings.lisp (file)

Special Variable: *file*

Package

cl-i18n

Source

parser.lisp (file)

Special Variable: *has-errors*

Package

cl-i18n

Source

parser.lisp (file)

Special Variable: *parsing-errors*

Package

cl-i18n

Source

parser.lisp (file)

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 (file)

Special Variable: *translation-collect*

Package

cl-i18n

Source

base.lisp (file)

Special Variable: *translation-file-root*

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

Package

cl-i18n

Source

base.lisp (file)

5.1.3 Macros

Macro: define-parser-skeleton NAME CLASSNAME &rest OTHER-VARS

Package

cl-i18n

Source

parser.lisp (file)

Macro: define-plural-form (LANG) &body BODY

Package

cl-i18n

Source

plural-forms.lisp (file)

Macro: define-tokenizer (CLASSNAME &rest REGEXPS) &body OTHER-COND-CLAUSE

Package

cl-i18n

Source

parser.lisp (file)

Macro: defnocfun NAME ARGS &body BODY

Package

cl-i18n

Source

parser.lisp (file)

Macro: with-error (PREDICATE MSG &rest ARG-PREDICATE) &body BODY

Package

cl-i18n

Source

parser.lisp (file)

Macro: with-extract-parsed-file (&key BUFFER FILENAME) &rest BODY

Package

cl-i18n

Source

extraction-translatable-strings.lisp (file)

Macro: with-mo-file (STREAM MOCLASS MOFILE) &rest BODY

Package

cl-i18n

Source

mofile.lisp (file)

Macro: with-no-errors &body BODY

Package

cl-i18n

Source

parser.lisp (file)

Macro: with-no-errors* &body FORMS

Package

cl-i18n

Source

parser.lisp (file)

Macro: with-po-file (&key BUFFER FILENAME) &rest BODY

Package

cl-i18n

Source

pofile.lisp (file)

Macro: with-translation (TRANSLATIONS PLURAL-FUNCTION) &body BODY

Macro to switch between language at runtime

Package

cl-i18n

Source

base.lisp (file)

Macro: with-utx-file (&key BUFFER FILENAME) &rest BODY

Package

utx-file

Source

utx-file.lisp (file)

5.1.4 Functions

Function: brazilian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: bulgarian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

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 (file)

Function: croatian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: czech-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: danish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: dutch-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: english-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: esperanto-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: estonian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: faroese-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: find-locale ()

Package

cl-i18n

Source

base.lisp (file)

Function: finnish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: french-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: gaeilge-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

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 (file)

Function: german-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: greek-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: hebrew-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: hungarian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

Function: irish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: italian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: latvian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: lithuanian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

Function: make-translation TRANSLATION &optional FLAG PLURAL-FORM PLURAL-TRANSLATED

Create an instance of a translation class

Package

cl-i18n

Source

translation-class.lisp (file)

Function: n/=1-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: norwegian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

Function: parse-extract-parsed-file &optional ACCUM

Package

cl-i18n

Source

extraction-translatable-strings.lisp (file)

Function: parse-utx-file ()

Package

utx-file

Source

utx-file.lisp (file)

Function: peek-valid-stream ()

Package

cl-i18n

Source

parser.lisp (file)

Function: polish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: portuguese-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: random-string STRINGS

Package

cl-i18n

Source

base.lisp (file)

Function: romanian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: russian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

Function: search-mo-repository ROOT &key MAX-PATH-DEPTH

Package

cl-i18n

Source

utils.lisp (file)

Function: serbian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: slovak-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: slovenian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: slurp-file FILENAME &key CONVERT-TO-STRING

A simple way to slurp a file.

Package

cl-i18n

Source

utils.lisp (file)

Function: spanish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: swedish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

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 (file)

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 (file)

Function: translation-table ()

Package

cl-i18n

Source

base.lisp (file)

Function: turkish-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

Function: ukrainian-plural-form N

Package

cl-i18n

Source

plural-forms.lisp (file)

5.1.5 Generic functions

Generic Function: comment-line OBJECT

Generic Function: (setf comment-line) NEW-VALUE OBJECT

Package

cl-i18n

Methods

Method: comment-line (PARSED-FILE parsed-file)

automatically generated reader method

Source

parser.lisp (file)

Method: (setf comment-line) NEW-VALUE (PARSED-FILE parsed-file)

automatically generated writer method

Source

parser.lisp (file)

Generic Function: flag OBJECT

Generic Function: (setf flag) NEW-VALUE OBJECT

Package

cl-i18n

Methods

Method: flag (TRANSLATION translation)

Method: (setf flag) NEW-VALUE (TRANSLATION translation)

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

Source

translation-class.lisp (file)

Generic Function: get-line OBJECT &key LINE-SEPARATOR

Package

cl-i18n

Source

buffered-input-file.lisp (file)

Methods

Method: get-line OBJECT &key LINE-SEPARATOR

Generic Function: is-comment-line-p OBJECT LINE

Package

cl-i18n

Source

parser.lisp (file)

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 (file)

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 (file)

Method: next-token (OBJECT po-parsed-file) &key HOOK-TO-STRINGPOS RETURN-FIRST-MATCH PREDICATE-SORT-TOKENS NO-MORE-TOKEN-ERROR

Source

pofile.lisp (file)

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 (file)

Generic Function: parse-comment-line OBJECT

Package

cl-i18n

Source

parser.lisp (file)

Methods

Method: parse-comment-line (OBJECT utx-parsed-file)

Source

utx-file.lisp (file)

Method: parse-comment-line (OBJECT parsed-file)

Generic Function: peek-token OBJECT &optional TEST

Package

cl-i18n

Source

parser.lisp (file)

Methods

Method: peek-token (OBJECT utx-parsed-file) &optional TEST

Source

utx-file.lisp (file)

Method: peek-token (OBJECT parsed-file) &optional TEST

Generic Function: peek-token-suppress-errors OBJECT &optional TEST

Package

cl-i18n

Source

parser.lisp (file)

Methods

Method: peek-token-suppress-errors (OBJECT parsed-file) &optional TEST

Generic Function: seek OBJECT POS

Package

cl-i18n

Source

buffered-input-file.lisp (file)

Methods

Method: seek (OBJECT buffered-input-file) POS

Generic Function: translated OBJECT

Generic Function: (setf translated) NEW-VALUE OBJECT

Package

cl-i18n

Methods

Method: translated (TRANSLATION translation)

Method: (setf translated) NEW-VALUE (TRANSLATION translation)

The translated string

Source

translation-class.lisp (file)

Generic Function: translation-list->hash-table SOURCE DEST

Package

cl-i18n

Source

translation-class.lisp (file)

Methods

Method: translation-list->hash-table (LIST list) (HT hash-table)

Parse a list into a translation table.

5.1.6 Conditions

Condition: no-translation ()

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

text-warning (condition)

Condition: no-translation-table-error ()

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

text-error (condition)

Condition: out-of-bounds ()

Error when you go out of bound

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct methods

• idx (method)
• seq (method)

Direct slots

Slot: seq

Initargs

:seq

Readers

seq (generic function)

Slot: idx

Initargs

:idx

Readers

idx (generic function)

Condition: parsing-mofile-error ()

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

text-error (condition)

Condition: parsing-pofile-error ()

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

text-error (condition)

Condition: parsing-utxfile-error ()

Package

i18n-conditions

Source

conditions.lisp (file)

Direct superclasses

text-error (condition)

5.1.7 Classes

Class: parsed-file ()

Package

cl-i18n

Source

parser.lisp (file)

Direct superclasses

buffered-input-file (class)

Direct subclasses

• utx-parsed-file (class)
• po-parsed-file (class)
• extract-parsed-file (class)

Direct methods

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

Direct slots

Slot: comment-line

Initargs

:comment-line

Readers

comment-line (generic function)

Writers

(setf comment-line) (generic function)

Class: translation ()

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

Package

cl-i18n

Source

translation-class.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• copy-translation (method)
• make-load-form (method)
• print-object (method)
• flag (method)
• flag (method)
• plural-translated (method)
• plural-translated (method)
• plural-form (method)
• plural-form (method)
• translated (method)
• translated (method)

Direct slots

Slot: translated

The translated string

Type

string

Initargs

:translated

Initform

""

Readers

translated (generic function)

Writers

(setf translated) (generic function)

Slot: plural-form

Type

string

Initargs

:plural-form

Initform

""

Readers

plural-form (generic function)

Writers

(setf plural-form) (generic function)

Slot: plural-translated

a list of string for each valid plural form

Type

list

Initargs

:plural-translated

Initform

(quote nil)

Readers

plural-translated (generic function)

Writers

(setf plural-translated) (generic function)

Slot: flag

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

Initargs

:flag

Initform

cl-i18n:+untranslated-flag+

Readers

flag (generic function)

Writers

(setf flag) (generic function)

Class: utx-parsed-file ()

Package

utx-file

Source

utx-file.lisp (file)

Direct superclasses

parsed-file (class)

Direct methods

• next-token (method)
• parse-comment-line (method)
• last-comment-line-p (method)
• peek-token (method)
• initialize-instance (method)

5.2 Internal definitions

5.2.1 Constants

Constant: +!=+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +%+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +<+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +<=+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +==+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +>+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +>=+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +?+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +?-regex+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +agnostic-comment+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +and-op+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +close-paren+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +close-paren-regex+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +colon+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +column+

Package

utx-file

Source

utx-file.lisp (file)

Constant: +column-id+

Package

utx-file

Source

utx-file.lisp (file)

Constant: +default-buffer-size+

Package

cl-i18n

Source

buffered-input-file.lisp (file)

Constant: +default-element-type+

Package

cl-i18n

Source

buffered-input-file.lisp (file)

Constant: +end-expression+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +escape-newline+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +escape-string-escape-char+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +escape-string-escaped-newline+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +escaped-string-delim+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +extr-escaped-stopper

Package

cl-i18n

Source

extraction-translatable-strings.lisp (file)

Constant: +extr-string-re+

Package

cl-i18n

Source

extraction-translatable-strings.lisp (file)

Constant: +flag-fuzzy+

Package

cl-i18n

Source

pofile.lisp (file)

Constant: +flag-line+

Package

cl-i18n

Source

pofile.lisp (file)

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

Package

cl-i18n

Source

mofile.lisp (file)