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