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 else:
  66     conv_path=''
  67 convert_ly=conv_path+'convert-ly'
  68 print 'using '+convert_ly
  69
  70 unsafe = []
  71 unconverted = []
  72 notags_files = []
  73
  74 # mark the section that will be printed verbatim by lilypond-book
  75 end_header_re = re.compile ('(\\header {.+?doctitle = ".+?})\n', re.M | re.S)
  76
  77 doctitle_re = re.compile (r'(doctitle[a-zA-Z_]{0,6}\s*=\s*")((?:\\"|[^"\n])*)"')
  78 texinfo_q_re = re.compile (r'@q{(.*?)}')
  79 texinfo_qq_re = re.compile (r'@qq{(.*?)}')
  80 def doctitle_sub (title_match):
  81     # Comma forbidden in Texinfo node name
  82     title = title_match.group (2).replace (',', '')
  83     title = texinfo_q_re.sub (r"`\1'", title)
  84     title = texinfo_qq_re.sub (r'\"\1\"', title)
  85     return title_match.group (1) + title + '"'
  86
  87 def mark_verbatim_section (ly_code):
  88     return end_header_re.sub ('\\1 % begin verbatim\n\n', ly_code, 1)
  89
  90 # '% LSR' comments are to be stripped
  91 lsr_comment_re = re.compile (r'\s*%+\s*LSR.*')
  92 begin_header_re = re.compile (r'\\header\s*{', re.M)
  93 ly_new_version_re = re.compile (r'\\version\s*"(.+?)"')
  94 strip_white_spaces_re = re.compile (r'[ \t]+(?=\n)')
  95
  96 # add tags to ly files from LSR
  97 def add_tags (ly_code, tags):
  98     return begin_header_re.sub ('\\g<0>\n  lsrtags = "' + tags + '"\n',
  99                                 ly_code, 1)
 100
 101 # for snippets from input/new, add message for earliest working version
 102 def add_version (ly_code):
 103     return '''%% Note: this file works from version ''' + \
 104         ly_new_version_re.search (ly_code).group (1) + '\n'
 105
 106 s = 'Translation of GIT [Cc]ommittish'
 107 texidoc_chunk_re = re.compile (r'^(?:%+\s*' + s + \
 108     r'.+)?\s*(?:texidoc|doctitle)([a-zA-Z]{2,4})\s+=(?:.|\n)*?(?=%+\s*' + \
 109     s + r'|\n\} % begin verbatim|\n  (?:doctitle|texidoc|lsrtags) |$(?!.|\n))', re.M)
 110
 111 def update_translated_texidoc (m, snippet_path, visited_languages):
 112     base = os.path.splitext (os.path.basename (snippet_path))[0]
 113     language_code = m.group (1)
 114     visited_languages.append (language_code)
 115     texidoc_path = os.path.join ('Documentation', language_code,
 116                                  'texidocs', base + '.texidoc')
 117     if os.path.isfile (texidoc_path):
 118         return open (texidoc_path).read ()
 119     else:
 120         return m.group (0)
 121
 122 def escape_backslashes_in_header(snippet):
 123     # ASSUME: the \header exists.
 124     header_char_number_start = snippet.find('\header {')
 125     header_char_number_end = snippet.find('} % begin verbatim')
 126
 127     header = snippet[header_char_number_start:header_char_number_end]
 128     # two levels of escaping happening here -- 4\ means 1\
 129     # and the 10\ means two \ backslashes (that's 8\ ), and
 130     # one backreference to group 1 (that's two 2\ ).
 131     new_header = re.sub("@code\{\\\\([a-zA-Z])", "@code{\\\\\\\\\\1", header)
 132     escaped_snippet = (snippet[:header_char_number_start] +
 133         new_header + snippet[header_char_number_end:])
 134     return escaped_snippet
 135
 136 def copy_ly (srcdir, name, tags):
 137     global unsafe
 138     global unconverted
 139     dest = os.path.join (DEST, name)
 140     tags = ', '.join (tags)
 141     s = open (os.path.join (srcdir, name)).read ()
 142
 143     for path in TEXIDOCS:
 144         texidoc_translation_path = \
 145             os.path.join (path, os.path.splitext (name)[0] + '.texidoc')
 146         if os.path.exists (texidoc_translation_path):
 147             texidoc_translation = open (texidoc_translation_path).read ()
 148             # Since we want to insert the translations verbatim using a
 149             # regexp, \\ is understood as ONE escaped backslash. So we have
 150             # to escape those backslashes once more...
 151             texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
 152             s = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, s, 1)
 153
 154     s = doctitle_re.sub (doctitle_sub, s)
 155     if in_dir and in_dir in srcdir:
 156         s = LY_HEADER_LSR + add_tags (s, tags)
 157     else:
 158         s = LY_HEADER_NEW + add_version (s) + s
 159
 160     s = mark_verbatim_section (s)
 161     s = lsr_comment_re.sub ('', s)
 162     s = strip_white_spaces_re.sub ('', s)
 163     s = escape_backslashes_in_header (s)
 164     open (dest, 'w').write (s)
 165
 166     e = os.system (convert_ly+(" -e '%s'" % dest))
 167     if e:
 168         unconverted.append (dest)
 169     if os.path.exists (dest + '~'):
 170         os.remove (dest + '~')
 171     # no need to check snippets from input/new
 172     if in_dir and in_dir in srcdir:
 173         # -V seems to make unsafe snippets fail nicer/sooner
 174         e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
 175         if e:
 176             unsafe.append (dest)
 177
 178 def read_source_with_dirs (src):
 179     s = {}
 180     l = {}
 181     for tag in TAGS:
 182         srcdir = os.path.join (src, tag)
 183         l[tag] = set (map (os.path.basename,
 184                            glob.glob (os.path.join (srcdir, '*.ly'))))
 185         for f in l[tag]:
 186             if f in s:
 187                 s[f][1].append (tag)
 188             else:
 189                 s[f] = (srcdir, [tag])
 190     return s, l
 191
 192
 193 tags_re = re.compile ('lsrtags\\s*=\\s*"(.+?)"')
 194
 195 def read_source (src):
 196     s = {}
 197     l = dict ([(tag, set()) for tag in TAGS])
 198     for f in glob.glob (os.path.join (src, '*.ly')):
 199         basename = os.path.basename (f)
 200         m = tags_re.search (open (f, 'r').read ())
 201         if m:
 202             file_tags = [tag.strip() for tag in m.group (1). split(',')]
 203             s[basename] = (src, file_tags)
 204             [l[tag].add (basename) for tag in file_tags if tag in TAGS]
 205         else:
 206             notags_files.append (f)
 207     return s, l
 208
 209
 210 def dump_file_list (file, file_list, update=False):
 211     if update:
 212         old_list = set (open (file, 'r').read ().splitlines ())
 213         old_list.update (file_list)
 214         new_list = list (old_list)
 215     else:
 216         new_list = file_list
 217     f = open (file, 'w')
 218     f.write ('\n'.join (sorted (new_list)) + '\n')
 219
 220 def update_ly_in_place (snippet_path):
 221     visited_languages = []
 222     contents = open (snippet_path).read ()
 223     contents = texidoc_chunk_re.sub \
 224         (lambda m: update_translated_texidoc (m,
 225                                               snippet_path,
 226                                               visited_languages),
 227          contents)
 228     need_line_break_workaround = False
 229     for language_code in langdefs.LANGDICT:
 230         if not language_code in visited_languages:
 231             base = os.path.splitext (os.path.basename (snippet_path))[0]
 232             texidoc_path = os.path.join ('Documentation', language_code,
 233                          'texidocs', base + '.texidoc')
 234             if os.path.isfile (texidoc_path):
 235                 texidoc_translation = open (texidoc_path).read ()
 236                 texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
 237                 contents = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, contents, 1)
 238         else:
 239             need_line_break_workaround = True
 240     contents = doctitle_re.sub (doctitle_sub, contents)
 241     contents = escape_backslashes_in_header (contents)
 242
 243     # workaround for a bug in the regex's that I'm not smart
 244     # enough to figure out.  -gp
 245     if need_line_break_workaround:
 246         first_translated = contents.find('%% Translation of')
 247         keep = contents[:first_translated+5]
 248         contents = keep + contents[first_translated+5:].replace('%% Translation of', '\n%% Translation of')
 249
 250     open (snippet_path, 'w').write (contents)
 251
 252 if in_dir:
 253     ## clean out existing lys and generated files
 254     map (os.remove, glob.glob (os.path.join (DEST, '*.ly')) +
 255          glob.glob (os.path.join (DEST, '*.snippet-list')))
 256
 257     # read LSR source where tags are defined by subdirs
 258     snippets, tag_lists = read_source_with_dirs (in_dir)
 259
 260     # read input/new where tags are directly defined
 261     s, l = read_source (NEW_LYS)
 262     snippets.update (s)
 263     for t in TAGS:
 264         tag_lists[t].update (l[t])
 265 else:
 266     snippets, tag_lists = read_source (NEW_LYS)
 267     ## update texidocs of snippets that don't come from NEW_LYS
 268     for snippet_path in glob.glob (os.path.join (DEST, '*.ly')):
 269         if not os.path.basename (snippet_path) in snippets:
 270             update_ly_in_place (snippet_path)
 271
 272 for (name, (srcdir, tags)) in snippets.items ():
 273     copy_ly (srcdir, name, tags)
 274 for (tag, file_set) in tag_lists.items ():
 275     dump_file_list (os.path.join (DEST, tag + '.snippet-list'),
 276                     file_set, update=not(in_dir))
 277 if unconverted:
 278     sys.stderr.write ('These files could not be converted successfully by convert-ly:\n')
 279     sys.stderr.write ('\n'.join (unconverted) + '\n\n')
 280 if notags_files:
 281     sys.stderr.write ('No tags could be found in these files:\n')
 282     sys.stderr.write ('\n'.join (notags_files) + '\n\n')
 283 if unsafe:
 284     dump_file_list ('lsr-unsafe.txt', unsafe)
 285     sys.stderr.write ('''
 286
 287 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
 288   git add %s/*.ly
 289   xargs git diff HEAD < lsr-unsafe.txt
 290
 291 ''' % DEST)