cl-i18n

2016-06-28

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 quicklisp

(ql:quickload "cl-i18n")

Usage

This library can load translations from file formats of the following types:
  • GNU gettext text file (AKA PO files);
  • 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:

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

Will extract all #! strings1 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

    (with-html-output *out*
      (:p (str #!"Blood and honour!")))

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

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

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:

(cl-i18n-utils:convert-save-dictionary oldfile-path new-filepath)

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 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 <polzer@stardawn.org> (base)
  • Vilson Vieira <vilson@void.cc> (string extractor)
  • Cage <cage@katamail.com> (developer and maintainer)

  1. If you use a function like:

      (defun _ (a) (translate a))
    

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

Author
Leslie P. Polzer <polzer@stardawn.org>, Vilson Vieira <vilson@void.cc>, cage <cage@katamail.com>
Maintainer
cage <cage@katamail.com>
License
LLGPL
Categories
internationalization, llgpl