scripts/auxiliar/makelsr.py

   1 #!/usr/bin/env python
   2
   3 import sys
   4 import os
   5 import glob
   6 import re
   7
   8 sys.path.append ('python')
   9 import langdefs
  10
  11 DEST = os.path.join ('Documentation', 'snippets')
  12 NEW_LYS = os.path.join ('Documentation', 'snippets', 'new')
  13 TEXIDOCS = [os.path.join ('Documentation', language_code, 'texidocs')
  14             for language_code in langdefs.LANGDICT]
  15
  16 USAGE = '''  Usage: makelsr.py [LSR_SNIPPETS_DIR]
  17 This script must be run from top of the source tree;
  18 it updates snippets %(DEST)s with snippets
  19 from %(NEW_LYS)s or LSR_SNIPPETS_DIR.
  20 If a snippet is present in both directories, the one
  21 from %(NEW_LYS)s is preferred.
  22 ''' % vars ()
  23
  24 LY_HEADER_LSR = '''%% Do not edit this file; it is automatically
  25 %% generated from LSR http://lsr.dsi.unimi.it
  26 %% This file is in the public domain.
  27 '''
  28
  29 LY_HEADER_NEW = '''%% Do not edit this file; it is automatically
  30 %% generated from %s
  31 %% This file is in the public domain.
  32 ''' % NEW_LYS
  33
  34 TAGS = []
  35 # NR 1
  36 TAGS.extend (['pitches', 'rhythms', 'expressive-marks',
  37 'repeats', 'simultaneous-notes', 'staff-notation',
  38 'editorial-annotations', 'text'])
  39 # NR 2
  40 TAGS.extend (['vocal-music', 'chords', 'keyboards',
  41 'percussion', 'fretted-strings', 'unfretted-strings',
  42 'ancient-notation', 'winds', 'world-music'
  43 ])
  44
  45 # other
  46 TAGS.extend (['contexts-and-engravers', 'tweaks-and-overrides',
  47 'paper-and-layout', 'breaks', 'spacing', 'midi', 'titles', 'template'])
  48
  49 def exit_with_usage (n=0):
  50     sys.stderr.write (USAGE)
  51     sys.exit (n)
  52
  53 if len (sys.argv) >= 2:
  54     in_dir = sys.argv[1]
  55     if len (sys.argv) >= 3:
  56         exit_with_usage (2)
  57     if not (os.path.isdir (DEST) and os.path.isdir (NEW_LYS)):
  58         exit_with_usage (3)
  59 else:
  60     in_dir = ''
  61
  62 # which convert-ly to use
  63 if os.path.isfile("out/bin/convert-ly"):
  64     conv_path='out/bin/'
  65 elif os.path.isfile("build/out/bin/convert-ly"):
  66     conv_path='build/out/bin/'
  67 else:
  68     conv_path=''
  69 convert_ly=conv_path+'convert-ly'
  70 print 'using '+convert_ly
  71
  72 unsafe = []
  73 unconverted = []
  74 notags_files = []
  75
  76 # mark the section that will be printed verbatim by lilypond-book
  77 end_header_re = re.compile ('(\\header {.+?doctitle = ".+?})\n', re.M | re.S)
  78
  79 doctitle_re = re.compile (r'(doctitle[a-zA-Z_]{0,6}\s*=\s*")((?:\\"|[^"\n])*)"')
  80 texinfo_q_re = re.compile (r'@q{(.*?)}')
  81 texinfo_qq_re = re.compile (r'@qq{(.*?)}')
  82 def doctitle_sub (title_match):
  83     # Comma forbidden in Texinfo node name
  84     title = title_match.group (2).replace (',', '')
  85     title = texinfo_q_re.sub (r"`\1'", title)
  86     title = texinfo_qq_re.sub (r'\"\1\"', title)
  87     return title_match.group (1) + title + '"'
  88
  89 def mark_verbatim_section (ly_code):
  90     return end_header_re.sub ('\\1 % begin verbatim\n\n', ly_code, 1)
  91
  92 # '% LSR' comments are to be stripped
  93 lsr_comment_re = re.compile (r'\s*%+\s*LSR.*')
  94 begin_header_re = re.compile (r'\\header\s*{', re.M)
  95 ly_new_version_re = re.compile (r'\\version\s*"(.+?)"')
  96 strip_white_spaces_re = re.compile (r'[ \t]+(?=\n)')
  97
  98 # add tags to ly files from LSR
  99 def add_tags (ly_code, tags):
 100     return begin_header_re.sub ('\\g<0>\n  lsrtags = "' + tags + '"\n',
 101                                 ly_code, 1)
 102
 103 # for snippets from input/new, add message for earliest working version
 104 def add_version (ly_code):
 105     return '''%% Note: this file works from version ''' + \
 106         ly_new_version_re.search (ly_code).group (1) + '\n'
 107
 108 s = 'Translation of GIT [Cc]ommittish'
 109 texidoc_chunk_re = re.compile (r'^(?:%+\s*' + s + \
 110     r'.+)?\s*(?:texidoc|doctitle)([a-zA-Z]{2,4})\s+=(?:.|\n)*?(?=%+\s*' + \
 111     s + r'|\n\} % begin verbatim|\n  (?:doctitle|texidoc|lsrtags) |$(?!.|\n))', re.M)
 112
 113 def update_translated_texidoc (m, snippet_path, visited_languages):
 114     base = os.path.splitext (os.path.basename (snippet_path))[0]
 115     language_code = m.group (1)
 116     visited_languages.append (language_code)
 117     texidoc_path = os.path.join ('Documentation', language_code,
 118                                  'texidocs', base + '.texidoc')
 119     if os.path.isfile (texidoc_path):
 120         return open (texidoc_path).read ()
 121     else:
 122         return m.group (0)
 123
 124 def escape_backslashes_in_header(snippet):
 125     # ASSUME: the \header exists.
 126     header_char_number_start = snippet.find('\header {')
 127     header_char_number_end = snippet.find('} % begin verbatim')
 128
 129     header = snippet[header_char_number_start:header_char_number_end]
 130     # two levels of escaping happening here -- 4\ means 1\
 131     # and the 10\ means two \ backslashes (that's 8\ ), and
 132     # one backreference to group 1 (that's two 2\ ).
 133     new_header = re.sub("@code\{\\\\([a-zA-Z])", "@code{\\\\\\\\\\1", header)
 134     escaped_snippet = (snippet[:header_char_number_start] +
 135         new_header + snippet[header_char_number_end:])
 136     return escaped_snippet
 137
 138 def copy_ly (srcdir, name, tags):
 139     global unsafe
 140     global unconverted
 141     dest = os.path.join (DEST, name)
 142     tags = ', '.join (tags)
 143     s = open (os.path.join (srcdir, name)).read ()
 144
 145     for path in TEXIDOCS:
 146         texidoc_translation_path = \
 147             os.path.join (path, os.path.splitext (name)[0] + '.texidoc')
 148         if os.path.exists (texidoc_translation_path):
 149             texidoc_translation = open (texidoc_translation_path).read ()
 150             # Since we want to insert the translations verbatim using a
 151             # regexp, \\ is understood as ONE escaped backslash. So we have
 152             # to escape those backslashes once more...
 153             texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
 154             s = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, s, 1)
 155
 156     s = doctitle_re.sub (doctitle_sub, s)
 157     if in_dir and in_dir in srcdir:
 158         s = LY_HEADER_LSR + add_tags (s, tags)
 159     else:
 160         s = LY_HEADER_NEW + add_version (s) + s
 161
 162     s = mark_verbatim_section (s)
 163     s = lsr_comment_re.sub ('', s)
 164     s = strip_white_spaces_re.sub ('', s)
 165     s = escape_backslashes_in_header (s)
 166     open (dest, 'w').write (s)
 167
 168     e = os.system (convert_ly+(" -d -e '%s'" % dest))
 169     if e:
 170         unconverted.append (dest)
 171     if os.path.exists (dest + '~'):
 172         os.remove (dest + '~')
 173     # no need to check snippets from input/new
 174     if in_dir and in_dir in srcdir:
 175         # -V seems to make unsafe snippets fail nicer/sooner
 176         e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
 177         if e:
 178             unsafe.append (dest)
 179
 180 def read_source_with_dirs (src):
 181     s = {}
 182     l = {}
 183     for tag in TAGS:
 184         srcdir = os.path.join (src, tag)
 185         l[tag] = set (map (os.path.basename,
 186                            glob.glob (os.path.join (srcdir, '*.ly'))))
 187         for f in l[tag]:
 188             if f in s:
 189                 s[f][1].append (tag)
 190             else:
 191                 s[f] = (srcdir, [tag])
 192     return s, l
 193
 194
 195 tags_re = re.compile ('lsrtags\\s*=\\s*"(.+?)"')
 196
 197 def read_source (src):
 198     s = {}
 199     l = dict ([(tag, set()) for tag in TAGS])
 200     for f in glob.glob (os.path.join (src, '*.ly')):
 201         basename = os.path.basename (f)
 202         m = tags_re.search (open (f, 'r').read ())
 203         if m:
 204             file_tags = [tag.strip() for tag in m.group (1). split(',')]
 205             s[basename] = (src, file_tags)
 206             [l[tag].add (basename) for tag in file_tags if tag in TAGS]
 207         else:
 208             notags_files.append (f)
 209     return s, l
 210
 211
 212 def dump_file_list (file, file_list, update=False):
 213     if update:
 214         old_list = set (open (file, 'r').read ().splitlines ())
 215         old_list.update (file_list)
 216         new_list = list (old_list)
 217     else:
 218         new_list = file_list
 219     f = open (file, 'w')
 220     f.write ('\n'.join (sorted (new_list)) + '\n')
 221
 222 def update_ly_in_place (snippet_path):
 223     visited_languages = []
 224     contents = open (snippet_path).read ()
 225     contents = texidoc_chunk_re.sub \
 226         (lambda m: update_translated_texidoc (m,
 227                                               snippet_path,
 228                                               visited_languages),
 229          contents)
 230     need_line_break_workaround = False
 231     for language_code in langdefs.LANGDICT:
 232         if not language_code in visited_languages:
 233             base = os.path.splitext (os.path.basename (snippet_path))[0]
 234             texidoc_path = os.path.join ('Documentation', language_code,
 235                          'texidocs', base + '.texidoc')
 236             if os.path.isfile (texidoc_path):
 237                 texidoc_translation = open (texidoc_path).read ()
 238                 texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
 239                 contents = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, contents, 1)
 240         else:
 241             need_line_break_workaround = True
 242     contents = doctitle_re.sub (doctitle_sub, contents)
 243     contents = escape_backslashes_in_header (contents)
 244
 245     # workaround for a bug in the regex's that I'm not smart
 246     # enough to figure out.  -gp
 247     if need_line_break_workaround:
 248         first_translated = contents.find('%% Translation of')
 249         keep = contents[:first_translated+5]
 250         contents = keep + contents[first_translated+5:].replace('%% Translation of', '\n%% Translation of')
 251
 252     open (snippet_path, 'w').write (contents)
 253
 254 if in_dir:
 255     ## clean out existing lys and generated files
 256     map (os.remove, glob.glob (os.path.join (DEST, '*.ly')) +
 257          glob.glob (os.path.join (DEST, '*.snippet-list')))
 258
 259     # read LSR source where tags are defined by subdirs
 260     snippets, tag_lists = read_source_with_dirs (in_dir)
 261
 262     # read input/new where tags are directly defined
 263     s, l = read_source (NEW_LYS)
 264     snippets.update (s)
 265     for t in TAGS:
 266         tag_lists[t].update (l[t])
 267 else:
 268     snippets, tag_lists = read_source (NEW_LYS)
 269     ## update texidocs of snippets that don't come from NEW_LYS
 270     for snippet_path in glob.glob (os.path.join (DEST, '*.ly')):
 271         if not os.path.basename (snippet_path) in snippets:
 272             update_ly_in_place (snippet_path)
 273
 274 for (name, (srcdir, tags)) in snippets.items ():
 275     copy_ly (srcdir, name, tags)
 276 for (tag, file_set) in tag_lists.items ():
 277     dump_file_list (os.path.join (DEST, tag + '.snippet-list'),
 278                     file_set, update=not(in_dir))
 279 if unconverted:
 280     sys.stderr.write ('These files could not be converted successfully by convert-ly:\n')
 281     sys.stderr.write ('\n'.join (unconverted) + '\n\n')
 282 if notags_files:
 283     sys.stderr.write ('No tags could be found in these files:\n')
 284     sys.stderr.write ('\n'.join (notags_files) + '\n\n')
 285 if unsafe:
 286     dump_file_list ('lsr-unsafe.txt', unsafe)
 287     sys.stderr.write ('''
 288
 289 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
 290   git add %s/*.ly
 291   xargs git diff HEAD < lsr-unsafe.txt
 292
 293 ''' % DEST)