scripts/lilypond-book.py

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