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
18 debug = ly.debug_output
24 ####################################################################
25 # Snippet option handling
26 ####################################################################
30 # Is this pythonic? Personally, I find this rather #define-nesque. --hwn
33 ADDVERSION = 'addversion'
38 EXAMPLEINDENT = 'exampleindent'
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 RAGGED_RIGHT: r'''ragged-right = ##t''',
117 NORAGGED_RIGHT: r'''ragged-right = ##f''',
129 \remove "Time_signature_engraver"
135 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
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)
149 m = re.search ('relative\s*([-0-9])', key)
151 return ('relative', m.group (1))
153 m = re.match ('([0-9]+)pt', key)
155 return ('staffsize', m.group (1))
157 if key == 'indent' or key == 'line-width':
158 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
160 f = float (m.group (1))
161 return (key, '%f\\%s' % (f, m.group (2)))
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"
173 %% ****************************************************************
174 %% Start cut-&-pastable-section
175 %% ****************************************************************
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))
197 %% ****************************************************************
199 %% ****************************************************************
203 %% ****************************************************************
205 %% ****************************************************************
213 %% ****************************************************************
214 %% ly snippet contents follows:
215 %% ****************************************************************
219 %% ****************************************************************
221 %% ****************************************************************
228 ####################################################################
230 ####################################################################
232 def ps_page_count (ps_name):
233 header = file (ps_name).read (1024)
234 m = re.search ('\n%%Pages: ([0-9]+)', header)
236 return int (m.group (1))
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+')
244 def ly_comment_gettext (t, m):
245 return m.group (1) + t (m.group (2))
249 class CompileError(Exception):
254 ####################################################################
256 ####################################################################
259 def replacement_text (self):
262 def filter_text (self):
263 return self.replacement_text ()
268 class Substring (Chunk):
269 """A string that does not require extra memory."""
270 def __init__ (self, source, start, end, line_number):
274 self.line_number = line_number
275 self.override_text = None
280 def replacement_text (self):
281 if self.override_text:
282 return self.override_text
284 return self.source[self.start:self.end]
288 class Snippet (Chunk):
289 def __init__ (self, type, match, formatter, line_number, global_options):
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}
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)
305 def replacement_text (self):
306 return self.match.group ('match')
308 def substring (self, s):
309 return self.match.group (s)
312 return `self.__class__` + ' type = ' + self.type
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
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)
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.parse_snippet_options (os, self.type)
335 def snippet_options (self):
338 def verb_ly_gettext (self, s):
339 lang = self.formatter.document_language
343 t = langdefs.translation[lang]
347 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
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",
354 for id in ly_context_id_re.findall (s):
355 s = re.sub (r'(\s+|")%s(\s+|")' % id,
356 "\\1" + t (id) + "\\2",
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'):
369 contents = self.substring ('code')
370 return ('\\sourcefileline %d\n%s'
371 % (self.line_number - 1, contents))
376 return self.compose_ly (s)
379 def split_options (self, option_string):
380 return self.formatter.split_snippet_options (option_string);
382 def parse_snippet_options (self, option_string, type):
383 self.snippet_option_dict = {}
385 # Split option string and create raw option_dict from it
386 options = self.split_options (option_string)
388 for option in options:
389 (key, value) = (option, None)
391 (key, value) = re.split ('\s*=\s*', option)
393 # a no... option removes a previous option if present!
394 if key in no_options:
395 if no_options[key] in self.option_dict:
396 del self.snippet_option_dict[no_options[key]]
398 # Check for deprecated options, replace them by new ones
399 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
403 _ ("deprecated ly-option used: %s=%s") % (key, value))
405 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
408 _ ("deprecated ly-option used: %s") % key)
410 _ ("compatibility mode translation: %s") % c_key)
411 (key, value) = (c_key, c_value)
412 # Finally, insert the option:
414 self.snippet_option_dict[key] = value
416 # If LINE_WIDTH is used without parameter, set it to default.
417 has_line_width = self.snippet_option_dict.has_key (LINE_WIDTH)
418 if has_line_width and self.snippet_option_dict[LINE_WIDTH] == None:
419 del self.snippet_option_dict[LINE_WIDTH]
421 # RELATIVE does not work without FRAGMENT, so imply that
422 if self.snippet_option_dict.has_key (RELATIVE):
423 self.snippet_option_dict[FRAGMENT] = None
425 # Now get the default options from the formatter object (HTML, latex,
426 # texinfo, etc.) and insert the explicit snippet options to get the
427 # list of all options for this snippet
428 # first, make sure we have an INDENT value as a fallback
429 self.option_dict = {INDENT: '0\\mm'};
430 self.option_dict.update (self.formatter.default_snippet_options);
431 self.option_dict.update (self.snippet_option_dict);
433 # also construct a list of all options (as strings) that influence the
434 # visual appearance of the snippet
435 lst = filter (lambda (x,y): x not in PROCESSING_INDEPENDENT_OPTIONS,
436 self.option_dict.iteritems ());
438 for (key, value) in lst:
440 option_list.append (key)
442 option_list.append (key + "=" + value)
444 self.outputrelevant_option_list = option_list
445 #print ("self.outputrelevant_option_list: %s\n" % self.outputrelevant_option_list);
448 # Set a default line-width if there is none. We need this, because
449 # lilypond-book has set left-padding by default and therefore does
450 # #(define line-width (- line-width (* 3 mm)))
451 # TODO: Junk this ugly hack if the code gets rewritten to concatenate
452 # all settings before writing them in the \paper block.
453 #if not LINE_WIDTH in self.option_dict:
454 #if not QUOTE in self.option_dict:
455 #self.option_dict[LINE_WIDTH] = "#(- paper-width \
456 #left-margin-default right-margin-default)"
458 # Get a list of all options (as string) that influence the snippet appearance
459 def get_outputrelevant_option_strings (self):
460 return self.outputrelevant_option_list
462 def compose_ly (self, code):
467 # The original concept of the `exampleindent' option is broken.
468 # It is not possible to get a sane value for @exampleindent at all
469 # without processing the document itself. Saying
477 # causes ugly results with the DVI backend of texinfo since the
478 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
479 # value). Executing the above code changes the environment
480 # indentation to an unknown value because we don't know the amount
481 # of 1em in advance since it is font-dependent. Modifying
482 # @exampleindent in the middle of a document is simply not
483 # supported within texinfo.
485 # As a consequence, the only function of @exampleindent is now to
486 # specify the amount of indentation for the `quote' option.
488 # To set @exampleindent locally to zero, we use the @format
489 # environment for non-quoted snippets.
491 # Update: since July 2011 we are running texinfo on a test file
492 # to detect the default exampleindent, so we might reintroduce
493 # further usage of exampleindent again.
495 # First, make sure we have some falback default value, auto-detected
496 # values and explicitly specified values will always override them:
497 override[EXAMPLEINDENT] = r'0.4\in'
498 override[LINE_WIDTH] = '5\\in'
499 override.update (self.formatter.default_snippet_options)
501 option_string = ','.join (self.get_outputrelevant_option_strings ())
503 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
504 for a in compose_types:
507 option_names = self.option_dict.keys ()
509 for key in option_names:
510 value = self.option_dict[key]
513 override[key] = value
515 if not override.has_key (key):
519 for typ in compose_types:
520 if snippet_options[typ].has_key (key):
521 compose_dict[typ].append (snippet_options[typ][key])
525 if not found and key not in simple_options and key not in self.snippet_options ():
526 warning (_ ("ignoring unknown ly option: %s") % key)
529 if RELATIVE in override and override[RELATIVE]:
530 relative = int (override[RELATIVE])
536 relative_quotes += ',' * (- relative)
538 relative_quotes += "'" * relative
540 # put paper-size first, if it exists
541 for i,elem in enumerate(compose_dict[PAPER]):
542 if elem.startswith("#(set-paper-size"):
543 compose_dict[PAPER].insert(0, compose_dict[PAPER].pop(i))
546 paper_string = '\n '.join (compose_dict[PAPER]) % override
547 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
548 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
549 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
550 padding_mm = self.global_options.padding_mm
551 if self.global_options.safe_mode:
552 safe_mode_string = "#(ly:set-option 'safe #t)"
554 safe_mode_string = ""
558 d.update (self.global_options.information)
559 if FRAGMENT in self.option_dict:
563 return (PREAMBLE_LY + body) % d
565 def get_checksum (self):
566 if not self.checksum:
567 # Work-around for md5 module deprecation warning in python 2.5+:
569 from hashlib import md5
573 # We only want to calculate the hash based on the snippet
574 # code plus fragment options relevant to processing by
575 # lilypond, not the snippet + preamble
576 hash = md5 (self.relevant_contents (self.ly ()))
577 for option in self.get_outputrelevant_option_strings ():
580 ## let's not create too long names.
581 self.checksum = hash.hexdigest ()[:10]
586 cs = self.get_checksum ()
587 name = os.path.join (cs[:2], 'lily-%s' % cs[2:])
590 final_basename = basename
593 base = self.basename ()
594 path = os.path.join (self.global_options.lily_output_dir, base)
595 directory = os.path.split(path)[0]
596 if not os.path.isdir (directory):
597 os.makedirs (directory)
598 filename = path + '.ly'
599 if os.path.exists (filename):
600 existing = open (filename, 'r').read ()
602 if self.relevant_contents (existing) != self.relevant_contents (self.full_ly ()):
603 warning ("%s: duplicate filename but different contents of orginal file,\n\
604 printing diff against existing file." % filename)
605 ly.stderr_write (self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename))
607 out = file (filename, 'w')
608 out.write (self.full_ly ())
609 file (path + '.txt', 'w').write ('image of music')
611 def relevant_contents (self, ly):
612 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
614 def link_all_output_files (self, output_dir, output_dir_files, destination):
615 existing, missing = self.all_output_files (output_dir, output_dir_files)
617 print '\nMissing', missing
618 raise CompileError(self.basename())
619 for name in existing:
620 if (self.global_options.use_source_file_names
621 and isinstance (self, LilypondFileSnippet)):
622 base, ext = os.path.splitext (name)
623 components = base.split ('-')
624 # ugh, assume filenames with prefix with one dash (lily-xxxx)
625 if len (components) > 2:
626 base_suffix = '-' + components[-1]
629 final_name = self.final_basename () + base_suffix + ext
633 os.unlink (os.path.join (destination, final_name))
637 src = os.path.join (output_dir, name)
638 dst = os.path.join (destination, final_name)
639 dst_path = os.path.split(dst)[0]
640 if not os.path.isdir (dst_path):
641 os.makedirs (dst_path)
644 def additional_files_to_consider (self, base, full):
646 def additional_files_required (self, base, full):
650 def all_output_files (self, output_dir, output_dir_files):
651 """Return all files generated in lily_output_dir, a set.
653 output_dir_files is the list of files in the output directory.
657 base = self.basename()
658 full = os.path.join (output_dir, base)
659 def consider_file (name):
660 if name in output_dir_files:
663 def require_file (name):
664 if name in output_dir_files:
669 # UGH - junk self.global_options
670 skip_lily = self.global_options.skip_lilypond_run
671 for required in [base + '.ly',
673 require_file (required)
675 require_file (base + '-systems.count')
677 if 'ddump-profile' in self.global_options.process_cmd:
678 require_file (base + '.profile')
679 if 'dseparate-log-file' in self.global_options.process_cmd:
680 require_file (base + '.log')
682 map (consider_file, [base + '.tex',
686 base + '-systems.texi',
687 base + '-systems.tex',
688 base + '-systems.pdftexi'])
689 if self.formatter.document_language:
691 [base + '.texidoc' + self.formatter.document_language,
692 base + '.doctitle' + self.formatter.document_language])
694 required_files = self.formatter.required_files (self, base, full, result)
695 for f in required_files:
699 if not skip_lily and not missing:
700 system_count = int(file (full + '-systems.count').read())
702 for number in range(1, system_count + 1):
703 systemfile = '%s-%d' % (base, number)
704 require_file (systemfile + '.eps')
705 consider_file (systemfile + '.pdf')
707 # We can't require signatures, since books and toplevel
708 # markups do not output a signature.
709 if 'ddump-signature' in self.global_options.process_cmd:
710 consider_file (systemfile + '.signature')
712 map (consider_file, self.additional_files_to_consider (base, full))
713 map (require_file, self.additional_files_required (base, full))
715 return (result, missing)
717 def is_outdated (self, output_dir, current_files):
718 found, missing = self.all_output_files (output_dir, current_files)
721 def filter_pipe (self, input, cmd):
722 """Pass input through cmd, and return the result."""
724 debug (_ ("Running through filter `%s'") % cmd, True)
726 # TODO: Use Popen once we resolve the problem with msvcrt in Windows:
727 (stdin, stdout, stderr) = os.popen3 (cmd)
728 # p = Popen(cmd, shell=True, stdin=PIPE, stdout=PIPE, stderr=PIPE, close_fds=True)
729 # (stdin, stdout, stderr) = (p.stdin, p.stdout, p.stderr)
731 status = stdin.close ()
735 output = stdout.read ()
736 status = stdout.close ()
741 signal = 0x0f & status
742 if status or (not output and err):
743 exit_status = status >> 8
744 ly.error (_ ("`%s' failed (%d)") % (cmd, exit_status))
745 ly.error (_ ("The error log is as follows:"))
746 ly.stderr_write (err)
747 ly.stderr_write (stderr.read ())
754 def get_snippet_code (self):
755 return self.substring ('code');
757 def filter_text (self):
758 """Run snippet bodies through a command (say: convert-ly).
760 This functionality is rarely used, and this code must have bitrot.
762 code = self.get_snippet_code ();
763 s = self.filter_pipe (code, self.global_options.filter_cmd)
766 'options': self.match.group ('options')
768 return self.formatter.output_simple_replacements (FILTER, d)
770 def replacement_text (self):
771 base = self.final_basename ()
772 return self.formatter.snippet_output (base, self)
774 def get_images (self):
775 rep = {'base': self.final_basename ()}
777 single = '%(base)s.png' % rep
778 multiple = '%(base)s-page1.png' % rep
780 if (os.path.exists (multiple)
781 and (not os.path.exists (single)
782 or (os.stat (multiple)[stat.ST_MTIME]
783 > os.stat (single)[stat.ST_MTIME]))):
784 count = ps_page_count ('%(base)s.eps' % rep)
785 images = ['%s-page%d.png' % (rep['base'], page) for page in range (1, count+1)]
786 images = tuple (images)
792 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
793 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
795 class LilypondFileSnippet (LilypondSnippet):
796 def __init__ (self, type, match, formatter, line_number, global_options):
797 LilypondSnippet.__init__ (self, type, match, formatter, line_number, global_options)
798 self.filename = self.substring ('filename')
799 self.ext = os.path.splitext (os.path.basename (self.filename))[1]
800 self.contents = file (BookBase.find_file (self.filename, global_options.include_path)).read ()
802 def get_snippet_code (self):
803 return self.contents;
807 s = re_begin_verbatim.split (s)[-1]
808 s = re_end_verbatim.split (s)[0]
809 if not NOGETTEXT in self.option_dict:
810 s = self.verb_ly_gettext (s)
811 if not s.endswith ('\n'):
817 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
818 % (name, self.contents))
820 def final_basename (self):
821 if self.global_options.use_source_file_names:
822 base = os.path.splitext (os.path.basename (self.filename))[0]
825 return self.basename ()
828 class MusicXMLFileSnippet (LilypondFileSnippet):
829 def __init__ (self, type, match, formatter, line_number, global_options):
830 LilypondFileSnippet.__init__ (self, type, match, formatter, line_number, global_options)
831 self.compressed = False
832 self.converted_ly = None
833 self.musicxml_options_dict = {
834 'verbose': '--verbose',
836 'compressed': '--compressed',
837 'relative': '--relative',
838 'absolute': '--absolute',
839 'no-articulation-directions': '--no-articulation-directions',
840 'no-rest-positions': '--no-rest-positions',
841 'no-page-layout': '--no-page-layout',
842 'no-beaming': '--no-beaming',
843 'language': '--language',
846 def snippet_options (self):
847 return self.musicxml_options_dict.keys ()
849 def convert_from_musicxml (self):
851 xml2ly_option_list = []
852 for (key, value) in self.option_dict.items ():
853 cmd_key = self.musicxml_options_dict.get (key, None)
857 xml2ly_option_list.append (cmd_key)
859 xml2ly_option_list.append (cmd_key + '=' + value)
860 if ('.mxl' in name) and ('--compressed' not in xml2ly_option_list):
861 xml2ly_option_list.append ('--compressed')
862 self.compressed = True
863 opts = " ".join (xml2ly_option_list)
864 progress (_ ("Converting MusicXML file `%s'...\n") % self.filename)
866 ly_code = self.filter_pipe (self.contents, 'musicxml2ly %s --out=- - ' % opts)
870 if self.converted_ly == None:
871 self.converted_ly = self.convert_from_musicxml ()
873 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
874 % (name, self.converted_ly))
876 def additional_files_required (self, base, full):
879 result.append (base + '.mxl')
881 result.append (base + '.xml')
885 base = self.basename ()
886 path = os.path.join (self.global_options.lily_output_dir, base)
887 directory = os.path.split(path)[0]
888 if not os.path.isdir (directory):
889 os.makedirs (directory)
891 # First write the XML to a file (so we can link it!)
893 xmlfilename = path + '.mxl'
895 xmlfilename = path + '.xml'
896 if os.path.exists (xmlfilename):
897 diff_against_existing = self.filter_pipe (self.contents, 'diff -u %s - ' % xmlfilename)
898 if diff_against_existing:
899 warning (_ ("%s: duplicate filename but different contents of orginal file,\n\
900 printing diff against existing file.") % xmlfilename)
901 ly.stderr_write (diff_against_existing)
903 out = file (xmlfilename, 'w')
904 out.write (self.contents)
907 # also write the converted lilypond
908 filename = path + '.ly'
909 if os.path.exists (filename):
910 diff_against_existing = self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename)
911 if diff_against_existing:
912 warning (_ ("%s: duplicate filename but different contents of converted lilypond file,\n\
913 printing diff against existing file.") % filename)
914 ly.stderr_write (diff_against_existing)
916 out = file (filename, 'w')
917 out.write (self.full_ly ())
919 file (path + '.txt', 'w').write ('image of music')
923 class LilyPondVersionString (Snippet):
924 """A string that does not require extra memory."""
925 def __init__ (self, type, match, formatter, line_number, global_options):
926 Snippet.__init__ (self, type, match, formatter, line_number, global_options)
928 def replacement_text (self):
929 return self.formatter.output_simple (self.type, self)
932 snippet_type_to_class = {
933 'lilypond_file': LilypondFileSnippet,
934 'lilypond_block': LilypondSnippet,
935 'lilypond': LilypondSnippet,
936 'include': IncludeSnippet,
937 'lilypondversion': LilyPondVersionString,
938 'musicxml_file': MusicXMLFileSnippet,