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'
41 LANG = 'lang' ## TODO: This is handled nowhere!
43 LILYQUOTE = 'lilyquote'
44 LINE_WIDTH = 'line-width'
45 NOFRAGMENT = 'nofragment'
46 NOGETTEXT = 'nogettext'
50 NORAGGED_RIGHT = 'noragged-right'
54 OUTPUTIMAGE = 'outputimage'
57 PRINTFILENAME = 'printfilename'
59 RAGGED_RIGHT = 'ragged-right'
61 STAFFSIZE = 'staffsize'
64 VERSION = 'lilypondversion'
68 # NOTIME and NOGETTEXT have no opposite so they aren't part of this
70 # NOQUOTE is used internally only.
76 # Options that have no impact on processing by lilypond (or --process
78 PROCESSING_INDEPENDENT_OPTIONS = (
79 ALT, NOGETTEXT, VERBATIM, ADDVERSION,
80 TEXIDOC, DOCTITLE, VERSION, PRINTFILENAME)
84 # Options without a pattern in snippet_options.
103 ####################################################################
104 # LilyPond templates for the snippets
105 ####################################################################
110 RELATIVE: r'''\relative c%(relative_quotes)s''',
115 INDENT: r'''indent = %(indent)s''',
116 LINE_WIDTH: r'''line-width = %(line-width)s''',
117 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
118 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
119 RAGGED_RIGHT: r'''ragged-right = ##t''',
120 NORAGGED_RIGHT: r'''ragged-right = ##f''',
132 \remove "Time_signature_engraver"
138 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
151 %% ****************************************************************
152 %% ly snippet contents follows:
153 %% ****************************************************************
157 %% ****************************************************************
159 %% ****************************************************************
163 def classic_lilypond_book_compatibility (key, value):
164 if key == 'singleline' and value == None:
165 return (RAGGED_RIGHT, None)
167 m = re.search ('relative\s*([-0-9])', key)
169 return ('relative', m.group (1))
171 m = re.match ('([0-9]+)pt', key)
173 return ('staffsize', m.group (1))
175 if key == 'indent' or key == 'line-width':
176 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
178 f = float (m.group (1))
179 return (key, '%f\\%s' % (f, m.group (2)))
184 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
185 %%%% Options: [%(option_string)s]
186 \\include "lilypond-book-preamble.ly"
189 %% ****************************************************************
190 %% Start cut-&-pastable-section
191 %% ****************************************************************
197 force-assignment = #""
198 line-width = #(- line-width (* mm %(padding_mm)f))
210 %% ****************************************************************
212 %% ****************************************************************
216 %% ****************************************************************
218 %% ****************************************************************
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.do_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 do_options (self, option_string, type):
383 self.option_dict = {}
385 options = self.split_options (option_string)
387 for option in options:
389 (key, value) = re.split ('\s*=\s*', option)
390 self.option_dict[key] = value
392 if option in no_options:
393 if no_options[option] in self.option_dict:
394 del self.option_dict[no_options[option]]
396 self.option_dict[option] = None
399 # If LINE_WIDTH is used without parameter, set it to default.
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]
405 # TODO: Can't we do that more efficiently (built-in python func?)
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]
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
416 if not has_line_width:
417 if type == 'lilypond' or FRAGMENT in self.option_dict:
418 self.option_dict[RAGGED_RIGHT] = None
420 if type == 'lilypond':
421 if LINE_WIDTH in self.option_dict:
422 del self.option_dict[LINE_WIDTH]
424 if RAGGED_RIGHT in self.option_dict:
425 if LINE_WIDTH in self.option_dict:
426 del self.option_dict[LINE_WIDTH]
428 if QUOTE in self.option_dict or type == 'lilypond':
429 if LINE_WIDTH in self.option_dict:
430 del self.option_dict[LINE_WIDTH]
432 if not INDENT in self.option_dict:
433 self.option_dict[INDENT] = '0\\mm'
435 # Set a default line-width if there is none. We need this, because
436 # lilypond-book has set left-padding by default and therefore does
437 # #(define line-width (- line-width (* 3 mm)))
438 # TODO: Junk this ugly hack if the code gets rewritten to concatenate
439 # all settings before writing them in the \paper block.
440 if not LINE_WIDTH in self.option_dict:
441 if not QUOTE in self.option_dict:
442 if not LILYQUOTE in self.option_dict:
443 self.option_dict[LINE_WIDTH] = "#(- paper-width \
444 left-margin-default right-margin-default)"
446 def get_option_list (self):
447 if not 'option_list' in self.__dict__:
449 for (key, value) in self.option_dict.items ():
451 option_list.append (key)
453 option_list.append (key + '=' + value)
455 self.option_list = option_list
456 return self.option_list
458 def compose_ly (self, code):
459 if FRAGMENT in self.option_dict:
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.
490 override[EXAMPLEINDENT] = r'0.4\in'
491 override[LINE_WIDTH] = '5\\in' # = texinfo_line_widths['@smallbook']
492 override.update (self.formatter.default_snippet_options)
495 for option in self.get_option_list ():
496 for name in PROCESSING_INDEPENDENT_OPTIONS:
497 if option.startswith (name):
500 option_list.append (option)
501 option_string = ','.join (option_list)
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]
511 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
515 _ ("deprecated ly-option used: %s=%s") % (key, value))
517 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
520 _ ("deprecated ly-option used: %s") % key)
522 _ ("compatibility mode translation: %s") % c_key)
524 (key, value) = (c_key, c_value)
527 override[key] = value
529 if not override.has_key (key):
533 for typ in compose_types:
534 if snippet_options[typ].has_key (key):
535 compose_dict[typ].append (snippet_options[typ][key])
539 if not found and key not in simple_options and key not in self.snippet_options ():
540 warning (_ ("ignoring unknown ly option: %s") % key)
543 if RELATIVE in override and override[RELATIVE]:
544 relative = int (override[RELATIVE])
550 relative_quotes += ',' * (- relative)
552 relative_quotes += "'" * relative
554 paper_string = '\n '.join (compose_dict[PAPER]) % override
555 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
556 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
557 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
558 padding_mm = self.global_options.padding_mm
562 d.update (self.global_options.information)
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_option_list ():
578 for name in PROCESSING_INDEPENDENT_OPTIONS:
579 if option.startswith (name):
584 ## let's not create too long names.
585 self.checksum = hash.hexdigest ()[:10]
590 cs = self.get_checksum ()
591 name = '%s/lily-%s' % (cs[:2], cs[2:])
594 final_basename = basename
597 base = self.basename ()
598 path = os.path.join (self.global_options.lily_output_dir, base)
599 directory = os.path.split(path)[0]
600 if not os.path.isdir (directory):
601 os.makedirs (directory)
602 filename = path + '.ly'
603 if os.path.exists (filename):
604 existing = open (filename, 'r').read ()
606 if self.relevant_contents (existing) != self.relevant_contents (self.full_ly ()):
607 warning ("%s: duplicate filename but different contents of orginal file,\n\
608 printing diff against existing file." % filename)
609 ly.stderr_write (self.filter_pipe (self.full_ly (), 'diff -u %s -' % filename))
611 out = file (filename, 'w')
612 out.write (self.full_ly ())
613 file (path + '.txt', 'w').write ('image of music')
615 def relevant_contents (self, ly):
616 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
618 def link_all_output_files (self, output_dir, output_dir_files, destination):
619 existing, missing = self.all_output_files (output_dir, output_dir_files)
621 print '\nMissing', missing
622 raise CompileError(self.basename())
623 for name in existing:
624 if (self.global_options.use_source_file_names
625 and isinstance (self, LilypondFileSnippet)):
626 base, ext = os.path.splitext (name)
627 components = base.split ('-')
628 # ugh, assume filenames with prefix with one dash (lily-xxxx)
629 if len (components) > 2:
630 base_suffix = '-' + components[-1]
633 final_name = self.final_basename () + base_suffix + ext
637 os.unlink (os.path.join (destination, final_name))
641 src = os.path.join (output_dir, name)
642 dst = os.path.join (destination, final_name)
643 dst_path = os.path.split(dst)[0]
644 if not os.path.isdir (dst_path):
645 os.makedirs (dst_path)
649 def all_output_files (self, output_dir, output_dir_files):
650 """Return all files generated in lily_output_dir, a set.
652 output_dir_files is the list of files in the output directory.
656 base = self.basename()
657 full = os.path.join (output_dir, base)
658 def consider_file (name):
659 if name in output_dir_files:
662 def require_file (name):
663 if name in output_dir_files:
668 # UGH - junk self.global_options
669 skip_lily = self.global_options.skip_lilypond_run
670 for required in [base + '.ly',
672 require_file (required)
674 require_file (base + '-systems.count')
676 if 'ddump-profile' in self.global_options.process_cmd:
677 require_file (base + '.profile')
678 if 'dseparate-log-file' in self.global_options.process_cmd:
679 require_file (base + '.log')
681 map (consider_file, [base + '.tex',
685 base + '-systems.texi',
686 base + '-systems.tex',
687 base + '-systems.pdftexi'])
688 if self.formatter.document_language:
690 [base + '.texidoc' + self.formatter.document_language,
691 base + '.doctitle' + self.formatter.document_language])
693 required_files = self.formatter.required_files (self, base, full, result)
694 for f in required_files:
698 if not skip_lily and not missing:
699 system_count = int(file (full + '-systems.count').read())
701 for number in range(1, system_count + 1):
702 systemfile = '%s-%d' % (base, number)
703 require_file (systemfile + '.eps')
704 consider_file (systemfile + '.pdf')
706 # We can't require signatures, since books and toplevel
707 # markups do not output a signature.
708 if 'ddump-signature' in self.global_options.process_cmd:
709 consider_file (systemfile + '.signature')
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 (_ ("Opening 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 ()
735 error = stderr.read ()
739 signal = 0x0f & status
740 if status or (not output and error):
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 (error)
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.contents = file (BookBase.find_file (self.substring ('filename'), global_options.include_path)).read ()
799 def get_snippet_code (self):
800 return 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'):
813 name = self.substring ('filename')
814 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
815 % (name, self.contents))
817 def final_basename (self):
818 if self.global_options.use_source_file_names:
819 base = os.path.splitext (os.path.basename (self.substring ('filename')))[0]
822 return self.basename ()
825 class LilyPondVersionString (Snippet):
826 """A string that does not require extra memory."""
827 def __init__ (self, type, match, formatter, line_number, global_options):
828 Snippet.__init__ (self, type, match, formatter, line_number, global_options)
830 def replacement_text (self):
831 return self.formatter.output_simple (self.type, self)
834 snippet_type_to_class = {
835 'lilypond_file': LilypondFileSnippet,
836 'lilypond_block': LilypondSnippet,
837 'lilypond': LilypondSnippet,
838 'include': IncludeSnippet,
839 'lilypondversion': LilyPondVersionString,