LSR: Update.
[lilypond.git] / buildscripts / makelsr.py
blobcb0619f6deae2e726b0b0e28d90062fbbc4123e3
1 #!/usr/bin/env python
3 import sys
4 import os
5 import glob
6 import re
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 '''
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 '''
17 LY_HEADER_NEW = '''%% Do not edit this file; it is auto-generated from input/new
18 %% This file is in the public domain.
19 '''
21 DEST = os.path.join ('input', 'lsr')
22 NEW_LYS = os.path.join ('input', 'new')
23 TEXIDOCS = os.path.join ('input', 'texidocs')
25 TAGS = []
26 # NR 1
27 TAGS.extend (['pitches', 'rhythms', 'expressive-marks',
28 'repeats', 'simultaneous-notes', 'staff-notation',
29 'editorial-annotations', 'text'])
30 # NR 2
31 TAGS.extend (['vocal-music', 'chords', 'keyboards',
32 'percussion', 'fretted-strings', 'unfretted-strings',
33 'ancient-notation', 'winds', 'world-music'
36 # other
37 TAGS.extend (['contexts-and-engravers', 'tweaks-and-overrides',
38 'paper-and-layout', 'breaks', 'spacing', 'midi', 'titles', 'template'])
40 def exit_with_usage (n=0):
41 sys.stderr.write (USAGE)
42 sys.exit (n)
44 try:
45 in_dir = sys.argv[1]
46 except:
47 exit_with_usage (2)
49 if not (os.path.isdir (DEST) and os.path.isdir (NEW_LYS)):
50 exit_with_usage (3)
52 unsafe = []
53 unconverted = []
54 notags_files = []
56 # mark the section that will be printed verbatim by lilypond-book
57 end_header_re = re.compile ('(\\header {.+?doctitle = ".+?})\n', re.M | re.S)
59 def mark_verbatim_section (ly_code):
60 return end_header_re.sub ('\\1 % begin verbatim\n\n', ly_code, 1)
62 # '% LSR' comments are to be stripped
63 lsr_comment_re = re.compile (r'\s*%+\s*LSR.*')
65 begin_header_re = re.compile (r'\\header\s*{', re.M)
67 # add tags to ly files from LSR
68 def add_tags (ly_code, tags):
69 return begin_header_re.sub ('\\g<0>\n lsrtags = "' + tags + '"\n', ly_code, 1)
71 def copy_ly (srcdir, name, tags):
72 global unsafe
73 global unconverted
74 dest = os.path.join (DEST, name)
75 tags = ', '.join (tags)
76 s = open (os.path.join (srcdir, name)).read ()
78 texidoc_translations_path = os.path.join (TEXIDOCS,
79 os.path.splitext (name)[0] + '.texidoc')
80 if os.path.exists (texidoc_translations_path):
81 texidoc_translations = open (texidoc_translations_path).read ()
82 # Since we want to insert the translations verbatim using a
83 # regexp, \\ is understood as ONE escaped backslash. So we have
84 # to escape those backslashes once more...
85 texidoc_translations = texidoc_translations.replace ('\\', '\\\\')
86 s = begin_header_re.sub ('\\g<0>\n' + texidoc_translations, s, 1)
88 if in_dir in srcdir:
89 s = LY_HEADER_LSR + add_tags (s, tags)
90 else:
91 s = LY_HEADER_NEW + s
93 s = mark_verbatim_section (s)
94 s = lsr_comment_re.sub ('', s)
95 open (dest, 'w').write (s)
97 e = os.system ("convert-ly -e '%s'" % dest)
98 if e:
99 unconverted.append (dest)
100 if os.path.exists (dest + '~'):
101 os.remove (dest + '~')
102 # -V seems to make unsafe snippets fail nicer/sooner
103 e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
104 if e:
105 unsafe.append (dest)
107 def read_source_with_dirs (src):
108 s = {}
109 l = {}
110 for tag in TAGS:
111 srcdir = os.path.join (src, tag)
112 l[tag] = set (map (os.path.basename, glob.glob (os.path.join (srcdir, '*.ly'))))
113 for f in l[tag]:
114 if f in s:
115 s[f][1].append (tag)
116 else:
117 s[f] = (srcdir, [tag])
118 return s, l
121 tags_re = re.compile ('lsrtags\\s*=\\s*"(.+?)"')
123 def read_source (src):
124 s = {}
125 l = dict ([(tag, set()) for tag in TAGS])
126 for f in glob.glob (os.path.join (src, '*.ly')):
127 basename = os.path.basename (f)
128 m = tags_re.search (open (f, 'r').read ())
129 if m:
130 file_tags = [tag.strip() for tag in m.group (1). split(',')]
131 s[basename] = (src, file_tags)
132 [l[tag].add (basename) for tag in file_tags if tag in TAGS]
133 else:
134 notags_files.append (f)
135 return s, l
138 def dump_file_list (file, list):
139 f = open (file, 'w')
140 f.write ('\n'.join (list) + '\n')
142 ## clean out existing lys and generated files
143 map (os.remove, glob.glob (os.path.join (DEST, '*.ly')) +
144 glob.glob (os.path.join (DEST, '*.snippet-list')))
146 # read LSR source where tags are defined by subdirs
147 snippets, tag_lists = read_source_with_dirs (in_dir)
148 # read input/new where tags are directly
149 s, l = read_source (NEW_LYS)
150 snippets.update (s)
151 for t in TAGS:
152 tag_lists[t].update (l[t])
154 for (name, (srcdir, tags)) in snippets.items ():
155 copy_ly (srcdir, name, tags)
157 for (tag, file_set) in tag_lists.items ():
158 dump_file_list (os.path.join (DEST, tag + '.snippet-list'), sorted(file_set))
160 if unconverted:
161 sys.stderr.write ('These files could not be converted successfully by convert-ly:\n')
162 sys.stderr.write ('\n'.join (unconverted) + '\n\n')
164 if notags_files:
165 sys.stderr.write ('No tags could be found in these files:\n')
166 sys.stderr.write ('\n'.join (notags_files) + '\n\n')
168 dump_file_list ('lsr-unsafe.txt', unsafe)
169 sys.stderr.write ('''
171 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
172 git add input/lsr/*.ly
173 xargs git-diff HEAD < lsr-unsafe.txt
175 ''')