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 ('--lily-output-dir',
 150                   help=_ ("write lily-XXX files to DIR, link into --output dir."),
 151                   metavar=_ ("DIR"),
 152                   action='store', dest='lily_output_dir',
 153                   default=None)
 154
 155     p.add_option ('-P', '--process', metavar=_ ("COMMAND"),
 156                   help = _ ("process ly_files using COMMAND FILE..."),
 157                   action='store',
 158                   dest='process_cmd', default='')
 159
 160     p.add_option ('--pdf',
 161                   action="store_true",
 162                   dest="create_pdf",
 163                   help=_ ("create PDF files for use with PDFTeX"),
 164                   default=False)
 165
 166     p.add_option ('', '--psfonts', action="store_true", dest="psfonts",
 167                   help=_ ('''extract all PostScript fonts into INPUT.psfonts for LaTeX
 168 must use this with dvips -h INPUT.psfonts'''),
 169                   default=None)
 170
 171     p.add_option ('-V', '--verbose', help=_ ("be verbose"),
 172                   action="store_true",
 173                   default=False,
 174                   dest="verbose")
 175
 176     p.version = "@TOPLEVEL_VERSION@"
 177     p.add_option("--version",
 178                  action="version",
 179                  help=_ ("show version number and exit"))
 180
 181     p.add_option ('-w', '--warranty',
 182                   help=_ ("show warranty and copyright"),
 183                   action='store_true')
 184     p.add_option_group (ly.display_encode (_ ('Bugs')),
 185                         description=(
 186         _ ("Report bugs via")
 187         + ' http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs\n'))
 188     return p
 189
 190 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
 191
 192 # Only use installed binary when we are installed too.
 193 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
 194     lilypond_binary = 'lilypond'
 195
 196 global_options = None
 197
 198
 199 default_ly_options = { 'alt': "[image of music]" }
 200
 201 #
 202 # Is this pythonic?  Personally, I find this rather #define-nesque. --hwn
 203 #
 204 ADDVERSION = 'addversion'
 205 AFTER = 'after'
 206 BEFORE = 'before'
 207 DOCBOOK = 'docbook'
 208 EXAMPLEINDENT = 'exampleindent'
 209 FILTER = 'filter'
 210 FRAGMENT = 'fragment'
 211 HTML = 'html'
 212 INDENT = 'indent'
 213 LANG = 'lang'
 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     LANG,
 521     VERBATIM,
 522     FONTLOAD,
 523     FILENAME,
 524     ALT,
 525     ADDVERSION
 526 ]
 527
 528 ly_options = {
 529     ##
 530     NOTES: {
 531         RELATIVE: r'''\relative c%(relative_quotes)s''',
 532     },
 533
 534     ##
 535     PAPER: {
 536         INDENT: r'''indent = %(indent)s''',
 537
 538         LINE_WIDTH: r'''line-width = %(line-width)s''',
 539
 540         QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
 541
 542         LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
 543
 544         RAGGED_RIGHT: r'''ragged-right = ##t''',
 545
 546         PACKED: r'''packed = ##t''',
 547     },
 548
 549     ##
 550     LAYOUT: {
 551         NOTIME: r'''
 552  \context {
 553   \Score
 554   timing = ##f
 555  }
 556  \context {
 557   \Staff
 558   \remove Time_signature_engraver
 559  }''',
 560     },
 561
 562     ##
 563     PREAMBLE: {
 564         STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
 565     },
 566 }
 567
 568 output = {
 569     ##
 570     DOCBOOK: {
 571         FILTER: r'''<mediaobject><textobject><programlisting language="lilypond" role="%(options)s">%(code)s</programlisting></textobject></mediaobject>''',
 572
 573         OUTPUT: r'''
 574         <imageobject role="latex">
 575                 <imagedata fileref="%(base)s.pdf" format="PDF"/>
 576                 </imageobject>
 577                 <imageobject role="html">
 578                 <imagedata fileref="%(base)s.png" format="PNG"/></imageobject>''',
 579
 580         VERBATIM: r'''<programlisting>%(verb)s</programlisting>''',
 581
 582         PRINTFILENAME: '<textobject><simpara><ulink url="%(base)s.ly"><filename>%(filename)s</filename></ulink></simpara></textobject>'
 583     },
 584     ##
 585     HTML: {
 586         FILTER: r'''<lilypond %(options)s>
 587 %(code)s
 588 </lilypond>
 589 ''',
 590
 591         AFTER: r'''
 592  </a>
 593 </p>''',
 594
 595         BEFORE: r'''<p>
 596  <a href="%(base)s.ly">''',
 597
 598         OUTPUT: r'''
 599   <img align="middle"
 600     border="0" src="%(image)s" alt="%(alt)s">''',
 601
 602         PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
 603
 604         QUOTE: r'''<blockquote>
 605 %(str)s
 606 </blockquote>
 607 ''',
 608
 609         VERBATIM: r'''<pre>
 610 %(verb)s</pre>''',
 611     },
 612
 613     ##
 614     LATEX: {
 615         OUTPUT: r'''{%%
 616 \parindent 0pt%%
 617 \ifx\preLilyPondExample \undefined%%
 618  \relax%%
 619 \else%%
 620  \preLilyPondExample%%
 621 \fi%%
 622 \def\lilypondbook{}%%
 623 \input %(base)s-systems.tex%%
 624 \ifx\postLilyPondExample \undefined%%
 625  \relax%%
 626 \else%%
 627  \postLilyPondExample%%
 628 \fi%%
 629 }''',
 630
 631         PRINTFILENAME: '''\\texttt{%(filename)s}
 632     ''',
 633
 634         QUOTE: r'''\begin{quotation}%(str)s
 635 \end{quotation}''',
 636
 637         VERBATIM: r'''\noindent
 638 \begin{verbatim}%(verb)s\end{verbatim}''',
 639
 640         FILTER: r'''\begin{lilypond}[%(options)s]
 641 %(code)s
 642 \end{lilypond}''',
 643     },
 644
 645     ##
 646     TEXINFO: {
 647         FILTER: r'''@lilypond[%(options)s]
 648 %(code)s
 649 @lilypond''',
 650
 651         OUTPUT: r'''
 652 @iftex
 653 @include %(base)s-systems.texi
 654 @end iftex
 655 ''',
 656
 657         OUTPUTIMAGE: r'''@noindent
 658 @ifinfo
 659 @image{%(info_image_path)s,,,%(alt)s,%(ext)s}
 660 @end ifinfo
 661 @html
 662 <p>
 663  <a href="%(base)s.ly">
 664   <img align="middle"
 665     border="0" src="%(image)s" alt="%(alt)s">
 666  </a>
 667 </p>
 668 @end html
 669 ''',
 670
 671         PRINTFILENAME: '''
 672 @html
 673 <a href="%(base)s.ly">
 674 @end html
 675 @file{%(filename)s}
 676 @html
 677 </a>
 678 @end html
 679     ''',
 680
 681         QUOTE: r'''@quotation
 682 %(str)s@end quotation
 683 ''',
 684
 685         NOQUOTE: r'''@format
 686 %(str)s@end format
 687 ''',
 688
 689         VERBATIM: r'''@exampleindent 0
 690 %(version)s@verbatim
 691 %(verb)s@end verbatim
 692 ''',
 693
 694         ADDVERSION: r'''@example
 695 \version @w{"@version{}"}
 696 @end example
 697 '''
 698     },
 699 }
 700
 701 #
 702 # Maintain line numbers.
 703 #
 704
 705 ## TODO
 706 if 0:
 707     for f in [HTML, LATEX]:
 708         for s in (QUOTE, VERBATIM):
 709             output[f][s] = output[f][s].replace("\n"," ")
 710
 711
 712 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
 713 %%%% Options: [%(option_string)s]
 714 \\include "lilypond-book-preamble.ly"
 715
 716
 717 %% ****************************************************************
 718 %% Start cut-&-pastable-section
 719 %% ****************************************************************
 720
 721 %(preamble_string)s
 722
 723 \paper {
 724   #(define dump-extents #t)
 725   %(font_dump_setting)s
 726   %(paper_string)s
 727   force-assignment = #""
 728   line-width = #(- line-width (* mm  %(padding_mm)f))
 729 }
 730
 731 \layout {
 732   %(layout_string)s
 733 }
 734 '''
 735
 736 FRAGMENT_LY = r'''
 737 %(notes_string)s
 738 {
 739
 740
 741 %% ****************************************************************
 742 %% ly snippet contents follows:
 743 %% ****************************************************************
 744 %(code)s
 745
 746
 747 %% ****************************************************************
 748 %% end ly snippet
 749 %% ****************************************************************
 750 }
 751 '''
 752
 753 FULL_LY = '''
 754
 755
 756 %% ****************************************************************
 757 %% ly snippet:
 758 %% ****************************************************************
 759 %(code)s
 760
 761
 762 %% ****************************************************************
 763 %% end ly snippet
 764 %% ****************************************************************
 765 '''
 766
 767 texinfo_line_widths = {
 768     '@afourpaper': '160\\mm',
 769     '@afourwide': '6.5\\in',
 770     '@afourlatex': '150\\mm',
 771     '@smallbook': '5\\in',
 772     '@letterpaper': '6\\in',
 773 }
 774
 775 def classic_lilypond_book_compatibility (key, value):
 776     if key == 'singleline' and value == None:
 777         return (RAGGED_RIGHT, None)
 778
 779     m = re.search ('relative\s*([-0-9])', key)
 780     if m:
 781         return ('relative', m.group (1))
 782
 783     m = re.match ('([0-9]+)pt', key)
 784     if m:
 785         return ('staffsize', m.group (1))
 786
 787     if key == 'indent' or key == 'line-width':
 788         m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
 789         if m:
 790             f = float (m.group (1))
 791             return (key, '%f\\%s' % (f, m.group (2)))
 792
 793     return (None, None)
 794
 795 def find_file (name, raise_error=True):
 796     for i in global_options.include_path:
 797         full = os.path.join (i, name)
 798         if os.path.exists (full):
 799             return full
 800
 801     if raise_error:
 802         error (_ ("file not found: %s") % name + '\n')
 803         exit (1)
 804     return ''
 805
 806 def verbatim_html (s):
 807     return re.sub ('>', '&gt;',
 808            re.sub ('<', '&lt;',
 809                re.sub ('&', '&amp;', s)))
 810
 811
 812 texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)')
 813 def set_default_options (source, default_ly_options, format):
 814     if LINE_WIDTH not in default_ly_options:
 815         if format == LATEX:
 816             textwidth = get_latex_textwidth (source)
 817             default_ly_options[LINE_WIDTH] = '%.0f\\pt' % textwidth
 818         elif format == TEXINFO:
 819             m = texinfo_lang_re.search (source)
 820             if m and not m.group (1).startswith ('en'):
 821                 default_ly_options[LANG] = m.group (1)
 822             else:
 823                 default_ly_options[LANG] = ''
 824             for regex in texinfo_line_widths:
 825                 # FIXME: @layout is usually not in
 826                 # chunk #0:
 827                 #
 828                 #  \input texinfo @c -*-texinfo-*-
 829                 #
 830                 # Bluntly search first K items of
 831                 # source.
 832                 # s = chunks[0].replacement_text ()
 833                 if re.search (regex, source[:1024]):
 834                     default_ly_options[LINE_WIDTH] = texinfo_line_widths[regex]
 835                     break
 836
 837 class Chunk:
 838     def replacement_text (self):
 839         return ''
 840
 841     def filter_text (self):
 842         return self.replacement_text ()
 843
 844     def is_plain (self):
 845         return False
 846
 847 class Substring (Chunk):
 848     """A string that does not require extra memory."""
 849     def __init__ (self, source, start, end, line_number):
 850         self.source = source
 851         self.start = start
 852         self.end = end
 853         self.line_number = line_number
 854         self.override_text = None
 855
 856     def is_plain (self):
 857         return True
 858
 859     def replacement_text (self):
 860         if self.override_text:
 861             return self.override_text
 862         else:
 863             return self.source[self.start:self.end]
 864
 865 class Snippet (Chunk):
 866     def __init__ (self, type, match, format, line_number):
 867         self.type = type
 868         self.match = match
 869         self.checksum = 0
 870         self.option_dict = {}
 871         self.format = format
 872         self.line_number = line_number
 873
 874     def replacement_text (self):
 875         return self.match.group ('match')
 876
 877     def substring (self, s):
 878         return self.match.group (s)
 879
 880     def __repr__ (self):
 881         return `self.__class__` + ' type = ' + self.type
 882
 883 class IncludeSnippet (Snippet):
 884     def processed_filename (self):
 885         f = self.substring ('filename')
 886         return os.path.splitext (f)[0] + format2ext[self.format]
 887
 888     def replacement_text (self):
 889         s = self.match.group ('match')
 890         f = self.substring ('filename')
 891
 892         return re.sub (f, self.processed_filename (), s)
 893
 894 class LilypondSnippet (Snippet):
 895     def __init__ (self, type, match, format, line_number):
 896         Snippet.__init__ (self, type, match, format, line_number)
 897         os = match.group ('options')
 898         self.do_options (os, self.type)
 899
 900     def verb_ly (self):
 901         return self.substring ('code')
 902
 903     def ly (self):
 904         contents = self.substring ('code')
 905         return ('\\sourcefileline %d\n%s'
 906                 % (self.line_number - 1, contents))
 907
 908     def full_ly (self):
 909         s = self.ly ()
 910         if s:
 911             return self.compose_ly (s)
 912         return ''
 913
 914     def split_options (self, 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 = self.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") % (key, value))
1037                     warning (
1038                         _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
1039                 else:
1040                     warning (
1041                         _ ("deprecated ly-option used: %s") % key)
1042                     warning (
1043                         _ ("compatibility mode translation: %s") % c_key)
1044
1045                 (key, value) = (c_key, c_value)
1046
1047             if value:
1048                 override[key] = value
1049             else:
1050                 if not override.has_key (key):
1051                     override[key] = None
1052
1053             found = 0
1054             for type in compose_types:
1055                 if ly_options[type].has_key (key):
1056                     compose_dict[type].append (ly_options[type][key])
1057                     found = 1
1058                     break
1059
1060             if not found and key not in simple_options:
1061                 warning (_ ("ignoring unknown ly option: %s") % key)
1062
1063         # URGS
1064         if RELATIVE in override and override[RELATIVE]:
1065             relative = int (override[RELATIVE])
1066
1067         relative_quotes = ''
1068
1069         # 1 = central C
1070         if relative < 0:
1071             relative_quotes += ',' * (- relative)
1072         elif relative > 0:
1073             relative_quotes += "'" * relative
1074
1075         paper_string = '\n  '.join (compose_dict[PAPER]) % override
1076         layout_string = '\n  '.join (compose_dict[LAYOUT]) % override
1077         notes_string = '\n  '.join (compose_dict[NOTES]) % vars ()
1078         preamble_string = '\n  '.join (compose_dict[PREAMBLE]) % override
1079         padding_mm = global_options.padding_mm
1080         font_dump_setting = ''
1081         if FONTLOAD in self.option_dict:
1082             font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1083
1084         d = globals().copy()
1085         d.update (locals())
1086         return (PREAMBLE_LY + body) % d
1087
1088     def get_checksum (self):
1089         if not self.checksum:
1090             hash = md5.md5 (self.relevant_contents (self.full_ly ()))
1091
1092             ## let's not create too long names.
1093             self.checksum = hash.hexdigest ()[:10]
1094
1095         return self.checksum
1096
1097     def basename (self):
1098         if FILENAME in self.option_dict:
1099             return self.option_dict[FILENAME]
1100
1101         cs = self.get_checksum ()
1102
1103         # TODO: use xx/xxxxx directory layout.
1104         name = 'lily-%s' % cs[:10]
1105         return name
1106
1107     def write_ly (self):
1108         base = self.basename ()
1109         path = os.path.join (global_options.lily_output_dir, base)
1110
1111         out = file (path + '.ly', 'w')
1112         out.write (self.full_ly ())
1113         file (path + '.txt', 'w').write ('image of music')
1114
1115     def relevant_contents (self, ly):
1116         return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
1117
1118     def link_all_output_files (self, output_dir, output_dir_files, destination):
1119         existing = self.all_output_files (output_dir, output_dir_files)
1120         for name in existing:
1121             try:
1122                 os.unlink (os.path.join (destination, name))
1123             except OSError:
1124                 pass
1125
1126             src = os.path.join (output_dir, name)
1127             dst = os.path.join (destination, name)
1128             os.link (src, dst)
1129
1130
1131     def all_output_files (self, output_dir, output_dir_files):
1132         """Return all files generated in lily_output_dir, a set.
1133
1134         output_dir_files is the list of files in the output directory.
1135         """
1136         class Missing(Exception):
1137             pass
1138
1139         result = set()
1140         base = self.basename()
1141         full = os.path.join (output_dir, base)
1142         def consider_file (name):
1143             if name in output_dir_files:
1144                 result.add (name)
1145
1146         def require_file (name):
1147             if name not in output_dir_files:
1148                 raise Missing
1149             result.add (name)
1150
1151         try:
1152             for required in [base + '.ly',
1153                              base + '.txt',
1154                              base + '-systems.count']:
1155                 require_file (required)
1156
1157             map (consider_file, [base + '.tex',
1158                                  base + '.eps',
1159                                  base + '.texidoc',
1160                                  base + '-systems.texi',
1161                                  base + '-systems.tex',
1162                                  base + '-systems.pdftexi'])
1163
1164             if base + '.eps' in result and self.format in (HTML, TEXINFO):
1165                 page_count = ps_page_count (full + '.eps')
1166                 if page_count <= 1:
1167                     require_file (base + '.png')
1168                 else:
1169                     for page in range (1, page_count + 1):
1170                         require_file (base + '-page%d.png' % page)
1171
1172             system_count = int(file (full + '-systems.count').read())
1173             for number in range(1, system_count + 1):
1174                 systemfile = '%s-%d' % (base, number)
1175                 require_file (systemfile + '.eps')
1176                 consider_file (systemfile + '.pdf')
1177         except Missing:
1178             return None
1179
1180         return result
1181
1182     def is_outdated (self, output_dir, current_files):
1183         return self.all_output_files (output_dir, current_files) is None
1184
1185     def filter_text (self):
1186         """Run snippet bodies through a command (say: convert-ly).
1187
1188         This functionality is rarely used, and this code must have bitrot.
1189         """
1190
1191         code = self.substring ('code')
1192         s = filter_pipe (code, global_options.filter_cmd)
1193         d = {
1194             'code': s,
1195             'options': self.match.group ('options')
1196         }
1197         # TODO
1198         return output[self.format][FILTER] % d
1199
1200     def replacement_text (self):
1201         func = LilypondSnippet.__dict__['output_' + self.format]
1202         return func (self)
1203
1204     def get_images (self):
1205         base = self.basename ()
1206
1207         single = '%(base)s.png' % vars ()
1208         multiple = '%(base)s-page1.png' % vars ()
1209         images = (single,)
1210         if (os.path.exists (multiple)
1211             and (not os.path.exists (single)
1212                  or (os.stat (multiple)[stat.ST_MTIME]
1213                      > os.stat (single)[stat.ST_MTIME]))):
1214             count = ps_page_count ('%(base)s.eps' % vars ())
1215             images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)]
1216             images = tuple (images)
1217
1218         return images
1219
1220     def output_docbook (self):
1221         str = ''
1222         base = self.basename ()
1223         for image in self.get_images ():
1224             (base, ext) = os.path.splitext (image)
1225             str += output[DOCBOOK][OUTPUT] % vars ()
1226             str += self.output_print_filename (DOCBOOK)
1227             if (self.substring('inline') == 'inline'):
1228                 str = '<inlinemediaobject>' + str + '</inlinemediaobject>'
1229             else:
1230                 str = '<mediaobject>' + str + '</mediaobject>'
1231         if VERBATIM in self.option_dict:
1232                 verb = verbatim_html (self.verb_ly ())
1233                 str = output[DOCBOOK][VERBATIM] % vars () + str
1234         return str
1235
1236     def output_html (self):
1237         str = ''
1238         base = self.basename ()
1239         if self.format == HTML:
1240             str += self.output_print_filename (HTML)
1241             if VERBATIM in self.option_dict:
1242                 verb = verbatim_html (self.verb_ly ())
1243                 str += output[HTML][VERBATIM] % vars ()
1244             if QUOTE in self.option_dict:
1245                 str = output[HTML][QUOTE] % vars ()
1246
1247         str += output[HTML][BEFORE] % vars ()
1248         for image in self.get_images ():
1249             (base, ext) = os.path.splitext (image)
1250             alt = self.option_dict[ALT]
1251             str += output[HTML][OUTPUT] % vars ()
1252         str += output[HTML][AFTER] % vars ()
1253         return str
1254
1255     def output_info (self):
1256         str = ''
1257         for image in self.get_images ():
1258             (base, ext) = os.path.splitext (image)
1259
1260             # URG, makeinfo implicitly prepends dot to extension.
1261             # Specifying no extension is most robust.
1262             ext = ''
1263             alt = self.option_dict[ALT]
1264             info_image_path = os.path.join (global_options.info_images_dir, base)
1265             str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1266
1267         base = self.basename ()
1268         str += output[self.format][OUTPUT] % vars ()
1269         return str
1270
1271     def output_latex (self):
1272         str = ''
1273         base = self.basename ()
1274         if self.format == LATEX:
1275             str += self.output_print_filename (LATEX)
1276             if VERBATIM in self.option_dict:
1277                 verb = self.verb_ly ()
1278                 str += (output[LATEX][VERBATIM] % vars ())
1279
1280         str += (output[LATEX][OUTPUT] % vars ())
1281
1282         ## todo: maintain breaks
1283         if 0:
1284             breaks = self.ly ().count ("\n")
1285             str += "".ljust (breaks, "\n").replace ("\n","%\n")
1286
1287         if QUOTE in self.option_dict:
1288             str = output[LATEX][QUOTE] % vars ()
1289         return str
1290
1291     def output_print_filename (self, format):
1292         str = ''
1293         if PRINTFILENAME in self.option_dict:
1294             base = self.basename ()
1295             filename = os.path.basename (self.substring ('filename'))
1296             str = output[format][PRINTFILENAME] % vars ()
1297
1298         return str
1299
1300     def output_texinfo (self):
1301         str = self.output_print_filename (TEXINFO)
1302         base = self.basename ()
1303         if TEXIDOC in self.option_dict:
1304             texidoc = base + '.texidoc'
1305             translated_texidoc = texidoc + default_ly_options[LANG]
1306             if os.path.exists (translated_texidoc):
1307                 str += '@include %(translated_texidoc)s\n\n' % vars ()
1308             elif os.path.exists (texidoc):
1309                 str += '@include %(texidoc)s\n\n' % vars ()
1310
1311         substr = ''
1312         if VERBATIM in self.option_dict:
1313             version = ''
1314             if ADDVERSION in self.option_dict:
1315                 version = output[TEXINFO][ADDVERSION]
1316             verb = self.verb_ly ()
1317             substr = output[TEXINFO][VERBATIM] % vars ()
1318         substr += self.output_info ()
1319         if LILYQUOTE in self.option_dict:
1320             substr = output[TEXINFO][QUOTE] % {'str':substr}
1321         str += substr
1322
1323 #                str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1324 #                str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1325 #                str += ('@html\n' + self.output_html () + '\n@end html\n')
1326
1327         if QUOTE in self.option_dict:
1328             str = output[TEXINFO][QUOTE] % vars ()
1329
1330         # need par after image
1331         str += '\n'
1332
1333         return str
1334
1335 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
1336 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
1337
1338 class LilypondFileSnippet (LilypondSnippet):
1339     def __init__ (self, type, match, format, line_number):
1340         LilypondSnippet.__init__ (self, type, match, format, line_number)
1341         self.contents = file (find_file (self.substring ('filename'))).read ()
1342
1343     def verb_ly (self):
1344         s = self.contents
1345         s = re_begin_verbatim.split (s)[-1]
1346         s = re_end_verbatim.split (s)[0]
1347         return s
1348
1349     def ly (self):
1350         name = self.substring ('filename')
1351         return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
1352                 % (name, self.contents))
1353
1354
1355 snippet_type_to_class = {
1356     'lilypond_file': LilypondFileSnippet,
1357     'lilypond_block': LilypondSnippet,
1358     'lilypond': LilypondSnippet,
1359     'include': IncludeSnippet,
1360 }
1361
1362 def find_linestarts (s):
1363     nls = [0]
1364     start = 0
1365     end = len (s)
1366     while 1:
1367         i = s.find ('\n', start)
1368         if i < 0:
1369             break
1370
1371         i = i + 1
1372         nls.append (i)
1373         start = i
1374
1375     nls.append (len (s))
1376     return nls
1377
1378 def find_toplevel_snippets (input_string, format, types):
1379     res = {}
1380     for t in types:
1381         res[t] = ly.re.compile (snippet_res[format][t])
1382
1383     snippets = []
1384     index = 0
1385     found = dict ([(t, None) for t in types])
1386
1387     line_starts = find_linestarts (input_string)
1388     line_start_idx = 0
1389     # We want to search for multiple regexes, without searching
1390     # the string multiple times for one regex.
1391     # Hence, we use earlier results to limit the string portion
1392     # where we search.
1393     # Since every part of the string is traversed at most once for
1394     # every type of snippet, this is linear.
1395
1396     while 1:
1397         first = None
1398         endex = 1 << 30
1399         for type in types:
1400             if not found[type] or found[type][0] < index:
1401                 found[type] = None
1402
1403                 m = res[type].search (input_string[index:endex])
1404                 if not m:
1405                     continue
1406
1407                 klass = Snippet
1408                 if type in snippet_type_to_class:
1409                     klass = snippet_type_to_class[type]
1410
1411                 start = index + m.start ('match')
1412                 line_number = line_start_idx
1413                 while (line_starts[line_number] < start):
1414                     line_number += 1
1415
1416                 line_number += 1
1417                 snip = klass (type, m, format, line_number)
1418
1419                 found[type] = (start, snip)
1420
1421             if (found[type]
1422                 and (not first
1423                      or found[type][0] < found[first][0])):
1424                 first = type
1425
1426                 # FIXME.
1427
1428                 # Limiting the search space is a cute
1429                 # idea, but this *requires* to search
1430                 # for possible containing blocks
1431                 # first, at least as long as we do not
1432                 # search for the start of blocks, but
1433                 # always/directly for the entire
1434                 # @block ... @end block.
1435
1436                 endex = found[first][0]
1437
1438         if not first:
1439             snippets.append (Substring (input_string, index, len (input_string), line_start_idx))
1440             break
1441
1442         while (start > line_starts[line_start_idx+1]):
1443             line_start_idx += 1
1444
1445         (start, snip) = found[first]
1446         snippets.append (Substring (input_string, index, start, line_start_idx + 1))
1447         snippets.append (snip)
1448         found[first] = None
1449         index = start + len (snip.match.group ('match'))
1450
1451     return snippets
1452
1453 def filter_pipe (input, cmd):
1454     """Pass input through cmd, and return the result."""
1455
1456     if global_options.verbose:
1457         progress (_ ("Opening filter `%s'") % cmd)
1458
1459     (stdin, stdout, stderr) = os.popen3 (cmd)
1460     stdin.write (input)
1461     status = stdin.close ()
1462
1463     if not status:
1464         status = 0
1465         output = stdout.read ()
1466         status = stdout.close ()
1467         error = stderr.read ()
1468
1469     if not status:
1470         status = 0
1471     signal = 0x0f & status
1472     if status or (not output and error):
1473         exit_status = status >> 8
1474         error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1475         error (_ ("The error log is as follows:"))
1476         ly.stderr_write (error)
1477         ly.stderr_write (stderr.read ())
1478         exit (status)
1479
1480     if global_options.verbose:
1481         progress ('\n')
1482
1483     return output
1484
1485 def system_in_directory (cmd, directory):
1486     """Execute a command in a different directory.
1487
1488     Because of win32 compatibility, we can't simply use subprocess.
1489     """
1490
1491     current = os.getcwd()
1492     os.chdir (directory)
1493     ly.system(cmd, be_verbose=global_options.verbose,
1494               progress_p=1)
1495     os.chdir (current)
1496
1497
1498 def process_snippets (cmd, snippets,
1499                       format, lily_output_dir):
1500     """Run cmd on all of the .ly files from snippets."""
1501
1502     if not snippets:
1503         return
1504
1505     if format in (HTML, TEXINFO) and '--formats' not in cmd:
1506         cmd += ' --formats=png '
1507     elif format in (DOCBOOK) and '--formats' not in cmd:
1508         cmd += ' --formats=png,pdf '
1509
1510     checksum = snippet_list_checksum (snippets)
1511     contents = '\n'.join (['snippet-map-%d.ly' % checksum]
1512                           + [snip.basename() for snip in snippets])
1513     name = os.path.join (lily_output_dir,
1514                          'snippet-names-%d' % checksum)
1515     file (name, 'wb').write (contents)
1516
1517     system_in_directory (' '.join ([cmd, name]),
1518                          lily_output_dir)
1519
1520
1521 ###
1522 # Retrieve dimensions from LaTeX
1523 LATEX_INSPECTION_DOCUMENT = r'''
1524 \nonstopmode
1525 %(preamble)s
1526 \begin{document}
1527 \typeout{textwidth=\the\textwidth}
1528 \typeout{columnsep=\the\columnsep}
1529 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1530 \end{document}
1531 '''
1532
1533 # Do we need anything else besides `textwidth'?
1534 def get_latex_textwidth (source):
1535     m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1536     if m == None:
1537         warning (_ ("cannot find \\begin{document} in LaTeX document"))
1538
1539         ## what's a sensible default?
1540         return 550.0
1541
1542     preamble = source[:m.start (0)]
1543     latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1544
1545     (handle, tmpfile) = tempfile.mkstemp('.tex')
1546     logfile = os.path.splitext (tmpfile)[0] + '.log'
1547     logfile = os.path.split (logfile)[1]
1548
1549     tmp_handle = os.fdopen (handle,'w')
1550     tmp_handle.write (latex_document)
1551     tmp_handle.close ()
1552
1553     ly.system ('latex %s' % tmpfile, be_verbose=global_options.verbose)
1554     parameter_string = file (logfile).read()
1555
1556     os.unlink (tmpfile)
1557     os.unlink (logfile)
1558
1559     columns = 0
1560     m = re.search ('columns=([0-9.]*)', parameter_string)
1561     if m:
1562         columns = int (m.group (1))
1563
1564     columnsep = 0
1565     m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1566     if m:
1567         columnsep = float (m.group (1))
1568
1569     textwidth = 0
1570     m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1571     if m:
1572         textwidth = float (m.group (1))
1573         if columns:
1574             textwidth = (textwidth - columnsep) / columns
1575
1576     return textwidth
1577
1578 def modify_preamble (chunk):
1579     str = chunk.replacement_text ()
1580     if (re.search (r"\\begin *{document}", str)
1581       and not re.search ("{graphic[sx]", str)):
1582         str = re.sub (r"\\begin{document}",
1583                r"\\usepackage{graphics}" + '\n'
1584                + r"\\begin{document}",
1585                str)
1586         chunk.override_text = str
1587
1588
1589 format2ext = {
1590     HTML: '.html',
1591     # TEXINFO: '.texinfo',
1592     TEXINFO: '.texi',
1593     LATEX: '.tex',
1594     DOCBOOK: '.xml'
1595 }
1596
1597 class CompileError(Exception):
1598     pass
1599
1600 def snippet_list_checksum (snippets):
1601     return hash (' '.join([l.basename() for l in snippets]))
1602
1603 def write_file_map (lys, name):
1604     snippet_map = file (os.path.join (
1605         global_options.lily_output_dir,
1606         'snippet-map-%d.ly' % snippet_list_checksum (lys)), 'w')
1607
1608     snippet_map.write ("""
1609 #(define version-seen #t)
1610 #(define output-empty-score-list #f)
1611 #(ly:add-file-name-alist '(%s
1612     ))\n
1613 """ % '\n'.join('("%s.ly" . "%s")\n' % (ly.basename (), name)
1614                 for ly in lys))
1615
1616 def do_process_cmd (chunks, input_name, options):
1617     snippets = [c for c in chunks if isinstance (c, LilypondSnippet)]
1618
1619
1620     output_files = set(os.listdir(options.lily_output_dir))
1621     outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)]
1622
1623     write_file_map (outdated, input_name)
1624     progress (_ ("Writing snippets..."))
1625     for snippet in outdated:
1626         snippet.write_ly()
1627     progress ('\n')
1628
1629     if outdated:
1630         progress (_ ("Processing..."))
1631         progress ('\n')
1632         process_snippets (options.process_cmd, outdated,
1633                           options.format, options.lily_output_dir)
1634
1635     else:
1636         progress (_ ("All snippets are up to date..."))
1637
1638     if options.lily_output_dir != options.output_dir:
1639         output_files = set(os.listdir(options.lily_output_dir))
1640         for snippet in snippets:
1641             snippet.link_all_output_files (options.lily_output_dir,
1642                                            output_files,
1643                                            options.output_dir)
1644
1645     progress ('\n')
1646
1647
1648 ###
1649 # Format guessing data
1650 ext2format = {
1651     '.html': HTML,
1652     '.itely': TEXINFO,
1653     '.latex': LATEX,
1654     '.lytex': LATEX,
1655     '.tely': TEXINFO,
1656     '.tex': LATEX,
1657     '.texi': TEXINFO,
1658     '.texinfo': TEXINFO,
1659     '.xml': HTML,
1660     '.lyxml': DOCBOOK
1661 }
1662
1663 def guess_format (input_filename):
1664     format = None
1665     e = os.path.splitext (input_filename)[1]
1666     if e in ext2format:
1667         # FIXME
1668         format = ext2format[e]
1669     else:
1670         error (_ ("cannot determine format for: %s"
1671                   % input_filename))
1672         exit (1)
1673     return format
1674
1675 def write_if_updated (file_name, lines):
1676     try:
1677         f = file (file_name)
1678         oldstr = f.read ()
1679         new_str = ''.join (lines)
1680         if oldstr == new_str:
1681             progress (_ ("%s is up to date.") % file_name)
1682             progress ('\n')
1683
1684             # this prevents make from always rerunning lilypond-book:
1685             # output file must be touched in order to be up to date
1686             os.utime (file_name, None)
1687     except:
1688         pass
1689
1690     progress (_ ("Writing `%s'...") % file_name)
1691     file (file_name, 'w').writelines (lines)
1692     progress ('\n')
1693
1694
1695 def note_input_file (name, inputs=[]):
1696     ## hack: inputs is mutable!
1697     inputs.append (name)
1698     return inputs
1699
1700 def samefile (f1, f2):
1701     try:
1702         return os.path.samefile (f1, f2)
1703     except AttributeError:                # Windoze
1704         f1 = re.sub ("//*", "/", f1)
1705         f2 = re.sub ("//*", "/", f2)
1706         return f1 == f2
1707
1708 def do_file (input_filename):
1709     # Ugh.
1710     if not input_filename or input_filename == '-':
1711         in_handle = sys.stdin
1712         input_fullname = '<stdin>'
1713     else:
1714         if os.path.exists (input_filename):
1715             input_fullname = input_filename
1716         elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1717             input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1718         else:
1719             input_fullname = find_file (input_filename)
1720
1721         note_input_file (input_fullname)
1722         in_handle = file (input_fullname)
1723
1724     if input_filename == '-':
1725         input_base = 'stdin'
1726     else:
1727         input_base = os.path.basename (
1728             os.path.splitext (input_filename)[0])
1729
1730     # don't complain when global_options.output_dir is existing
1731     if not global_options.output_dir:
1732         global_options.output_dir = os.getcwd()
1733     else:
1734         global_options.output_dir = os.path.abspath(global_options.output_dir)
1735
1736         if not os.path.isdir (global_options.output_dir):
1737             os.mkdir (global_options.output_dir, 0777)
1738         os.chdir (global_options.output_dir)
1739
1740     output_filename = os.path.join(global_options.output_dir,
1741                                    input_base + format2ext[global_options.format])
1742     if (os.path.exists (input_filename)
1743         and os.path.exists (output_filename)
1744         and samefile (output_filename, input_fullname)):
1745      error (
1746      _ ("Output would overwrite input file; use --output."))
1747      exit (2)
1748
1749     try:
1750         progress (_ ("Reading %s...") % input_fullname)
1751         source = in_handle.read ()
1752         progress ('\n')
1753
1754         set_default_options (source, default_ly_options, global_options.format)
1755
1756
1757         # FIXME: Containing blocks must be first, see
1758         #        find_toplevel_snippets.
1759         snippet_types = (
1760             'multiline_comment',
1761             'verbatim',
1762             'lilypond_block',
1763     #                'verb',
1764             'singleline_comment',
1765             'lilypond_file',
1766             'include',
1767             'lilypond',
1768         )
1769         progress (_ ("Dissecting..."))
1770         chunks = find_toplevel_snippets (source, global_options.format, snippet_types)
1771
1772         if global_options.format == LATEX:
1773             for c in chunks:
1774                 if (c.is_plain () and
1775                   re.search (r"\\begin *{document}", c.replacement_text())):
1776                     modify_preamble (c)
1777                     break
1778         progress ('\n')
1779
1780         if global_options.filter_cmd:
1781             write_if_updated (output_filename,
1782                      [c.filter_text () for c in chunks])
1783         elif global_options.process_cmd:
1784             do_process_cmd (chunks, input_fullname, global_options)
1785             progress (_ ("Compiling %s...") % output_filename)
1786             progress ('\n')
1787             write_if_updated (output_filename,
1788                      [s.replacement_text ()
1789                      for s in chunks])
1790
1791         def process_include (snippet):
1792             os.chdir (original_dir)
1793             name = snippet.substring ('filename')
1794             progress (_ ("Processing include: %s") % name)
1795             progress ('\n')
1796             return do_file (name)
1797
1798         include_chunks = map (process_include,
1799                               filter (lambda x: isinstance (x, IncludeSnippet),
1800                                       chunks))
1801
1802         return chunks + reduce (lambda x, y: x + y, include_chunks, [])
1803
1804     except CompileError:
1805         os.chdir (original_dir)
1806         progress (_ ("Removing `%s'") % output_filename)
1807         progress ('\n')
1808         raise CompileError
1809
1810 def do_options ():
1811     global global_options
1812
1813     opt_parser = get_option_parser()
1814     (global_options, args) = opt_parser.parse_args ()
1815     if global_options.format in ('texi-html', 'texi'):
1816         global_options.format = TEXINFO
1817
1818     global_options.include_path =  map (os.path.abspath, global_options.include_path)
1819
1820     if global_options.warranty:
1821         warranty ()
1822         exit (0)
1823     if not args or len (args) > 1:
1824         opt_parser.print_help ()
1825         exit (2)
1826
1827     return args
1828
1829 def main ():
1830     # FIXME: 85 lines of `main' macramee??
1831     files = do_options ()
1832
1833     basename = os.path.splitext (files[0])[0]
1834     basename = os.path.split (basename)[1]
1835
1836     if not global_options.format:
1837         global_options.format = guess_format (files[0])
1838
1839     formats = 'ps'
1840     if global_options.format in (TEXINFO, HTML, DOCBOOK):
1841         formats += ',png'
1842
1843     if global_options.process_cmd == '':
1844         global_options.process_cmd = (lilypond_binary
1845                                       + ' --formats=%s -dbackend=eps ' % formats)
1846
1847     if global_options.process_cmd:
1848         global_options.process_cmd += ' '.join ([(' -I %s' % ly.mkarg (p))
1849                                                  for p in global_options.include_path])
1850
1851     if global_options.format in (TEXINFO, LATEX):
1852         ## prevent PDF from being switched on by default.
1853         global_options.process_cmd += ' --formats=eps '
1854         if global_options.create_pdf:
1855             global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts "
1856
1857     if global_options.verbose:
1858         global_options.process_cmd += " --verbose "
1859
1860     if global_options.padding_mm:
1861         global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm
1862
1863     global_options.process_cmd += " -dread-file-list "
1864
1865     if global_options.lily_output_dir:
1866         global_options.lily_output_dir = os.path.abspath(global_options.lily_output_dir)
1867         if not os.path.isdir (global_options.lily_output_dir):
1868             os.makedirs (global_options.lily_output_dir)
1869     else:
1870         global_options.lily_output_dir = os.path.abspath(global_options.output_dir)
1871
1872
1873     identify ()
1874     try:
1875         chunks = do_file (files[0])
1876     except CompileError:
1877         exit (1)
1878
1879     inputs = note_input_file ('')
1880     inputs.pop ()
1881
1882     base_file_name = os.path.splitext (os.path.basename (files[0]))[0]
1883     dep_file = os.path.join (global_options.output_dir, base_file_name + '.dep')
1884     final_output_file = os.path.join (global_options.output_dir,
1885                      base_file_name
1886                      + '.%s' % global_options.format)
1887
1888     os.chdir (original_dir)
1889     file (dep_file, 'w').write ('%s: %s'
1890                                 % (final_output_file, ' '.join (inputs)))
1891
1892 if __name__ == '__main__':
1893     main ()