python/book_snippets.py

   1 # -*- coding: utf-8 -*-
   2
   3 import book_base as BookBase
   4 import lilylib as ly
   5 global _;_=ly._
   6 import re
   7 import os
   8 import copy
   9 # TODO: We are using os.popen3, which has been deprecated since python 2.6. The
  10 # suggested replacement is the Popen function of the subprocess module.
  11 # Unfortunately, on windows this needs the msvcrt module, which doesn't seem
  12 # to be available in GUB?!?!?!
  13 # from subprocess import Popen, PIPE
  14
  15 progress = ly.progress
  16 warning = ly.warning
  17 error = ly.error
  18 debug = ly.debug_output
  19
  20
  21
  22
  23
  24 ####################################################################
  25 # Snippet option handling
  26 ####################################################################
  27
  28
  29 #
  30 # Is this pythonic?  Personally, I find this rather #define-nesque. --hwn
  31 #
  32 # Global definitions:
  33 ADDVERSION = 'addversion'
  34 AFTER = 'after'
  35 ALT = 'alt'
  36 BEFORE = 'before'
  37 DOCTITLE = 'doctitle'
  38 EXAMPLEINDENT = 'exampleindent'
  39 FILENAME = 'filename'
  40 FILTER = 'filter'
  41 FRAGMENT = 'fragment'
  42 LAYOUT = 'layout'
  43 LINE_WIDTH = 'line-width'
  44 NOFRAGMENT = 'nofragment'
  45 NOGETTEXT = 'nogettext'
  46 NOINDENT = 'noindent'
  47 INDENT = 'indent'
  48 NORAGGED_RIGHT = 'noragged-right'
  49 NOTES = 'body'
  50 NOTIME = 'notime'
  51 OUTPUT = 'output'
  52 OUTPUTIMAGE = 'outputimage'
  53 PAPER = 'paper'
  54 PAPERSIZE = 'papersize'
  55 PREAMBLE = 'preamble'
  56 PRINTFILENAME = 'printfilename'
  57 QUOTE = 'quote'
  58 RAGGED_RIGHT = 'ragged-right'
  59 RELATIVE = 'relative'
  60 STAFFSIZE = 'staffsize'
  61 TEXIDOC = 'texidoc'
  62 VERBATIM = 'verbatim'
  63 VERSION = 'lilypondversion'
  64
  65
  66
  67 # NOTIME and NOGETTEXT have no opposite so they aren't part of this
  68 # dictionary.
  69 no_options = {
  70     NOFRAGMENT: FRAGMENT,
  71     NOINDENT: INDENT,
  72 }
  73
  74 # Options that have no impact on processing by lilypond (or --process
  75 # argument)
  76 PROCESSING_INDEPENDENT_OPTIONS = (
  77     ALT, NOGETTEXT, VERBATIM, ADDVERSION,
  78     TEXIDOC, DOCTITLE, VERSION, PRINTFILENAME)
  79
  80
  81
  82 # Options without a pattern in snippet_options.
  83 simple_options = [
  84     EXAMPLEINDENT,
  85     FRAGMENT,
  86     NOFRAGMENT,
  87     NOGETTEXT,
  88     NOINDENT,
  89     PRINTFILENAME,
  90     DOCTITLE,
  91     TEXIDOC,
  92     VERBATIM,
  93     FILENAME,
  94     ALT,
  95     ADDVERSION
  96 ]
  97
  98
  99
 100 ####################################################################
 101 # LilyPond templates for the snippets
 102 ####################################################################
 103
 104 snippet_options = {
 105     ##
 106     NOTES: {
 107         RELATIVE: r'''\relative c%(relative_quotes)s''',
 108     },
 109
 110     ##
 111     PAPER: {
 112         PAPERSIZE: r'''#(set-paper-size "%(papersize)s")''',
 113         INDENT: r'''indent = %(indent)s''',
 114         LINE_WIDTH: r'''line-width = %(line-width)s''',
 115         QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
 116         RAGGED_RIGHT: r'''ragged-right = ##t''',
 117         NORAGGED_RIGHT: r'''ragged-right = ##f''',
 118     },
 119
 120     ##
 121     LAYOUT: {
 122         NOTIME: r'''
 123  \context {
 124    \Score
 125    timing = ##f
 126  }
 127  \context {
 128    \Staff
 129    \remove "Time_signature_engraver"
 130  }''',
 131     },
 132
 133     ##
 134     PREAMBLE: {
 135         STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
 136     },
 137 }
 138
 139
 140
 141
 142
 143 def classic_lilypond_book_compatibility (key, value):
 144     if key == 'lilyquote':
 145         return (QUOTE, value)
 146     if key == 'singleline' and value == None:
 147         return (RAGGED_RIGHT, None)
 148
 149     m = re.search ('relative\s*([-0-9])', key)
 150     if m:
 151         return ('relative', m.group (1))
 152
 153     m = re.match ('([0-9]+)pt', key)
 154     if m:
 155         return ('staffsize', m.group (1))
 156
 157     if key == 'indent' or key == 'line-width':
 158         m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
 159         if m:
 160             f = float (m.group (1))
 161             return (key, '%f\\%s' % (f, m.group (2)))
 162
 163     return (None, None)
 164
 165
 166 # TODO: Remove the 1mm additional padding in the line-width, once lilypond
 167 #       creates tighter cropped images!
 168 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
 169 %%%% Options: [%(option_string)s]
 170 \\include "lilypond-book-preamble.ly"
 171
 172
 173 %% ****************************************************************
 174 %% Start cut-&-pastable-section
 175 %% ****************************************************************
 176
 177 %(preamble_string)s
 178
 179 \paper {
 180   %(paper_string)s
 181   %% offset the left padding, also add 1mm as lilypond creates cropped
 182   %% images with a little space on the right
 183   line-width = #(- line-width (* mm  %(padding_mm)f) (* mm 1))
 184 }
 185
 186 \layout {
 187   %(layout_string)s
 188 }
 189
 190 %(safe_mode_string)s
 191 '''
 192
 193
 194 FULL_LY = '''
 195
 196
 197 %% ****************************************************************
 198 %% ly snippet:
 199 %% ****************************************************************
 200 %(code)s
 201
 202
 203 %% ****************************************************************
 204 %% end ly snippet
 205 %% ****************************************************************
 206 '''
 207
 208 FRAGMENT_LY = r'''
 209 %(notes_string)s
 210 {
 211
 212
 213 %% ****************************************************************
 214 %% ly snippet contents follows:
 215 %% ****************************************************************
 216 %(code)s
 217
 218
 219 %% ****************************************************************
 220 %% end ly snippet
 221 %% ****************************************************************
 222 }
 223 '''
 224
 225
 226
 227
 228 ####################################################################
 229 # Helper functions
 230 ####################################################################
 231
 232 def ps_page_count (ps_name):
 233     header = file (ps_name).read (1024)
 234     m = re.search ('\n%%Pages: ([0-9]+)', header)
 235     if m:
 236         return int (m.group (1))
 237     return 0
 238
 239 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
 240 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
 241 ly_context_id_re = re.compile ('\\\\(?:new|context)\\s+(?:[a-zA-Z]*?(?:Staff\
 242 (?:Group)?|Voice|FiguredBass|FretBoards|Names|Devnull))\\s+=\\s+"?([a-zA-Z]+)"?\\s+')
 243
 244 def ly_comment_gettext (t, m):
 245     return m.group (1) + t (m.group (2))
 246
 247
 248
 249 class CompileError(Exception):
 250   pass
 251
 252
 253
 254 ####################################################################
 255 # Snippet classes
 256 ####################################################################
 257
 258 class Chunk:
 259     def replacement_text (self):
 260         return ''
 261
 262     def filter_text (self):
 263         return self.replacement_text ()
 264
 265     def is_plain (self):
 266         return False
 267
 268 class Substring (Chunk):
 269     """A string that does not require extra memory."""
 270     def __init__ (self, source, start, end, line_number):
 271         self.source = source
 272         self.start = start
 273         self.end = end
 274         self.line_number = line_number
 275         self.override_text = None
 276
 277     def is_plain (self):
 278         return True
 279
 280     def replacement_text (self):
 281         if self.override_text:
 282             return self.override_text
 283         else:
 284             return self.source[self.start:self.end]
 285
 286
 287
 288 class Snippet (Chunk):
 289     def __init__ (self, type, match, formatter, line_number, global_options):
 290         self.type = type
 291         self.match = match
 292         self.checksum = 0
 293         self.option_dict = {}
 294         self.formatter = formatter
 295         self.line_number = line_number
 296         self.global_options = global_options
 297         self.replacements = {'program_version': ly.program_version,
 298                              'program_name': ly.program_name}
 299
 300     # return a shallow copy of the replacements, so the caller can modify
 301     # it locally without interfering with other snippet operations
 302     def get_replacements (self):
 303         return copy.copy (self.replacements)
 304
 305     def replacement_text (self):
 306         return self.match.group ('match')
 307
 308     def substring (self, s):
 309         return self.match.group (s)
 310
 311     def __repr__ (self):
 312         return `self.__class__` + ' type = ' + self.type
 313
 314
 315
 316 class IncludeSnippet (Snippet):
 317     def processed_filename (self):
 318         f = self.substring ('filename')
 319         return os.path.splitext (f)[0] + self.formatter.default_extension
 320
 321     def replacement_text (self):
 322         s = self.match.group ('match')
 323         f = self.substring ('filename')
 324         return re.sub (f, self.processed_filename (), s)
 325
 326
 327
 328 class LilypondSnippet (Snippet):
 329     def __init__ (self, type, match, formatter, line_number, global_options):
 330         Snippet.__init__ (self, type, match, formatter, line_number, global_options)
 331         os = match.group ('options')
 332         self.do_options (os, self.type)
 333
 334
 335     def snippet_options (self):
 336         return [];
 337
 338     def verb_ly_gettext (self, s):
 339         lang = self.formatter.document_language
 340         if not lang:
 341             return s
 342         try:
 343             t = langdefs.translation[lang]
 344         except:
 345             return s
 346
 347         s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
 348
 349         if langdefs.LANGDICT[lang].enable_ly_identifier_l10n:
 350             for v in ly_var_def_re.findall (s):
 351                 s = re.sub (r"(?m)(?<!\\clef)(^|[' \\#])%s([^a-zA-Z])" % v,
 352                             "\\1" + t (v) + "\\2",
 353                             s)
 354             for id in ly_context_id_re.findall (s):
 355                 s = re.sub (r'(\s+|")%s(\s+|")' % id,
 356                             "\\1" + t (id) + "\\2",
 357                             s)
 358         return s
 359
 360     def verb_ly (self):
 361         verb_text = self.substring ('code')
 362         if not NOGETTEXT in self.option_dict:
 363             verb_text = self.verb_ly_gettext (verb_text)
 364         if not verb_text.endswith ('\n'):
 365             verb_text += '\n'
 366         return verb_text
 367
 368     def ly (self):
 369         contents = self.substring ('code')
 370         return ('\\sourcefileline %d\n%s'
 371                 % (self.line_number - 1, contents))
 372
 373     def full_ly (self):
 374         s = self.ly ()
 375         if s:
 376             return self.compose_ly (s)
 377         return ''
 378
 379     def split_options (self, option_string):
 380         return self.formatter.split_snippet_options (option_string);
 381
 382     def do_options (self, option_string, type):
 383         self.option_dict = {}
 384
 385         options = self.split_options (option_string)
 386
 387         for option in options:
 388             if '=' in option:
 389                 (key, value) = re.split ('\s*=\s*', option)
 390                 self.option_dict[key] = value
 391             else:
 392                 if option in no_options:
 393                     if no_options[option] in self.option_dict:
 394                         del self.option_dict[no_options[option]]
 395                 else:
 396                     self.option_dict[option] = None
 397
 398
 399         # Store if we have an explicit line-width given
 400         has_line_width = self.option_dict.has_key (LINE_WIDTH)
 401         if has_line_width and self.option_dict[LINE_WIDTH] == None:
 402             has_line_width = False
 403             del self.option_dict[LINE_WIDTH]
 404
 405         # Use default options (i.e. auto-detected line-width, etc)
 406         for k in self.formatter.default_snippet_options:
 407             if k not in self.option_dict:
 408                 self.option_dict[k] = self.formatter.default_snippet_options[k]
 409
 410         # RELATIVE does not work without FRAGMENT;
 411         # make RELATIVE imply FRAGMENT
 412         has_relative = self.option_dict.has_key (RELATIVE)
 413         if has_relative and not self.option_dict.has_key (FRAGMENT):
 414             self.option_dict[FRAGMENT] = None
 415
 416         if not INDENT in self.option_dict:
 417             self.option_dict[INDENT] = '0\\mm'
 418
 419         # Set a default line-width if there is none. We need this, because
 420         # lilypond-book has set left-padding by default and therefore does
 421         # #(define line-width (- line-width (* 3 mm)))
 422         # TODO: Junk this ugly hack if the code gets rewritten to concatenate
 423         # all settings before writing them in the \paper block.
 424         if not LINE_WIDTH in self.option_dict:
 425             if not QUOTE in self.option_dict:
 426                 self.option_dict[LINE_WIDTH] = "#(- paper-width \
 427 left-margin-default right-margin-default)"
 428
 429     def get_option_list (self):
 430         if not 'option_list' in self.__dict__:
 431             option_list = []
 432             for (key, value) in self.option_dict.items ():
 433                 if value == None:
 434                     option_list.append (key)
 435                 else:
 436                     option_list.append (key + '=' + value)
 437             option_list.sort ()
 438             self.option_list = option_list
 439         return self.option_list
 440
 441     def compose_ly (self, code):
 442
 443         # Defaults.
 444         relative = 1
 445         override = {}
 446         # The original concept of the `exampleindent' option is broken.
 447         # It is not possible to get a sane value for @exampleindent at all
 448         # without processing the document itself.  Saying
 449         #
 450         #   @exampleindent 0
 451         #   @example
 452         #   ...
 453         #   @end example
 454         #   @exampleindent 5
 455         #
 456         # causes ugly results with the DVI backend of texinfo since the
 457         # default value for @exampleindent isn't 5em but 0.4in (or a smaller
 458         # value).  Executing the above code changes the environment
 459         # indentation to an unknown value because we don't know the amount
 460         # of 1em in advance since it is font-dependent.  Modifying
 461         # @exampleindent in the middle of a document is simply not
 462         # supported within texinfo.
 463         #
 464         # As a consequence, the only function of @exampleindent is now to
 465         # specify the amount of indentation for the `quote' option.
 466         #
 467         # To set @exampleindent locally to zero, we use the @format
 468         # environment for non-quoted snippets.
 469         override[EXAMPLEINDENT] = r'0.4\in'
 470         override[LINE_WIDTH] = '5\\in' # = texinfo_line_widths['@smallbook']
 471         override.update (self.formatter.default_snippet_options)
 472
 473         option_list = []
 474         for option in self.get_option_list ():
 475             for name in PROCESSING_INDEPENDENT_OPTIONS:
 476                 if option.startswith (name):
 477                     break
 478             else:
 479                 option_list.append (option)
 480         option_string = ','.join (option_list)
 481         compose_dict = {}
 482         compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
 483         for a in compose_types:
 484             compose_dict[a] = []
 485
 486         option_names = self.option_dict.keys ()
 487         option_names.sort ()
 488         for key in option_names:
 489             value = self.option_dict[key]
 490             (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
 491             if c_key:
 492                 if c_value:
 493                     warning (
 494                         _ ("deprecated ly-option used: %s=%s") % (key, value))
 495                     warning (
 496                         _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
 497                 else:
 498                     warning (
 499                         _ ("deprecated ly-option used: %s") % key)
 500                     warning (
 501                         _ ("compatibility mode translation: %s") % c_key)
 502
 503                 (key, value) = (c_key, c_value)
 504
 505             if value:
 506                 override[key] = value
 507             else:
 508                 if not override.has_key (key):
 509                     override[key] = None
 510
 511             found = 0
 512             for typ in compose_types:
 513                 if snippet_options[typ].has_key (key):
 514                     compose_dict[typ].append (snippet_options[typ][key])
 515                     found = 1
 516                     break
 517
 518             if not found and key not in simple_options and key not in self.snippet_options ():
 519                 warning (_ ("ignoring unknown ly option: %s") % key)
 520
 521         # URGS
 522         if RELATIVE in override and override[RELATIVE]:
 523             relative = int (override[RELATIVE])
 524
 525         relative_quotes = ''
 526
 527         # 1 = central C
 528         if relative < 0:
 529             relative_quotes += ',' * (- relative)
 530         elif relative > 0:
 531             relative_quotes += "'" * relative
 532
 533         # put paper-size first, if it exists
 534         for i,elem in enumerate(compose_dict[PAPER]):
 535             if elem.startswith("#(set-paper-size"):
 536                 compose_dict[PAPER].insert(0, compose_dict[PAPER].pop(i))
 537                 break
 538
 539         paper_string = '\n  '.join (compose_dict[PAPER]) % override
 540         layout_string = '\n  '.join (compose_dict[LAYOUT]) % override
 541         notes_string = '\n  '.join (compose_dict[NOTES]) % vars ()
 542         preamble_string = '\n  '.join (compose_dict[PREAMBLE]) % override
 543         padding_mm = self.global_options.padding_mm
 544         if self.global_options.safe_mode:
 545             safe_mode_string = "#(ly:set-option 'safe #t)"
 546         else:
 547             safe_mode_string = ""
 548
 549         d = globals().copy()
 550         d.update (locals())
 551         d.update (self.global_options.information)
 552         if FRAGMENT in self.option_dict:
 553             body = FRAGMENT_LY
 554         else:
 555             body = FULL_LY
 556         return (PREAMBLE_LY + body) % d
 557
 558     def get_checksum (self):
 559         if not self.checksum:
 560             # Work-around for md5 module deprecation warning in python 2.5+:
 561             try:
 562                 from hashlib import md5
 563             except ImportError:
 564                 from md5 import md5
 565
 566             # We only want to calculate the hash based on the snippet
 567             # code plus fragment options relevant to processing by
 568             # lilypond, not the snippet + preamble
 569             hash = md5 (self.relevant_contents (self.ly ()))
 570             for option in self.get_option_list ():
 571                 for name in PROCESSING_INDEPENDENT_OPTIONS:
 572                     if option.startswith (name):
 573                         break
 574                 else:
 575                     hash.update (option)
 576
 577             ## let's not create too long names.
 578             self.checksum = hash.hexdigest ()[:10]
 579
 580         return self.checksum
 581
 582     def basename (self):
 583         cs = self.get_checksum ()
 584         name = os.path.join (cs[:2], 'lily-%s' % cs[2:])
 585         return name
 586
 587     final_basename = basename
 588
 589     def write_ly (self):
 590         base = self.basename ()
 591         path = os.path.join (self.global_options.lily_output_dir, base)
 592         directory = os.path.split(path)[0]
 593         if not os.path.isdir (directory):
 594             os.makedirs (directory)
 595         filename = path + '.ly'
 596         if os.path.exists (filename):
 597             existing = open (filename, 'r').read ()
 598
 599             if self.relevant_contents (existing) != self.relevant_contents (self.full_ly ()):
 600                 warning ("%s: duplicate filename but different contents of orginal file,\n\
 601 printing diff against existing file." % filename)
 602                 ly.stderr_write (self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename))
 603         else:
 604             out = file (filename, 'w')
 605             out.write (self.full_ly ())
 606             file (path + '.txt', 'w').write ('image of music')
 607
 608     def relevant_contents (self, ly):
 609         return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
 610
 611     def link_all_output_files (self, output_dir, output_dir_files, destination):
 612         existing, missing = self.all_output_files (output_dir, output_dir_files)
 613         if missing:
 614             print '\nMissing', missing
 615             raise CompileError(self.basename())
 616         for name in existing:
 617             if (self.global_options.use_source_file_names
 618                 and isinstance (self, LilypondFileSnippet)):
 619                 base, ext = os.path.splitext (name)
 620                 components = base.split ('-')
 621                 # ugh, assume filenames with prefix with one dash (lily-xxxx)
 622                 if len (components) > 2:
 623                     base_suffix = '-' + components[-1]
 624                 else:
 625                     base_suffix = ''
 626                 final_name = self.final_basename () + base_suffix + ext
 627             else:
 628                 final_name = name
 629             try:
 630                 os.unlink (os.path.join (destination, final_name))
 631             except OSError:
 632                 pass
 633
 634             src = os.path.join (output_dir, name)
 635             dst = os.path.join (destination, final_name)
 636             dst_path = os.path.split(dst)[0]
 637             if not os.path.isdir (dst_path):
 638                 os.makedirs (dst_path)
 639             os.link (src, dst)
 640
 641     def additional_files_to_consider (self, base, full):
 642         return []
 643     def additional_files_required (self, base, full):
 644         return []
 645
 646
 647     def all_output_files (self, output_dir, output_dir_files):
 648         """Return all files generated in lily_output_dir, a set.
 649
 650         output_dir_files is the list of files in the output directory.
 651         """
 652         result = set ()
 653         missing = set ()
 654         base = self.basename()
 655         full = os.path.join (output_dir, base)
 656         def consider_file (name):
 657             if name in output_dir_files:
 658                 result.add (name)
 659
 660         def require_file (name):
 661             if name in output_dir_files:
 662                 result.add (name)
 663             else:
 664                 missing.add (name)
 665
 666         # UGH - junk self.global_options
 667         skip_lily = self.global_options.skip_lilypond_run
 668         for required in [base + '.ly',
 669                          base + '.txt']:
 670             require_file (required)
 671         if not skip_lily:
 672             require_file (base + '-systems.count')
 673
 674         if 'ddump-profile' in self.global_options.process_cmd:
 675             require_file (base + '.profile')
 676         if 'dseparate-log-file' in self.global_options.process_cmd:
 677             require_file (base + '.log')
 678
 679         map (consider_file, [base + '.tex',
 680                              base + '.eps',
 681                              base + '.texidoc',
 682                              base + '.doctitle',
 683                              base + '-systems.texi',
 684                              base + '-systems.tex',
 685                              base + '-systems.pdftexi'])
 686         if self.formatter.document_language:
 687             map (consider_file,
 688                  [base + '.texidoc' + self.formatter.document_language,
 689                   base + '.doctitle' + self.formatter.document_language])
 690
 691         required_files = self.formatter.required_files (self, base, full, result)
 692         for f in required_files:
 693             require_file (f)
 694
 695         system_count = 0
 696         if not skip_lily and not missing:
 697             system_count = int(file (full + '-systems.count').read())
 698
 699         for number in range(1, system_count + 1):
 700             systemfile = '%s-%d' % (base, number)
 701             require_file (systemfile + '.eps')
 702             consider_file (systemfile + '.pdf')
 703
 704             # We can't require signatures, since books and toplevel
 705             # markups do not output a signature.
 706             if 'ddump-signature' in self.global_options.process_cmd:
 707                 consider_file (systemfile + '.signature')
 708
 709         map (consider_file, self.additional_files_to_consider (base, full))
 710         map (require_file, self.additional_files_required (base, full))
 711
 712         return (result, missing)
 713
 714     def is_outdated (self, output_dir, current_files):
 715         found, missing = self.all_output_files (output_dir, current_files)
 716         return missing
 717
 718     def filter_pipe (self, input, cmd):
 719         """Pass input through cmd, and return the result."""
 720
 721         debug (_ ("Running through filter `%s'") % cmd, True)
 722
 723         # TODO: Use Popen once we resolve the problem with msvcrt in Windows:
 724         (stdin, stdout, stderr) = os.popen3 (cmd)
 725         # p = Popen(cmd, shell=True, stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
 726         # (stdin, stdout, stderr) = (p.stdin, p.stdout, p.stderr)
 727         stdin.write (input)
 728         status = stdin.close ()
 729
 730         if not status:
 731             status = 0
 732             output = stdout.read ()
 733             status = stdout.close ()
 734             err = stderr.read ()
 735
 736         if not status:
 737             status = 0
 738         signal = 0x0f & status
 739         if status or (not output and err):
 740             exit_status = status >> 8
 741             ly.error (_ ("`%s' failed (%d)") % (cmd, exit_status))
 742             ly.error (_ ("The error log is as follows:"))
 743             ly.stderr_write (err)
 744             ly.stderr_write (stderr.read ())
 745             exit (status)
 746
 747         debug ('\n')
 748
 749         return output
 750
 751     def get_snippet_code (self):
 752         return self.substring ('code');
 753
 754     def filter_text (self):
 755         """Run snippet bodies through a command (say: convert-ly).
 756
 757         This functionality is rarely used, and this code must have bitrot.
 758         """
 759         code = self.get_snippet_code ();
 760         s = self.filter_pipe (code, self.global_options.filter_cmd)
 761         d = {
 762             'code': s,
 763             'options': self.match.group ('options')
 764         }
 765         return self.formatter.output_simple_replacements (FILTER, d)
 766
 767     def replacement_text (self):
 768         base = self.final_basename ()
 769         return self.formatter.snippet_output (base, self)
 770
 771     def get_images (self):
 772         rep = {'base': self.final_basename ()}
 773
 774         single = '%(base)s.png' % rep
 775         multiple = '%(base)s-page1.png' % rep
 776         images = (single,)
 777         if (os.path.exists (multiple)
 778             and (not os.path.exists (single)
 779                  or (os.stat (multiple)[stat.ST_MTIME]
 780                      > os.stat (single)[stat.ST_MTIME]))):
 781             count = ps_page_count ('%(base)s.eps' % rep)
 782             images = ['%s-page%d.png' % (rep['base'], page) for page in range (1, count+1)]
 783             images = tuple (images)
 784
 785         return images
 786
 787
 788
 789 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
 790 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
 791
 792 class LilypondFileSnippet (LilypondSnippet):
 793     def __init__ (self, type, match, formatter, line_number, global_options):
 794         LilypondSnippet.__init__ (self, type, match, formatter, line_number, global_options)
 795         self.filename = self.substring ('filename')
 796         self.ext = os.path.splitext (os.path.basename (self.filename))[1]
 797         self.contents = file (BookBase.find_file (self.filename, global_options.include_path)).read ()
 798
 799     def get_snippet_code (self):
 800         return self.contents;
 801
 802     def verb_ly (self):
 803         s = self.contents
 804         s = re_begin_verbatim.split (s)[-1]
 805         s = re_end_verbatim.split (s)[0]
 806         if not NOGETTEXT in self.option_dict:
 807             s = self.verb_ly_gettext (s)
 808         if not s.endswith ('\n'):
 809             s += '\n'
 810         return s
 811
 812     def ly (self):
 813         name = self.filename
 814         return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
 815                 % (name, self.contents))
 816
 817     def final_basename (self):
 818         if self.global_options.use_source_file_names:
 819             base = os.path.splitext (os.path.basename (self.filename))[0]
 820             return base
 821         else:
 822             return self.basename ()
 823
 824
 825 class MusicXMLFileSnippet (LilypondFileSnippet):
 826     def __init__ (self, type, match, formatter, line_number, global_options):
 827         LilypondFileSnippet.__init__ (self, type, match, formatter, line_number, global_options)
 828         self.compressed = False
 829         self.converted_ly = None
 830         self.musicxml_options_dict = {
 831             'verbose': '--verbose',
 832             'lxml': '--lxml',
 833             'compressed': '--compressed',
 834             'relative': '--relative',
 835             'absolute': '--absolute',
 836             'no-articulation-directions': '--no-articulation-directions',
 837             'no-rest-positions': '--no-rest-positions',
 838             'no-page-layout': '--no-page-layout',
 839             'no-beaming': '--no-beaming',
 840             'language': '--language',
 841          }
 842
 843     def snippet_options (self):
 844         return self.musicxml_options_dict.keys ()
 845
 846     def convert_from_musicxml (self):
 847         name = self.filename
 848         xml2ly_option_list = []
 849         for (key, value) in self.option_dict.items ():
 850             cmd_key = self.musicxml_options_dict.get (key, None)
 851             if cmd_key == None:
 852                 continue
 853             if value == None:
 854                 xml2ly_option_list.append (cmd_key)
 855             else:
 856                 xml2ly_option_list.append (cmd_key + '=' + value)
 857         if ('.mxl' in name) and ('--compressed' not in xml2ly_option_list):
 858             xml2ly_option_list.append ('--compressed')
 859             self.compressed = True
 860         opts = " ".join (xml2ly_option_list)
 861         progress (_ ("Converting MusicXML file `%s'...\n") % self.filename)
 862
 863         ly_code = self.filter_pipe (self.contents, 'musicxml2ly %s --out=- - ' % opts)
 864         return ly_code
 865
 866     def ly (self):
 867         if self.converted_ly == None:
 868             self.converted_ly = self.convert_from_musicxml ()
 869         name = self.filename
 870         return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
 871                 % (name, self.converted_ly))
 872
 873     def additional_files_required (self, base, full):
 874         result = [];
 875         if self.compressed:
 876             result.append (base + '.mxl')
 877         else:
 878             result.append (base + '.xml')
 879         return result
 880
 881     def write_ly (self):
 882         base = self.basename ()
 883         path = os.path.join (self.global_options.lily_output_dir, base)
 884         directory = os.path.split(path)[0]
 885         if not os.path.isdir (directory):
 886             os.makedirs (directory)
 887
 888         # First write the XML to a file (so we can link it!)
 889         if self.compressed:
 890             xmlfilename = path + '.mxl'
 891         else:
 892             xmlfilename = path + '.xml'
 893         if os.path.exists (xmlfilename):
 894             diff_against_existing = self.filter_pipe (self.contents, 'diff -u %s - ' % xmlfilename)
 895             if diff_against_existing:
 896                 warning (_ ("%s: duplicate filename but different contents of orginal file,\n\
 897 printing diff against existing file.") % xmlfilename)
 898                 ly.stderr_write (diff_against_existing)
 899         else:
 900             out = file (xmlfilename, 'w')
 901             out.write (self.contents)
 902             out.close ()
 903
 904         # also write the converted lilypond
 905         filename = path + '.ly'
 906         if os.path.exists (filename):
 907             diff_against_existing = self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename)
 908             if diff_against_existing:
 909                 warning (_ ("%s: duplicate filename but different contents of converted lilypond file,\n\
 910 printing diff against existing file.") % filename)
 911                 ly.stderr_write (diff_against_existing)
 912         else:
 913             out = file (filename, 'w')
 914             out.write (self.full_ly ())
 915             out.close ()
 916             file (path + '.txt', 'w').write ('image of music')
 917
 918
 919
 920 class LilyPondVersionString (Snippet):
 921     """A string that does not require extra memory."""
 922     def __init__ (self, type, match, formatter, line_number, global_options):
 923         Snippet.__init__ (self, type, match, formatter, line_number, global_options)
 924
 925     def replacement_text (self):
 926         return self.formatter.output_simple (self.type, self)
 927
 928
 929 snippet_type_to_class = {
 930     'lilypond_file': LilypondFileSnippet,
 931     'lilypond_block': LilypondSnippet,
 932     'lilypond': LilypondSnippet,
 933     'include': IncludeSnippet,
 934     'lilypondversion': LilyPondVersionString,
 935     'musicxml_file': MusicXMLFileSnippet,
 936 }