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