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