buildscripts/makelsr.py

   1 #!/usr/bin/python
   2
   3 import sys
   4 import os
   5 import glob
   6 import re
   7
   8 USAGE = '''  Usage: makelsr.py LSR_SNIPPETS_DIR
   9 This script must be run from top of the source tree;
  10 it updates snippets input/lsr with snippets in input/new or LSR_SNIPPETS_DIR.
  11 '''
  12
  13 LY_HEADER_LSR = '''%%%% Do not edit this file; it is auto-generated from LSR http://lsr.dsi.unimi.it
  14 %%%% This file is in the public domain.
  15 %%%% Tags: %(tags)s
  16 '''
  17
  18 LY_HEADER_NEW = '''%%%% Do not edit this file; it is auto-generated from input/new
  19 '''
  20
  21 DEST = os.path.join ('input', 'lsr')
  22 NEW_LYS = os.path.join ('input', 'new')
  23
  24 TAGS = []
  25 # NR 1
  26 TAGS.extend (['pitches', 'rhythms', 'expressive-marks',
  27 'repeats', 'simultaneous-notes', 'staff-notation',
  28 'editorial-and-educational-use', 'text'])
  29 # NR 2
  30 TAGS.extend (['vocal-music', 'chords', 'piano-music',
  31 'percussion', 'guitar', 'strings', 'bagpipes', 'ancient-notation'])
  32
  33 # other
  34 TAGS.extend (['contexts-and-engravers', 'tweaks-and-overrides',
  35 'paper-and-layout', 'breaks', 'spacing', 'midi', 'titles', 'template'])
  36
  37 def exit_with_usage (n=0):
  38         sys.stderr.write (USAGE)
  39         sys.exit (n)
  40
  41 try:
  42         in_dir = sys.argv[1]
  43 except:
  44         exit_with_usage (2)
  45
  46 if not (os.path.isdir (DEST) and os.path.isdir (NEW_LYS)):
  47         exit_with_usage (3)
  48
  49 unsafe = []
  50 unconverted = []
  51 notags_files = []
  52
  53 # mark the section that will be printed verbatim by lilypond-book
  54 end_header_re = re.compile ('(\\header {.*?}\n)\n', re.M | re.S)
  55
  56 def mark_verbatim_section (ly_code):
  57         return end_header_re.sub ('\\1% begin verbatim\n', ly_code)
  58
  59 def copy_ly (srcdir, name, tags):
  60         global unsafe
  61         global unconverted
  62         dest = os.path.join (DEST, name)
  63         f = open (dest, 'w')
  64         tags = ', '.join (tags)
  65         if in_dir in srcdir:
  66                 h = LY_HEADER_LSR
  67         else:
  68                 h = LY_HEADER_NEW
  69         f.write (h % vars ())
  70         f.write (mark_verbatim_section (open (os.path.join (srcdir, name)).read ()))
  71         f.close ()
  72         e = os.system('convert-ly -e ' + dest)
  73         if e:
  74                 unconverted.append (dest)
  75         if os.path.exists (dest + '~'):
  76                 os.remove (dest + '~')
  77         # -V seems to make unsafe snippets fail nicer/sooner
  78         e = os.system ('nice lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest ' + dest)
  79         if e:
  80                 unsafe.append (dest)
  81
  82 def read_source_with_dirs (src):
  83         s = {}
  84         l = {}
  85         for tag in TAGS:
  86                 srcdir = os.path.join (src, tag)
  87                 l[tag] = set (map (os.path.basename, glob.glob (os.path.join (srcdir, '*.ly'))))
  88                 for f in l[tag]:
  89                         if f in s.keys ():
  90                                 s[f][1].append (tag)
  91                         else:
  92                                 s[f] = (srcdir, [tag])
  93         return s, l
  94
  95
  96 tags_re = re.compile ('lsrtags\\s*=\\s*"(.+?)"')
  97
  98 def read_source (src):
  99         s = {}
 100         l = dict ([(tag, set()) for tag in TAGS])
 101         for f in glob.glob (os.path.join (src, '*.ly')):
 102                 basename = os.path.basename (f)
 103                 m = tags_re.search (open (f, 'r').read ())
 104                 if m:
 105                         file_tags = [tag.strip() for tag in m.group (1). split(',')]
 106                         s[basename] = (src, file_tags)
 107                         [l[tag].add (basename) for tag in file_tags if tag in TAGS]
 108                 else:
 109                         notags_files.append (f)
 110         return s, l
 111
 112
 113 def dump_file_list (file, list):
 114         f = open (file, 'w')
 115         f.write ('\n'.join (list) + '\n')
 116
 117 ## clean out existing lys and generated files
 118 map (os.remove, glob.glob (os.path.join (DEST, '*.ly')) +
 119      glob.glob (os.path.join (DEST, '*.snippet-list')))
 120
 121 # read LSR source where tags are defined by subdirs
 122 snippets, tag_lists = read_source_with_dirs (in_dir)
 123 # read input/new where tags are directly
 124 s, l = read_source (NEW_LYS)
 125 snippets.update (s)
 126 for t in TAGS:
 127         tag_lists[t].update (l[t])
 128
 129 for (name, (srcdir, tags)) in snippets.items ():
 130         copy_ly (srcdir, name, tags)
 131
 132 for (tag, file_set) in tag_lists.items ():
 133         dump_file_list (os.path.join (DEST, tag + '.snippet-list'), file_set)
 134
 135 if unconverted:
 136         sys.stderr.write ('These files could not be converted successfully by convert-ly:\n')
 137         sys.stderr.write ('\n'.join (unconverted) + '\n\n')
 138
 139 if notags_files:
 140         sys.stderr.write ('No tags could be found in these files:\n')
 141         sys.stderr.write ('\n'.join (notags_files) + '\n\n')
 142
 143 dump_file_list ('lsr-unsafe.txt', unsafe)
 144 sys.stderr.write ('''
 145
 146 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
 147   xargs git-diff < lsr-unsafe.txt
 148
 149 ''')
 150