scripts/lilypond-book.py

   1 #!@TARGET_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" BOOK.tely
  14
  15 TODO:
  16
  17   *  this script is too complex. Modularize.
  18
  19   *  ly-options: intertext?
  20   *  --line-width?
  21   *  eps in latex / eps by lilypond -b ps?
  22   *  check latex parameters, twocolumn, multicolumn?
  23   *  use --png --ps --pdf for making images?
  24
  25   *  Converting from lilypond-book source, substitute:
  26    @mbinclude foo.itely -> @include foo.itely
  27    \mbinput -> \input
  28
  29 '''
  30
  31 import stat
  32 import string
  33 import tempfile
  34 import commands
  35 import os
  36 import sys
  37 import re
  38
  39 # Users of python modules should include this snippet
  40 # and customize variables below.
  41
  42 # We'll suffer this path initialization stuff as long as we don't install
  43 # our python packages in <prefix>/lib/pythonX.Y
  44
  45 # If set, LILYPONDPREFIX must take prevalence.
  46 # if datadir is not set, we're doing a build and LILYPONDPREFIX.
  47
  48 ################
  49 # RELOCATION
  50 ################
  51
  52 datadir = '@local_lilypond_datadir@'
  53 if not os.path.isdir (datadir):
  54     datadir = '@lilypond_datadir@'
  55
  56 sys.path.insert (0, os.path.join (datadir, 'python'))
  57
  58 if os.environ.has_key ('LILYPONDPREFIX'):
  59     datadir = os.environ['LILYPONDPREFIX']
  60     while datadir[-1] == os.sep:
  61         datadir= datadir[:-1]
  62
  63     datadir = os.path.join (datadir, "share/lilypond/current/")
  64 sys.path.insert (0, os.path.join (datadir, 'python'))
  65
  66 # dynamic relocation, for GUB binaries.
  67 bindir = os.path.split (sys.argv[0])[0]
  68
  69
  70 for prefix_component in ['share', 'lib']:
  71     datadir = os.path.abspath (bindir + '/../%s/lilypond/current/python/' % prefix_component)
  72     sys.path.insert (0, datadir)
  73
  74
  75 import lilylib as ly
  76 import fontextract
  77 global _;_=ly._
  78
  79
  80 # Lilylib globals.
  81 program_version = '@TOPLEVEL_VERSION@'
  82 program_name = os.path.basename (sys.argv[0])
  83
  84 original_dir = os.getcwd ()
  85 backend = 'ps'
  86
  87 help_summary = _ (
  88 '''Process LilyPond snippets in hybrid HTML, LaTeX, or texinfo document.
  89
  90 Example usage:
  91
  92  lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
  93  lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" BOOK
  94  lilypond-book --process='lilypond -I include' BOOK
  95 ''')
  96
  97 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  98       'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
  99
 100
 101 ################################################################
 102 def exit (i):
 103     if global_options.verbose:
 104         raise _ ('Exiting (%d)...') % i
 105     else:
 106         sys.exit (i)
 107
 108 def identify ():
 109     sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
 110
 111 def progress (s):
 112     sys.stderr.write (s)
 113
 114 def warning (s):
 115     sys.stderr.write (program_name + ": " + _ ("warning: %s") % s + '\n')
 116
 117 def error (s):
 118     sys.stderr.write (program_name + ": " + _ ("error: %s") % s + '\n')
 119
 120 def ps_page_count (ps_name):
 121     header = open (ps_name).read (1024)
 122     m = re.search ('\n%%Pages: ([0-9]+)', header)
 123     if m:
 124         return string.atoi (m.group (1))
 125     return 0
 126
 127 def warranty ():
 128     identify ()
 129     sys.stdout.write ('''
 130 %s
 131
 132 %s
 133
 134 %s
 135 %s
 136 ''' % ( _('Copyright (c) %s by') % '2001--2006',
 137     ' '.join (authors),
 138    _('Distributed under terms of the GNU General Public License.'),
 139    _('It comes with NO WARRANTY.')))
 140
 141
 142 def get_option_parser ():
 143     p = ly.get_option_parser (usage='lilypond-book [OPTIONS] FILE',
 144                               version="@TOPLEVEL_VERSION@",
 145                               description=help_summary)
 146
 147     p.add_option ('-F', '--filter', metavar=_ ("FILTER"),
 148                   action="store",
 149                   dest="filter_cmd",
 150                   help=_ ("pipe snippets through FILTER [convert-ly -n -]"),
 151                   default=None)
 152     p.add_option ('-f', '--format',
 153                   help=_('''use output format FORMAT (texi [default], texi-html, latex, html)'''),
 154                   action='store')
 155     p.add_option ("-I", '--include', help=_('add DIR to include path'),
 156                   metavar="DIR",
 157                   action='append', dest='include_path',
 158                   default=[os.path.abspath (os.getcwd ())])
 159
 160     p.add_option ("-o", '--output', help=_('write output to DIR'),
 161                   metavar="DIR",
 162                   action='store', dest='output_name',
 163                   default='')
 164     p.add_option ('-P', '--process', metavar=_("COMMAND"),
 165                   help = _ ("process ly_files using COMMAND FILE..."),
 166                   action='store',
 167                   dest='process_cmd', default='lilypond -b eps')
 168
 169     p.add_option ('', '--psfonts', action="store_true", dest="psfonts",
 170                   help=_ ('''extract all PostScript fonts into INPUT.psfonts for LaTeX'''
 171                    '''must use this with dvips -h INPUT.psfonts'''),
 172                   default=None)
 173     p.add_option ('-V', '--verbose', help=_("be verbose"),
 174                   action="store_true",
 175                   default=False,
 176                   dest="verbose")
 177
 178     p.add_option ('-w', '--warranty',
 179                   help=_("show warranty and copyright"),
 180                   action='store_true')
 181
 182
 183     p.add_option_group  ('bugs',
 184                          description='''Report bugs via http://post.gmane.org/post.php'''
 185                          '''?group=gmane.comp.gnu.lilypond.bugs\n''')
 186
 187     return p
 188
 189 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
 190
 191 # Only use installed binary when we are installed too.
 192 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
 193     lilypond_binary = 'lilypond'
 194
 195 global_options = None
 196
 197
 198 default_ly_options = { 'alt': "[image of music]" }
 199
 200 #
 201 # Is this pythonic?  Personally, I find this rather #define-nesque. --hwn
 202 #
 203 AFTER = 'after'
 204 BEFORE = 'before'
 205 EXAMPLEINDENT = 'exampleindent'
 206 FILTER = 'filter'
 207 FRAGMENT = 'fragment'
 208 HTML = 'html'
 209 INDENT = 'indent'
 210 LATEX = 'latex'
 211 LAYOUT = 'layout'
 212 LINE_WIDTH = 'line-width'
 213 NOFRAGMENT = 'nofragment'
 214 NOINDENT = 'noindent'
 215 NOQUOTE = 'noquote'
 216 NOTES = 'body'
 217 NOTIME = 'notime'
 218 OUTPUT = 'output'
 219 OUTPUTIMAGE = 'outputimage'
 220 PACKED = 'packed'
 221 PAPER = 'paper'
 222 PREAMBLE = 'preamble'
 223 PRINTFILENAME = 'printfilename'
 224 QUOTE = 'quote'
 225 RAGGED_RIGHT = 'ragged-right'
 226 RELATIVE = 'relative'
 227 STAFFSIZE = 'staffsize'
 228 TEXIDOC = 'texidoc'
 229 TEXINFO = 'texinfo'
 230 VERBATIM = 'verbatim'
 231 FONTLOAD = 'fontload'
 232 FILENAME = 'filename'
 233 ALT = 'alt'
 234
 235
 236 # NOTIME has no opposite so it isn't part of this dictionary.
 237 # NOQUOTE is used internally only.
 238 no_options = {
 239     NOFRAGMENT: FRAGMENT,
 240     NOINDENT: INDENT,
 241 }
 242
 243
 244 # Recognize special sequences in the input.
 245 #
 246 #   (?P<name>regex) -- Assign result of REGEX to NAME.
 247 #   *? -- Match non-greedily.
 248 #   (?m) -- Multiline regex: Make ^ and $ match at each line.
 249 #   (?s) -- Make the dot match all characters including newline.
 250 #   (?x) -- Ignore whitespace in patterns.
 251 no_match = 'a\ba'
 252 snippet_res = {
 253     ##
 254     HTML: {
 255         'include':
 256          no_match,
 257
 258         'lilypond':
 259          r'''(?mx)
 260           (?P<match>
 261           <lilypond
 262            (\s*(?P<options>.*?)\s*:)?\s*
 263            (?P<code>.*?)
 264           />)''',
 265
 266         'lilypond_block':
 267          r'''(?msx)
 268           (?P<match>
 269           <lilypond
 270            \s*(?P<options>.*?)\s*
 271           >
 272           (?P<code>.*?)
 273           </lilypond>)''',
 274
 275         'lilypond_file':
 276          r'''(?mx)
 277           (?P<match>
 278           <lilypondfile
 279            \s*(?P<options>.*?)\s*
 280           >
 281           \s*(?P<filename>.*?)\s*
 282           </lilypondfile>)''',
 283
 284         'multiline_comment':
 285          r'''(?smx)
 286           (?P<match>
 287           \s*(?!@c\s+)
 288           (?P<code><!--\s.*?!-->)
 289           \s)''',
 290
 291         'singleline_comment':
 292          no_match,
 293
 294         'verb':
 295          r'''(?x)
 296           (?P<match>
 297            (?P<code><pre>.*?</pre>))''',
 298
 299         'verbatim':
 300          r'''(?x)
 301           (?s)
 302           (?P<match>
 303            (?P<code><pre>\s.*?</pre>\s))''',
 304     },
 305
 306     ##
 307     LATEX: {
 308         'include':
 309          r'''(?smx)
 310           ^[^%\n]*?
 311           (?P<match>
 312           \\input\s*{
 313            (?P<filename>\S+?)
 314           })''',
 315
 316         'lilypond':
 317          r'''(?smx)
 318           ^[^%\n]*?
 319           (?P<match>
 320           \\lilypond\s*(
 321           \[
 322            \s*(?P<options>.*?)\s*
 323           \])?\s*{
 324            (?P<code>.*?)
 325           })''',
 326
 327         'lilypond_block':
 328          r'''(?smx)
 329           ^[^%\n]*?
 330           (?P<match>
 331           \\begin\s*(
 332           \[
 333            \s*(?P<options>.*?)\s*
 334           \])?\s*{lilypond}
 335            (?P<code>.*?)
 336           ^[^%\n]*?
 337           \\end\s*{lilypond})''',
 338
 339         'lilypond_file':
 340          r'''(?smx)
 341           ^[^%\n]*?
 342           (?P<match>
 343           \\lilypondfile\s*(
 344           \[
 345            \s*(?P<options>.*?)\s*
 346           \])?\s*\{
 347            (?P<filename>\S+?)
 348           })''',
 349
 350         'multiline_comment':
 351          no_match,
 352
 353         'singleline_comment':
 354          r'''(?mx)
 355           ^.*?
 356           (?P<match>
 357            (?P<code>
 358            %.*$\n+))''',
 359
 360         'verb':
 361          r'''(?mx)
 362           ^[^%\n]*?
 363           (?P<match>
 364            (?P<code>
 365            \\verb(?P<del>.)
 366             .*?
 367            (?P=del)))''',
 368
 369         'verbatim':
 370          r'''(?msx)
 371           ^[^%\n]*?
 372           (?P<match>
 373            (?P<code>
 374            \\begin\s*{verbatim}
 375             .*?
 376            \\end\s*{verbatim}))''',
 377     },
 378
 379     ##
 380     TEXINFO: {
 381         'include':
 382          r'''(?mx)
 383           ^(?P<match>
 384           @include\s+
 385            (?P<filename>\S+))''',
 386
 387         'lilypond':
 388          r'''(?smx)
 389           ^[^\n]*?(?!@c\s+)[^\n]*?
 390           (?P<match>
 391           @lilypond\s*(
 392           \[
 393            \s*(?P<options>.*?)\s*
 394           \])?\s*{
 395            (?P<code>.*?)
 396           })''',
 397
 398         'lilypond_block':
 399          r'''(?msx)
 400           ^(?P<match>
 401           @lilypond\s*(
 402           \[
 403            \s*(?P<options>.*?)\s*
 404           \])?\s+?
 405           ^(?P<code>.*?)
 406           ^@end\s+lilypond)\s''',
 407
 408         'lilypond_file':
 409          r'''(?mx)
 410           ^(?P<match>
 411           @lilypondfile\s*(
 412           \[
 413            \s*(?P<options>.*?)\s*
 414           \])?\s*{
 415            (?P<filename>\S+)
 416           })''',
 417
 418         'multiline_comment':
 419          r'''(?smx)
 420           ^(?P<match>
 421            (?P<code>
 422            @ignore\s
 423             .*?
 424            @end\s+ignore))\s''',
 425
 426         'singleline_comment':
 427          r'''(?mx)
 428           ^.*
 429           (?P<match>
 430            (?P<code>
 431            @c([ \t][^\n]*|)\n))''',
 432
 433     # Don't do this: It interferes with @code{@{}.
 434     #        'verb': r'''(?P<code>@code{.*?})''',
 435
 436         'verbatim':
 437          r'''(?sx)
 438           (?P<match>
 439            (?P<code>
 440            @example
 441             \s.*?
 442            @end\s+example\s))''',
 443     },
 444 }
 445
 446
 447
 448
 449 format_res = {
 450     HTML: {
 451         'intertext': r',?\s*intertext=\".*?\"',
 452         'option_sep': '\s*',
 453     },
 454
 455     LATEX: {
 456         'intertext': r',?\s*intertext=\".*?\"',
 457         'option_sep': '\s*,\s*',
 458     },
 459
 460     TEXINFO: {
 461         'intertext': r',?\s*intertext=\".*?\"',
 462         'option_sep': '\s*,\s*',
 463     },
 464 }
 465
 466 # Options without a pattern in ly_options.
 467 simple_options = [
 468     EXAMPLEINDENT,
 469     FRAGMENT,
 470     NOFRAGMENT,
 471     NOINDENT,
 472     PRINTFILENAME,
 473     TEXIDOC,
 474     VERBATIM,
 475     FONTLOAD,
 476     FILENAME,
 477     ALT
 478 ]
 479
 480 ly_options = {
 481     ##
 482     NOTES: {
 483         RELATIVE: r'''\relative c%(relative_quotes)s''',
 484     },
 485
 486     ##
 487     PAPER: {
 488         INDENT: r'''indent = %(indent)s''',
 489
 490         LINE_WIDTH: r'''line-width = %(line-width)s''',
 491
 492         QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
 493
 494         RAGGED_RIGHT: r'''ragged-right = ##t''',
 495
 496         PACKED: r'''packed = ##t''',
 497     },
 498
 499     ##
 500     LAYOUT: {
 501         NOTIME: r'''
 502  \context {
 503   \Score
 504   timing = ##f
 505  }
 506  \context {
 507   \Staff
 508   \remove Time_signature_engraver
 509  }''',
 510     },
 511
 512     ##
 513     PREAMBLE: {
 514         STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
 515     },
 516 }
 517
 518 output = {
 519     ##
 520     HTML: {
 521         FILTER: r'''<lilypond %(options)s>
 522 %(code)s
 523 </lilypond>
 524 ''',
 525
 526         AFTER: r'''
 527  </a>
 528 </p>''',
 529
 530         BEFORE: r'''<p>
 531  <a href="%(base)s.ly">''',
 532
 533         OUTPUT: r'''
 534   <img align="center" valign="center"
 535     border="0" src="%(image)s" alt="%(alt)s">''',
 536
 537         PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
 538
 539         QUOTE: r'''<blockquote>
 540 %(str)s
 541 </blockquote>
 542 ''',
 543
 544         VERBATIM: r'''<pre>
 545 %(verb)s</pre>''',
 546     },
 547
 548     ##
 549     LATEX: {
 550         OUTPUT: r'''{%%
 551 \parindent 0pt%%
 552 \catcode`\@=12%%
 553 \ifx\preLilyPondExample \undefined%%
 554  \relax%%
 555 \else%%
 556  \preLilyPondExample%%
 557 \fi%%
 558 \def\lilypondbook{}%%
 559 \input %(base)s-systems.tex%%
 560 \ifx\postLilyPondExample \undefined%%
 561  \relax%%
 562 \else%%
 563  \postLilyPondExample%%
 564 \fi%%
 565 }''',
 566
 567         PRINTFILENAME: '''\\texttt{%(filename)s}
 568     ''',
 569
 570         QUOTE: r'''\begin{quotation}%(str)s
 571 \end{quotation}''',
 572
 573         VERBATIM: r'''\noindent
 574 \begin{verbatim}%(verb)s\end{verbatim}''',
 575
 576         FILTER: r'''\begin{lilypond}[%(options)s]
 577 %(code)s
 578 \end{lilypond}''',
 579     },
 580
 581     ##
 582     TEXINFO: {
 583         FILTER: r'''@lilypond[%(options)s]
 584 %(code)s
 585 @lilypond''',
 586
 587         OUTPUT: r'''
 588 @iftex
 589 @include %(base)s-systems.texi
 590 @end iftex
 591 ''',
 592
 593         OUTPUTIMAGE: r'''@noindent
 594 @ifinfo
 595 @image{%(base)s,,,%(alt)s,%(ext)s}
 596 @end ifinfo
 597 @html
 598 <p>
 599  <a href="%(base)s.ly">
 600   <img align="center" valign="center"
 601     border="0" src="%(image)s" alt="%(alt)s">
 602  </a>
 603 </p>
 604 @end html
 605 ''',
 606
 607         PRINTFILENAME: '''
 608 @html
 609 <a href="%(base)s.ly">
 610 @end html
 611 @file{%(filename)s}
 612 @html
 613 </a>
 614 @end html
 615     ''',
 616
 617         QUOTE: r'''@quotation
 618 %(str)s@end quotation
 619 ''',
 620
 621         NOQUOTE: r'''@format
 622 %(str)s@end format
 623 ''',
 624
 625         VERBATIM: r'''@exampleindent 0
 626 @verbatim
 627 %(verb)s@end verbatim
 628 ''',
 629     },
 630 }
 631
 632 #
 633 # Maintain line numbers.
 634 #
 635
 636 ## TODO
 637 if 0:
 638     for f in [HTML, LATEX]:
 639         for s in (QUOTE, VERBATIM):
 640             output[f][s] = output[f][s].replace("\n"," ")
 641
 642
 643 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
 644 %%%% Options: [%(option_string)s]
 645
 646 #(set! toplevel-score-handler print-score-with-defaults)
 647 #(set! toplevel-music-handler
 648  (lambda (p m)
 649  (if (not (eq? (ly:music-property m \'void) #t))
 650     (print-score-with-defaults
 651     p (scorify-music m p)))))
 652
 653 #(ly:set-option (quote no-point-and-click))
 654 #(define inside-lilypond-book #t)
 655 #(define version-seen? #t)
 656 %(preamble_string)s
 657
 658
 659
 660
 661
 662
 663 %% ****************************************************************
 664 %% Start cut-&-pastable-section
 665 %% ****************************************************************
 666
 667 \paper {
 668  #(define dump-extents #t)
 669  %(font_dump_setting)s
 670  %(paper_string)s
 671 }
 672
 673 \layout {
 674  %(layout_string)s
 675 }
 676 '''
 677
 678 FRAGMENT_LY = r'''
 679 %(notes_string)s
 680 {
 681
 682
 683 %% ****************************************************************
 684 %% ly snippet contents follows:
 685 %% ****************************************************************
 686 %(code)s
 687
 688
 689 %% ****************************************************************
 690 %% end ly snippet
 691 %% ****************************************************************
 692 }
 693 '''
 694
 695 FULL_LY = '''
 696
 697
 698 %% ****************************************************************
 699 %% ly snippet:
 700 %% ****************************************************************
 701 %(code)s
 702
 703
 704 %% ****************************************************************
 705 %% end ly snippet
 706 %% ****************************************************************
 707 '''
 708
 709 texinfo_line_widths = {
 710     '@afourpaper': '160\\mm',
 711     '@afourwide': '6.5\\in',
 712     '@afourlatex': '150\\mm',
 713     '@smallbook': '5\\in',
 714     '@letterpaper': '6\\in',
 715 }
 716
 717 def classic_lilypond_book_compatibility (key, value):
 718     if key == 'singleline' and value == None:
 719         return (RAGGED_RIGHT, None)
 720
 721     m = re.search ('relative\s*([-0-9])', key)
 722     if m:
 723         return ('relative', m.group (1))
 724
 725     m = re.match ('([0-9]+)pt', key)
 726     if m:
 727         return ('staffsize', m.group (1))
 728
 729     if key == 'indent' or key == 'line-width':
 730         m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
 731         if m:
 732             f = float (m.group (1))
 733             return (key, '%f\\%s' % (f, m.group (2)))
 734
 735     return (None, None)
 736
 737 def find_file (name):
 738     for i in global_options.include_path:
 739         full = os.path.join (i, name)
 740         if os.path.exists (full):
 741             return full
 742
 743     error (_ ("file not found: %s") % name + '\n')
 744     exit (1)
 745     return ''
 746
 747 def verbatim_html (s):
 748     return re.sub ('>', '&gt;',
 749            re.sub ('<', '&lt;',
 750                re.sub ('&', '&amp;', s)))
 751
 752 def split_options (option_string):
 753     if option_string:
 754         if global_options.format == HTML:
 755             options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',option_string)
 756             for i in range(len(options)):
 757                 options[i] = re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)','\g<1>\g<3>',options[i])
 758             return options
 759         else:
 760             return re.split (format_res[global_options.format]['option_sep'],
 761                     option_string)
 762     return []
 763
 764 def set_default_options (source):
 765     global default_ly_options
 766     if not default_ly_options.has_key (LINE_WIDTH):
 767         if global_options.format == LATEX:
 768             textwidth = get_latex_textwidth (source)
 769             default_ly_options[LINE_WIDTH] = \
 770              '''%.0f\\pt''' % textwidth
 771         elif global_options.format == TEXINFO:
 772             for (k, v) in texinfo_line_widths.items ():
 773                 # FIXME: @layout is usually not in
 774                 # chunk #0:
 775                 #
 776                 #  \input texinfo @c -*-texinfo-*-
 777                 #
 778                 # Bluntly search first K items of
 779                 # source.
 780                 # s = chunks[0].replacement_text ()
 781                 if re.search (k, source[:1024]):
 782                     default_ly_options[LINE_WIDTH] = v
 783                     break
 784
 785 class Chunk:
 786     def replacement_text (self):
 787         return ''
 788
 789     def filter_text (self):
 790         return self.replacement_text ()
 791
 792     def ly_is_outdated (self):
 793         return 0
 794
 795     def png_is_outdated (self):
 796         return 0
 797
 798     def is_plain (self):
 799         return False
 800
 801 class Substring (Chunk):
 802     def __init__ (self, source, start, end, line_number):
 803         self.source = source
 804         self.start = start
 805         self.end = end
 806         self.line_number = line_number
 807         self.override_text = None
 808
 809     def is_plain (self):
 810         return True
 811
 812     def replacement_text (self):
 813         if self.override_text:
 814             return self.override_text
 815         else:
 816             return self.source[self.start:self.end]
 817
 818 class Snippet (Chunk):
 819     def __init__ (self, type, match, format, line_number):
 820         self.type = type
 821         self.match = match
 822         self.hash = 0
 823         self.option_dict = {}
 824         self.format = format
 825         self.line_number = line_number
 826
 827     def replacement_text (self):
 828         return self.match.group ('match')
 829
 830     def substring (self, s):
 831         return self.match.group (s)
 832
 833     def __repr__ (self):
 834         return `self.__class__` + ' type = ' + self.type
 835
 836 class Include_snippet (Snippet):
 837     def processed_filename (self):
 838         f = self.substring ('filename')
 839         return os.path.splitext (f)[0] + format2ext[global_options.format]
 840
 841     def replacement_text (self):
 842         s = self.match.group ('match')
 843         f = self.substring ('filename')
 844
 845         return re.sub (f, self.processed_filename (), s)
 846
 847 class Lilypond_snippet (Snippet):
 848     def __init__ (self, type, match, format, line_number):
 849         Snippet.__init__ (self, type, match, format, line_number)
 850         os = match.group ('options')
 851         self.do_options (os, self.type)
 852
 853     def ly (self):
 854         return self.substring ('code')
 855
 856     def full_ly (self):
 857         s = self.ly ()
 858         if s:
 859             return self.compose_ly (s)
 860         return ''
 861
 862     def do_options (self, option_string, type):
 863         self.option_dict = {}
 864
 865         options = split_options (option_string)
 866
 867         for i in options:
 868             if string.find (i, '=') > 0:
 869                 (key, value) = re.split ('\s*=\s*', i)
 870                 self.option_dict[key] = value
 871             else:
 872                 if i in no_options.keys ():
 873                     if no_options[i] in self.option_dict.keys ():
 874                         del self.option_dict[no_options[i]]
 875                 else:
 876                     self.option_dict[i] = None
 877
 878         has_line_width = self.option_dict.has_key (LINE_WIDTH)
 879         no_line_width_value = 0
 880
 881         # If LINE_WIDTH is used without parameter, set it to default.
 882         if has_line_width and self.option_dict[LINE_WIDTH] == None:
 883             no_line_width_value = 1
 884             del self.option_dict[LINE_WIDTH]
 885
 886         for i in default_ly_options.keys ():
 887             if i not in self.option_dict.keys ():
 888                 self.option_dict[i] = default_ly_options[i]
 889
 890         if not has_line_width:
 891             if type == 'lilypond' or FRAGMENT in self.option_dict.keys ():
 892                 self.option_dict[RAGGED_RIGHT] = None
 893
 894             if type == 'lilypond':
 895                 if LINE_WIDTH in self.option_dict.keys ():
 896                     del self.option_dict[LINE_WIDTH]
 897             else:
 898                 if RAGGED_RIGHT in self.option_dict.keys ():
 899                     if LINE_WIDTH in self.option_dict.keys ():
 900                         del self.option_dict[LINE_WIDTH]
 901
 902             if QUOTE in self.option_dict.keys () or type == 'lilypond':
 903                 if LINE_WIDTH in self.option_dict.keys ():
 904                     del self.option_dict[LINE_WIDTH]
 905
 906         if not INDENT in self.option_dict.keys ():
 907             self.option_dict[INDENT] = '0\\mm'
 908
 909         # The QUOTE pattern from ly_options only emits the `line-width'
 910         # keyword.
 911         if has_line_width and QUOTE in self.option_dict.keys ():
 912             if no_line_width_value:
 913                 del self.option_dict[LINE_WIDTH]
 914             else:
 915                 del self.option_dict[QUOTE]
 916
 917     def compose_ly (self, code):
 918         if FRAGMENT in self.option_dict.keys ():
 919             body = FRAGMENT_LY
 920         else:
 921             body = FULL_LY
 922
 923         # Defaults.
 924         relative = 1
 925         override = {}
 926         # The original concept of the `exampleindent' option is broken.
 927         # It is not possible to get a sane value for @exampleindent at all
 928         # without processing the document itself.  Saying
 929         #
 930         #   @exampleindent 0
 931         #   @example
 932         #   ...
 933         #   @end example
 934         #   @exampleindent 5
 935         #
 936         # causes ugly results with the DVI backend of texinfo since the
 937         # default value for @exampleindent isn't 5em but 0.4in (or a smaller
 938         # value).  Executing the above code changes the environment
 939         # indentation to an unknown value because we don't know the amount
 940         # of 1em in advance since it is font-dependent.  Modifying
 941         # @exampleindent in the middle of a document is simply not
 942         # supported within texinfo.
 943         #
 944         # As a consequence, the only function of @exampleindent is now to
 945         # specify the amount of indentation for the `quote' option.
 946         #
 947         # To set @exampleindent locally to zero, we use the @format
 948         # environment for non-quoted snippets.
 949         override[EXAMPLEINDENT] = r'0.4\in'
 950         override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
 951         override.update (default_ly_options)
 952
 953         option_list = []
 954         for (key, value) in self.option_dict.items ():
 955             if value == None:
 956                 option_list.append (key)
 957             else:
 958                 option_list.append (key + '=' + value)
 959         option_string = string.join (option_list, ',')
 960
 961         compose_dict = {}
 962         compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
 963         for a in compose_types:
 964             compose_dict[a] = []
 965
 966         for (key, value) in self.option_dict.items ():
 967             (c_key, c_value) = \
 968              classic_lilypond_book_compatibility (key, value)
 969             if c_key:
 970                 if c_value:
 971                     warning \
 972                      (_ ("deprecated ly-option used: %s=%s" \
 973                       % (key, value)))
 974                     warning \
 975                      (_ ("compatibility mode translation: %s=%s" \
 976                       % (c_key, c_value)))
 977                 else:
 978                     warning \
 979                      (_ ("deprecated ly-option used: %s" \
 980                       % key))
 981                     warning \
 982                      (_ ("compatibility mode translation: %s" \
 983                       % c_key))
 984
 985                 (key, value) = (c_key, c_value)
 986
 987             if value:
 988                 override[key] = value
 989             else:
 990                 if not override.has_key (key):
 991                     override[key] = None
 992
 993             found = 0
 994             for type in compose_types:
 995                 if ly_options[type].has_key (key):
 996                     compose_dict[type].append (ly_options[type][key])
 997                     found = 1
 998                     break
 999
1000             if not found and key not in simple_options:
1001                 warning (_ ("ignoring unknown ly option: %s") % key)
1002
1003         # URGS
1004         if RELATIVE in override.keys () and override[RELATIVE]:
1005             relative = int (override[RELATIVE])
1006
1007         relative_quotes = ''
1008
1009         # 1 = central C
1010         if relative < 0:
1011             relative_quotes += ',' * (- relative)
1012         elif relative > 0:
1013             relative_quotes += "'" * relative
1014
1015         paper_string = string.join (compose_dict[PAPER],
1016                       '\n  ') % override
1017         layout_string = string.join (compose_dict[LAYOUT],
1018                       '\n  ') % override
1019         notes_string = string.join (compose_dict[NOTES],
1020                       '\n  ') % vars ()
1021         preamble_string = string.join (compose_dict[PREAMBLE],
1022                        '\n  ') % override
1023
1024         font_dump_setting = ''
1025         if FONTLOAD in self.option_dict:
1026             font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1027
1028         d = globals().copy()
1029         d.update (locals())
1030         return (PREAMBLE_LY + body) % d
1031
1032     # TODO: Use md5?
1033     def get_hash (self):
1034         if not self.hash:
1035             self.hash = abs (hash (self.full_ly ()))
1036         return self.hash
1037
1038     def basename (self):
1039         if FILENAME in self.option_dict:
1040             return self.option_dict[FILENAME]
1041         if global_options.use_hash:
1042             return 'lily-%d' % self.get_hash ()
1043         raise 'to be done'
1044
1045     def write_ly (self):
1046         outf = open (self.basename () + '.ly', 'w')
1047         outf.write (self.full_ly ())
1048
1049         open (self.basename () + '.txt', 'w').write ('image of music')
1050
1051     def ly_is_outdated (self):
1052         base = self.basename ()
1053
1054         tex_file = '%s.tex' % base
1055         eps_file = '%s.eps' % base
1056         system_file = '%s-systems.tex' % base
1057         ly_file = '%s.ly' % base
1058         ok = os.path.exists (ly_file) \
1059           and os.path.exists (system_file)\
1060           and os.stat (system_file)[stat.ST_SIZE] \
1061           and re.match ('% eof', open (system_file).readlines ()[-1])
1062         if ok and (not global_options.use_hash or FILENAME in self.option_dict):
1063             ok = (self.full_ly () == open (ly_file).read ())
1064         if ok:
1065             # TODO: Do something smart with target formats
1066             #       (ps, png) and m/ctimes.
1067             return None
1068         return self
1069
1070     def png_is_outdated (self):
1071         base = self.basename ()
1072         ok = not self.ly_is_outdated ()
1073         if global_options.format in (HTML, TEXINFO):
1074             ok = ok and os.path.exists (base + '.eps')
1075
1076             page_count = 0
1077             if ok:
1078                 page_count = ps_page_count (base + '.eps')
1079
1080             if page_count <= 1:
1081                 ok = ok and os.path.exists (base + '.png')
1082
1083             elif page_count > 1:
1084                 for a in range (1, page_count + 1):
1085                         ok = ok and os.path.exists (base + '-page%d.png' % a)
1086
1087         return not ok
1088
1089     def texstr_is_outdated (self):
1090         if backend == 'ps':
1091             return 0
1092
1093         base = self.basename ()
1094         ok = self.ly_is_outdated ()
1095         ok = ok and (os.path.exists (base + '.texstr'))
1096         return not ok
1097
1098     def filter_text (self):
1099         code = self.substring ('code')
1100         s = run_filter (code)
1101         d = {
1102             'code': s,
1103             'options': self.match.group ('options')
1104         }
1105         # TODO
1106         return output[self.format][FILTER] % d
1107
1108     def replacement_text (self):
1109         func = Lilypond_snippet.__dict__['output_' + self.format]
1110         return func (self)
1111
1112     def get_images (self):
1113         base = self.basename ()
1114         # URGUGHUGHUGUGH
1115         single = '%(base)s.png' % vars ()
1116         multiple = '%(base)s-page1.png' % vars ()
1117         images = (single,)
1118         if os.path.exists (multiple) \
1119          and (not os.path.exists (single) \
1120             or (os.stat (multiple)[stat.ST_MTIME] \
1121               > os.stat (single)[stat.ST_MTIME])):
1122             count = ps_page_count ('%(base)s.eps' % vars ())
1123             images = ['%s-page%d.png' % (base, a) for a in range (1, count+1)]
1124             images = tuple (images)
1125         return images
1126
1127     def output_html (self):
1128         str = ''
1129         base = self.basename ()
1130         if global_options.format == HTML:
1131             str += self.output_print_filename (HTML)
1132             if VERBATIM in self.option_dict:
1133                 verb = verbatim_html (self.substring ('code'))
1134                 str += output[HTML][VERBATIM] % vars ()
1135             if QUOTE in self.option_dict:
1136                 str = output[HTML][QUOTE] % vars ()
1137
1138         str += output[HTML][BEFORE] % vars ()
1139         for image in self.get_images ():
1140             (base, ext) = os.path.splitext (image)
1141             alt = self.option_dict[ALT]
1142             str += output[HTML][OUTPUT] % vars ()
1143         str += output[HTML][AFTER] % vars ()
1144         return str
1145
1146     def output_info (self):
1147         str = ''
1148         for image in self.get_images ():
1149             (base, ext) = os.path.splitext (image)
1150
1151             # URG, makeinfo implicitly prepends dot to extension.
1152             # Specifying no extension is most robust.
1153             ext = ''
1154             alt = self.option_dict[ALT]
1155             str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1156
1157         base = self.basename ()
1158         str += output[global_options.format][OUTPUT] % vars ()
1159         return str
1160
1161     def output_latex (self):
1162         str = ''
1163         base = self.basename ()
1164         if global_options.format == LATEX:
1165             str += self.output_print_filename (LATEX)
1166             if VERBATIM in self.option_dict:
1167                 verb = self.substring ('code')
1168                 str += (output[LATEX][VERBATIM] % vars ())
1169
1170         str += (output[LATEX][OUTPUT] % vars ())
1171
1172         ## todo: maintain breaks
1173         if 0:
1174             breaks = self.ly ().count ("\n")
1175             str += "".ljust (breaks, "\n").replace ("\n","%\n")
1176
1177         if QUOTE in self.option_dict:
1178             str = output[LATEX][QUOTE] % vars ()
1179         return str
1180
1181     def output_print_filename (self, format):
1182         str = ''
1183         if PRINTFILENAME in self.option_dict:
1184             base = self.basename ()
1185             filename = self.substring ('filename')
1186             str = output[global_options.format][PRINTFILENAME] % vars ()
1187
1188         return str
1189
1190     def output_texinfo (self):
1191         str = ''
1192         if self.output_print_filename (TEXINFO):
1193             str += ('@html\n'
1194                 + self.output_print_filename (HTML)
1195                 + '\n@end html\n')
1196             str += ('@tex\n'
1197                 + self.output_print_filename (LATEX)
1198                 + '\n@end tex\n')
1199         base = self.basename ()
1200         if TEXIDOC in self.option_dict:
1201             texidoc = base + '.texidoc'
1202             if os.path.exists (texidoc):
1203                 str += '@include %(texidoc)s\n\n' % vars ()
1204
1205         if VERBATIM in self.option_dict:
1206             verb = self.substring ('code')
1207             str += (output[TEXINFO][VERBATIM] % vars ())
1208             if not QUOTE in self.option_dict:
1209                 str = output[TEXINFO][NOQUOTE] % vars ()
1210
1211         str += self.output_info ()
1212
1213 #                str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1214 #                str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1215 #                str += ('@html\n' + self.output_html () + '\n@end html\n')
1216
1217         if QUOTE in self.option_dict:
1218             str = output[TEXINFO][QUOTE] % vars ()
1219
1220         # need par after image
1221         str += '\n'
1222
1223         return str
1224
1225 class Lilypond_file_snippet (Lilypond_snippet):
1226     def ly (self):
1227         name = self.substring ('filename')
1228         contents = open (find_file (name)).read ()
1229
1230         ## strip version string to make automated regtest comparisons
1231         ## across versions easier.
1232         contents = re.sub (r'\\version *"[^"]*"', '', contents)
1233
1234         return ('\\sourcefilename \"%s\"\n%s'
1235                 % (name, contents).read ()))
1236
1237 snippet_type_to_class = {
1238     'lilypond_file': Lilypond_file_snippet,
1239     'lilypond_block': Lilypond_snippet,
1240     'lilypond': Lilypond_snippet,
1241     'include': Include_snippet,
1242 }
1243
1244 def find_linestarts (s):
1245     nls = [0]
1246     start = 0
1247     end = len (s)
1248     while 1:
1249         i = s.find ('\n', start)
1250         if i < 0:
1251             break
1252
1253         i = i + 1
1254         nls.append (i)
1255         start = i
1256
1257     nls.append (len (s))
1258     return nls
1259
1260 def find_toplevel_snippets (s, types):
1261     res = {}
1262     for i in types:
1263         res[i] = ly.re.compile (snippet_res[global_options.format][i])
1264
1265     snippets = []
1266     index = 0
1267     found = dict ((t, None) for t in types))
1268
1269     line_starts = find_linestarts (s)
1270     line_start_idx = 0
1271     # We want to search for multiple regexes, without searching
1272     # the string multiple times for one regex.
1273     # Hence, we use earlier results to limit the string portion
1274     # where we search.
1275     # Since every part of the string is traversed at most once for
1276     # every type of snippet, this is linear.
1277
1278     while 1:
1279         first = None
1280         endex = 1 << 30
1281         for type in types:
1282             if not found[type] or found[type][0] < index:
1283                 found[type] = None
1284
1285                 m = res[type].search (s[index:endex])
1286                 if not m:
1287                     continue
1288
1289                 cl = Snippet
1290                 if snippet_type_to_class.has_key (type):
1291                     cl = snippet_type_to_class[type]
1292
1293
1294                 start = index + m.start ('match')
1295                 line_number = line_start_idx
1296                 while (line_starts[line_number] < start):
1297                     line_number += 1
1298
1299                 line_number += 1
1300                 snip = cl (type, m, global_options.format, line_number)
1301
1302                 found[type] = (start, snip)
1303
1304             if found[type] \
1305              and (not first \
1306                 or found[type][0] < found[first][0]):
1307                 first = type
1308
1309                 # FIXME.
1310
1311                 # Limiting the search space is a cute
1312                 # idea, but this *requires* to search
1313                 # for possible containing blocks
1314                 # first, at least as long as we do not
1315                 # search for the start of blocks, but
1316                 # always/directly for the entire
1317                 # @block ... @end block.
1318
1319                 endex = found[first][0]
1320
1321         if not first:
1322             snippets.append (Substring (s, index, len (s), line_start_idx))
1323             break
1324
1325         while (start > line_starts[line_start_idx+1]):
1326             line_start_idx += 1
1327
1328         (start, snip) = found[first]
1329         snippets.append (Substring (s, index, start, line_start_idx + 1))
1330         snippets.append (snip)
1331         found[first] = None
1332         index = start + len (snip.match.group ('match'))
1333
1334     return snippets
1335
1336 def filter_pipe (input, cmd):
1337     if global_options.verbose:
1338         progress (_ ("Opening filter `%s'") % cmd)
1339
1340     (stdin, stdout, stderr) = os.popen3 (cmd)
1341     stdin.write (input)
1342     status = stdin.close ()
1343
1344     if not status:
1345         status = 0
1346         output = stdout.read ()
1347         status = stdout.close ()
1348         error = stderr.read ()
1349
1350     if not status:
1351         status = 0
1352     signal = 0x0f & status
1353     if status or (not output and error):
1354         exit_status = status >> 8
1355         error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1356         error (_ ("The error log is as follows:"))
1357         sys.stderr.write (error)
1358         sys.stderr.write (stderr.read ())
1359         exit (status)
1360
1361     if global_options.verbose:
1362         progress ('\n')
1363
1364     return output
1365
1366 def run_filter (s):
1367     return filter_pipe (s, global_options.filter_cmd)
1368
1369 def is_derived_class (cl, baseclass):
1370     if cl == baseclass:
1371         return 1
1372     for b in cl.__bases__:
1373         if is_derived_class (b, baseclass):
1374             return 1
1375     return 0
1376
1377 def process_snippets (cmd, ly_snippets, texstr_snippets, png_snippets):
1378     ly_names = filter (lambda x: x,
1379                        map (Lilypond_snippet.basename, ly_snippets))
1380     texstr_names = filter (lambda x: x,
1381                            map (Lilypond_snippet.basename, texstr_snippets))
1382
1383     png_names = filter (lambda x: x,
1384                         map (Lilypond_snippet.basename, png_snippets))
1385
1386     status = 0
1387     def my_system (cmd):
1388         status = ly.system (cmd,
1389                   be_verbose=global_options.verbose,
1390                   progress_p= 1)
1391
1392     if global_options.format in (HTML, TEXINFO):
1393         cmd += ' --format png '
1394
1395     # UGH
1396     # the --process=CMD switch is a bad idea
1397     # it is too generic for lilypond-book.
1398     if texstr_names:
1399         my_system (string.join ([cmd, '--backend texstr',
1400                                  'snippet-map.ly'] + texstr_names))
1401         for l in texstr_names:
1402             my_system ('latex %s.texstr' % l)
1403
1404     if ly_names:
1405         my_system (string.join ([cmd, 'snippet-map.ly'] + ly_names))
1406
1407 LATEX_INSPECTION_DOCUMENT = r'''
1408 \nonstopmode
1409 %(preamble)s
1410 \begin{document}
1411 \typeout{textwidth=\the\textwidth}
1412 \typeout{columnsep=\the\columnsep}
1413 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1414 \end{document}
1415 '''
1416
1417 # Do we need anything else besides `textwidth'?
1418 def get_latex_textwidth (source):
1419     m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1420     if m == None:
1421         warning (_ ("Can't find \\begin{document} in LaTeX document"))
1422
1423         ## what's a sensible default?
1424         return 550.0
1425
1426     preamble = source[:m.start (0)]
1427     latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1428
1429     (handle, tmpfile) = tempfile.mkstemp('.tex')
1430     logfile = os.path.splitext (tmpfile)[0] + '.log'
1431     logfile = os.path.split (logfile)[1]
1432
1433     tmp_handle = os.fdopen (handle,'w')
1434     tmp_handle.write (latex_document)
1435     tmp_handle.close ()
1436
1437     ly.system ('latex %s' % tmpfile, be_verbose=global_options.verbose)
1438     parameter_string = open (logfile).read()
1439
1440     os.unlink (tmpfile)
1441     os.unlink (logfile)
1442
1443     columns = 0
1444     m = re.search ('columns=([0-9.]*)', parameter_string)
1445     if m:
1446         columns = int (m.group (1))
1447
1448     columnsep = 0
1449     m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1450     if m:
1451         columnsep = float (m.group (1))
1452
1453     textwidth = 0
1454     m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1455     if m:
1456         textwidth = float (m.group (1))
1457         if columns:
1458             textwidth = (textwidth - columnsep) / columns
1459
1460     return textwidth
1461
1462 def modify_preamble (chunk):
1463     str = chunk.replacement_text ()
1464     if (re.search (r"\\begin *{document}", str)
1465       and not re.search ("{graphic[sx]", str)):
1466         str = re.sub (r"\\begin{document}",
1467                r"\\usepackage{graphics}" + '\n'
1468                + r"\\begin{document}",
1469                str)
1470         chunk.override_text = str
1471
1472
1473
1474 ext2format = {
1475     '.html': HTML,
1476     '.itely': TEXINFO,
1477     '.latex': LATEX,
1478     '.lytex': LATEX,
1479     '.tely': TEXINFO,
1480     '.tex': LATEX,
1481     '.texi': TEXINFO,
1482     '.texinfo': TEXINFO,
1483     '.xml': HTML,
1484 }
1485
1486 format2ext = {
1487     HTML: '.html',
1488     # TEXINFO: '.texinfo',
1489     TEXINFO: '.texi',
1490     LATEX: '.tex',
1491 }
1492
1493 class Compile_error:
1494     pass
1495
1496 def write_file_map (lys, name):
1497     snippet_map = open ('snippet-map.ly', 'w')
1498     snippet_map.write ("""
1499 #(define version-seen? #t)
1500 #(ly:add-file-name-alist '(
1501 """)
1502     for ly in lys:
1503         snippet_map.write ('("%s.ly" . "%s:%d (%s.ly)")\n'
1504                  % (ly.basename (),
1505                    name,
1506                    ly.line_number,
1507                    ly.basename ()))
1508
1509     snippet_map.write ('))\n')
1510
1511 def do_process_cmd (chunks, input_name):
1512     all_lys = filter (lambda x: is_derived_class (x.__class__,
1513                            Lilypond_snippet),
1514              chunks)
1515
1516     write_file_map (all_lys, input_name)
1517     ly_outdated = filter (lambda x: is_derived_class (x.__class__,
1518                                                       Lilypond_snippet)
1519                           and x.ly_is_outdated (), chunks)
1520     texstr_outdated = filter (lambda x: is_derived_class (x.__class__,
1521                                                           Lilypond_snippet)
1522                               and x.texstr_is_outdated (),
1523                               chunks)
1524     png_outdated = filter (lambda x: is_derived_class (x.__class__,
1525                                                         Lilypond_snippet)
1526                            and x.png_is_outdated (),
1527                            chunks)
1528
1529     outdated = png_outdated + texstr_outdated + ly_outdated
1530
1531     progress (_ ("Writing snippets..."))
1532     map (Lilypond_snippet.write_ly, ly_outdated)
1533     progress ('\n')
1534
1535     if outdated:
1536         progress (_ ("Processing..."))
1537         progress ('\n')
1538         process_snippets (global_options.process_cmd, ly_outdated, texstr_outdated, png_outdated)
1539     else:
1540         progress (_ ("All snippets are up to date..."))
1541     progress ('\n')
1542
1543 def guess_format (input_filename):
1544     format = None
1545     e = os.path.splitext (input_filename)[1]
1546     if e in ext2format.keys ():
1547         # FIXME
1548         format = ext2format[e]
1549     else:
1550         error (_ ("can't determine format for: %s" \
1551               % input_filename))
1552         exit (1)
1553     return format
1554
1555 def write_if_updated (file_name, lines):
1556     try:
1557         f = open (file_name)
1558         oldstr = f.read ()
1559         new_str = string.join (lines, '')
1560         if oldstr == new_str:
1561             progress (_ ("%s is up to date.") % file_name)
1562             progress ('\n')
1563             return
1564     except:
1565         pass
1566
1567     progress (_ ("Writing `%s'...") % file_name)
1568     open (file_name, 'w').writelines (lines)
1569     progress ('\n')
1570
1571 def note_input_file (name, inputs=[]):
1572     ## hack: inputs is mutable!
1573     inputs.append (name)
1574     return inputs
1575
1576 def samefile (f1, f2):
1577     try:
1578         return os.path.samefile (f1, f2)
1579     except AttributeError:                # Windoze
1580         f1 = re.sub ("//*", "/", f1)
1581         f2 = re.sub ("//*", "/", f2)
1582         return f1 == f2
1583
1584 def do_file (input_filename):
1585     # Ugh.
1586     if not input_filename or input_filename == '-':
1587         in_handle = sys.stdin
1588         input_fullname = '<stdin>'
1589     else:
1590         if os.path.exists (input_filename):
1591             input_fullname = input_filename
1592         elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1593             input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1594         else:
1595             input_fullname = find_file (input_filename)
1596
1597         note_input_file (input_fullname)
1598         in_handle = open (input_fullname)
1599
1600     if input_filename == '-':
1601         input_base = 'stdin'
1602     else:
1603         input_base = os.path.basename \
1604                      (os.path.splitext (input_filename)[0])
1605
1606     # Only default to stdout when filtering.
1607     if global_options.output_name == '-' or (not global_options.output_name and global_options.filter_cmd):
1608         output_filename = '-'
1609         output_file = sys.stdout
1610     else:
1611         # don't complain when global_options.output_name is existing
1612         output_filename = input_base + format2ext[global_options.format]
1613         if global_options.output_name:
1614             if not os.path.isdir (global_options.output_name):
1615                 os.mkdir (global_options.output_name, 0777)
1616             os.chdir (global_options.output_name)
1617         else:
1618             if (os.path.exists (input_filename)
1619                 and os.path.exists (output_filename)
1620                 and samefile (output_filename, input_fullname)):
1621              error (
1622              _ ("Output would overwrite input file; use --output."))
1623              exit (2)
1624
1625     try:
1626         progress (_ ("Reading %s...") % input_fullname)
1627         source = in_handle.read ()
1628         progress ('\n')
1629
1630         set_default_options (source)
1631
1632
1633         # FIXME: Containing blocks must be first, see
1634         #        find_toplevel_snippets.
1635         snippet_types = (
1636             'multiline_comment',
1637             'verbatim',
1638             'lilypond_block',
1639     #                'verb',
1640             'singleline_comment',
1641             'lilypond_file',
1642             'include',
1643             'lilypond',
1644         )
1645         progress (_ ("Dissecting..."))
1646         chunks = find_toplevel_snippets (source, snippet_types)
1647
1648         if global_options.format == LATEX:
1649             for c in chunks:
1650                 if (c.is_plain () and
1651                   re.search (r"\\begin *{document}", c.replacement_text())):
1652                     modify_preamble (c)
1653                     break
1654         progress ('\n')
1655
1656         if global_options.filter_cmd:
1657             write_if_updated (output_filename,
1658                      [c.filter_text () for c in chunks])
1659         elif global_options.process_cmd:
1660             do_process_cmd (chunks, input_fullname)
1661             progress (_ ("Compiling %s...") % output_filename)
1662             progress ('\n')
1663             write_if_updated (output_filename,
1664                      [s.replacement_text ()
1665                      for s in chunks])
1666
1667         def process_include (snippet):
1668             os.chdir (original_dir)
1669             name = snippet.substring ('filename')
1670             progress (_ ("Processing include: %s") % name)
1671             progress ('\n')
1672             return do_file (name)
1673
1674         include_chunks = map (process_include,
1675                    filter (lambda x: is_derived_class (x.__class__,
1676                                      Include_snippet),
1677                        chunks))
1678
1679
1680         return chunks + reduce (lambda x,y: x + y, include_chunks, [])
1681
1682     except Compile_error:
1683         os.chdir (original_dir)
1684         progress (_ ("Removing `%s'") % output_filename)
1685         progress ('\n')
1686         raise Compile_error
1687
1688 def do_options ():
1689
1690     global global_options
1691
1692     opt_parser = get_option_parser()
1693     (global_options, args) = opt_parser.parse_args ()
1694
1695     if global_options.format in ('texi-html', 'texi'):
1696         global_options.format = TEXINFO
1697     global_options.use_hash = True
1698
1699     global_options.include_path =  map (os.path.abspath, global_options.include_path)
1700
1701     if global_options.warranty:
1702         warranty ()
1703         exit (0)
1704     if not args or len (args) > 1:
1705         opt_parser.print_help ()
1706         exit (2)
1707
1708     return args
1709
1710 def main ():
1711     files = do_options ()
1712
1713     file = files[0]
1714
1715     basename = os.path.splitext (file)[0]
1716     basename = os.path.split (basename)[1]
1717
1718     if not global_options.format:
1719         global_options.format = guess_format (files[0])
1720
1721     formats = 'ps'
1722     if global_options.format in (TEXINFO, HTML):
1723         formats += ',png'
1724     if global_options.process_cmd == '':
1725         global_options.process_cmd = lilypond_binary \
1726                + ' --formats=%s --backend eps ' % formats
1727
1728     if global_options.process_cmd:
1729         global_options.process_cmd += string.join ([(' -I %s' % commands.mkarg (p))
1730                               for p in global_options.include_path])
1731
1732     identify ()
1733
1734     try:
1735         chunks = do_file (file)
1736         if global_options.psfonts:
1737             fontextract.verbose = global_options.verbose
1738             snippet_chunks = filter (lambda x: is_derived_class (x.__class__,
1739                                        Lilypond_snippet),
1740                         chunks)
1741
1742             psfonts_file = basename + '.psfonts'
1743             if not global_options.verbose:
1744                 progress (_ ("Writing fonts to %s...") % psfonts_file)
1745             fontextract.extract_fonts (psfonts_file,
1746                          [x.basename() + '.eps'
1747                           for x in snippet_chunks])
1748             if not global_options.verbose:
1749                 progress ('\n')
1750
1751     except Compile_error:
1752         exit (1)
1753
1754     if global_options.format in (TEXINFO, LATEX):
1755         if not global_options.psfonts:
1756             warning (_ ("option --psfonts not used"))
1757             warning (_ ("processing with dvips will have no fonts"))
1758
1759         psfonts_file = os.path.join (global_options.output_name, basename + '.psfonts')
1760         output = os.path.join (global_options.output_name, basename +  '.dvi' )
1761
1762         progress ('\n')
1763         progress (_ ("DVIPS usage:"))
1764         progress ('\n')
1765         progress ("    dvips -h %(psfonts_file)s %(output)s" % vars ())
1766         progress ('\n')
1767
1768     inputs = note_input_file ('')
1769     inputs.pop ()
1770
1771     base_file_name = os.path.splitext (os.path.basename (file))[0]
1772     dep_file = os.path.join (global_options.output_name, base_file_name + '.dep')
1773     final_output_file = os.path.join (global_options.output_name,
1774                      base_file_name
1775                      + '.%s' % global_options.format)
1776
1777     os.chdir (original_dir)
1778     open (dep_file, 'w').write ('%s: %s' % (final_output_file, ' '.join (inputs)))
1779
1780 if __name__ == '__main__':
1781     main ()