8 sys.path.append ('python')
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]
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.
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.
29 LY_HEADER_NEW = '''%% Do not edit this file; it is automatically
31 %% This file is in the public domain.
36 TAGS.extend (['pitches', 'rhythms', 'expressive-marks',
37 'repeats', 'simultaneous-notes', 'staff-notation',
38 'editorial-annotations', 'text'])
40 TAGS.extend (['vocal-music', 'chords', 'keyboards',
41 'percussion', 'fretted-strings', 'unfretted-strings',
42 'ancient-notation', 'winds', 'world-music'
46 TAGS.extend (['contexts-and-engravers', 'tweaks-and-overrides',
47 'paper-and-layout', 'breaks', 'spacing', 'midi', 'titles', 'template'])
49 def exit_with_usage (n=0):
50 sys.stderr.write (USAGE)
53 if len (sys.argv) >= 2:
55 if len (sys.argv) >= 3:
57 if not (os.path.isdir (DEST) and os.path.isdir (NEW_LYS)):
66 # mark the section that will be printed verbatim by lilypond-book
67 end_header_re = re.compile ('(\\header {.+?doctitle = ".+?})\n', re.M | re.S)
69 doctitle_re = re.compile (r'(doctitle[a-zA-Z_]{0,6}\s*=\s*")((?:\\"|[^"\n])*)"')
70 texinfo_q_re = re.compile (r'@q{(.*?)}')
71 texinfo_qq_re = re.compile (r'@qq{(.*?)}')
72 def doctitle_sub (title_match):
73 # Comma forbidden in Texinfo node name
74 title = title_match.group (2).replace (',', '')
75 title = texinfo_q_re.sub (r"`\1'", title)
76 title = texinfo_qq_re.sub (r'\"\1\"', title)
77 return title_match.group (1) + title + '"'
79 def mark_verbatim_section (ly_code):
80 return end_header_re.sub ('\\1 % begin verbatim\n\n', ly_code, 1)
82 # '% LSR' comments are to be stripped
83 lsr_comment_re = re.compile (r'\s*%+\s*LSR.*')
84 begin_header_re = re.compile (r'\\header\s*{', re.M)
85 ly_new_version_re = re.compile (r'\\version\s*"(.+?)"')
86 strip_white_spaces_re = re.compile (r'[ \t]+(?=\n)')
88 # add tags to ly files from LSR
89 def add_tags (ly_code, tags):
90 return begin_header_re.sub ('\\g<0>\n lsrtags = "' + tags + '"\n',
93 # for snippets from input/new, add message for earliest working version
94 def add_version (ly_code):
95 return '''%% Note: this file works from version ''' + \
96 ly_new_version_re.search (ly_code).group (1) + '\n'
98 s = 'Translation of GIT [Cc]ommittish'
99 texidoc_chunk_re = re.compile (r'^(?:%+\s*' + s + \
100 r'.+)?\s*(?:texidoc|doctitle)([a-zA-Z]{2,4})\s+=(?:.|\n)*?(?=%+\s*' + \
101 s + r'|\n\} % begin verbatim|\n (?:doctitle|texidoc|lsrtags) |$(?!.|\n))', re.M)
103 def update_translated_texidoc (m, snippet_path, visited_languages):
104 base = os.path.splitext (os.path.basename (snippet_path))[0]
105 language_code = m.group (1)
106 visited_languages.append (language_code)
107 texidoc_path = os.path.join ('Documentation', language_code,
108 'texidocs', base + '.texidoc')
109 if os.path.isfile (texidoc_path):
110 return open (texidoc_path).read ()
114 def copy_ly (srcdir, name, tags):
117 dest = os.path.join (DEST, name)
118 tags = ', '.join (tags)
119 s = open (os.path.join (srcdir, name)).read ()
121 for path in TEXIDOCS:
122 texidoc_translation_path = \
123 os.path.join (path, os.path.splitext (name)[0] + '.texidoc')
124 if os.path.exists (texidoc_translation_path):
125 texidoc_translation = open (texidoc_translation_path).read ()
126 # Since we want to insert the translations verbatim using a
127 # regexp, \\ is understood as ONE escaped backslash. So we have
128 # to escape those backslashes once more...
129 texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
130 s = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, s, 1)
132 s = doctitle_re.sub (doctitle_sub, s)
133 if in_dir and in_dir in srcdir:
134 s = LY_HEADER_LSR + add_tags (s, tags)
136 s = LY_HEADER_NEW + add_version (s) + s
138 s = mark_verbatim_section (s)
139 s = lsr_comment_re.sub ('', s)
140 s = strip_white_spaces_re.sub ('', s)
141 open (dest, 'w').write (s)
143 e = os.system ("convert-ly -e '%s'" % dest)
145 unconverted.append (dest)
146 if os.path.exists (dest + '~'):
147 os.remove (dest + '~')
148 # no need to check snippets from input/new
149 if in_dir and in_dir in srcdir:
150 # -V seems to make unsafe snippets fail nicer/sooner
151 e = os.system ("lilypond -V -dno-print-pages -dsafe -o /tmp/lsrtest '%s'" % dest)
155 def read_source_with_dirs (src):
159 srcdir = os.path.join (src, tag)
160 l[tag] = set (map (os.path.basename,
161 glob.glob (os.path.join (srcdir, '*.ly'))))
166 s[f] = (srcdir, [tag])
170 tags_re = re.compile ('lsrtags\\s*=\\s*"(.+?)"')
172 def read_source (src):
174 l = dict ([(tag, set()) for tag in TAGS])
175 for f in glob.glob (os.path.join (src, '*.ly')):
176 basename = os.path.basename (f)
177 m = tags_re.search (open (f, 'r').read ())
179 file_tags = [tag.strip() for tag in m.group (1). split(',')]
180 s[basename] = (src, file_tags)
181 [l[tag].add (basename) for tag in file_tags if tag in TAGS]
183 notags_files.append (f)
187 def dump_file_list (file, file_list, update=False):
189 old_list = set (open (file, 'r').read ().splitlines ())
190 old_list.update (file_list)
191 new_list = list (old_list)
195 f.write ('\n'.join (sorted (new_list)) + '\n')
197 def update_ly_in_place (snippet_path):
198 visited_languages = []
199 contents = open (snippet_path).read ()
200 contents = texidoc_chunk_re.sub \
201 (lambda m: update_translated_texidoc (m,
205 for language_code in langdefs.LANGDICT:
206 if not language_code in visited_languages:
207 base = os.path.splitext (os.path.basename (snippet_path))[0]
208 texidoc_path = os.path.join ('Documentation', language_code,
209 'texidocs', base + '.texidoc')
210 if os.path.isfile (texidoc_path):
211 texidoc_translation = open (texidoc_path).read ()
212 texidoc_translation = texidoc_translation.replace ('\\', '\\\\')
213 contents = begin_header_re.sub ('\\g<0>\n' + texidoc_translation, contents, 1)
214 contents = doctitle_re.sub (doctitle_sub, contents)
215 open (snippet_path, 'w').write (contents)
218 ## clean out existing lys and generated files
219 map (os.remove, glob.glob (os.path.join (DEST, '*.ly')) +
220 glob.glob (os.path.join (DEST, '*.snippet-list')))
222 # read LSR source where tags are defined by subdirs
223 snippets, tag_lists = read_source_with_dirs (in_dir)
225 # read input/new where tags are directly defined
226 s, l = read_source (NEW_LYS)
229 tag_lists[t].update (l[t])
231 snippets, tag_lists = read_source (NEW_LYS)
232 ## update texidocs of snippets that don't come from NEW_LYS
233 for snippet_path in glob.glob (os.path.join (DEST, '*.ly')):
234 if not os.path.basename (snippet_path) in snippets:
235 update_ly_in_place (snippet_path)
237 for (name, (srcdir, tags)) in snippets.items ():
238 copy_ly (srcdir, name, tags)
239 for (tag, file_set) in tag_lists.items ():
240 dump_file_list (os.path.join (DEST, tag + '.snippet-list'),
241 file_set, update=not(in_dir))
243 sys.stderr.write ('These files could not be converted successfully by convert-ly:\n')
244 sys.stderr.write ('\n'.join (unconverted) + '\n\n')
246 sys.stderr.write ('No tags could be found in these files:\n')
247 sys.stderr.write ('\n'.join (notags_files) + '\n\n')
249 dump_file_list ('lsr-unsafe.txt', unsafe)
250 sys.stderr.write ('''
252 Unsafe files printed in lsr-unsafe.txt: CHECK MANUALLY!
254 xargs git diff HEAD < lsr-unsafe.txt