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 LINE_WIDTH = 'line-width'
43 NOFRAGMENT = 'nofragment'
44 NOGETTEXT = 'nogettext'
47 NORAGGED_RIGHT = 'noragged-right'
51 OUTPUTIMAGE = 'outputimage'
53 PAPERSIZE = 'papersize'
55 PRINTFILENAME = 'printfilename'
57 RAGGED_RIGHT = 'ragged-right'
59 STAFFSIZE = 'staffsize'
62 VERSION = 'lilypondversion'
66 # NOTIME and NOGETTEXT have no opposite so they aren't part of this
73 # Options that have no impact on processing by lilypond (or --process
75 PROCESSING_INDEPENDENT_OPTIONS = (
76 ALT, NOGETTEXT, VERBATIM, ADDVERSION,
77 TEXIDOC, DOCTITLE, VERSION, PRINTFILENAME)
81 # Options without a pattern in snippet_options.
99 ####################################################################
100 # LilyPond templates for the snippets
101 ####################################################################
106 RELATIVE: r'''\relative c%(relative_quotes)s''',
111 PAPERSIZE: r'''#(set-paper-size "%(papersize)s")''',
112 INDENT: r'''indent = %(indent)s''',
113 LINE_WIDTH: r'''line-width = %(line-width)s''',
114 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
115 RAGGED_RIGHT: r'''ragged-right = ##t''',
116 NORAGGED_RIGHT: r'''ragged-right = ##f''',
128 \remove "Time_signature_engraver"
134 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
142 def classic_lilypond_book_compatibility (key, value):
143 if key == 'lilyquote':
144 return (QUOTE, 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 # Store if we have an explicit line-width given
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 # Use default options (i.e. auto-detected line-width, etc)
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 self.option_dict[LINE_WIDTH] = "#(- paper-width \
426 left-margin-default right-margin-default)"
428 def get_option_list (self):
429 if not 'option_list' in self.__dict__:
431 for (key, value) in self.option_dict.items ():
433 option_list.append (key)
435 option_list.append (key + '=' + value)
437 self.option_list = option_list
438 return self.option_list
440 def compose_ly (self, code):
445 # The original concept of the `exampleindent' option is broken.
446 # It is not possible to get a sane value for @exampleindent at all
447 # without processing the document itself. Saying
455 # causes ugly results with the DVI backend of texinfo since the
456 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
457 # value). Executing the above code changes the environment
458 # indentation to an unknown value because we don't know the amount
459 # of 1em in advance since it is font-dependent. Modifying
460 # @exampleindent in the middle of a document is simply not
461 # supported within texinfo.
463 # As a consequence, the only function of @exampleindent is now to
464 # specify the amount of indentation for the `quote' option.
466 # To set @exampleindent locally to zero, we use the @format
467 # environment for non-quoted snippets.
468 override[EXAMPLEINDENT] = r'0.4\in'
469 override[LINE_WIDTH] = '5\\in' # = texinfo_line_widths['@smallbook']
470 override.update (self.formatter.default_snippet_options)
473 for option in self.get_option_list ():
474 for name in PROCESSING_INDEPENDENT_OPTIONS:
475 if option.startswith (name):
478 option_list.append (option)
479 option_string = ','.join (option_list)
481 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
482 for a in compose_types:
485 option_names = self.option_dict.keys ()
487 for key in option_names:
488 value = self.option_dict[key]
489 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
493 _ ("deprecated ly-option used: %s=%s") % (key, value))
495 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
498 _ ("deprecated ly-option used: %s") % key)
500 _ ("compatibility mode translation: %s") % c_key)
502 (key, value) = (c_key, c_value)
505 override[key] = value
507 if not override.has_key (key):
511 for typ in compose_types:
512 if snippet_options[typ].has_key (key):
513 compose_dict[typ].append (snippet_options[typ][key])
517 if not found and key not in simple_options and key not in self.snippet_options ():
518 warning (_ ("ignoring unknown ly option: %s") % key)
521 if RELATIVE in override and override[RELATIVE]:
522 relative = int (override[RELATIVE])
528 relative_quotes += ',' * (- relative)
530 relative_quotes += "'" * relative
532 # put paper-size first, if it exists
533 for i,elem in enumerate(compose_dict[PAPER]):
534 if elem.startswith("#(set-paper-size"):
535 compose_dict[PAPER].insert(0, compose_dict[PAPER].pop(i))
538 paper_string = '\n '.join (compose_dict[PAPER]) % override
539 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
540 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
541 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
542 padding_mm = self.global_options.padding_mm
543 if self.global_options.safe_mode:
544 safe_mode_string = "#(ly:set-option 'safe #t)"
546 safe_mode_string = ""
550 d.update (self.global_options.information)
551 if FRAGMENT in self.option_dict:
555 return (PREAMBLE_LY + body) % d
557 def get_checksum (self):
558 if not self.checksum:
559 # Work-around for md5 module deprecation warning in python 2.5+:
561 from hashlib import md5
565 # We only want to calculate the hash based on the snippet
566 # code plus fragment options relevant to processing by
567 # lilypond, not the snippet + preamble
568 hash = md5 (self.relevant_contents (self.ly ()))
569 for option in self.get_option_list ():
570 for name in PROCESSING_INDEPENDENT_OPTIONS:
571 if option.startswith (name):
576 ## let's not create too long names.
577 self.checksum = hash.hexdigest ()[:10]
582 cs = self.get_checksum ()
583 name = '%s/lily-%s' % (cs[:2], cs[2:])
586 final_basename = basename
589 base = self.basename ()
590 path = os.path.join (self.global_options.lily_output_dir, base)
591 directory = os.path.split(path)[0]
592 if not os.path.isdir (directory):
593 os.makedirs (directory)
594 filename = path + '.ly'
595 if os.path.exists (filename):
596 existing = open (filename, 'r').read ()
598 if self.relevant_contents (existing) != self.relevant_contents (self.full_ly ()):
599 warning ("%s: duplicate filename but different contents of orginal file,\n\
600 printing diff against existing file." % filename)
601 ly.stderr_write (self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename))
603 out = file (filename, 'w')
604 out.write (self.full_ly ())
605 file (path + '.txt', 'w').write ('image of music')
607 def relevant_contents (self, ly):
608 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
610 def link_all_output_files (self, output_dir, output_dir_files, destination):
611 existing, missing = self.all_output_files (output_dir, output_dir_files)
613 print '\nMissing', missing
614 raise CompileError(self.basename())
615 for name in existing:
616 if (self.global_options.use_source_file_names
617 and isinstance (self, LilypondFileSnippet)):
618 base, ext = os.path.splitext (name)
619 components = base.split ('-')
620 # ugh, assume filenames with prefix with one dash (lily-xxxx)
621 if len (components) > 2:
622 base_suffix = '-' + components[-1]
625 final_name = self.final_basename () + base_suffix + ext
629 os.unlink (os.path.join (destination, final_name))
633 src = os.path.join (output_dir, name)
634 dst = os.path.join (destination, final_name)
635 dst_path = os.path.split(dst)[0]
636 if not os.path.isdir (dst_path):
637 os.makedirs (dst_path)
640 def additional_files_to_consider (self, base, full):
642 def additional_files_required (self, base, full):
646 def all_output_files (self, output_dir, output_dir_files):
647 """Return all files generated in lily_output_dir, a set.
649 output_dir_files is the list of files in the output directory.
653 base = self.basename()
654 full = os.path.join (output_dir, base)
655 def consider_file (name):
656 if name in output_dir_files:
659 def require_file (name):
660 if name in output_dir_files:
665 # UGH - junk self.global_options
666 skip_lily = self.global_options.skip_lilypond_run
667 for required in [base + '.ly',
669 require_file (required)
671 require_file (base + '-systems.count')
673 if 'ddump-profile' in self.global_options.process_cmd:
674 require_file (base + '.profile')
675 if 'dseparate-log-file' in self.global_options.process_cmd:
676 require_file (base + '.log')
678 map (consider_file, [base + '.tex',
682 base + '-systems.texi',
683 base + '-systems.tex',
684 base + '-systems.pdftexi'])
685 if self.formatter.document_language:
687 [base + '.texidoc' + self.formatter.document_language,
688 base + '.doctitle' + self.formatter.document_language])
690 required_files = self.formatter.required_files (self, base, full, result)
691 for f in required_files:
695 if not skip_lily and not missing:
696 system_count = int(file (full + '-systems.count').read())
698 for number in range(1, system_count + 1):
699 systemfile = '%s-%d' % (base, number)
700 require_file (systemfile + '.eps')
701 consider_file (systemfile + '.pdf')
703 # We can't require signatures, since books and toplevel
704 # markups do not output a signature.
705 if 'ddump-signature' in self.global_options.process_cmd:
706 consider_file (systemfile + '.signature')
708 map (consider_file, self.additional_files_to_consider (base, full))
709 map (require_file, self.additional_files_required (base, full))
711 return (result, missing)
713 def is_outdated (self, output_dir, current_files):
714 found, missing = self.all_output_files (output_dir, current_files)
717 def filter_pipe (self, input, cmd):
718 """Pass input through cmd, and return the result."""
720 if self.global_options.verbose:
721 progress (_ ("Running through filter `%s'\n") % cmd)
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)
728 status = stdin.close ()
732 output = stdout.read ()
733 status = stdout.close ()
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 ())
747 if self.global_options.verbose:
752 def get_snippet_code (self):
753 return self.substring ('code');
755 def filter_text (self):
756 """Run snippet bodies through a command (say: convert-ly).
758 This functionality is rarely used, and this code must have bitrot.
760 code = self.get_snippet_code ();
761 s = self.filter_pipe (code, self.global_options.filter_cmd)
764 'options': self.match.group ('options')
766 return self.formatter.output_simple_replacements (FILTER, d)
768 def replacement_text (self):
769 base = self.final_basename ()
770 return self.formatter.snippet_output (base, self)
772 def get_images (self):
773 rep = {'base': self.final_basename ()}
775 single = '%(base)s.png' % rep
776 multiple = '%(base)s-page1.png' % rep
778 if (os.path.exists (multiple)
779 and (not os.path.exists (single)
780 or (os.stat (multiple)[stat.ST_MTIME]
781 > os.stat (single)[stat.ST_MTIME]))):
782 count = ps_page_count ('%(base)s.eps' % rep)
783 images = ['%s-page%d.png' % (rep['base'], page) for page in range (1, count+1)]
784 images = tuple (images)
790 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
791 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
793 class LilypondFileSnippet (LilypondSnippet):
794 def __init__ (self, type, match, formatter, line_number, global_options):
795 LilypondSnippet.__init__ (self, type, match, formatter, line_number, global_options)
796 self.filename = self.substring ('filename')
797 self.ext = os.path.splitext (os.path.basename (self.filename))[1]
798 self.contents = file (BookBase.find_file (self.filename, global_options.include_path)).read ()
800 def get_snippet_code (self):
801 return self.contents;
805 s = re_begin_verbatim.split (s)[-1]
806 s = re_end_verbatim.split (s)[0]
807 if not NOGETTEXT in self.option_dict:
808 s = self.verb_ly_gettext (s)
809 if not s.endswith ('\n'):
815 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
816 % (name, self.contents))
818 def final_basename (self):
819 if self.global_options.use_source_file_names:
820 base = os.path.splitext (os.path.basename (self.filename))[0]
823 return self.basename ()
826 class MusicXMLFileSnippet (LilypondFileSnippet):
827 def __init__ (self, type, match, formatter, line_number, global_options):
828 LilypondFileSnippet.__init__ (self, type, match, formatter, line_number, global_options)
829 self.compressed = False
830 self.converted_ly = None
831 self.musicxml_options_dict = {
832 'verbose': '--verbose',
834 'compressed': '--compressed',
835 'relative': '--relative',
836 'absolute': '--absolute',
837 'no-articulation-directions': '--no-articulation-directions',
838 'no-rest-positions': '--no-rest-positions',
839 'no-page-layout': '--no-page-layout',
840 'no-beaming': '--no-beaming',
841 'language': '--language',
844 def snippet_options (self):
845 return self.musicxml_options_dict.keys ()
847 def convert_from_musicxml (self):
849 xml2ly_option_list = []
850 for (key, value) in self.option_dict.items ():
851 cmd_key = self.musicxml_options_dict.get (key, None)
855 xml2ly_option_list.append (cmd_key)
857 xml2ly_option_list.append (cmd_key + '=' + value)
858 if ('.mxl' in name) and ('--compressed' not in xml2ly_option_list):
859 xml2ly_option_list.append ('--compressed')
860 self.compressed = True
861 opts = " ".join (xml2ly_option_list)
862 progress (_ ("Converting MusicXML file `%s'...\n") % self.filename)
864 ly_code = self.filter_pipe (self.contents, 'musicxml2ly %s --out=- - ' % opts)
868 if self.converted_ly == None:
869 self.converted_ly = self.convert_from_musicxml ()
871 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
872 % (name, self.converted_ly))
874 def additional_files_required (self, base, full):
877 result.append (base + '.mxl')
879 result.append (base + '.xml')
883 base = self.basename ()
884 path = os.path.join (self.global_options.lily_output_dir, base)
885 directory = os.path.split(path)[0]
886 if not os.path.isdir (directory):
887 os.makedirs (directory)
889 # First write the XML to a file (so we can link it!)
891 xmlfilename = path + '.mxl'
893 xmlfilename = path + '.xml'
894 if os.path.exists (xmlfilename):
895 diff_against_existing = self.filter_pipe (self.contents, 'diff -u %s - ' % xmlfilename)
896 if diff_against_existing:
897 warning (_ ("%s: duplicate filename but different contents of orginal file,\n\
898 printing diff against existing file.") % xmlfilename)
899 ly.stderr_write (diff_against_existing)
901 out = file (xmlfilename, 'w')
902 out.write (self.contents)
905 # also write the converted lilypond
906 filename = path + '.ly'
907 if os.path.exists (filename):
908 diff_against_existing = self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename)
909 if diff_against_existing:
910 warning (_ ("%s: duplicate filename but different contents of converted lilypond file,\n\
911 printing diff against existing file.") % filename)
912 ly.stderr_write (diff_against_existing)
914 out = file (filename, 'w')
915 out.write (self.full_ly ())
917 file (path + '.txt', 'w').write ('image of music')
921 class LilyPondVersionString (Snippet):
922 """A string that does not require extra memory."""
923 def __init__ (self, type, match, formatter, line_number, global_options):
924 Snippet.__init__ (self, type, match, formatter, line_number, global_options)
926 def replacement_text (self):
927 return self.formatter.output_simple (self.type, self)
930 snippet_type_to_class = {
931 'lilypond_file': LilypondFileSnippet,
932 'lilypond_block': LilypondSnippet,
933 'lilypond': LilypondSnippet,
934 'include': IncludeSnippet,
935 'lilypondversion': LilyPondVersionString,
936 'musicxml_file': MusicXMLFileSnippet,