5 ly-options: intertext, quote ?
8 check latex parameters, twocolumn
16 lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
19 lilypond-book --filter="convert-ly --no-version --from=1.6.11 -" BOOK
21 classic lilypond-book:
22 lilypond-book --process="lilypond-bin" BOOK.tely
25 @mbinclude foo.itely -> @include foo.itely
33 ################################################################
34 # Users of python modules should include this snippet
35 # and customize variables below.
37 # We'll suffer this path init stuff as long as we don't install our
38 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
39 # it as we do with teTeX on Red Hat Linux: set some environment var
40 # (PYTHONPATH) in profile)
42 # If set, LILYPONDPREFIX must take prevalence
43 # if datadir is not set, we're doing a build and LILYPONDPREFIX
44 import getopt, os, sys
45 datadir = '@local_lilypond_datadir@'
46 if not os.path.isdir (datadir):
47 datadir = '@lilypond_datadir@'
48 if os.environ.has_key ('LILYPONDPREFIX') :
49 datadir = os.environ['LILYPONDPREFIX']
50 while datadir[-1] == os.sep:
53 sys.path.insert (0, os.path.join (datadir, 'python'))
56 #if __name__ == '__main__':
64 program_version = '@TOPLEVEL_VERSION@'
65 program_name = 'lilypond-book'
68 original_dir = os.getcwd ()
71 help_summary = _ ("""Process LilyPond snippets in hybrid HTML, LaTeX or texinfo document. Example usage:
73 lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
74 lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" BOOK
75 lilypond-book --process='lilypond-bin -I include' BOOK
79 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>>',
80 'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
82 option_definitions = [
83 (_ ("EXT"), 'f', 'format', _ ("use output format EXT (texi [default], texi-html, latex, html)")),
84 (_ ("FILTER"), 'F', 'filter', _ ("pipe snippets through FILTER [convert-ly -n -]")),
85 ('', 'h', 'help', _ ("print this help")),
86 (_ ("DIR"), 'I', 'include', _ ("add DIR to include path")),
87 (_ ("COMMAND"), 'P', 'process', _ ("process ly_files using COMMAND FILE...")),
88 (_ ("DIR"), 'o', 'output', _ ("write output to DIR")),
89 ('', 'V', 'verbose', _ ("be verbose")),
90 ('', 'v', 'version', _ ("print version information")),
91 ('', 'w', 'warranty', _ ("show warranty and copyright")),
94 include_path = [ly.abspath (os.getcwd ())]
95 lilypond_binary = os.path.join ('@bindir@', 'lilypond-bin')
97 # only use installed binary when we're installed too.
98 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
99 lilypond_binary = 'lilypond-bin'
105 latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
107 process_cmd = lilypond_binary
108 default_ly_options = { }
114 LINEWIDTH = 'linewidth'
118 PREAMBLE = 'preamble'
120 VERBATIM = 'verbatim'
121 PRINTFILENAME = 'printfilename'
123 # Recognize special sequences in the input
125 # (?P<name>regex) -- assign result of REGEX to NAME
126 # *? -- match non-greedily.
127 # (?m) -- multiline regex: make ^ and $ match at each line
128 # (?s) -- make the dot match all characters including newline
133 'lilypond' : '(?m)(?P<match><lilypond((?P<options>[^:]*):)(?P<code>.*?)/>)',
134 'lilypond_block': r'''(?ms)(?P<match><lilypond(?P<options>[^>]+)?>(?P<code>.*?)</lilypond>)''',
135 'lilypond_file': r'(?m)(?P<match><lilypondfile(?P<options>[^>]+)?>\s*(?P<filename>[^<]+)\s*</lilypondfile>)',
136 'multiline_comment': r"(?sm)\s*(?!@c\s+)(?P<code><!--\s.*?!-->)\s",
137 'singleline_comment': no_match,
138 'verb': r'''(?P<code><pre>.*?</pre>)''',
139 'verbatim': r'''(?s)(?P<code><pre>\s.*?</pre>\s)''',
143 'include': r'(?m)^[^%\n]*?(?P<match>\\input{(?P<filename>[^}]+)})',
144 'lilypond' : r'(?m)^[^%\n]*?(?P<match>\\lilypond\s*(\[(?P<options>.*?)\])?\s*{(?P<code>.*?)})',
145 'lilypond_block': r"(?sm)^[^%\n]*?(?P<match>\\begin\s*(\[(?P<options>.*?)\])?\s*{lilypond}(?P<code>.*?)\\end{lilypond})",
146 'lilypond_file': r'(?m)^[^%\n]*?(?P<match>\\lilypondfile\s*(\[(?P<options>.*?)\])?\s*\{(?P<filename>.+)})',
147 'multiline_comment': no_match,
148 'singleline_comment': r"(?m)^.*?(?P<match>(?P<code>^%.*$\n+))",
149 'verb': r"(?P<code>\\verb(?P<del>.).*?(?P=del))",
150 'verbatim': r"(?s)(?P<code>\\begin\s*{verbatim}.*?\\end{verbatim})",
154 'include': '(?m)^[^%\n]*?(?P<match>@include\s+(?P<filename>\S*))',
155 'lilypond' : '(?m)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?{(?P<code>.*?)})',
156 'lilypond_block': r'''(?ms)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?\s(?P<code>.*?)@end lilypond)\s''',
157 'lilypond_file': '(?m)^(?P<match>@lilypondfile(\[(?P<options>[^]]*)\])?{(?P<filename>[^}]+)})',
158 'multiline_comment': r"(?sm)^\s*(?!@c\s+)(?P<code>@ignore\s.*?@end ignore)\s",
159 'singleline_comment': r"(?m)^.*?(?P<match>(?P<code>@c([ \t][^\n]*|)\n))",
160 'verb': r'''(?P<code>@code{.*?})''',
161 'verbatim': r'''(?s)(?P<code>@example\s.*?@end example\s)''',
167 'option-sep' : '\s*',
168 'intertext': r',?\s*intertext=\".*?\"',
171 'intertext': r',?\s*intertext=\".*?\"',
172 'option-sep' : ',\s*',
175 'intertext': r',?\s*intertext=\".*?\"',
176 'option-sep' : ',\s*',
182 'relative': r'''\relative c%(relative_quotes)s''',
186 indent = %(indent)s''',
188 linewidth = %(linewidth)s''',
194 \remove Time_signature_engraver
198 raggedright = ##t''',
202 #(set-global-staff-size %(staffsize)s)''',
209 PRINTFILENAME:'<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
212 <img align="center" valign="center"
213 border="0" src="%(base)s.png" alt="[picture of music]">''',
220 PRINTFILENAME: '''\\texttt{%(filename)s}
224 OUTPUT: r'''{\parindent 0pt
226 \ifx\preLilyPondExample\preLilyPondExample\fi
229 \ifx\preLilyPondExample\postLilyPondExample\fi
231 VERBATIM: r'''\begin{verbatim}
232 %(verb)s\end{verbatim}
239 VERBATIM: r'''@example
247 PREAMBLE_LY = r'''%% Generated by %(program_name)s
248 %% Options: [%(option_string)s]
250 \paper {%(paper_string)s
254 FRAGMENT_LY = r'''\score{
255 \notes%(notes_string)s{
260 def classic_lilypond_book_compatibility (o):
261 if o == 'singleline':
263 m = re.search ('relative\s*([-0-9])', o)
265 return 'relative=%s' % m.group (1)
266 m = re.match ('([0-9]+)pt', o)
268 return 'staffsize=%s' % m.group (1)
269 m = re.match ('indent=([-.0-9]+)(cm|in|mm|pt)', o)
271 f = float (m.group (1))
272 return 'indent=%f\\%s' % (f, m.group (2))
273 m = re.match ('linewidth=([-.0-9]+)(cm|in|mm|pt)', o)
275 f = float (m.group (1))
276 return 'linewidth=%f\\%s' % (f, m.group (2))
279 def compose_ly (code, options):
281 options += default_ly_options.keys ()
282 vars ().update (default_ly_options)
284 m = re.search (r'''\\score''', code)
285 if not m and (not options \
286 or not 'nofragment' in options \
287 or 'fragment' in options):
288 options.append ('raggedright')
296 option_string = string.join (options, ',')
299 preamble_options = []
301 c = classic_lilypond_book_compatibility (i)
303 ly.warning (_ ("deprecated ly-option used: %s" % i))
304 ly.warning (_ ("compatibility mode translation: %s" \
308 if string.find (i, '=') > 0:
309 key, value = string.split (i, '=')
315 if key in ly_options[NOTES].keys ():
316 notes_options.append (ly_options[NOTES][key])
317 elif key in ly_options[PREAMBLE].keys ():
318 preamble_options.append (ly_options[PREAMBLE][key])
319 elif key in ly_options[PAPER].keys ():
320 paper_options.append (ly_options[PAPER][key])
321 elif key not in ('fragment', 'nofragment', 'printfilename',
322 'relative', 'verbatim'):
323 ly.warning (_("ignoring unknown ly option: %s") % i)
325 relative_quotes = (",,,", ",,", ",", "", "'", "''", "'''")[relative-3]
326 program_name = __main__.program_name
327 notes_string = string.join (notes_options, '\n ') % vars ()
328 paper_string = string.join (paper_options, '\n ') % vars ()
329 preamble_string = string.join (preamble_options, '\n ') % vars ()
330 return (PREAMBLE_LY + body) % vars ()
334 # use lilypond-bin for latex (.lytex) books,
335 # and lilypond --preview for html, texinfo books?
337 cmd = r'latex "\nonstopmode \input %s"' % file
338 # Ugh. (La)TeX writes progress and error messages on stdout
340 cmd = '(( %s >&2 ) >&- )' % cmd
342 ly.system ('dvips -Ppdf -u+lilypond.map -E -o %s.eps %s' \
345 def find_file (name):
346 for i in include_path:
347 full = os.path.join (i, name)
348 if os.path.exists (full):
350 ly.error (_ ('file not found: %s\n' % name))
354 def verbatim_html (s):
355 return re.sub ('>', '>',
357 re.sub ('&', '&', s)))
359 def verbatim_texinfo (s):
360 return re.sub ('{', '@{',
362 re.sub ('@', '@@', s)))
364 def split_options (option_string):
365 return re.split (format_res[format]['option-sep'], option_string)
369 def __init__ (self, type, match):
375 os = match.group ('options')
377 self.options = split_options (os)
382 return self.match.start (s)
385 return self.match.end (s)
387 def substring (self, s):
388 return self.match.group (s)
392 if self.type == 'lilypond_block' or self.type == 'lilypond':
393 s = self.substring ('code')
394 elif self.type == 'lilypond_file':
395 name = self.substring ('filename')
396 s = open (find_file (name)).read ()
402 return compose_ly (s, self.options)
407 self.hash = abs (hash (self.ly ()))
412 return 'lily-%d' % self.get_hash ()
416 if self.type == 'lilypond_block' or self.type == 'lilypond'\
417 or self.type == 'lilypond_file':
418 outf = open (self.basename () + '.ly', 'w')
419 outf.write (self.full_ly ())
421 def replacement_text (self, format):
422 if self.type in ['lilypond_file',
426 func = Snippet.__dict__ ['output_' + format]
428 elif self.type == 'include':
429 s = self.match.group (0)
430 f = self.substring ('filename')
431 nf = os.path.splitext (f)[0] + format2ext[format]
433 return re.sub (f, nf, s)
435 return self.match.group (0)
437 def output_html (self):
438 base = self.basename ()
439 str = self.output_print_filename (HTML)
440 if VERBATIM in self.options and format == HTML:
441 verb = verbatim_html (self.substring ('code'))
442 str += write (output[HTML][VERBATIM] % vars ())
443 return (str + output[HTML][BEFORE]
444 + (output[HTML][OUTPUT] % vars ())
445 + output[HTML][AFTER])
447 def output_latex (self):
449 str = self.output_print_filename (LATEX)
451 base = self.basename ()
452 str += (output[LATEX][BEFORE]
453 + (output[LATEX][OUTPUT] % vars ())
454 + output[LATEX][AFTER])
457 if VERBATIM in self.options\
459 verb = self.substring ('code')
460 str += (output[LATEX][VERBATIM] % vars ())
464 def output_print_filename (self,format):
466 if PRINTFILENAME in self.options:
467 base = self.basename ()
468 filename = self.substring ('filename')
469 str += output[format][PRINTFILENAME] % vars ()
473 def output_texinfo (self):
476 ## Ugh, this breaks texidoc.
479 str += self.output_latex ()
480 str += ('\n@end tex\n')
483 str += self.output_html ()
484 str += ('\n@end html\n')
487 if VERBATIM in self.options:
488 verb = verbatim_texinfo (self.substring ('code'))
489 str += (output[TEXINFO][VERBATIM] % vars ())
493 def outdated_p (self):
494 if self.type != 'lilypond_block' and self.type != 'lilypond'\
495 and self.type != 'lilypond_file':
497 base = self.basename ()
498 if os.path.exists (base + '.ly') \
499 and os.path.exists (base + '.tex') \
501 or self.ly () == open (base + '.ly').read ()):
502 # TODO: something smart with target formats
503 # (ps, png) and m/ctimes
507 def filter_code (self):
512 def simple_find_toplevel_snippets (str, types):
513 "return: (new string, snippets)"
516 regex = re.compile (snippet_res[format][t])
518 # ugh, this can be done nicer in python 2.x
519 def notice_snippet (match, snippets = snippets,
521 s = Snippet (t, str, match)
525 return s.replacement_text (format)
527 str = regex.sub (notice_snippet, str)
528 return (str, snippets)
530 def find_toplevel_snippets (infile, outfile, types):
531 res = ['(?P<regex%s>%s)' % (t,
533 re.sub (r"\(\?P<[^>]+>", "(", snippet_res[format][t]))
536 big_re = re.compile (string.join (res, '|'))
538 i = big_re.finditer(str)
543 outfile.write (str[last_end:match.start (0)])
544 last_end = match.end (0)
546 m =re.match (snippet_res[format][t], match.group(0))
550 outfile.write (sn.replacement_text (format))
555 def filter_pipe (input, cmd):
557 ly.progress (_ ("Opening filter `%s\'") % cmd)
559 stdin, stdout, stderr = os.popen3 (cmd)
561 status = stdin.close ()
565 output = stdout.read ()
566 status = stdout.close ()
567 error = stderr.read ()
571 signal = 0x0f & status
572 if status or (not output and error):
573 exit_status = status >> 8
574 ly.error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
575 ly.error (_ ("The error log is as follows:"))
576 sys.stderr.write (error)
577 sys.stderr.write (stderr.read ())
586 return filter_pipe (s, filter_cmd)
588 def process_snippets (cmd, snippets):
589 names = filter (lambda x:x, map (Snippet.basename, snippets))
591 ly.system (string.join ([cmd] + names))
593 if format == HTML or format == TEXINFO:
595 if os.path.exists (i + '.tex'):
597 ly.make_ps_images (i + '.eps', resolution=110)
599 LATEX_DOCUMENT = r'''
602 \typeout{textwidth=\the\textwidth}
603 \typeout{columnsep=\the\columnsep}
604 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
607 #need anything else besides textwidth?
608 def get_latex_textwidth (source):
609 m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
610 preamble = source[:m.start (0)]
611 latex_document = LATEX_DOCUMENT % vars ()
612 parameter_string = filter_pipe (latex_document, latex_filter_cmd)
615 m = re.search ('columns=([0-9.]*)', parameter_string)
617 columns = string.atoi (m.group (1))
620 m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
622 columnsep = string.atof (m.group (1))
625 m = re.search('textwidth=([0-9.]*)pt', parameter_string)
627 textwidth = string.atof (m.group (1))
629 textwidth = (textwidth - columnsep) / columns
641 '.texinfo' : TEXINFO,
647 #TEXINFO: '.texinfo',
652 def do_file (input_filename):
656 e = os.path.splitext (input_filename)[1]
657 if e in ext2format.keys ():
659 format = ext2format[e]
661 ly.error (_ ("cannot determine format for: %s" \
664 ly.progress (_ ("Reading %s...") % input_filename)
665 if not input_filename or input_filename == '-':
668 ih = open (input_filename)
672 ly.progress (_ ("Dissecting..."))
673 #snippets = find_toplevel_snippets (source, snippet_res[format].keys ())
678 'singleline_comment',
685 if output_name == '-' or not output_name:
686 output_file = sys.stdout
687 output_filename = '-'
689 if not os.path.isdir (output_name):
690 os.mkdir (output_name, 0777)
691 if input_filename == '-':
694 input_base = os.path.splitext (input_filename)[0]
695 input_base = os.path.basename (input_base)
697 output_filename = output_name + '/' + input_base \
699 output_file = open (output_filename, 'w')
700 os.chdir (output_name)
703 snippets = find_toplevel_snippets (ih, output_file, snippet_types)
707 global default_ly_options
709 if format == LATEX and LINEWIDTH not in default_ly_options.keys ():
710 textwidth = get_latex_textwidth (source)
711 default_ly_options[LINEWIDTH] = '''%.0f\pt''' % textwidth
716 outdated = filter (lambda x:x,
717 map (Snippet.outdated_p, snippets))
718 ly.progress (_ ("Writing snippets..."))
719 map (Snippet.write_ly, snippets)
723 ly.progress (_ ("Processing..."))
724 process_snippets (process_cmd, outdated)
726 ly.progress (_ ("All snippets are up to date..."))
729 ly.progress (_ ("Compiling %s...") % output_filename)
732 def process_include (snippet):
733 os.chdir (original_dir)
734 name = snippet.substring ('filename')
735 ly.progress (_ ('Processing include: %s') % name)
739 map (process_include, filter (lambda x: x.type == 'include', snippets))
742 global format, output_name
743 global filter_cmd, process_cmd, verbose_p
745 (sh, long) = ly.getopt_args (option_definitions)
747 (options, files) = getopt.getopt (sys.argv[1:], sh, long)
748 except getopt.error, s:
749 sys.stderr.write ('\n')
750 ly.error (_ ("getopt says: `%s\'" % s))
751 sys.stderr.write ('\n')
761 elif o == '--filter' or o == '-F':
764 elif o == '--format' or o == '-f':
766 if a == 'texi-html' or a == 'texi':
768 elif o == '--help' or o == '-h':
771 elif o == '--include' or o == '-I':
772 include_path.append (os.path.join (original_dir,
774 elif o == '--output' or o == '-o':
776 elif o == '--outdir':
778 elif o == '--process' or o == '-P':
781 elif o == '--version' or o == '-v':
782 ly.identify (sys.stdout)
784 elif o == '--verbose' or o == '-V':
786 elif o == '--warranty' or o == '-w':
794 files = do_options ()
797 process_cmd += string.join ([(' -I %s' % p)
798 for p in include_path])
800 ly.identify (sys.stderr)
801 ly.setup_environment ()
805 if __name__ == '__main__':