]> git.donarmstrong.com Git - lilypond.git/blob - scripts/lilypond-book.py
(compose_ly): make fragment mandatory
[lilypond.git] / scripts / lilypond-book.py
1 #!@PYTHON@
2
3 '''
4 Example usage:
5
6 test:
7      lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
8           
9 convert-ly on book:
10      lilypond-book --filter="convert-ly --no-version --from=1.6.11 -" BOOK
11
12 classic lilypond-book:
13      lilypond-book --process="lilypond-bin" BOOK.tely
14
15 TODO:
16     *  ly-options: intertext ?
17     *  --linewidth?
18     *  eps in latex / eps by lilypond-bin -fps ?
19     *  check latex parameters, twocolumn, multicolumn?
20       
21     *  Converting from lilypond-book source, substitute:
22        @mbinclude foo.itely -> @include foo.itely
23        \mbinput -> \input
24
25 '''
26
27 import __main__
28 import glob
29 import stat
30 import string
31 ################################################################
32 # Users of python modules should include this snippet
33 # and customize variables below.
34
35 # We'll suffer this path init stuff as long as we don't install our
36 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
37 # it as we do with teTeX on Red Hat Linux: set some environment var
38 # (PYTHONPATH) in profile)
39
40 # If set, LILYPONDPREFIX must take prevalence
41 # if datadir is not set, we're doing a build and LILYPONDPREFIX
42 import getopt, os, sys
43 datadir = '@local_lilypond_datadir@'
44 if not os.path.isdir (datadir):
45         datadir = '@lilypond_datadir@'
46 if os.environ.has_key ('LILYPONDPREFIX') :
47         datadir = os.environ['LILYPONDPREFIX']
48         while datadir[-1] == os.sep:
49                 datadir= datadir[:-1]
50
51 sys.path.insert (0, os.path.join (datadir, 'python'))
52
53 # Customize these
54 #if __name__ == '__main__':
55
56 import lilylib as ly
57 global _;_=ly._
58 global re;re = ly.re
59
60
61 # lilylib globals
62 program_version = '@TOPLEVEL_VERSION@'
63 program_name = 'lilypond-book'
64 verbose_p = 0
65 pseudo_filter_p = 0
66 original_dir = os.getcwd ()
67
68
69 help_summary = _ ("""Process LilyPond snippets in hybrid HTML, LaTeX or texinfo document.
70 Example usage:
71
72    lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
73    lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" BOOK
74    lilypond-book --process='lilypond-bin -I include' BOOK
75
76 """)
77
78 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
79              'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
80
81 option_definitions = [
82         (_ ("EXT"), 'f', 'format', _ ("use output format EXT (texi [default], texi-html, latex, html)")),
83         (_ ("FILTER"), 'F', 'filter', _ ("pipe snippets through FILTER [convert-ly -n -]")),
84         ('', 'h', 'help', _ ("print this help")),
85         (_ ("DIR"), 'I', 'include', _ ("add DIR to include path")),
86         (_ ("COMMAND"), 'P', 'process', _ ("process ly_files using COMMAND FILE...")),
87         (_ ("DIR"), 'o', 'output', _ ("write output to DIR")),
88         ('', 'V', 'verbose', _ ("be verbose")),
89         ('', 'v', 'version', _ ("print version information")),
90         ('', 'w', 'warranty', _ ("show warranty and copyright")),
91         ]
92
93 include_path = [ly.abspath (os.getcwd ())]
94 lilypond_binary = os.path.join ('@bindir@', 'lilypond-bin')
95
96 # only use installed binary  when we're installed too.
97 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
98         lilypond_binary = 'lilypond-bin'
99
100
101 use_hash_p = 1
102 format = 0
103 output_name = 0
104 latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
105 filter_cmd = 0
106 process_cmd = lilypond_binary
107 default_ly_options = {}
108
109 AFTER = 'after'
110 FILTER = 'filter'
111 BEFORE = 'before'
112 EXAMPLEINDENT = 'exampleindent'
113 FRAGMENT = 'fragment'
114 HTML = 'html'
115 INDENT = 'indent'
116 LATEX = 'latex'
117 LINEWIDTH = 'linewidth'
118 NOFRAGMENT = 'nofragment'
119 NOINDENT = 'noindent'
120 NOTES = 'body'
121 NOTIME = 'notime'
122 OUTPUT = 'output'
123 PAPER = 'paper'
124 PREAMBLE = 'preamble'
125 PRINTFILENAME = 'printfilename'
126 RAGGEDRIGHT = 'raggedright'
127 RELATIVE = 'relative'
128 QUOTE = 'quote'
129 STAFFSIZE = 'staffsize'
130 TEXIDOC = 'texidoc'
131 TEXINFO = 'texinfo'
132 VERBATIM = 'verbatim'
133
134 # Recognize special sequences in the input 
135 #
136 # (?P<name>regex) -- assign result of REGEX to NAME
137 # *? -- match non-greedily.
138 # (?m) -- multiline regex: make ^ and $ match at each line
139 # (?s) -- make the dot match all characters including newline
140 no_match = 'a\ba'
141 snippet_res = {
142         HTML: {
143         'include':  no_match,
144         'lilypond' : '(?m)(?P<match><lilypond((?P<options>[^:]*):)(?P<code>.*?)/>)',
145         'lilypond_block': r'''(?ms)(?P<match><lilypond(?P<options>[^>]+)?>(?P<code>.*?)</lilypond>)''',
146         'lilypond_file': r'(?m)(?P<match><lilypondfile(?P<options>[^>]+)?>\s*(?P<filename>[^<]+)\s*</lilypondfile>)',
147         'multiline_comment': r"(?sm)\s*(?!@c\s+)(?P<code><!--\s.*?!-->)\s",
148         'singleline_comment': no_match,
149         'verb': r'''(?P<code><pre>.*?</pre>)''',
150         'verbatim': r'''(?s)(?P<code><pre>\s.*?</pre>\s)''',
151         },
152
153         LATEX: {
154         'include': r'(?m)^[^%\n]*?(?P<match>\\input{(?P<filename>[^}]+)})',
155         'lilypond' : r'(?m)^[^%\n]*?(?P<match>\\lilypond\s*(\[(?P<options>.*?)\])?\s*{(?P<code>.*?)})',
156         'lilypond_block': r"(?sm)^[^%\n]*?(?P<match>\\begin\s*(\[(?P<options>.*?)\])?\s*{lilypond}(?P<code>.*?)\\end{lilypond})",
157         'lilypond_file': r'(?m)^[^%\n]*?(?P<match>\\lilypondfile\s*(\[(?P<options>.*?)\])?\s*\{(?P<filename>.+)})',
158         'multiline_comment': no_match,
159         'singleline_comment': r"(?m)^.*?(?P<match>(?P<code>^%.*$\n+))",
160         'verb': r"(?P<code>\\verb(?P<del>.).*?(?P=del))",
161         'verbatim': r"(?s)(?P<code>\\begin\s*{verbatim}.*?\\end{verbatim})",
162         },
163
164         TEXINFO: {
165         'include':  '(?m)^[^%\n]*?(?P<match>@include\s+(?P<filename>\S+))',
166         'lilypond' : '(?m)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?{(?P<code>.*?)})',
167         'lilypond_block': r'''(?ms)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?\s(?P<code>.*?)@end lilypond)\s''',
168         'lilypond_file': '(?m)^(?P<match>@lilypondfile(\[(?P<options>[^]]*)\])?{(?P<filename>[^}]+)})',
169         'multiline_comment': r'(?sm)^\s*(?!@c\s+)(?P<code>@ignore\s.*?@end\s+ignore)\s',
170         'singleline_comment': r'(?m)^.*(?P<match>(?P<code>@c([ \t][^\n]*|)\n))',
171
172 # don't do this: fucks up with @code{@{}
173 #       'verb': r'''(?P<code>@code{.*?})''',
174         'verbatim': r'''(?s)(?P<code>@example\s.*?@end\s+example\s)''',
175         },
176         }
177
178 format_res = {
179         HTML: {
180         'option-sep' : '\s*',
181         'intertext': r',?\s*intertext=\".*?\"',
182         },
183         LATEX: {
184         'intertext': r',?\s*intertext=\".*?\"',
185         'option-sep' : ',\s*',
186         },
187         TEXINFO: {
188         'intertext': r',?\s*intertext=\".*?\"',
189         'option-sep' : ',\s*',
190         },
191         }
192
193 ly_options = {
194         NOTES: {
195         RELATIVE: r'''\relative c%(relative_quotes)s''',
196         },
197         PAPER: {
198         EXAMPLEINDENT : '',
199         INDENT : r'''
200     indent = %(indent)s''',
201         'linewidth' : r'''
202     linewidth = %(linewidth)s''',
203         NOINDENT : r'''
204     indent = 0.0\mm''',
205         NOTIME : r'''
206     \context {
207         \Staff
208         \remove Time_signature_engraver
209     }''',
210         QUOTE : r'''
211     linewidth = %(linewidth)s - 2.0 * %(exampleindent)s
212 ''',    
213         RAGGEDRIGHT : r'''
214     indent = 0.0\mm
215     raggedright = ##t''',
216         },
217         PREAMBLE: {
218         STAFFSIZE: r'''
219 #(set-global-staff-size %(staffsize)s)''',
220         },
221         }
222
223 output = {
224         HTML : {
225         FILTER: r'''<lilypond %(options)s>
226 %(code)s
227 </lilypond>
228 ''',
229         
230         AFTER: r'''
231   </a>
232 </p>''',
233         BEFORE: r'''
234 <p>
235   <a href="%(base)s.ly">''',
236         OUTPUT: r'''
237     <img align="center" valign="center"
238          border="0" src="%(image)s" alt="[image of music]">''',
239         PRINTFILENAME:'<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
240         QUOTE: r'''<blockquote>
241 %(str)s
242 </blockquote>
243 ''',    
244         VERBATIM: r'''<pre>
245 %(verb)s</pre>''',
246         },
247
248         LATEX : {
249         AFTER: '',
250         BEFORE: '',
251         OUTPUT: r'''{\parindent 0pt
252 \catcode`\@=12
253 \ifx\preLilyPondExample\undefined\relax\else\preLilyPondExample\fi
254 \def\lilypondbook{}
255 \input %(base)s.tex
256 \ifx\postLilyPondExample\undefined\relax\else\postLilyPondExample\fi
257 \catcode`\@=0}''',
258         PRINTFILENAME: '''\\texttt{%(filename)s}
259
260         ''',
261         QUOTE: r'''\begin{quotation}
262 %(str)s
263 \end{quotation}
264 ''',    
265         VERBATIM: r'''\noindent
266 \begin{verbatim}
267 %(verb)s\end{verbatim}
268 ''',
269         FILTER: r'''\begin{lilypond}[%(options)s]
270 %(code)s
271 \end{lilypond}''',
272         },
273
274         TEXINFO : {
275         FILTER: r'''@lilypond[%(options)s]
276 %(code)s
277 @lilypond''',
278         AFTER: '',
279         BEFORE: '',
280         OUTPUT: r'''@noindent
281 @image{%(base)s,,,[image of music],%(ext)s}
282 ''',    
283         PRINTFILENAME: '''@file{%(filename)s}
284
285         ''',
286         QUOTE: r'''@quotation
287 %(str)s
288 @end quotation
289 ''',
290         # FIXME: @exampleindent 5  is the default...
291         VERBATIM: r'''@exampleindent 0
292 @example
293 %(verb)s@end example
294 @exampleindent 5
295 ''',
296         },
297         }
298
299 PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
300 %%%% Options: [%(option_string)s]
301 #(set! toplevel-score-handler ly:parser-print-score)
302 #(set! toplevel-music-handler (lambda (p m)
303                                (ly:parser-print-score
304                                 p (ly:music-scorify m))
305                             ))
306 %(preamble_string)s
307 \paper {%(paper_string)s
308 }
309 ''' 
310
311 FRAGMENT_LY = r'''
312     %(notes_string)s{
313         %(code)s    }
314 '''
315 FULL_LY = '%(code)s'
316
317 texinfo_linewidths = {
318         '@afourpaper': '160 \\mm',
319         '@afourwide': '6.5 \\in',
320         '@afourlatex': '150 \\mm',
321         '@smallbook': '5 \\in' ,
322         '@letterpaper': '6\\in',
323         }
324
325 def classic_lilypond_book_compatibility (o):
326         if o == 'singleline':
327                 return RAGGEDRIGHT
328         m = re.search ('relative\s*([-0-9])', o)
329         if m:
330                 return 'relative=%s' % m.group (1)
331         m = re.match ('([0-9]+)pt', o)
332         if m:
333                 return 'staffsize=%s' % m.group (1)
334         m = re.match ('indent=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
335         if m:
336                 f = float (m.group (1))
337                 return 'indent=%f\\%s' % (f, m.group (2))
338         m = re.match ('linewidth=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
339         if m:
340                 f = float (m.group (1))
341                 return 'linewidth=%f\\%s' % (f, m.group (2))
342         return None
343
344 def compose_ly (code, options):
345         #Hmm
346         for i in default_ly_options.keys ():
347                 if i not in options:
348                         options.append (i)
349         
350         #Hmm
351         if QUOTE in options and LINEWIDTH in options:
352                 options.remove (LINEWIDTH)
353
354         if FRAGMENT in options:
355                 if RAGGEDRIGHT not in options:
356                         options.append (RAGGEDRIGHT)
357                 body = FRAGMENT_LY
358         else:
359                 body = FULL_LY
360
361         # defaults
362         relative = 1
363         staffsize = 16
364         override = {}
365         override.update (default_ly_options)
366         #FIXME: where to get sane value for exampleindent?
367         override[EXAMPLEINDENT] = r'9.0 \mm'
368
369         option_string = string.join (options, ',')
370         notes_options = []
371         paper_options = []
372         preamble_options = []
373         for i in options:
374                 c = classic_lilypond_book_compatibility (i)
375                 if c:
376                         ly.warning (_ ("deprecated ly-option used: %s" % i))
377                         ly.warning (_ ("compatibility mode translation: %s" \
378                                        % c))
379                         i = c
380                 
381                 if string.find (i, '=') > 0:
382                         key, value = string.split (i, '=')
383                         override[key] = value
384                 else:
385                         key = i
386                         if i not in override.keys ():
387                                 override[i] = None
388
389                 if key in ly_options[NOTES].keys ():
390                         notes_options.append (ly_options[NOTES][key])
391                 elif key in ly_options[PREAMBLE].keys ():
392                         preamble_options.append (ly_options[PREAMBLE][key])
393                 elif key in ly_options[PAPER].keys ():
394                         paper_options.append (ly_options[PAPER][key])
395                 elif key not in (FRAGMENT, NOFRAGMENT, PRINTFILENAME,
396                                  RELATIVE, VERBATIM, TEXIDOC):
397                         ly.warning (_("ignoring unknown ly option: %s") % i)
398
399         #URGS
400         if RELATIVE in override.keys () and override[RELATIVE]:
401                 relative = string.atoi (override[RELATIVE])
402
403         relative_quotes = ''
404
405         # 1 = central C
406         if relative < 0:
407                 relative_quotes += ',' * (- relative)
408         elif relative > 0:
409                 relative_quotes += "'" * relative
410                 
411         program_name = __main__.program_name
412         paper_string = string.join (paper_options, '\n    ') % override
413         preamble_string = string.join (preamble_options, '\n    ') % override
414         notes_string = string.join (notes_options, '\n    ') % vars ()
415         return (PREAMBLE_LY + body) % vars ()
416
417 # BARF
418 # use lilypond-bin for latex (.lytex) books,
419 # and lilypond --preview for html, texinfo books?
420 def to_eps (file):
421         cmd = r'latex "\nonstopmode \input %s"' % file
422         # Ugh.  (La)TeX writes progress and error messages on stdout
423         # Redirect to stderr
424         cmd = '(( %s  >&2 ) >&- )' % cmd
425         ly.system (cmd)
426         ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -E -o %s.eps %s' \
427                    % (file, file))
428
429
430         # check if it really is EPS.
431         # Otherwise music glyphs disappear from 2nd and following pages.
432
433         # TODO: should run dvips -pp -E per page, then we get proper
434         # cropping as well.
435         
436         f = open ('%s.eps' % file)
437         for x in range(0,10) :
438                 if re.search ("^%%Pages: ", f.readline ()):
439
440                         # make non EPS.
441                         ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -o %s.eps %s' \
442                                    % (file, file))
443                         break
444         
445
446 def find_file (name):
447         for i in include_path:
448                 full = os.path.join (i, name)
449                 if os.path.exists (full):
450                         return full
451         ly.error (_ ('file not found: %s') % name + '\n')
452         ly.exit (1)
453         return ''
454         
455 def verbatim_html (s):
456         return re.sub ('>', '&gt;',
457                        re.sub ('<', '&lt;',
458                                re.sub ('&', '&amp;', s)))
459
460 def verbatim_texinfo (s):
461         return re.sub ('{', '@{',
462                        re.sub ('}', '@}',
463                                re.sub ('@', '@@', s)))
464
465 def split_options (option_string):
466         return re.split (format_res[format]['option-sep'], option_string)
467
468
469 class Chunk:
470         def replacement_text (self):
471                 return ''
472         
473         def filter_text (self):
474                 return self.replacement_text ()
475
476
477         def is_outdated (self):
478                 return 0
479
480 class Substring (Chunk):
481         def __init__ (self, source, start, end):
482                 self.source = source
483                 self.start = start
484                 self.end = end
485
486         def replacement_text (self):
487                 return self.source [self.start:self.end]
488         
489 class Snippet (Chunk):
490         def __init__ (self, type, match, format):
491                 self.type = type
492                 self.match = match
493                 self.hash = 0
494                 self.options = []
495                 self.format = format
496
497         def replacement_text (self):
498                 return self.match.group (0)
499         
500         def substring (self, s):
501                 return self.match.group (s)
502
503         def __repr__ (self):
504                 return `self.__class__`  +  " type =  " + self.type
505
506 class Include_snippet (Snippet):
507         def processed_filename (self):
508                 f = self.substring ('filename')
509                 return os.path.splitext (f)[0] + format2ext[format]
510
511         def replacement_text (self):
512                 s = self.match.group (0)
513                 f = self.substring ('filename')
514         
515                 return re.sub (f, self.processed_filename (), s)
516
517 class Lilypond_snippet (Snippet):
518         def __init__ (self, type, match, format):
519                 Snippet.__init__ (self, type, match, format)
520                 os = match.group ('options')
521                 if os:
522                         self.options = split_options (os)
523
524         def ly (self):
525                 return self.substring ('code')
526                 
527         def full_ly (self):
528                 s = self.ly ()
529                 if s:
530                         return compose_ly (s, self.options)
531                 return ''
532         
533         def get_hash (self):
534                 if not self.hash:
535                         self.hash = abs (hash (self.full_ly ()))
536                 return self.hash
537
538         def basename (self):
539                 if use_hash_p:
540                         return 'lily-%d' % self.get_hash ()
541                 raise 'to be done'
542
543         def write_ly (self):
544                 outf = open (self.basename () + '.ly', 'w')
545                 outf.write (self.full_ly ())
546
547         def is_outdated (self):
548                 base = self.basename ()
549
550                 tex_file = '%s.tex' % base
551                 ly_file = '%s.ly' % base
552                 ok = os.path.exists (ly_file) and os.path.exists (tex_file)\
553                      and os.stat (tex_file)[stat.ST_SIZE] \
554                      and open (tex_file).readlines ()[-1][1:-1] \
555                      == 'lilypondend'
556
557                 if format == HTML or format == TEXINFO:
558                         ok = ok and (os.path.exists (base + '.png')
559                                      or glob.glob (base + '-page*.png'))
560                         
561                 if ok and (use_hash_p or self.ly () == open (ly_file).read ()):
562                         # TODO: something smart with target formats
563                         # (ps, png) and m/ctimes
564                         return None
565                 return self
566         
567         def filter_text (self):
568                 code  = self.substring ('code')
569                 s = run_filter (code)
570                 d = {'code' : s,
571                      'options': self.match.group ('options')
572                      }
573                 # TODO
574                 return output[self.format][FILTER] % d
575         
576         def replacement_text (self):
577                 func = Lilypond_snippet.__dict__ ['output_' + self.format]
578                 return func (self)
579         
580         def get_images (self):
581                 base = self.basename ()
582                 # URGUGHUGHUGUGHU
583                 single = '%(base)s.png' % vars ()
584                 multiple = '%(base)s-page1.png' % vars ()
585                 images = (single,)
586                 if os.path.exists (multiple) \
587                    and (not os.path.exists (single)\
588                         or (os.stat (multiple)[stat.ST_MTIME] \
589                             > os.stat (single)[stat.ST_MTIME])):
590                         images = glob.glob ('%(base)s-page*.png' % vars ())
591                 return images
592                 
593         def output_html (self):
594                 str = ''
595                 base = self.basename ()
596                 if format == HTML:
597                         str += self.output_print_filename (HTML)
598                         if VERBATIM in self.options:
599                                 verb = verbatim_html (self.substring ('code'))
600                                 str += write (output[HTML][VERBATIM] % vars ())
601                         if QUOTE in self.options:
602                                 str = output[HTML][QUOTE] % vars ()
603
604                 str += output[HTML][BEFORE] % vars ()
605                 for image in self.get_images ():
606                         base, ext = os.path.splitext (image)
607                         str += output[HTML][OUTPUT] % vars ()
608                 str += output[HTML][AFTER] % vars ()
609                 return str
610
611         def output_info (self):
612                 str = self.output_print_filename (HTML)
613                 str = output[TEXINFO][BEFORE] % vars ()
614                 for image in self.get_images ():
615                         base, ext = os.path.splitext (image)
616                         # URG, makeinfo implicitely prepends dot to ext
617                         # specifying no extension is most robust
618                         ext = ''
619                         str += output[TEXINFO][OUTPUT] % vars ()
620                 str += output[TEXINFO][AFTER] % vars ()
621                 return str
622
623         def output_latex (self):
624                 str = ''
625                 base = self.basename ()
626                 if format == LATEX:
627                         str += self.output_print_filename (LATEX)
628                         if  VERBATIM in self.options:
629                                 verb = self.substring ('code')
630                                 str += (output[LATEX][VERBATIM] % vars ())
631                         if QUOTE in self.options:
632                                 str = output[LATEX][QUOTE] % vars ()
633
634                 str +=  (output[LATEX][BEFORE]
635                          + (output[LATEX][OUTPUT] % vars ())
636                          + output[LATEX][AFTER])
637                 return str
638
639         def output_print_filename (self,format):
640                 str = ''
641                 if  PRINTFILENAME in self.options:
642                         base = self.basename ()
643                         filename = self.substring ('filename')
644                         str = output[format][PRINTFILENAME] % vars ()
645                 return str
646
647         def output_texinfo (self):
648                 str = ''
649                 # self.output_print_filename (TEXINFO)
650                 str += ('@html\n' + self.output_print_filename (HTML)
651                         + '\n@end html\n')
652                 str += ('@tex\n' + self.output_print_filename (LATEX)
653                         + '\n@end tex\n')
654                 base = self.basename ()
655                 if TEXIDOC in self.options:
656                         texidoc = base + '.texidoc'
657                         if os.path.exists (texidoc):
658                                 str += '@include %(texidoc)s\n\n' % vars ()
659
660                 if VERBATIM in self.options:
661                         verb = verbatim_texinfo (self.substring ('code'))
662                         str +=  (output[TEXINFO][VERBATIM] % vars ())
663
664                 str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
665                 str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
666                 str += ('@html\n' + self.output_html () + '\n@end html\n')
667
668                 if QUOTE in self.options:
669                         str = output[TEXINFO][QUOTE] % vars ()
670
671                 # need par after image
672                 str += '\n'
673
674                 return str
675
676 class Lilypond_file_snippet (Lilypond_snippet):
677         def ly (self):
678                 name = self.substring ('filename')
679                 return '\\renameinput \"%s\"\n' % name\
680                                + open (find_file (name)).read ()
681         
682                         
683 snippet_type_to_class = {
684         'lilypond_file' : Lilypond_file_snippet,
685         'lilypond_block' : Lilypond_snippet,
686         'lilypond' : Lilypond_snippet,
687         'include' : Include_snippet,
688         }
689
690 def find_toplevel_snippets (s, types):
691         res = {}
692         for i in types:
693                 res[i] = ly.re.compile (snippet_res[format][i])
694
695         snippets = []
696         index = 0
697         ##  found = dict (map (lambda x: (x, None), types))
698         ## urg python2.1
699         found = {}
700         map (lambda x, f=found: f.setdefault (x, None), types)
701
702         # We want to search for multiple regexes, without searching
703         # the string multiple times for one regex.
704         # Hence, we use earlier results to limit the string portion
705         # where we search.
706         # Since every part of the string is traversed at most once for
707         # every type of snippet, this is linear.
708
709         while 1:
710                 first = None
711                 endex = 1 << 30
712                 for type in types:
713                         if not found[type] or found[type][0] < index:
714                                 found[type] = None
715                                 m = res[type].search (s[index:endex])
716                                 if not m:
717                                         continue
718
719                                 cl = Snippet
720                                 if snippet_type_to_class.has_key (type):
721                                         cl = snippet_type_to_class[type]
722                                 snip = cl (type, m, format)
723                                 start = index + m.start (0)
724                                 found[type] = (start, snip)
725
726                         if found[type] \
727                            and (not first or found[type][0] < found[first][0]):
728                                 first = type
729
730                                 # FIXME.
731
732                                 # Limiting the search space is a cute
733                                 # idea, but this *requires* to search
734                                 # for possible containing blocks
735                                 # first, at least long as we do not
736                                 # search for the start of blocks, but
737                                 # always/directly for the entire
738                                 # @block ... @end block.
739                                 
740                                 endex = found[first][0]
741
742                 if not first:
743                         snippets.append (Substring (s, index, len (s)))
744                         break
745
746                 (start , snip) = found[first]
747                 snippets.append (Substring (s, index, start))
748                 snippets.append (snip)
749                 found[first] = None
750                 index = start + len (snip.match.group (0))
751
752         return snippets
753
754 def filter_pipe (input, cmd):
755         if verbose_p:
756                 ly.progress (_ ("Opening filter `%s\'") % cmd)
757                 
758         stdin, stdout, stderr = os.popen3 (cmd)
759         stdin.write (input)
760         status = stdin.close ()
761
762         if not status:
763                 status = 0
764                 output = stdout.read ()
765                 status = stdout.close ()
766                 error = stderr.read ()
767                 
768         if not status:
769                 status = 0
770         signal = 0x0f & status
771         if status or (not output and error):
772                 exit_status = status >> 8
773                 ly.error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
774                 ly.error (_ ("The error log is as follows:"))
775                 sys.stderr.write (error)
776                 sys.stderr.write (stderr.read ())
777                 ly.exit (status)
778         
779         if verbose_p:
780                 ly.progress ('\n')
781
782         return output
783         
784 def run_filter (s):
785         return filter_pipe (s, filter_cmd)
786
787 def is_derived_class (cl,  baseclass):
788         if cl == baseclass:
789                 return 1
790         for b in cl.__bases__:
791                 if is_derived_class (b, baseclass):
792                         return 1
793         return 0
794
795
796 def process_snippets (cmd, snippets):
797         names = filter (lambda x: x, map (Lilypond_snippet.basename, snippets))
798         if names:
799                 ly.system (string.join ([cmd] + names))
800
801         if format == HTML or format == TEXINFO:
802                 for i in names:
803                         if not os.path.exists (i + '.eps') and os.path.exists (i + '.tex'):
804                                 to_eps (i)
805                                 ly.make_ps_images (i + '.eps', resolution=110)
806 #                       elif os.path.exists (i + '.ps'):
807 #                               ly.make_ps_images (i + '.ps', resolution=110)
808
809
810 LATEX_DOCUMENT = r'''
811 %(preamble)s
812 \begin{document}
813 \typeout{textwidth=\the\textwidth}
814 \typeout{columnsep=\the\columnsep}
815 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
816 \end{document}
817 '''
818 #need anything else besides textwidth?
819 def get_latex_textwidth (source):
820         m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
821         preamble = source[:m.start (0)]
822         latex_document = LATEX_DOCUMENT % vars ()
823         parameter_string = filter_pipe (latex_document, latex_filter_cmd)
824
825         columns = 0
826         m = re.search ('columns=([0-9.]*)', parameter_string)
827         if m:
828                 columns = string.atoi (m.group (1))
829
830         columnsep = 0
831         m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
832         if m:
833                 columnsep = string.atof (m.group (1))
834
835         textwidth = 0
836         m = re.search('textwidth=([0-9.]*)pt', parameter_string)
837         if m:
838                 textwidth = string.atof (m.group (1))
839                 if columns:
840                         textwidth = (textwidth - columnsep) / columns
841
842         return textwidth
843
844 ext2format = {
845         '.html' : HTML,
846         '.itely' : TEXINFO,
847         '.lytex' : LATEX,
848         '.tely' : TEXINFO,
849         '.tex': LATEX,
850         '.texi' : TEXINFO,
851         '.texinfo' : TEXINFO,
852         '.xml' : HTML,
853         }
854                                
855 format2ext = {
856         HTML: '.html',
857         #TEXINFO: '.texinfo',
858         TEXINFO: '.texi',
859         LATEX: '.tex',
860         }
861         
862 def do_file (input_filename):
863         #ugh
864         global format
865         if not format:
866                 e = os.path.splitext (input_filename)[1]
867                 if e in ext2format.keys ():
868                         #FIXME
869                         format = ext2format[e]
870                 else:
871                         ly.error (_ ("cannot determine format for: %s" \
872                                      % input_filename))
873
874         if not input_filename or input_filename == '-':
875                 in_handle = sys.stdin
876                 input_fullname = '<stdin>'
877         else:
878                 if os.path.exists (input_filename):
879                         input_fullname = input_filename
880                 elif format == LATEX:
881                         # urg python interface to libkpathsea?
882                         input_fullname = ly.read_pipe ('kpsewhich '
883                                                        + input_filename)[:-1]
884                 else:
885                         input_fullname = find_file (input_filename)
886                 in_handle = open (input_fullname)
887                 
888         if input_filename == '-':
889                 input_base = 'stdin'
890         else:
891                 input_base = os.path.basename \
892                              (os.path.splitext (input_filename)[0])
893
894         # only default to stdout when filtering 
895         if output_name == '-' or (not output_name and filter_cmd):
896                 output_filename = '-'
897                 output_file = sys.stdout
898         else:
899                 if not output_name:
900                         output_filename = input_base + format2ext[format]
901                 else:
902                         if not os.path.isdir (output_name):
903                                 os.mkdir (output_name, 0777)
904                         output_filename = (output_name
905                                            + '/' + input_base
906                                            + format2ext[format])
907
908
909                 if (os.path.exists (input_filename) and 
910                     os.path.exists (output_filename) and 
911                     os.path.samefile (output_filename, input_fullname)):
912                         ly.error (_("Output would overwrite input file; use --output."))
913                         sys.exit (2)
914
915                 output_file = open (output_filename, 'w')
916                 if output_name:
917                         os.chdir (output_name)
918
919         ly.progress (_ ("Reading %s...") % input_fullname)
920         source = in_handle.read ()
921         ly.progress ('\n')
922
923         # FIXME: containing blocks must be first, see find_toplevel_snippets
924         snippet_types = (
925                 'multiline_comment',
926                 'verbatim',
927                 'lilypond_block',
928 #               'verb',
929                 'singleline_comment',
930                 'lilypond_file',
931                 'include',
932                 'lilypond', )
933         ly.progress (_ ("Dissecting..."))
934         chunks = find_toplevel_snippets (source, snippet_types)
935         ly.progress ('\n')
936
937         global default_ly_options
938         textwidth = 0
939         if LINEWIDTH not in default_ly_options.keys ():
940                 if format == LATEX:
941                         textwidth = get_latex_textwidth (source)
942                         default_ly_options[LINEWIDTH] = '''%.0f\\pt''' \
943                                                         % textwidth
944                 elif format == TEXINFO:
945                         for (k, v) in texinfo_linewidths.items ():
946                                 # FIXME: @paper is usually not in chunk #0:
947                                 #        \input texinfo @c -*-texinfo-*-
948                                 # bluntly search first K of source
949                                 # s = chunks[0].replacement_text ()
950                                 if re.search (k, source[:1024]):
951                                         default_ly_options[LINEWIDTH] = v
952                                         break
953
954         if filter_cmd:
955                 output_file.writelines ([c.filter_text () for c in chunks])
956                 
957                 
958         elif process_cmd:
959                 outdated = filter (lambda x: is_derived_class (x.__class__, Lilypond_snippet) \
960                                    and x.is_outdated (), chunks)
961                 ly.progress (_ ("Writing snippets..."))
962                 map (Lilypond_snippet.write_ly, outdated)
963                 ly.progress ('\n')
964
965                 if outdated:
966                         ly.progress (_ ("Processing..."))
967                         process_snippets (process_cmd, outdated)
968                 else:
969                         ly.progress (_ ("All snippets are up to date..."))
970                 ly.progress ('\n')
971
972                 ly.progress (_ ("Compiling %s...") % output_filename)
973                 output_file.writelines ([s.replacement_text () \
974                                          for s in chunks])
975                 ly.progress ('\n')
976
977         def process_include (snippet):
978                 os.chdir (original_dir)
979                 name = snippet.substring ('filename')
980                 ly.progress (_ ('Processing include: %s') % name)
981                 ly.progress ('\n')
982                 do_file (name)
983                 
984         map (process_include,
985              filter (lambda x: is_derived_class (x.__class__, Include_snippet), chunks))
986
987 def do_options ():
988         global format, output_name
989         global filter_cmd, process_cmd, verbose_p
990         
991         (sh, long) = ly.getopt_args (option_definitions)
992         try:
993                 (options, files) = getopt.getopt (sys.argv[1:], sh, long)
994         except getopt.error, s:
995                 sys.stderr.write ('\n')
996                 ly.error (_ ("getopt says: `%s\'" % s))
997                 sys.stderr.write ('\n')
998                 ly.help ()
999                 ly.exit (2)
1000
1001         for opt in options:
1002                 o = opt[0]
1003                 a = opt[1]
1004
1005                 if 0:
1006                         pass
1007                 elif o == '--filter' or o == '-F':
1008                         filter_cmd = a
1009                         process_cmd = 0
1010                 elif o == '--format' or o == '-f':
1011                         format = a
1012                         if a == 'texi-html' or a == 'texi':
1013                                 format = TEXINFO
1014                 elif o == '--help' or o == '-h':
1015                         ly.help ()
1016                         sys.exit (0)
1017                 elif o == '--include' or o == '-I':
1018                         include_path.append (os.path.join (original_dir,
1019                                                            ly.abspath (a)))
1020                 elif o == '--output' or o == '-o':
1021                         output_name = a
1022                 elif o == '--outdir':
1023                         output_name = a
1024                 elif o == '--process' or o == '-P':
1025                         process_cmd = a
1026                         filter_cmd = 0
1027                 elif o == '--version' or o == '-v':
1028                         ly.identify (sys.stdout)
1029                         sys.exit (0)
1030                 elif o == '--verbose' or o == '-V':
1031                         verbose_p = 1
1032                 elif o == '--warranty' or o == '-w':
1033                         if 1 or status:
1034                                 ly.warranty ()
1035                         sys.exit (0)
1036         return files
1037
1038 def main ():
1039         files = do_options ()
1040         global process_cmd
1041         if process_cmd:
1042                 process_cmd += string.join ([(' -I %s' % p)
1043                                              for p in include_path])
1044
1045         ly.identify (sys.stderr)
1046         ly.setup_environment ()
1047         if files:
1048                 do_file (files[0])
1049
1050 if __name__ == '__main__':
1051         main ()