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