Merge pull request #124 from patacrep/language_code

Differentiate language code and babel language

examples/example-all.sb

@@ -8,7 +8,7 @@
 "booktype" : "chorded",
 "datadir": ["datadir2"],
 "template" : "patacrep.tex",
-"lang" : "french",
+"lang" : "fr",
 "encoding": "utf8",
 "authwords" : {
   "sep" : ["and", "et"]

examples/songs/greensleeves.sgc

@@ -1,4 +1,4 @@
-{language : english}
+{lang : en}
 {columns :  2}
 { title : Greensleeves}
 {subtitle: Test of the chordpro format}

examples/songs/tests/chords.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {columns:  1}
 {title: Chords testing}
 {subtitle: Test of the chords specification and LaTeX translation}

examples/songs/tests/errors.sgc

@@ -1,4 +1,4 @@
-{language : english}
+{lang : en}
 {columns :  2}
 { title : Error}
 {subtitle: A chordpro file with many errors}

patacrep/build.py

@@ -29,7 +29,7 @@ GENERATED_EXTENSIONS = [
     ]
 DEFAULT_CONFIG = {
     'template': "default.tex",
-    'lang': 'english',
+    'lang': 'en',
     'content': [],
     'titleprefixwords': [],
     'encoding': None,

patacrep/content/song.py

@@ -60,8 +60,8 @@ def parse(keyword, argument, contentlist, config):
     Return a list of Song() instances.
     """
     plugins = config['_song_plugins']
-    if '_languages' not in config:
+    if '_langs' not in config:
-        config['_languages'] = set()
+        config['_langs'] = set()
     songlist = []
     for songdir in config['_songdir']:
         if contentlist:
@@ -92,7 +92,7 @@ def parse(keyword, argument, contentlist, config):
                         datadir=songdir.datadir,
                         ))
                     songlist.append(renderer)
-                    config["_languages"].add(renderer.song.language)
+                    config["_langs"].add(renderer.song.lang)
             if len(songlist) > before:
                 break
         if len(songlist) == before:

patacrep/data/templates/songs.tex

@@ -52,7 +52,7 @@
             "mandatory": true
             },
 "lang": {"description": {"english": "Language", "french": "Langue"},
-         "default": {"english": "english", "french": "french"}
+         "default": {"english": "en", "french": "fr"}
       },
 "titleprefixwords": {"description": {"english": "Ignore some words in the beginning of song titles",
                                      "french": "Ignore des mots dans le classement des chansons"},
@@ -80,11 +80,11 @@
 (* block songbookpreambule *)
 (( super() ))
 
-(* for lang in _languages -*)
+(* for lang in _langs -*)
-    \PassOptionsToPackage{((lang))}{babel}
+    \PassOptionsToPackage{(( lang2babel(lang) ))}{babel}
 (* endfor *)
-\usepackage[((lang))]{babel}
+\usepackage[(( lang2babel(lang) ))]{babel}
-\lang{((lang))}
+\lang{(( lang2babel(lang) ))}
 
 \usepackage{graphicx}
 \graphicspath{ %

patacrep/latex/__init__.py

@@ -5,4 +5,27 @@ This module uses an LALR parser to try to parse LaTeX code. LaTeX language
 will work on simple cases, but not on complex ones.
 """
 
+import logging
+from collections import OrderedDict
+
 from patacrep.latex.syntax import tex2plain, parse_song
+
+LOGGER = logging.getLogger(__name__)
+
+BABEL_LANGUAGES = OrderedDict((
+    ('fr', 'french'),
+    ('en', 'english'),
+    ('de', 'german'),
+    ('es', 'spanish'),
+    ('it', 'italian'),
+    ('pt', 'portuguese'),
+))
+
+def lang2babel(lang):
+    """Return the language used by babel, corresponding to the language code"""
+    try:
+        return BABEL_LANGUAGES[lang]
+    except KeyError:
+        available = ", ".join(BABEL_LANGUAGES.keys())
+        LOGGER.error('Unknown lang code: ' + lang + '. Supported: ' + available)
+        return 'english'

patacrep/songs/__init__.py

@@ -89,7 +89,7 @@ class Song:
         "cached",
         "data",
         "subpath",
-        "language",
+        "lang",
         "authors",
         "_filehash",
         "_version",
@@ -131,6 +131,7 @@ class Song:
         self.titles = []
         self.data = {}
         self.cached = None
+        self.lang = None
         self._parse(config)
 
         # Post processing of data
@@ -186,8 +187,7 @@ class Song:
 
         - titles: the list of (raw) titles. This list will be processed to
           remove prefixes.
-        - language: the main language of the song, as language recognized by
+        - lang: the main language of the song, as language code..
-          the LaTeX babel package.
         - authors: the list of (raw) authors. This list will be processed to
           'clean' it (see function :func:`patacrep.authors.processauthors`).
         - data: song metadata. Used (among others) to sort the songs.

patacrep/songs/chordpro/__init__.py

@@ -9,6 +9,7 @@ from patacrep import encoding, files
 from patacrep.songs import Song
 from patacrep.songs.chordpro.syntax import parse_song
 from patacrep.templates import Renderer
+from patacrep.latex import lang2babel
 
 class ChordproSong(Song):
     """Chordpros song parser."""
@@ -35,7 +36,7 @@ class ChordproSong(Song):
             song = parse_song(song.read(), self.fullpath)
         self.authors = song.authors
         self.titles = song.titles
-        self.language = song.get_data_argument('language', self.config['lang'])
+        self.lang = song.get_data_argument('lang', self.config['lang'])
         self.data = song.meta
         self.cached = {
             'song': song,
@@ -46,7 +47,7 @@ class ChordproSong(Song):
             templatedirs = []
 
         context = {
-            'language': self.language,
+            'lang': self.lang,
             "titles": self.titles,
             "authors": self.authors,
             "metadata": self.data,
@@ -60,6 +61,7 @@ class ChordproSong(Song):
             ))
         jinjaenv.filters['search_image'] = self.search_image
         jinjaenv.filters['search_partition'] = self.search_partition
+        jinjaenv.filters['lang2babel'] = lang2babel
 
         try:
             return Renderer(

patacrep/songs/chordpro/ast.py

@@ -31,6 +31,7 @@ DIRECTIVE_SHORTCUTS = {
     "c": "comment",
     "gc": "guitar_comment",
     "cover": "cov",
+    "language": "lang",
     }
 
 def directive_name(text):
@@ -181,7 +182,7 @@ class Song(AST):
         - content: the song content, as a list of objects `foo` such that
           `foo.inline` is True.
         - titles: The list of titles
-        - language: The language (if set), None otherwise
+        - lang: The language code (if set), None otherwise
         - authors: The list of authors
         - meta: Every other metadata.
         """

patacrep/songs/chordpro/data/chordpro/song_header

@@ -1,5 +1,5 @@
-(* if language is defined -*)
+(* if lang is defined -*)
-  {language: (( language ))}
+  {lang: (( lang ))}
 (* endif *)
 (* if metadata.columns is defined -*)
   {columns: (( metadata.columns ))}

patacrep/songs/chordpro/data/html/song_header

@@ -17,8 +17,8 @@
   (* endif *)
 (* endfor *)
 
-(* if language is defined -*)
+(* if lang is defined -*)
-  <span class="song-language">Language: (( language ))</span><br>
+  <span class="song-language">Lang: (( lang ))</span><br>
 (* endif *)
 
 (* include 'content_metadata_cover' *)

patacrep/songs/chordpro/data/latex/song

@@ -1,5 +1,5 @@
-(* if language is defined -*)
+(* if lang is defined -*)
-    \selectlanguage{((language))}
+    \selectlanguage{(( lang2babel(lang) ))}
 (* endif *)
 
 (*- if metadata.columns is defined *)

patacrep/songs/latex/__init__.py

@@ -8,19 +8,19 @@ will work on simple cases, but not on complex ones.
 import os
 
 from patacrep import files, encoding
-from patacrep.latex import parse_song
+from patacrep.latex import parse_song, BABEL_LANGUAGES
 from patacrep.songs import Song
 
 class LatexSong(Song):
     """LaTeX song parser."""
 
     def _parse(self, __config):
-        """Parse content, and return the dictinory of song data."""
+        """Parse content, and return the dictionary of song data."""
         with encoding.open_read(self.fullpath, encoding=self.encoding) as song:
             self.data = parse_song(song.read(), self.fullpath)
         self.titles = self.data['@titles']
         del self.data['@titles']
-        self.language = self.data['@language']
+        self.set_lang(self.data['@language'])
         del self.data['@language']
         if "by" in self.data:
             self.authors = [self.data['by']]
@@ -38,6 +38,18 @@ class LatexSong(Song):
         ))
         return r'\import{{{}/}}{{{}}}'.format(os.path.dirname(path), os.path.basename(path))
 
+    def set_lang(self, language):
+        """Set the language code"""
+        for lang, babel_language in BABEL_LANGUAGES.items():
+            if language == babel_language:
+                self.lang = lang
+                return
+
+        # Add a custom language to the babel dictionary (language is not officially supported)
+        custom_lang = '_' + language
+        BABEL_LANGUAGES[custom_lang] = language
+        self.lang = custom_lang
+
 SONG_PARSERS = {
     'is': LatexSong,
     'sg': LatexSong,

patacrep/templates.py

@@ -9,6 +9,7 @@ import re
 import json
 
 from patacrep import errors, files
+from patacrep.latex import lang2babel
 import patacrep.encoding
 
 _LATEX_SUBS = (
@@ -84,6 +85,7 @@ class Renderer:
         self.jinjaenv.trim_blocks = True
         self.jinjaenv.lstrip_blocks = True
         self.jinjaenv.globals["path2posix"] = files.path2posix
+        self.jinjaenv.globals["lang2babel"] = lang2babel
         self.template = self.jinjaenv.get_template(template)
 
 

test/test_chordpro/00.sgc

@@ -1 +1 @@
-{language: english}
+{lang: en}

test/test_chordpro/01.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 A verse line

test/test_chordpro/02.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 {title: A directive}
 

test/test_chordpro/03.sgc

@@ -1,2 +1,2 @@
-{language: english}
+{lang: en}
 

test/test_chordpro/04.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_chorus}
     A one line chorus

test/test_chordpro/05.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_bridge}
     A one line bridge

test/test_chordpro/06.sgc

@@ -1,2 +1,2 @@
-{language: english}
+{lang: en}
 

test/test_chordpro/07.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_tab}
 A tab

test/test_chordpro/08.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 
 A lot of new lines

test/test_chordpro/09.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {title: and a directive}
 
 

test/test_chordpro/10.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 A line[A] with a chord

test/test_chordpro/11.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 A line ending with a chord[A]

test/test_chordpro/12.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 [A]A line starting with a chord

test/test_chordpro/13.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_tab}
 A table

test/test_chordpro/21.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 A verse line

test/test_chordpro/22.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 {title: A directive}
 

test/test_chordpro/23.sgc

@@ -1 +1 @@
-{language: english}
+{lang: en}

test/test_chordpro/24.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_chorus}
     A one line chorus

test/test_chordpro/25.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_bridge}
     A one line bridge

test/test_chordpro/26.sgc

@@ -1,2 +1,2 @@
-{language: english}
+{lang: en}
 

test/test_chordpro/27.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 {start_of_tab}
 A tab

test/test_chordpro/28.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 
 A lot of new lines

test/test_chordpro/29.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {title: and a directive}
 
 

test/test_chordpro/author_names.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {title: Title}
 {artist: The Beatles}
 {artist:  Oasis}

test/test_chordpro/chords.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 [A]Simple
 [Bb]Bémol

test/test_chordpro/customchords.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {define: E4 base-fret 7 frets 0 1 3 3 x x}
 {define: E5 base-fret 7 frets 0 1 3 3 x x fingers - 1 2 3 - -}
 {define: E5/A* base-fret 7 frets 0 1 3 3 x x fingers - 1 2 3 - -}

test/test_chordpro/greensleeves.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {columns: 2}
 {title: Greensleeves}
 {title: Un autre sous-titre}

test/test_chordpro/greensleeves.source

@@ -1,4 +1,4 @@
-{language : english}
+{lang : en}
 {columns :  2}
 {subtitle : Un sous titre}
 { title : Greensleeves}

test/test_chordpro/invalid_chord.sgc

@@ -1,3 +1,3 @@
-{language: english}
+{lang: en}
 
 This is  invalid.

test/test_chordpro/invalid_customchord.sgc

@@ -1,2 +1,2 @@
-{language: english}
+{lang: en}
 

test/test_chordpro/lang.sgc

@@ -0,0 +1 @@
+{lang: fr}

test/test_chordpro/lang.source

@@ -0,0 +1 @@
+{language: fr}

test/test_chordpro/metadata.sgc

@@ -1,4 +1,4 @@
-{language: french}
+{lang: fr}
 {capo: Capo}
 {title: Title}
 {title: Subtitle1}

test/test_chordpro/metadata.source

@@ -4,8 +4,8 @@
 {subtitle: Subtitle4}
 {t: Subtitle2}
 {st: Subtitle5}
-{language: english}
+{lang: en}
-{language: french}
+{lang: fr}
 {by: Author1}
 {artist: Author2}
 {album: Album}

test/test_chordpro/newline.html

@@ -1,4 +1,4 @@
-<span class="song-language">Language: english</span><br>
+<span class="song-language">Lang: en</span><br>
 
 
 

test/test_chordpro/newline.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 This is a verse
 With a new line

test/test_chordpro/nolyrics.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 
 A chorus [A]with lyrics
 [Emaj3]maj et nombre

test/test_chordpro/ukulelechords.sgc

@@ -1,4 +1,4 @@
-{language: english}
+{lang: en}
 {define: G frets 0 2 3 2}
 {define: D7 frets 2 2 2 3 fingers 1 1 1 2}
 {define: G frets 3 2 0 0 0 3}