scripts/lilypond-book.py

   1 #!@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-bin" BOOK.tely
  14
  15 TODO:
  16     *  ly-options: intertext ?
  17     *  --linewidth?
  18     *  eps in latex / eps by lilypond-bin -fps ?
  19     *  check latex parameters, twocolumn, multicolumn?
  20
  21     *  Converting from lilypond-book source, substitute:
  22        @mbinclude foo.itely -> @include foo.itely
  23        \mbinput -> \input
  24
  25 '''
  26
  27 import __main__
  28 import glob
  29 import string
  30 import stat
  31 ################################################################
  32 # Users of python modules should include this snippet
  33 # and customize variables below.
  34
  35 # We'll suffer this path init stuff as long as we don't install our
  36 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
  37 # it as we do with teTeX on Red Hat Linux: set some environment var
  38 # (PYTHONPATH) in profile)
  39
  40 # If set, LILYPONDPREFIX must take prevalence
  41 # if datadir is not set, we're doing a build and LILYPONDPREFIX
  42 import getopt, os, sys
  43 datadir = '@local_lilypond_datadir@'
  44 if not os.path.isdir (datadir):
  45         datadir = '@lilypond_datadir@'
  46 if os.environ.has_key ('LILYPONDPREFIX') :
  47         datadir = os.environ['LILYPONDPREFIX']
  48         while datadir[-1] == os.sep:
  49                 datadir= datadir[:-1]
  50
  51 sys.path.insert (0, os.path.join (datadir, 'python'))
  52
  53 # Customize these
  54 #if __name__ == '__main__':
  55
  56 import lilylib as ly
  57 global _;_=ly._
  58 global re;re = ly.re
  59
  60
  61 # lilylib globals
  62 program_version = '@TOPLEVEL_VERSION@'
  63 program_name = 'lilypond-book'
  64 verbose_p = 0
  65 pseudo_filter_p = 0
  66 original_dir = os.getcwd ()
  67
  68
  69 help_summary = _ ("""Process LilyPond snippets in hybrid HTML, LaTeX or texinfo document.
  70 Example usage:
  71
  72    lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
  73    lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" BOOK
  74    lilypond-book --process='lilypond-bin -I include' BOOK
  75
  76 """)
  77
  78 copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
  79              'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
  80
  81 option_definitions = [
  82         (_ ("EXT"), 'f', 'format', _ ("use output format EXT (texi [default], texi-html, latex, html)")),
  83         (_ ("FILTER"), 'F', 'filter', _ ("pipe snippets through FILTER [convert-ly -n -]")),
  84         ('', 'h', 'help', _ ("print this help")),
  85         (_ ("DIR"), 'I', 'include', _ ("add DIR to include path")),
  86         (_ ("COMMAND"), 'P', 'process', _ ("process ly_files using COMMAND FILE...")),
  87         (_ ("DIR"), 'o', 'output', _ ("write output to DIR")),
  88         ('', 'V', 'verbose', _ ("be verbose")),
  89         ('', 'v', 'version', _ ("print version information")),
  90         ('', 'w', 'warranty', _ ("show warranty and copyright")),
  91         ]
  92
  93 include_path = [ly.abspath (os.getcwd ())]
  94 lilypond_binary = os.path.join ('@bindir@', 'lilypond-bin')
  95
  96 # only use installed binary  when we're installed too.
  97 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
  98         lilypond_binary = 'lilypond-bin'
  99
 100
 101 use_hash_p = 1
 102 format = 0
 103 output_name = 0
 104 latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
 105 filter_cmd = 0
 106 process_cmd = lilypond_binary
 107 default_ly_options = {}
 108
 109 AFTER = 'after'
 110 FILTER = 'filter'
 111 BEFORE = 'before'
 112 EXAMPLEINDENT = 'exampleindent'
 113 FRAGMENT = 'fragment'
 114 HTML = 'html'
 115 INDENT = 'indent'
 116 LATEX = 'latex'
 117 LINEWIDTH = 'linewidth'
 118 NOFRAGMENT = 'nofragment'
 119 NOINDENT = 'noindent'
 120 NOTES = 'body'
 121 NOTIME = 'notime'
 122 OUTPUT = 'output'
 123 PAPER = 'paper'
 124 PREAMBLE = 'preamble'
 125 PRINTFILENAME = 'printfilename'
 126 RAGGEDRIGHT = 'raggedright'
 127 RELATIVE = 'relative'
 128 QUOTE = 'quote'
 129 STAFFSIZE = 'staffsize'
 130 TEXIDOC = 'texidoc'
 131 TEXINFO = 'texinfo'
 132 VERBATIM = 'verbatim'
 133
 134 # Recognize special sequences in the input
 135 #
 136 # (?P<name>regex) -- assign result of REGEX to NAME
 137 # *? -- match non-greedily.
 138 # (?m) -- multiline regex: make ^ and $ match at each line
 139 # (?s) -- make the dot match all characters including newline
 140 no_match = 'a\ba'
 141 snippet_res = {
 142         HTML: {
 143         'include':  no_match,
 144         'lilypond' : '(?m)(?P<match><lilypond((?P<options>[^:]*):)(?P<code>.*?)/>)',
 145         'lilypond_block': r'''(?ms)(?P<match><lilypond(?P<options>[^>]+)?>(?P<code>.*?)</lilypond>)''',
 146         'lilypond_file': r'(?m)(?P<match><lilypondfile(?P<options>[^>]+)?>\s*(?P<filename>[^<]+)\s*</lilypondfile>)',
 147         'multiline_comment': r"(?sm)\s*(?!@c\s+)(?P<code><!--\s.*?!-->)\s",
 148         'singleline_comment': no_match,
 149         'verb': r'''(?P<code><pre>.*?</pre>)''',
 150         'verbatim': r'''(?s)(?P<code><pre>\s.*?</pre>\s)''',
 151         },
 152
 153         LATEX: {
 154         'include': r'(?m)^[^%\n]*?(?P<match>\\input{(?P<filename>[^}]+)})',
 155         'lilypond' : r'(?m)^[^%\n]*?(?P<match>\\lilypond\s*(\[(?P<options>.*?)\])?\s*{(?P<code>.*?)})',
 156         'lilypond_block': r"(?sm)^[^%\n]*?(?P<match>\\begin\s*(\[(?P<options>.*?)\])?\s*{lilypond}(?P<code>.*?)\\end{lilypond})",
 157         'lilypond_file': r'(?m)^[^%\n]*?(?P<match>\\lilypondfile\s*(\[(?P<options>.*?)\])?\s*\{(?P<filename>.+)})',
 158         'multiline_comment': no_match,
 159         'singleline_comment': r"(?m)^.*?(?P<match>(?P<code>^%.*$\n+))",
 160         'verb': r"(?P<code>\\verb(?P<del>.).*?(?P=del))",
 161         'verbatim': r"(?s)(?P<code>\\begin\s*{verbatim}.*?\\end{verbatim})",
 162         },
 163
 164         TEXINFO: {
 165         'include':  '(?m)^[^%\n]*?(?P<match>@include\s+(?P<filename>\S+))',
 166         'lilypond' : '(?m)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?{(?P<code>.*?)})',
 167         'lilypond_block': r'''(?ms)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?\s(?P<code>.*?)@end lilypond)\s''',
 168         'lilypond_file': '(?m)^(?P<match>@lilypondfile(\[(?P<options>[^]]*)\])?{(?P<filename>[^}]+)})',
 169         'multiline_comment': r'(?sm)^\s*(?!@c\s+)(?P<code>@ignore\s.*?@end\s+ignore)\s',
 170         'singleline_comment': r'(?m)^.*(?P<match>(?P<code>@c([ \t][^\n]*|)\n))',
 171
 172 # don't do this: fucks up with @code{@{}
 173 #       'verb': r'''(?P<code>@code{.*?})''',
 174         'verbatim': r'''(?s)(?P<code>@example\s.*?@end\s+example\s)''',
 175         },
 176         }
 177
 178 format_res = {
 179         HTML: {
 180         'option-sep' : '\s*',
 181         'intertext': r',?\s*intertext=\".*?\"',
 182         },
 183         LATEX: {
 184         'intertext': r',?\s*intertext=\".*?\"',
 185         'option-sep' : ',\s*',
 186         },
 187         TEXINFO: {
 188         'intertext': r',?\s*intertext=\".*?\"',
 189         'option-sep' : ',\s*',
 190         },
 191         }
 192
 193 ly_options = {
 194         NOTES: {
 195         RELATIVE: r'''\relative c%(relative_quotes)s''',
 196         },
 197         PAPER: {
 198         EXAMPLEINDENT : '',
 199         INDENT : r'''
 200     indent = %(indent)s''',
 201         'linewidth' : r'''
 202     linewidth = %(linewidth)s''',
 203         NOINDENT : r'''
 204     indent = 0.0\mm''',
 205         NOTIME : r'''
 206     \context {
 207         \Staff
 208         \remove Time_signature_engraver
 209     }''',
 210         QUOTE : r'''
 211     linewidth = %(linewidth)s - 2.0 * %(exampleindent)s
 212 ''',
 213         RAGGEDRIGHT : r'''
 214     indent = 0.0\mm
 215     raggedright = ##t''',
 216         },
 217         PREAMBLE: {
 218         STAFFSIZE: r'''
 219 #(set-global-staff-size %(staffsize)s)''',
 220         },
 221         }
 222
 223 output = {
 224         HTML : {
 225         FILTER: r'''<lilypond %(options)s>
 226 %(code)s
 227 </lilypond>
 228 ''',
 229
 230         AFTER: r'''
 231   </a>
 232 </p>''',
 233         BEFORE: r'''
 234 <p>
 235   <a href="%(base)s.ly">''',
 236         OUTPUT: r'''
 237     <img align="center" valign="center"
 238          border="0" src="%(image)s" alt="[image of music]">''',
 239         PRINTFILENAME:'<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
 240         QUOTE: r'''<blockquote>
 241 %(str)s
 242 </blockquote>
 243 ''',
 244         VERBATIM: r'''<pre>
 245 %(verb)s</pre>''',
 246         },
 247
 248         LATEX : {
 249         AFTER: '',
 250         BEFORE: '',
 251         OUTPUT: r'''{\parindent 0pt
 252 \catcode`\@=12
 253 \ifx\preLilyPondExample\undefined\relax\else\preLilyPondExample\fi
 254 \def\lilypondbook{}
 255 \input %(base)s.tex
 256 \ifx\postLilyPondExample\undefined\relax\else\postLilyPondExample\fi
 257 \catcode`\@=0}''',
 258         PRINTFILENAME: '''\\texttt{%(filename)s}
 259
 260         ''',
 261         QUOTE: r'''\begin{quotation}
 262 %(str)s
 263 \end{quotation}
 264 ''',
 265         VERBATIM: r'''\noindent
 266 \begin{verbatim}
 267 %(verb)s\end{verbatim}
 268 ''',
 269         FILTER: r'''\begin{lilypond}[%(options)s]
 270 %(code)s
 271 \end{lilypond}''',
 272         },
 273
 274         TEXINFO : {
 275         FILTER: r'''@lilypond[%(options)s]
 276 %(code)s
 277 @lilypond''',
 278         AFTER: '',
 279         BEFORE: '',
 280         OUTPUT: r'''@noindent
 281 @image{%(base)s,,,[image of music],%(ext)s}
 282 ''',
 283         PRINTFILENAME: '''@file{%(filename)s}
 284
 285         ''',
 286         QUOTE: r'''@quotation
 287 %(str)s
 288 @end quotation
 289 ''',
 290         # FIXME: @exampleindent 5  is the default...
 291         VERBATIM: r'''@exampleindent 0
 292 @example
 293 %(verb)s@end example
 294 @exampleindent 5
 295 ''',
 296         },
 297         }
 298
 299 PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
 300 %%%% Options: [%(option_string)s]
 301 #(set! toplevel-score-handler ly:parser-print-score)
 302 #(set! toplevel-music-handler (lambda (p m)
 303                                (ly:parser-print-score
 304                                 p (ly:music-scorify m))
 305                             ))
 306 %(preamble_string)s
 307 \paper {%(paper_string)s
 308 }
 309 '''
 310
 311 FRAGMENT_LY = r'''
 312     %(notes_string)s{
 313         %(code)s    }
 314 '''
 315 FULL_LY = '%(code)s'
 316
 317 texinfo_linewidths = {
 318         '@afourpaper': '160 \\mm',
 319         '@afourwide': '6.5 \\in',
 320         '@afourlatex': '150 \\mm',
 321         '@smallbook': '5 \\in' ,
 322         '@letterpaper': '6\\in',
 323         }
 324
 325 def classic_lilypond_book_compatibility (o):
 326         if o == 'singleline':
 327                 return RAGGEDRIGHT
 328         m = re.search ('relative\s*([-0-9])', o)
 329         if m:
 330                 return 'relative=%s' % m.group (1)
 331         m = re.match ('([0-9]+)pt', o)
 332         if m:
 333                 return 'staffsize=%s' % m.group (1)
 334         m = re.match ('indent=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
 335         if m:
 336                 f = float (m.group (1))
 337                 return 'indent=%f\\%s' % (f, m.group (2))
 338         m = re.match ('linewidth=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
 339         if m:
 340                 f = float (m.group (1))
 341                 return 'linewidth=%f\\%s' % (f, m.group (2))
 342         return None
 343
 344 def compose_ly (code, options):
 345         #Hmm
 346         for i in default_ly_options.keys ():
 347                 if i not in options:
 348                         options.append (i)
 349
 350         #Hmm
 351         if QUOTE in options and LINEWIDTH in options:
 352                 options.remove (LINEWIDTH)
 353
 354         m = re.search (r'''\\(header|score)''', code)
 355         if not m and (not options \
 356                       or not NOFRAGMENT in options or FRAGMENT in options):
 357                 if RAGGEDRIGHT not in options:
 358                         options.append (RAGGEDRIGHT)
 359                 body = FRAGMENT_LY
 360         else:
 361                 body = FULL_LY
 362
 363         # defaults
 364         relative = 1
 365         staffsize = 16
 366         override = {}
 367         override.update (default_ly_options)
 368         #FIXME: where to get sane value for exampleindent?
 369         override[EXAMPLEINDENT] = r'9.0 \mm'
 370
 371         option_string = string.join (options, ',')
 372         notes_options = []
 373         paper_options = []
 374         preamble_options = []
 375         for i in options:
 376                 c = classic_lilypond_book_compatibility (i)
 377                 if c:
 378                         ly.warning (_ ("deprecated ly-option used: %s" % i))
 379                         ly.warning (_ ("compatibility mode translation: %s" \
 380                                        % c))
 381                         i = c
 382
 383                 if string.find (i, '=') > 0:
 384                         key, value = string.split (i, '=')
 385                         override[key] = value
 386                 else:
 387                         key = i
 388                         if i not in override.keys ():
 389                                 override[i] = None
 390
 391                 if key in ly_options[NOTES].keys ():
 392                         notes_options.append (ly_options[NOTES][key])
 393                 elif key in ly_options[PREAMBLE].keys ():
 394                         preamble_options.append (ly_options[PREAMBLE][key])
 395                 elif key in ly_options[PAPER].keys ():
 396                         paper_options.append (ly_options[PAPER][key])
 397                 elif key not in (FRAGMENT, NOFRAGMENT, PRINTFILENAME,
 398                                  RELATIVE, VERBATIM, TEXIDOC):
 399                         ly.warning (_("ignoring unknown ly option: %s") % i)
 400
 401         #URGS
 402         if RELATIVE in override.keys () and override[RELATIVE]:
 403                 relative = string.atoi (override[RELATIVE])
 404
 405         relative_quotes = ''
 406
 407         # 1 = central C
 408         if relative < 0:
 409                 relative_quotes += ',' * (- relative)
 410         elif relative > 0:
 411                 relative_quotes += "'" * relative
 412
 413         program_name = __main__.program_name
 414         paper_string = string.join (paper_options, '\n    ') % override
 415         preamble_string = string.join (preamble_options, '\n    ') % override
 416         notes_string = string.join (notes_options, '\n    ') % vars ()
 417         return (PREAMBLE_LY + body) % vars ()
 418
 419 # BARF
 420 # use lilypond-bin for latex (.lytex) books,
 421 # and lilypond --preview for html, texinfo books?
 422 def to_eps (file):
 423         cmd = r'latex "\nonstopmode \input %s"' % file
 424         # Ugh.  (La)TeX writes progress and error messages on stdout
 425         # Redirect to stderr
 426         cmd = '(( %s  >&2 ) >&- )' % cmd
 427         ly.system (cmd)
 428         ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -E -o %s.eps %s' \
 429                    % (file, file))
 430
 431
 432         # check if it really is EPS.
 433         # Otherwise music glyphs disappear from 2nd and following pages.
 434
 435         # TODO: should run dvips -pp -E per page, then we get proper
 436         # cropping as well.
 437
 438         f = open ('%s.eps' % file)
 439         for x in range(0,10) :
 440                 if re.search ("^%%Pages: ", f.readline ()):
 441
 442                         # make non EPS.
 443                         ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -o %s.eps %s' \
 444                                    % (file, file))
 445                         break
 446
 447
 448 def find_file (name):
 449         for i in include_path:
 450                 full = os.path.join (i, name)
 451                 if os.path.exists (full):
 452                         return full
 453         ly.error (_ ('file not found: %s') % name + '\n')
 454         ly.exit (1)
 455         return ''
 456
 457 def verbatim_html (s):
 458         return re.sub ('>', '&gt;',
 459                        re.sub ('<', '&lt;',
 460                                re.sub ('&', '&amp;', s)))
 461
 462 def verbatim_texinfo (s):
 463         return re.sub ('{', '@{',
 464                        re.sub ('}', '@}',
 465                                re.sub ('@', '@@', s)))
 466
 467 def split_options (option_string):
 468         return re.split (format_res[format]['option-sep'], option_string)
 469
 470
 471 class Chunk:
 472         def replacement_text (self):
 473                 return ''
 474
 475         def filter_text (self):
 476                 return self.replacement_text ()
 477
 478
 479         def is_outdated (self):
 480                 return 0
 481
 482 class Substring (Chunk):
 483         def __init__ (self, source, start, end):
 484                 self.source = source
 485                 self.start = start
 486                 self.end = end
 487
 488         def replacement_text (self):
 489                 return self.source [self.start:self.end]
 490
 491 class Snippet (Chunk):
 492         def __init__ (self, type, match, format):
 493                 self.type = type
 494                 self.match = match
 495                 self.hash = 0
 496                 self.options = []
 497                 self.format = format
 498
 499         def replacement_text (self):
 500                 return self.match.group (0)
 501
 502         def substring (self, s):
 503                 return self.match.group (s)
 504
 505         def __repr__ (self):
 506                 return `self.__class__`  +  " type =  " + self.type
 507
 508 class Include_snippet (Snippet):
 509         def processed_filename (self):
 510                 f = self.substring ('filename')
 511                 return os.path.splitext (f)[0] + format2ext[format]
 512
 513         def replacement_text (self):
 514                 s = self.match.group (0)
 515                 f = self.substring ('filename')
 516
 517                 return re.sub (f, self.processed_filename (), s)
 518
 519 class Lilypond_snippet (Snippet):
 520         def __init__ (self, type, match, format):
 521                 Snippet.__init__ (self, type, match, format)
 522                 os = match.group ('options')
 523                 if os:
 524                         self.options = split_options (os)
 525
 526         def ly (self):
 527                 return self.substring ('code')
 528
 529         def full_ly (self):
 530                 s = self.ly ()
 531                 if s:
 532                         return compose_ly (s, self.options)
 533                 return ''
 534
 535         def get_hash (self):
 536                 if not self.hash:
 537                         self.hash = abs (hash (self.full_ly ()))
 538                 return self.hash
 539
 540         def basename (self):
 541                 if use_hash_p:
 542                         return 'lily-%d' % self.get_hash ()
 543                 raise 'to be done'
 544
 545         def write_ly (self):
 546                 outf = open (self.basename () + '.ly', 'w')
 547                 outf.write (self.full_ly ())
 548
 549         def is_outdated (self):
 550                 base = self.basename ()
 551
 552                 tex_file = '%s.tex' % base
 553                 ly_file = '%s.ly' % base
 554                 ok = os.path.exists (ly_file) and os.path.exists (tex_file)\
 555                      and os.stat (tex_file)[stat.ST_SIZE] \
 556                      and open (tex_file).readlines ()[-1][1:-1] \
 557                      == 'lilypondend'
 558
 559                 if format == HTML or format == TEXINFO:
 560                         ok = ok and (os.path.exists (base + '.png')
 561                                      or glob.glob (base + '-page*.png'))
 562
 563                 if ok and (use_hash_p or self.ly () == open (ly_file).read ()):
 564                         # TODO: something smart with target formats
 565                         # (ps, png) and m/ctimes
 566                         return None
 567                 return self
 568
 569         def filter_text (self):
 570                 code  = self.substring ('code')
 571                 s = run_filter (code)
 572                 d = {'code' : s,
 573                      'options': self.match.group ('options')
 574                      }
 575                 # TODO
 576                 return output[self.format][FILTER] % d
 577
 578         def replacement_text (self):
 579                 func = Lilypond_snippet.__dict__ ['output_' + self.format]
 580                 return func (self)
 581
 582         def get_images (self):
 583                 base = self.basename ()
 584                 # URGUGHUGHUGUGHU
 585                 single = '%(base)s.png' % vars ()
 586                 multiple = '%(base)s-page1.png' % vars ()
 587                 images = (single,)
 588                 if os.path.exists (multiple) \
 589                    and (not os.path.exists (single)\
 590                         or (os.stat (multiple)[stat.ST_MTIME] \
 591                             > os.stat (single)[stat.ST_MTIME])):
 592                         images = glob.glob ('%(base)s-page*.png' % vars ())
 593                 return images
 594
 595         def output_html (self):
 596                 str = ''
 597                 base = self.basename ()
 598                 if format == HTML:
 599                         str += self.output_print_filename (HTML)
 600                         if VERBATIM in self.options:
 601                                 verb = verbatim_html (self.substring ('code'))
 602                                 str += write (output[HTML][VERBATIM] % vars ())
 603                         if QUOTE in self.options:
 604                                 str = output[HTML][QUOTE] % vars ()
 605
 606                 str += output[HTML][BEFORE] % vars ()
 607                 for image in self.get_images ():
 608                         base, ext = os.path.splitext (image)
 609                         str += output[HTML][OUTPUT] % vars ()
 610                 str += output[HTML][AFTER] % vars ()
 611                 return str
 612
 613         def output_info (self):
 614                 str = self.output_print_filename (HTML)
 615                 str = output[TEXINFO][BEFORE] % vars ()
 616                 for image in self.get_images ():
 617                         base, ext = os.path.splitext (image)
 618                         # URG, makeinfo implicitely prepends dot to ext
 619                         # specifying no extension is most robust
 620                         ext = ''
 621                         str += output[TEXINFO][OUTPUT] % vars ()
 622                 str += output[TEXINFO][AFTER] % vars ()
 623                 return str
 624
 625         def output_latex (self):
 626                 str = ''
 627                 base = self.basename ()
 628                 if format == LATEX:
 629                         str += self.output_print_filename (LATEX)
 630                         if  VERBATIM in self.options:
 631                                 verb = self.substring ('code')
 632                                 str += (output[LATEX][VERBATIM] % vars ())
 633                         if QUOTE in self.options:
 634                                 str = output[LATEX][QUOTE] % vars ()
 635
 636                 str +=  (output[LATEX][BEFORE]
 637                          + (output[LATEX][OUTPUT] % vars ())
 638                          + output[LATEX][AFTER])
 639                 return str
 640
 641         def output_print_filename (self,format):
 642                 str = ''
 643                 if  PRINTFILENAME in self.options:
 644                         base = self.basename ()
 645                         filename = self.substring ('filename')
 646                         str = output[format][PRINTFILENAME] % vars ()
 647                 return str
 648
 649         def output_texinfo (self):
 650                 str = ''
 651                 # self.output_print_filename (TEXINFO)
 652                 str += ('@html\n' + self.output_print_filename (HTML)
 653                         + '\n@end html\n')
 654                 str += ('@tex\n' + self.output_print_filename (LATEX)
 655                         + '\n@end tex\n')
 656                 base = self.basename ()
 657                 if TEXIDOC in self.options:
 658                         texidoc = base + '.texidoc'
 659                         if os.path.exists (texidoc):
 660                                 str += '@include %(texidoc)s\n\n' % vars ()
 661
 662                 if VERBATIM in self.options:
 663                         verb = verbatim_texinfo (self.substring ('code'))
 664                         str +=  (output[TEXINFO][VERBATIM] % vars ())
 665
 666                 str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
 667                 str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
 668                 str += ('@html\n' + self.output_html () + '\n@end html\n')
 669
 670                 if QUOTE in self.options:
 671                         str = output[TEXINFO][QUOTE] % vars ()
 672
 673                 # need par after image
 674                 str += '\n'
 675
 676                 return str
 677
 678 class Lilypond_file_snippet (Lilypond_snippet):
 679         def ly (self):
 680                 name = self.substring ('filename')
 681                 return '\\renameinput \"%s\"\n' % name\
 682                                + open (find_file (name)).read ()
 683
 684
 685 snippet_type_to_class = {
 686         'lilypond_file' : Lilypond_file_snippet,
 687         'lilypond_block' : Lilypond_snippet,
 688         'lilypond' : Lilypond_snippet,
 689         'include' : Include_snippet,
 690         }
 691
 692 def find_toplevel_snippets (s, types):
 693         res = {}
 694         for i in types:
 695                 res[i] = ly.re.compile (snippet_res[format][i])
 696
 697         snippets = []
 698         index = 0
 699         ##  found = dict (map (lambda x: (x, None), types))
 700         ## urg python2.1
 701         found = {}
 702         map (lambda x, f=found: f.setdefault (x, None), types)
 703
 704         # We want to search for multiple regexes, without searching
 705         # the string multiple times for one regex.
 706         # Hence, we use earlier results to limit the string portion
 707         # where we search.
 708         # Since every part of the string is traversed at most once for
 709         # every type of snippet, this is linear.
 710
 711         while 1:
 712                 first = None
 713                 endex = 1 << 30
 714                 for type in types:
 715                         if not found[type] or found[type][0] < index:
 716                                 found[type] = None
 717                                 m = res[type].search (s[index:endex])
 718                                 if not m:
 719                                         continue
 720
 721                                 cl = Snippet
 722                                 if snippet_type_to_class.has_key (type):
 723                                         cl = snippet_type_to_class[type]
 724                                 snip = cl (type, m, format)
 725                                 start = index + m.start (0)
 726                                 found[type] = (start, snip)
 727
 728                         if found[type] \
 729                            and (not first or found[type][0] < found[first][0]):
 730                                 first = type
 731
 732                                 # FIXME.
 733
 734                                 # Limiting the search space is a cute
 735                                 # idea, but this *requires* to search
 736                                 # for possible containing blocks
 737                                 # first, at least long as we do not
 738                                 # search for the start of blocks, but
 739                                 # always/directly for the entire
 740                                 # @block ... @end block.
 741
 742                                 endex = found[first][0]
 743
 744                 if not first:
 745                         snippets.append (Substring (s, index, len (s)))
 746                         break
 747
 748                 (start , snip) = found[first]
 749                 snippets.append (Substring (s, index, start))
 750                 snippets.append (snip)
 751                 found[first] = None
 752                 index = start + len (snip.match.group (0))
 753
 754         return snippets
 755
 756 def filter_pipe (input, cmd):
 757         if verbose_p:
 758                 ly.progress (_ ("Opening filter `%s\'") % cmd)
 759
 760         stdin, stdout, stderr = os.popen3 (cmd)
 761         stdin.write (input)
 762         status = stdin.close ()
 763
 764         if not status:
 765                 status = 0
 766                 output = stdout.read ()
 767                 status = stdout.close ()
 768                 error = stderr.read ()
 769
 770         if not status:
 771                 status = 0
 772         signal = 0x0f & status
 773         if status or (not output and error):
 774                 exit_status = status >> 8
 775                 ly.error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
 776                 ly.error (_ ("The error log is as follows:"))
 777                 sys.stderr.write (error)
 778                 sys.stderr.write (stderr.read ())
 779                 ly.exit (status)
 780
 781         if verbose_p:
 782                 ly.progress ('\n')
 783
 784         return output
 785
 786 def run_filter (s):
 787         return filter_pipe (s, filter_cmd)
 788
 789 def is_derived_class (cl,  baseclass):
 790         if cl == baseclass:
 791                 return 1
 792         for b in cl.__bases__:
 793                 if is_derived_class (b, baseclass):
 794                         return 1
 795         return 0
 796
 797
 798 def process_snippets (cmd, snippets):
 799         names = filter (lambda x: x, map (Lilypond_snippet.basename, snippets))
 800         if names:
 801                 ly.system (string.join ([cmd] + names))
 802
 803         if format == HTML or format == TEXINFO:
 804                 for i in names:
 805                         if not os.path.exists (i + '.eps') and os.path.exists (i + '.tex'):
 806                                 to_eps (i)
 807                                 ly.make_ps_images (i + '.eps', resolution=110)
 808 #                       elif os.path.exists (i + '.ps'):
 809 #                               ly.make_ps_images (i + '.ps', resolution=110)
 810
 811
 812 LATEX_DOCUMENT = r'''
 813 %(preamble)s
 814 \begin{document}
 815 \typeout{textwidth=\the\textwidth}
 816 \typeout{columnsep=\the\columnsep}
 817 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
 818 \end{document}
 819 '''
 820 #need anything else besides textwidth?
 821 def get_latex_textwidth (source):
 822         m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
 823         preamble = source[:m.start (0)]
 824         latex_document = LATEX_DOCUMENT % vars ()
 825         parameter_string = filter_pipe (latex_document, latex_filter_cmd)
 826
 827         columns = 0
 828         m = re.search ('columns=([0-9.]*)', parameter_string)
 829         if m:
 830                 columns = string.atoi (m.group (1))
 831
 832         columnsep = 0
 833         m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
 834         if m:
 835                 columnsep = string.atof (m.group (1))
 836
 837         textwidth = 0
 838         m = re.search('textwidth=([0-9.]*)pt', parameter_string)
 839         if m:
 840                 textwidth = string.atof (m.group (1))
 841                 if columns:
 842                         textwidth = (textwidth - columnsep) / columns
 843
 844         return textwidth
 845
 846 ext2format = {
 847         '.html' : HTML,
 848         '.itely' : TEXINFO,
 849         '.lytex' : LATEX,
 850         '.tely' : TEXINFO,
 851         '.tex': LATEX,
 852         '.texi' : TEXINFO,
 853         '.texinfo' : TEXINFO,
 854         '.xml' : HTML,
 855         }
 856
 857 format2ext = {
 858         HTML: '.html',
 859         #TEXINFO: '.texinfo',
 860         TEXINFO: '.texi',
 861         LATEX: '.tex',
 862         }
 863
 864 def do_file (input_filename):
 865         #ugh
 866         global format
 867         if not format:
 868                 e = os.path.splitext (input_filename)[1]
 869                 if e in ext2format.keys ():
 870                         #FIXME
 871                         format = ext2format[e]
 872                 else:
 873                         ly.error (_ ("cannot determine format for: %s" \
 874                                      % input_filename))
 875
 876         if not input_filename or input_filename == '-':
 877                 in_handle = sys.stdin
 878                 input_fullname = '<stdin>'
 879         else:
 880                 if os.path.exists (input_filename):
 881                         input_fullname = input_filename
 882                 elif format == LATEX:
 883                         # urg python interface to libkpathsea?
 884                         input_fullname = ly.read_pipe ('kpsewhich '
 885                                                        + input_filename)[:-1]
 886                 else:
 887                         input_fullname = find_file (input_filename)
 888                 in_handle = open (input_fullname)
 889
 890         if input_filename == '-':
 891                 input_base = 'stdin'
 892         else:
 893                 input_base = os.path.basename \
 894                              (os.path.splitext (input_filename)[0])
 895
 896         # only default to stdout when filtering
 897         if output_name == '-' or (not output_name and filter_cmd):
 898                 output_filename = '-'
 899                 output_file = sys.stdout
 900         else:
 901                 if not output_name:
 902                         output_filename = input_base + format2ext[format]
 903                 else:
 904                         if not os.path.isdir (output_name):
 905                                 os.mkdir (output_name, 0777)
 906                         output_filename = (output_name
 907                                            + '/' + input_base
 908                                            + format2ext[format])
 909
 910
 911                 if (os.path.exists (input_filename) and
 912                     os.path.exists (output_filename) and
 913                     os.path.samefile (output_filename, input_fullname)):
 914                         ly.error (_("Output would overwrite input file; use --output."))
 915                         sys.exit (2)
 916
 917                 output_file = open (output_filename, 'w')
 918                 if output_name:
 919                         os.chdir (output_name)
 920
 921         ly.progress (_ ("Reading %s...") % input_fullname)
 922         source = in_handle.read ()
 923         ly.progress ('\n')
 924
 925         # FIXME: containing blocks must be first, see find_toplevel_snippets
 926         snippet_types = (
 927                 'multiline_comment',
 928                 'verbatim',
 929                 'lilypond_block',
 930 #               'verb',
 931                 'singleline_comment',
 932                 'lilypond_file',
 933                 'include',
 934                 'lilypond', )
 935         ly.progress (_ ("Dissecting..."))
 936         chunks = find_toplevel_snippets (source, snippet_types)
 937         ly.progress ('\n')
 938
 939         global default_ly_options
 940         textwidth = 0
 941         if LINEWIDTH not in default_ly_options.keys ():
 942                 if format == LATEX:
 943                         textwidth = get_latex_textwidth (source)
 944                         default_ly_options[LINEWIDTH] = '''%.0f\\pt''' \
 945                                                         % textwidth
 946                 elif format == TEXINFO:
 947                         for (k, v) in texinfo_linewidths.items ():
 948                                 # FIXME: @paper is usually not in chunk #0:
 949                                 #        \input texinfo @c -*-texinfo-*-
 950                                 # bluntly search first K of source
 951                                 # s = chunks[0].replacement_text ()
 952                                 if re.search (k, source[:1024]):
 953                                         default_ly_options[LINEWIDTH] = v
 954                                         break
 955
 956         if filter_cmd:
 957                 output_file.writelines ([c.filter_text () for c in chunks])
 958
 959
 960         elif process_cmd:
 961                 outdated = filter (lambda x: is_derived_class (x.__class__, Lilypond_snippet) \
 962                                    and x.is_outdated (), chunks)
 963                 ly.progress (_ ("Writing snippets..."))
 964                 map (Lilypond_snippet.write_ly, outdated)
 965                 ly.progress ('\n')
 966
 967                 if outdated:
 968                         ly.progress (_ ("Processing..."))
 969                         process_snippets (process_cmd, outdated)
 970                 else:
 971                         ly.progress (_ ("All snippets are up to date..."))
 972                 ly.progress ('\n')
 973
 974                 ly.progress (_ ("Compiling %s...") % output_filename)
 975                 output_file.writelines ([s.replacement_text () \
 976                                          for s in chunks])
 977                 ly.progress ('\n')
 978
 979         def process_include (snippet):
 980                 os.chdir (original_dir)
 981                 name = snippet.substring ('filename')
 982                 ly.progress (_ ('Processing include: %s') % name)
 983                 ly.progress ('\n')
 984                 do_file (name)
 985
 986         map (process_include,
 987              filter (lambda x: is_derived_class (x.__class__, Include_snippet), chunks))
 988
 989 def do_options ():
 990         global format, output_name
 991         global filter_cmd, process_cmd, verbose_p
 992
 993         (sh, long) = ly.getopt_args (option_definitions)
 994         try:
 995                 (options, files) = getopt.getopt (sys.argv[1:], sh, long)
 996         except getopt.error, s:
 997                 sys.stderr.write ('\n')
 998                 ly.error (_ ("getopt says: `%s\'" % s))
 999                 sys.stderr.write ('\n')
1000                 ly.help ()
1001                 ly.exit (2)
1002
1003         for opt in options:
1004                 o = opt[0]
1005                 a = opt[1]
1006
1007                 if 0:
1008                         pass
1009                 elif o == '--filter' or o == '-F':
1010                         filter_cmd = a
1011                         process_cmd = 0
1012                 elif o == '--format' or o == '-f':
1013                         format = a
1014                         if a == 'texi-html' or a == 'texi':
1015                                 format = TEXINFO
1016                 elif o == '--help' or o == '-h':
1017                         ly.help ()
1018                         sys.exit (0)
1019                 elif o == '--include' or o == '-I':
1020                         include_path.append (os.path.join (original_dir,
1021                                                            ly.abspath (a)))
1022                 elif o == '--output' or o == '-o':
1023                         output_name = a
1024                 elif o == '--outdir':
1025                         output_name = a
1026                 elif o == '--process' or o == '-P':
1027                         process_cmd = a
1028                         filter_cmd = 0
1029                 elif o == '--version' or o == '-v':
1030                         ly.identify (sys.stdout)
1031                         sys.exit (0)
1032                 elif o == '--verbose' or o == '-V':
1033                         verbose_p = 1
1034                 elif o == '--warranty' or o == '-w':
1035                         if 1 or status:
1036                                 ly.warranty ()
1037                         sys.exit (0)
1038         return files
1039
1040 def main ():
1041         files = do_options ()
1042         global process_cmd
1043         if process_cmd:
1044                 process_cmd += string.join ([(' -I %s' % p)
1045                                              for p in include_path])
1046
1047         ly.identify (sys.stderr)
1048         ly.setup_environment ()
1049         if files:
1050                 do_file (files[0])
1051
1052 if __name__ == '__main__':
1053         main ()