1 # -*- coding: utf-8 -*-
3 import book_base as BookBase
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
15 progress = ly.progress
23 ####################################################################
24 # Snippet option handling
25 ####################################################################
29 # Is this pythonic? Personally, I find this rather #define-nesque. --hwn
32 ADDVERSION = 'addversion'
37 EXAMPLEINDENT = 'exampleindent'
42 LILYQUOTE = 'lilyquote'
43 LINE_WIDTH = 'line-width'
44 NOFRAGMENT = 'nofragment'
45 NOGETTEXT = 'nogettext'
48 NORAGGED_RIGHT = 'noragged-right'
52 OUTPUTIMAGE = 'outputimage'
54 PAPERSIZE = 'papersize'
56 PRINTFILENAME = 'printfilename'
58 RAGGED_RIGHT = 'ragged-right'
60 STAFFSIZE = 'staffsize'
63 VERSION = 'lilypondversion'
67 # NOTIME and NOGETTEXT have no opposite so they aren't part of this
74 # Options that have no impact on processing by lilypond (or --process
76 PROCESSING_INDEPENDENT_OPTIONS = (
77 ALT, NOGETTEXT, VERBATIM, ADDVERSION,
78 TEXIDOC, DOCTITLE, VERSION, PRINTFILENAME)
82 # Options without a pattern in snippet_options.
100 ####################################################################
101 # LilyPond templates for the snippets
102 ####################################################################
107 RELATIVE: r'''\relative c%(relative_quotes)s''',
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 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
117 RAGGED_RIGHT: r'''ragged-right = ##t''',
118 NORAGGED_RIGHT: r'''ragged-right = ##f''',
130 \remove "Time_signature_engraver"
136 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
144 def classic_lilypond_book_compatibility (key, value):
145 if key == 'singleline' and value == None:
146 return (RAGGED_RIGHT, None)
148 m = re.search ('relative\s*([-0-9])', key)
150 return ('relative', m.group (1))
152 m = re.match ('([0-9]+)pt', key)
154 return ('staffsize', m.group (1))
156 if key == 'indent' or key == 'line-width':
157 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
159 f = float (m.group (1))
160 return (key, '%f\\%s' % (f, m.group (2)))
165 # TODO: Remove the 1mm additional padding in the line-width, once lilypond
166 # creates tighter cropped images!
167 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
168 %%%% Options: [%(option_string)s]
169 \\include "lilypond-book-preamble.ly"
172 %% ****************************************************************
173 %% Start cut-&-pastable-section
174 %% ****************************************************************
180 %% offset the left padding, also add 1mm as lilypond creates cropped
181 %% images with a little space on the right
182 line-width = #(- line-width (* mm %(padding_mm)f) (* mm 1))
196 %% ****************************************************************
198 %% ****************************************************************
202 %% ****************************************************************
204 %% ****************************************************************
212 %% ****************************************************************
213 %% ly snippet contents follows:
214 %% ****************************************************************
218 %% ****************************************************************
220 %% ****************************************************************
227 ####################################################################
229 ####################################################################
231 def ps_page_count (ps_name):
232 header = file (ps_name).read (1024)
233 m = re.search ('\n%%Pages: ([0-9]+)', header)
235 return int (m.group (1))
238 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
239 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
240 ly_context_id_re = re.compile ('\\\\(?:new|context)\\s+(?:[a-zA-Z]*?(?:Staff\
241 (?:Group)?|Voice|FiguredBass|FretBoards|Names|Devnull))\\s+=\\s+"?([a-zA-Z]+)"?\\s+')
243 def ly_comment_gettext (t, m):
244 return m.group (1) + t (m.group (2))
248 class CompileError(Exception):
253 ####################################################################
255 ####################################################################
258 def replacement_text (self):
261 def filter_text (self):
262 return self.replacement_text ()
267 class Substring (Chunk):
268 """A string that does not require extra memory."""
269 def __init__ (self, source, start, end, line_number):
273 self.line_number = line_number
274 self.override_text = None
279 def replacement_text (self):
280 if self.override_text:
281 return self.override_text
283 return self.source[self.start:self.end]
287 class Snippet (Chunk):
288 def __init__ (self, type, match, formatter, line_number, global_options):
292 self.option_dict = {}
293 self.formatter = formatter
294 self.line_number = line_number
295 self.global_options = global_options
296 self.replacements = {'program_version': ly.program_version,
297 'program_name': ly.program_name}
299 # return a shallow copy of the replacements, so the caller can modify
300 # it locally without interfering with other snippet operations
301 def get_replacements (self):
302 return copy.copy (self.replacements)
304 def replacement_text (self):
305 return self.match.group ('match')
307 def substring (self, s):
308 return self.match.group (s)
311 return `self.__class__` + ' type = ' + self.type
315 class IncludeSnippet (Snippet):
316 def processed_filename (self):
317 f = self.substring ('filename')
318 return os.path.splitext (f)[0] + self.formatter.default_extension
320 def replacement_text (self):
321 s = self.match.group ('match')
322 f = self.substring ('filename')
323 return re.sub (f, self.processed_filename (), s)
327 class LilypondSnippet (Snippet):
328 def __init__ (self, type, match, formatter, line_number, global_options):
329 Snippet.__init__ (self, type, match, formatter, line_number, global_options)
330 os = match.group ('options')
331 self.do_options (os, self.type)
334 def snippet_options (self):
337 def verb_ly_gettext (self, s):
338 lang = self.formatter.document_language
342 t = langdefs.translation[lang]
346 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
348 if langdefs.LANGDICT[lang].enable_ly_identifier_l10n:
349 for v in ly_var_def_re.findall (s):
350 s = re.sub (r"(?m)(?<!\\clef)(^|[' \\#])%s([^a-zA-Z])" % v,
351 "\\1" + t (v) + "\\2",
353 for id in ly_context_id_re.findall (s):
354 s = re.sub (r'(\s+|")%s(\s+|")' % id,
355 "\\1" + t (id) + "\\2",
360 verb_text = self.substring ('code')
361 if not NOGETTEXT in self.option_dict:
362 verb_text = self.verb_ly_gettext (verb_text)
363 if not verb_text.endswith ('\n'):
368 contents = self.substring ('code')
369 return ('\\sourcefileline %d\n%s'
370 % (self.line_number - 1, contents))
375 return self.compose_ly (s)
378 def split_options (self, option_string):
379 return self.formatter.split_snippet_options (option_string);
381 def do_options (self, option_string, type):
382 self.option_dict = {}
384 options = self.split_options (option_string)
386 for option in options:
388 (key, value) = re.split ('\s*=\s*', option)
389 self.option_dict[key] = value
391 if option in no_options:
392 if no_options[option] in self.option_dict:
393 del self.option_dict[no_options[option]]
395 self.option_dict[option] = None
398 # If LINE_WIDTH is used without parameter, set it to default.
399 has_line_width = self.option_dict.has_key (LINE_WIDTH)
400 if has_line_width and self.option_dict[LINE_WIDTH] == None:
401 has_line_width = False
402 del self.option_dict[LINE_WIDTH]
404 # TODO: Can't we do that more efficiently (built-in python func?)
405 for k in self.formatter.default_snippet_options:
406 if k not in self.option_dict:
407 self.option_dict[k] = self.formatter.default_snippet_options[k]
409 # RELATIVE does not work without FRAGMENT;
410 # make RELATIVE imply FRAGMENT
411 has_relative = self.option_dict.has_key (RELATIVE)
412 if has_relative and not self.option_dict.has_key (FRAGMENT):
413 self.option_dict[FRAGMENT] = None
415 if not INDENT in self.option_dict:
416 self.option_dict[INDENT] = '0\\mm'
418 # Set a default line-width if there is none. We need this, because
419 # lilypond-book has set left-padding by default and therefore does
420 # #(define line-width (- line-width (* 3 mm)))
421 # TODO: Junk this ugly hack if the code gets rewritten to concatenate
422 # all settings before writing them in the \paper block.
423 if not LINE_WIDTH in self.option_dict:
424 if not QUOTE in self.option_dict:
425 if not LILYQUOTE in self.option_dict:
426 self.option_dict[LINE_WIDTH] = "#(- paper-width \
427 left-margin-default right-margin-default)"
429 def get_option_list (self):
430 if not 'option_list' in self.__dict__:
432 for (key, value) in self.option_dict.items ():
434 option_list.append (key)
436 option_list.append (key + '=' + value)
438 self.option_list = option_list
439 return self.option_list
441 def compose_ly (self, code):
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
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.
464 # As a consequence, the only function of @exampleindent is now to
465 # specify the amount of indentation for the `quote' option.
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)
474 for option in self.get_option_list ():
475 for name in PROCESSING_INDEPENDENT_OPTIONS:
476 if option.startswith (name):
479 option_list.append (option)
480 option_string = ','.join (option_list)
482 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
483 for a in compose_types:
486 option_names = self.option_dict.keys ()
488 for key in option_names:
489 value = self.option_dict[key]
490 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
494 _ ("deprecated ly-option used: %s=%s") % (key, value))
496 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
499 _ ("deprecated ly-option used: %s") % key)
501 _ ("compatibility mode translation: %s") % c_key)
503 (key, value) = (c_key, c_value)
506 override[key] = value
508 if not override.has_key (key):
512 for typ in compose_types:
513 if snippet_options[typ].has_key (key):
514 compose_dict[typ].append (snippet_options[typ][key])
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)
522 if RELATIVE in override and override[RELATIVE]:
523 relative = int (override[RELATIVE])
529 relative_quotes += ',' * (- relative)
531 relative_quotes += "'" * relative
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))
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)"
547 safe_mode_string = ""
551 d.update (self.global_options.information)
552 if FRAGMENT in self.option_dict:
556 return (PREAMBLE_LY + body) % d
558 def get_checksum (self):
559 if not self.checksum:
560 # Work-around for md5 module deprecation warning in python 2.5+:
562 from hashlib import md5
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):
577 ## let's not create too long names.
578 self.checksum = hash.hexdigest ()[:10]
583 cs = self.get_checksum ()
584 name = '%s/lily-%s' % (cs[:2], cs[2:])
587 final_basename = basename
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 ()
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))
604 out = file (filename, 'w')
605 out.write (self.full_ly ())
606 file (path + '.txt', 'w').write ('image of music')
608 def relevant_contents (self, ly):
609 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
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)
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]
626 final_name = self.final_basename () + base_suffix + ext
630 os.unlink (os.path.join (destination, final_name))
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)
641 def additional_files_to_consider (self, base, full):
643 def additional_files_required (self, base, full):
647 def all_output_files (self, output_dir, output_dir_files):
648 """Return all files generated in lily_output_dir, a set.
650 output_dir_files is the list of files in the output directory.
654 base = self.basename()
655 full = os.path.join (output_dir, base)
656 def consider_file (name):
657 if name in output_dir_files:
660 def require_file (name):
661 if name in output_dir_files:
666 # UGH - junk self.global_options
667 skip_lily = self.global_options.skip_lilypond_run
668 for required in [base + '.ly',
670 require_file (required)
672 require_file (base + '-systems.count')
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')
679 map (consider_file, [base + '.tex',
683 base + '-systems.texi',
684 base + '-systems.tex',
685 base + '-systems.pdftexi'])
686 if self.formatter.document_language:
688 [base + '.texidoc' + self.formatter.document_language,
689 base + '.doctitle' + self.formatter.document_language])
691 required_files = self.formatter.required_files (self, base, full, result)
692 for f in required_files:
696 if not skip_lily and not missing:
697 system_count = int(file (full + '-systems.count').read())
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')
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')
709 map (consider_file, self.additional_files_to_consider (base, full))
710 map (require_file, self.additional_files_required (base, full))
712 return (result, missing)
714 def is_outdated (self, output_dir, current_files):
715 found, missing = self.all_output_files (output_dir, current_files)
718 def filter_pipe (self, input, cmd):
719 """Pass input through cmd, and return the result."""
721 if self.global_options.verbose:
722 progress (_ ("Running through filter `%s'\n") % cmd)
724 # TODO: Use Popen once we resolve the problem with msvcrt in Windows:
725 (stdin, stdout, stderr) = os.popen3 (cmd)
726 # p = Popen(cmd, shell=True, stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
727 # (stdin, stdout, stderr) = (p.stdin, p.stdout, p.stderr)
729 status = stdin.close ()
733 output = stdout.read ()
734 status = stdout.close ()
739 signal = 0x0f & status
740 if status or (not output and err):
741 exit_status = status >> 8
742 ly.error (_ ("`%s' failed (%d)") % (cmd, exit_status))
743 ly.error (_ ("The error log is as follows:"))
744 ly.stderr_write (err)
745 ly.stderr_write (stderr.read ())
748 if self.global_options.verbose:
753 def get_snippet_code (self):
754 return self.substring ('code');
756 def filter_text (self):
757 """Run snippet bodies through a command (say: convert-ly).
759 This functionality is rarely used, and this code must have bitrot.
761 code = self.get_snippet_code ();
762 s = self.filter_pipe (code, self.global_options.filter_cmd)
765 'options': self.match.group ('options')
767 return self.formatter.output_simple_replacements (FILTER, d)
769 def replacement_text (self):
770 base = self.final_basename ()
771 return self.formatter.snippet_output (base, self)
773 def get_images (self):
774 rep = {'base': self.final_basename ()}
776 single = '%(base)s.png' % rep
777 multiple = '%(base)s-page1.png' % rep
779 if (os.path.exists (multiple)
780 and (not os.path.exists (single)
781 or (os.stat (multiple)[stat.ST_MTIME]
782 > os.stat (single)[stat.ST_MTIME]))):
783 count = ps_page_count ('%(base)s.eps' % rep)
784 images = ['%s-page%d.png' % (rep['base'], page) for page in range (1, count+1)]
785 images = tuple (images)
791 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
792 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
794 class LilypondFileSnippet (LilypondSnippet):
795 def __init__ (self, type, match, formatter, line_number, global_options):
796 LilypondSnippet.__init__ (self, type, match, formatter, line_number, global_options)
797 self.filename = self.substring ('filename')
798 self.ext = os.path.splitext (os.path.basename (self.filename))[1]
799 self.contents = file (BookBase.find_file (self.filename, global_options.include_path)).read ()
801 def get_snippet_code (self):
802 return self.contents;
806 s = re_begin_verbatim.split (s)[-1]
807 s = re_end_verbatim.split (s)[0]
808 if not NOGETTEXT in self.option_dict:
809 s = self.verb_ly_gettext (s)
810 if not s.endswith ('\n'):
816 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
817 % (name, self.contents))
819 def final_basename (self):
820 if self.global_options.use_source_file_names:
821 base = os.path.splitext (os.path.basename (self.filename))[0]
824 return self.basename ()
827 class MusicXMLFileSnippet (LilypondFileSnippet):
828 def __init__ (self, type, match, formatter, line_number, global_options):
829 LilypondFileSnippet.__init__ (self, type, match, formatter, line_number, global_options)
830 self.compressed = False
831 self.converted_ly = None
832 self.musicxml_options_dict = {
833 'verbose': '--verbose',
835 'compressed': '--compressed',
836 'relative': '--relative',
837 'absolute': '--absolute',
838 'no-articulation-directions': '--no-articulation-directions',
839 'no-rest-positions': '--no-rest-positions',
840 'no-page-layout': '--no-page-layout',
841 'no-beaming': '--no-beaming',
842 'language': '--language',
845 def snippet_options (self):
846 return self.musicxml_options_dict.keys ()
848 def convert_from_musicxml (self):
850 xml2ly_option_list = []
851 for (key, value) in self.option_dict.items ():
852 cmd_key = self.musicxml_options_dict.get (key, None)
856 xml2ly_option_list.append (cmd_key)
858 xml2ly_option_list.append (cmd_key + '=' + value)
859 if ('.mxl' in name) and ('--compressed' not in xml2ly_option_list):
860 xml2ly_option_list.append ('--compressed')
861 self.compressed = True
862 opts = " ".join (xml2ly_option_list)
863 progress (_ ("Converting MusicXML file `%s'...\n") % self.filename)
865 ly_code = self.filter_pipe (self.contents, 'musicxml2ly %s --out=- - ' % opts)
869 if self.converted_ly == None:
870 self.converted_ly = self.convert_from_musicxml ()
872 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
873 % (name, self.converted_ly))
875 def additional_files_required (self, base, full):
878 result.append (base + '.mxl')
880 result.append (base + '.xml')
884 base = self.basename ()
885 path = os.path.join (self.global_options.lily_output_dir, base)
886 directory = os.path.split(path)[0]
887 if not os.path.isdir (directory):
888 os.makedirs (directory)
890 # First write the XML to a file (so we can link it!)
892 xmlfilename = path + '.mxl'
894 xmlfilename = path + '.xml'
895 if os.path.exists (xmlfilename):
896 diff_against_existing = self.filter_pipe (self.contents, 'diff -u %s - ' % xmlfilename)
897 if diff_against_existing:
898 warning (_ ("%s: duplicate filename but different contents of orginal file,\n\
899 printing diff against existing file.") % xmlfilename)
900 ly.stderr_write (diff_against_existing)
902 out = file (xmlfilename, 'w')
903 out.write (self.contents)
906 # also write the converted lilypond
907 filename = path + '.ly'
908 if os.path.exists (filename):
909 diff_against_existing = self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename)
910 if diff_against_existing:
911 warning (_ ("%s: duplicate filename but different contents of converted lilypond file,\n\
912 printing diff against existing file.") % filename)
913 ly.stderr_write (diff_against_existing)
915 out = file (filename, 'w')
916 out.write (self.full_ly ())
918 file (path + '.txt', 'w').write ('image of music')
922 class LilyPondVersionString (Snippet):
923 """A string that does not require extra memory."""
924 def __init__ (self, type, match, formatter, line_number, global_options):
925 Snippet.__init__ (self, type, match, formatter, line_number, global_options)
927 def replacement_text (self):
928 return self.formatter.output_simple (self.type, self)
931 snippet_type_to_class = {
932 'lilypond_file': LilypondFileSnippet,
933 'lilypond_block': LilypondSnippet,
934 'lilypond': LilypondSnippet,
935 'include': IncludeSnippet,
936 'lilypondversion': LilyPondVersionString,
937 'musicxml_file': MusicXMLFileSnippet,