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