Docs: reorganize documentation directory structure

[lilypond.git] / scripts / auxiliar / makelsr.py

diff --git a/scripts/auxiliar/makelsr.py b/scripts/auxiliar/makelsr.py
index 4f95e7de77ca3c69ca076c7d82af0adc6c1e229a..88731719c1e6a3562d5f5ce85518adce7c4e4b1c 100755 (executable)
--- a/scripts/auxiliar/makelsr.py
+++ b/scripts/auxiliar/makelsr.py
@@ -5,23 +5,31 @@ import os
 import glob
 import re
 
+os.environ['PYTHONPATH'] += ':python'
+import langdefs
+
+DEST = os.path.join ('Documentation', 'snippets')
+NEW_LYS = os.path.join ('Documentation', 'snippets', 'new')
+TEXIDOCS = [os.path.join ('Documentation', language_code, 'texidocs')
+            for language_code in langdefs.LANGDICT]
+
 USAGE = '''  Usage: makelsr.py [LSR_SNIPPETS_DIR]
 This script must be run from top of the source tree;
-it updates snippets input/lsr with snippets in input/new or LSR_SNIPPETS_DIR.
-If a snippet is present in both directories, the one from input/new is preferred.
-'''
-
-LY_HEADER_LSR = '''%% Do not edit this file; it is auto-generated from LSR http://lsr.dsi.unimi.it
+it updates snippets %(DEST)s with snippets
+from %(NEW_LYS)s or LSR_SNIPPETS_DIR.
+If a snippet is present in both directories, the one
+from %(NEW_LYS)s is preferred.
+''' % vars ()
+
+LY_HEADER_LSR = '''%% Do not edit this file; it is automatically
+%% generated from LSR http://lsr.dsi.unimi.it
 %% This file is in the public domain.
 '''
 
-LY_HEADER_NEW = '''%% Do not edit this file; it is auto-generated from input/new
+LY_HEADER_NEW = '''%% Do not edit this file; it is automatically
+%% generated from %s
 %% This file is in the public domain.
-'''
-
-DEST = os.path.join ('input', 'lsr')
-NEW_LYS = os.path.join ('input', 'new')
-TEXIDOCS = os.path.join ('input', 'texidocs')
+''' % NEW_LYS
 
 TAGS = []
 # NR 1
@@ -66,9 +74,17 @@ lsr_comment_re = re.compile (r'\s*%+\s*LSR.*')
 
 begin_header_re = re.compile (r'\\header\s*{', re.M)
 
+ly_new_version_re = re.compile (r'\\version\s*"(.+?)"')
+
 # add tags to ly files from LSR
 def add_tags (ly_code, tags):
-    return begin_header_re.sub ('\\g<0>\n  lsrtags = "' + tags + '"\n', ly_code, 1)
+    return begin_header_re.sub ('\\g<0>\n  lsrtags = "' + tags + '"\n',
+                                ly_code, 1)
+
+# for snippets from input/new, add message for earliest working version
+def add_version (ly_code):
+    return '''%% Note: this file works from version ''' + \
+        ly_new_version_re.search (ly_code).group (1) + '\n'
 
 def copy_ly (srcdir, name, tags):
     global unsafe
@@ -77,20 +93,21 @@ def copy_ly (srcdir, name, tags):
     tags = ', '.join (tags)
     s = open (os.path.join (srcdir, name)).read ()
 
-    texidoc_translations_path = os.path.join (TEXIDOCS,
-                                              os.path.splitext (name)[0] + '.texidoc')
-    if os.path.exists (texidoc_translations_path):
-        texidoc_translations = open (texidoc_translations_path).read ()
-        # Since we want to insert the translations verbatim using a 
-        # regexp, \\ is understood as ONE escaped backslash. So we have
-        # to escape those backslashes once more...
-        texidoc_translations = texidoc_translations.replace ('\\', '\\\\')
-        s = begin_header_re.sub ('\\g<0>\n' + texidoc_translations, s, 1)
+    for path in TEXIDOCS:
+        texidoc_translation_path = \
+            os.path.join (path, os.path.splitext (name)[0] + '.texidoc')
+        if os.path.exists (texidoc_translation_path):
+            texidoc_translation = open (texidoc_translation_path).read ()
+            # Since we want to insert the translations verbatim using a 
+            # regexp, \\ is understood as ONE escaped backslash. So we have
+            # to escape those backslashes once more...
+            texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
+            s = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, s, 1)
 
     if in_dir and in_dir in srcdir:
         s = LY_HEADER_LSR + add_tags (s, tags)
     else:
-        s = LY_HEADER_NEW + s
+        s = LY_HEADER_NEW + add_version (s) + s
 
     s = mark_verbatim_section (s)
     s = lsr_comment_re.sub ('', s)
@@ -101,10 +118,12 @@ def copy_ly (srcdir, name, tags):
         unconverted.append (dest)
     if os.path.exists (dest + '~'):
         os.remove (dest + '~')
-    # -V seems to make unsafe snippets fail nicer/sooner
-    e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
-    if e:
-        unsafe.append (dest)
+    # no need to check snippets from input/new
+    if in_dir and in_dir in srcdir:
+        # -V seems to make unsafe snippets fail nicer/sooner
+        e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
+        if e:
+            unsafe.append (dest)
 
 def read_source_with_dirs (src):
     s = {}
@@ -175,13 +194,12 @@ if unconverted:
 if notags_files:
     sys.stderr.write ('No tags could be found in these files:\n')
     sys.stderr.write ('\n'.join (notags_files) + '\n\n')
-
-dump_file_list ('lsr-unsafe.txt', unsafe)
-sys.stderr.write ('''
+if unsafe:
+    dump_file_list ('lsr-unsafe.txt', unsafe)
+    sys.stderr.write ('''
 
 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
-  git add input/lsr/*.ly
+  git add %s/*.ly
   xargs git diff HEAD < lsr-unsafe.txt
 
-''')
-
+''' % DEST)