7 lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
10 lilypond-book --filter="convert-ly --no-version --from=1.6.11 -" BOOK
12 classic lilypond-book:
13 lilypond-book --process="lilypond" BOOK.tely
17 * this script is too complex. Modularize.
19 * ly-options: intertext?
21 * eps in latex / eps by lilypond -b ps?
22 * check latex parameters, twocolumn, multicolumn?
23 * use --png --ps --pdf for making images?
25 * Converting from lilypond-book source, substitute:
26 @mbinclude foo.itely -> @include foo.itely
50 program_version = '@TOPLEVEL_VERSION@'
51 program_name = os.path.basename (sys.argv[0])
53 original_dir = os.getcwd ()
57 _ ("Process LilyPond snippets in hybrid HTML, LaTeX, texinfo or DocBook document.")
61 lilypond-book --filter="tr '[a-z]' '[A-Z]'" %(BOOK)s
62 lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" %(BOOK)s
63 lilypond-book --process='lilypond -I include' %(BOOK)s
64 ''' % {'BOOK': _ ("BOOK")})
66 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
67 'Han-Wen Nienhuys <hanwen@xs4all.nl>')
69 ################################################################
71 if global_options.verbose:
72 raise Exception (_ ('Exiting (%d)...') % i)
77 ly.encoded_write (sys.stdout, '%s (GNU LilyPond) %s\n' % (program_name, program_version))
79 progress = ly.progress
82 ly.stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
85 ly.stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
87 def ps_page_count (ps_name):
88 header = file (ps_name).read (1024)
89 m = re.search ('\n%%Pages: ([0-9]+)', header)
91 return int (m.group (1))
96 ly.encoded_write (sys.stdout, '''
103 ''' % ( _ ('Copyright (c) %s by') % '2001--2007',
105 _ ("Distributed under terms of the GNU General Public License."),
106 _ ("It comes with NO WARRANTY.")))
108 def get_option_parser ():
109 p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'lilypond-book',
110 description=help_summary,
111 add_help_option=False)
113 p.add_option ('-F', '--filter', metavar=_ ("FILTER"),
116 help=_ ("pipe snippets through FILTER [convert-ly -n -]"),
119 p.add_option ('-f', '--format',
120 help=_ ("use output format FORMAT (texi [default], texi-html, latex, html, docbook)"),
123 p.add_option("-h", "--help",
125 help=_ ("show this help and exit"))
127 p.add_option ("-I", '--include', help=_ ("add DIR to include path"),
129 action='append', dest='include_path',
130 default=[os.path.abspath (os.getcwd ())])
132 p.add_option ('--info-images-dir',
133 help=_ ("format Texinfo output so that Info will "
134 "look for images of music in DIR"),
136 action='store', dest='info_images_dir',
139 p.add_option ('--latex-program',
140 help=_ ("run executable PROG instead of latex"),
142 action='store', dest='latex_program',
145 p.add_option ('--left-padding',
148 help=_ ("pad left side of music to align music inspite of uneven bar numbers (in mm)"),
152 p.add_option ("-o", '--output', help=_ ("write output to DIR"),
154 action='store', dest='output_dir',
157 p.add_option ('--skip-lily-check',
158 help=_ ("do not fail if no lilypond output is found."),
160 action='store_true', dest='skip_lilypond_run',
163 p.add_option ('--skip-png-check',
164 help=_ ("do not fail if no PNG images are found for EPS files"),
166 action='store_true', dest='skip_png_check',
169 p.add_option ('--lily-output-dir',
170 help=_ ("write lily-XXX files to DIR, link into --output dir."),
172 action='store', dest='lily_output_dir',
175 p.add_option ('-P', '--process', metavar=_ ("COMMAND"),
176 help = _ ("process ly_files using COMMAND FILE..."),
178 dest='process_cmd', default='')
180 p.add_option ('--pdf',
183 help=_ ("create PDF files for use with PDFTeX"),
186 p.add_option ('-V', '--verbose', help=_ ("be verbose"),
191 p.version = "@TOPLEVEL_VERSION@"
192 p.add_option("--version",
194 help=_ ("show version number and exit"))
196 p.add_option ('-w', '--warranty',
197 help=_ ("show warranty and copyright"),
199 p.add_option_group (ly.display_encode (_ ('Bugs')),
201 _ ("Report bugs via")
202 + ' http://post.gmane.org/post.php?group=gmane.comp.gnu.lilypond.bugs\n'))
205 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
207 # Only use installed binary when we are installed too.
208 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
209 lilypond_binary = 'lilypond'
211 global_options = None
214 default_ly_options = { 'alt': "[image of music]" }
216 document_language = ''
219 # Is this pythonic? Personally, I find this rather #define-nesque. --hwn
221 ADDVERSION = 'addversion'
225 EXAMPLEINDENT = 'exampleindent'
227 FRAGMENT = 'fragment'
233 LINE_WIDTH = 'line-width'
234 LILYQUOTE = 'lilyquote'
235 NOFRAGMENT = 'nofragment'
236 NOINDENT = 'noindent'
238 NORAGGED_RIGHT = 'noragged-right'
242 OUTPUTIMAGE = 'outputimage'
245 PREAMBLE = 'preamble'
246 PRINTFILENAME = 'printfilename'
248 RAGGED_RIGHT = 'ragged-right'
249 RELATIVE = 'relative'
250 STAFFSIZE = 'staffsize'
251 DOCTITLE = 'doctitle'
254 VERBATIM = 'verbatim'
255 FONTLOAD = 'fontload'
256 FILENAME = 'filename'
260 # NOTIME has no opposite so it isn't part of this dictionary.
261 # NOQUOTE is used internally only.
263 NOFRAGMENT: FRAGMENT,
268 # Recognize special sequences in the input.
270 # (?P<name>regex) -- Assign result of REGEX to NAME.
271 # *? -- Match non-greedily.
272 # (?m) -- Multiline regex: Make ^ and $ match at each line.
273 # (?s) -- Make the dot match all characters including newline.
274 # (?x) -- Ignore whitespace in patterns.
285 <(?P<inline>(inline)?)mediaobject>\s*<textobject.*?>\s*<programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>(?P<code>.*?)</programlisting\s*>\s*</textobject\s*>\s*</(inline)?mediaobject>)''',
290 <(?P<inline>(inline)?)mediaobject>\s*<textobject.*?>\s*<programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>(?P<code>.*?)</programlisting\s*>\s*</textobject\s*>\s*</(inline)?mediaobject>)''',
295 <(?P<inline>(inline)?)mediaobject>\s*<imageobject.*?>\s*<imagedata\s+fileref="(?P<filename>.*?\.ly)"\s*(role="(?P<options>.*?)")?\s*(/>|>\s*</imagedata>)\s*</imageobject>\s*</(inline)?mediaobject>)''',
301 (?P<code><!--\s.*?!-->)
304 'singleline_comment':
323 (\s*(?P<options>.*?)\s*:)?\s*
331 \s*(?P<options>.*?)\s*
340 \s*(?P<options>.*?)\s*
342 \s*(?P<filename>.*?)\s*
349 (?P<code><!--\s.*?!-->)
352 'singleline_comment':
358 (?P<code><pre>.*?</pre>))''',
364 (?P<code><pre>\s.*?</pre>\s))''',
383 \s*(?P<options>.*?)\s*
394 \s*(?P<options>.*?)\s*
398 \\end\s*{lilypond})''',
406 \s*(?P<options>.*?)\s*
414 'singleline_comment':
437 \\end\s*{verbatim}))''',
446 (?P<filename>\S+))''',
450 ^[^\n]*?(?!@c\s+)[^\n]*?
454 \s*(?P<options>.*?)\s*
464 \s*(?P<options>.*?)\s*
467 ^@end\s+lilypond)\s''',
474 \s*(?P<options>.*?)\s*
485 @end\s+ignore))\s''',
487 'singleline_comment':
492 @c([ \t][^\n]*|)\n))''',
494 # Don't do this: It interferes with @code{@{}.
495 # 'verb': r'''(?P<code>@code{.*?})''',
503 @end\s+example\s))''',
512 'intertext': r',?\s*intertext=\".*?\"',
516 'intertext': r',?\s*intertext=\".*?\"',
521 'intertext': r',?\s*intertext=\".*?\"',
522 'option_sep': '\s*,\s*',
526 'intertext': r',?\s*intertext=\".*?\"',
527 'option_sep': '\s*,\s*',
531 # Options without a pattern in ly_options.
551 RELATIVE: r'''\relative c%(relative_quotes)s''',
556 INDENT: r'''indent = %(indent)s''',
558 LINE_WIDTH: r'''line-width = %(line-width)s''',
560 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
562 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
564 RAGGED_RIGHT: r'''ragged-right = ##t''',
566 NORAGGED_RIGHT: r'''ragged-right = ##f''',
568 PACKED: r'''packed = ##t''',
580 \remove "Time_signature_engraver"
586 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
593 FILTER: r'''<mediaobject><textobject><programlisting language="lilypond" role="%(options)s">%(code)s</programlisting></textobject></mediaobject>''',
596 <imageobject role="latex">
597 <imagedata fileref="%(base)s.pdf" format="PDF"/>
599 <imageobject role="html">
600 <imagedata fileref="%(base)s.png" format="PNG"/></imageobject>''',
602 VERBATIM: r'''<programlisting>%(verb)s</programlisting>''',
604 PRINTFILENAME: '<textobject><simpara><ulink url="%(base)s.ly"><filename>%(filename)s</filename></ulink></simpara></textobject>'
608 FILTER: r'''<lilypond %(options)s>
618 <a href="%(base)s.ly">''',
622 border="0" src="%(image)s" alt="%(alt)s">''',
624 PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
626 QUOTE: r'''<blockquote>
639 \ifx\preLilyPondExample \undefined%%
642 \preLilyPondExample%%
644 \def\lilypondbook{}%%
645 \input %(base)s-systems.tex%%
646 \ifx\postLilyPondExample \undefined%%
649 \postLilyPondExample%%
653 PRINTFILENAME: '''\\texttt{%(filename)s}
656 QUOTE: r'''\begin{quotation}%(str)s
659 VERBATIM: r'''\noindent
660 \begin{verbatim}%(verb)s\end{verbatim}''',
662 FILTER: r'''\begin{lilypond}[%(options)s]
669 FILTER: r'''@lilypond[%(options)s]
675 @include %(base)s-systems.texi
679 OUTPUTIMAGE: r'''@noindent
681 @image{%(info_image_path)s,,,%(alt)s,%(ext)s}
685 <a href="%(base)s.ly">
687 border="0" src="%(image)s" alt="%(alt)s">
695 <a href="%(base)s.ly">
703 QUOTE: r'''@quotation
704 %(str)s@end quotation
711 VERBATIM: r'''@exampleindent 0
713 %(verb)s@end verbatim
716 ADDVERSION: r'''@example
717 \version @w{"@version{}"}
724 # Maintain line numbers.
729 for f in [HTML, LATEX]:
730 for s in (QUOTE, VERBATIM):
731 output[f][s] = output[f][s].replace("\n"," ")
734 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
735 %%%% Options: [%(option_string)s]
736 \\include "lilypond-book-preamble.ly"
739 %% ****************************************************************
740 %% Start cut-&-pastable-section
741 %% ****************************************************************
746 #(define dump-extents #t)
747 %(font_dump_setting)s
749 force-assignment = #""
750 line-width = #(- line-width (* mm %(padding_mm)f))
763 %% ****************************************************************
764 %% ly snippet contents follows:
765 %% ****************************************************************
769 %% ****************************************************************
771 %% ****************************************************************
778 %% ****************************************************************
780 %% ****************************************************************
784 %% ****************************************************************
786 %% ****************************************************************
789 texinfo_line_widths = {
790 '@afourpaper': '160\\mm',
791 '@afourwide': '6.5\\in',
792 '@afourlatex': '150\\mm',
793 '@smallbook': '5\\in',
794 '@letterpaper': '6\\in',
797 def classic_lilypond_book_compatibility (key, value):
798 if key == 'singleline' and value == None:
799 return (RAGGED_RIGHT, None)
801 m = re.search ('relative\s*([-0-9])', key)
803 return ('relative', m.group (1))
805 m = re.match ('([0-9]+)pt', key)
807 return ('staffsize', m.group (1))
809 if key == 'indent' or key == 'line-width':
810 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
812 f = float (m.group (1))
813 return (key, '%f\\%s' % (f, m.group (2)))
817 def find_file (name, raise_error=True):
818 for i in global_options.include_path:
819 full = os.path.join (i, name)
820 if os.path.exists (full):
824 error (_ ("file not found: %s") % name + '\n')
828 def verbatim_html (s):
829 return re.sub ('>', '>',
831 re.sub ('&', '&', s)))
833 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
834 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
836 def ly_comment_gettext (t, m):
837 return m.group (1) + t (m.group (2))
839 def verb_ly_gettext (s):
840 if not document_language:
843 t = langdefs.translation[document_language]
847 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
849 for v in ly_var_def_re.findall (s):
850 s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v,
851 "\\1" + t (v) + "\\2",
855 texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)')
856 def set_default_options (source, default_ly_options, format):
857 global document_language
858 if LINE_WIDTH not in default_ly_options:
860 textwidth = get_latex_textwidth (source)
861 default_ly_options[LINE_WIDTH] = '%.0f\\pt' % textwidth
862 elif format == TEXINFO:
863 m = texinfo_lang_re.search (source)
864 if m and not m.group (1).startswith ('en'):
865 document_language = m.group (1)
867 document_language = ''
868 for regex in texinfo_line_widths:
869 # FIXME: @layout is usually not in
872 # \input texinfo @c -*-texinfo-*-
874 # Bluntly search first K items of
876 # s = chunks[0].replacement_text ()
877 if re.search (regex, source[:1024]):
878 default_ly_options[LINE_WIDTH] = texinfo_line_widths[regex]
882 def replacement_text (self):
885 def filter_text (self):
886 return self.replacement_text ()
891 class Substring (Chunk):
892 """A string that does not require extra memory."""
893 def __init__ (self, source, start, end, line_number):
897 self.line_number = line_number
898 self.override_text = None
903 def replacement_text (self):
904 if self.override_text:
905 return self.override_text
907 return self.source[self.start:self.end]
909 class Snippet (Chunk):
910 def __init__ (self, type, match, format, line_number):
914 self.option_dict = {}
916 self.line_number = line_number
918 def replacement_text (self):
919 return self.match.group ('match')
921 def substring (self, s):
922 return self.match.group (s)
925 return `self.__class__` + ' type = ' + self.type
927 class IncludeSnippet (Snippet):
928 def processed_filename (self):
929 f = self.substring ('filename')
930 return os.path.splitext (f)[0] + format2ext[self.format]
932 def replacement_text (self):
933 s = self.match.group ('match')
934 f = self.substring ('filename')
936 return re.sub (f, self.processed_filename (), s)
938 class LilypondSnippet (Snippet):
939 def __init__ (self, type, match, format, line_number):
940 Snippet.__init__ (self, type, match, format, line_number)
941 os = match.group ('options')
942 self.do_options (os, self.type)
945 return verb_ly_gettext (self.substring ('code'))
948 contents = self.substring ('code')
949 return ('\\sourcefileline %d\n%s'
950 % (self.line_number - 1, contents))
955 return self.compose_ly (s)
958 def split_options (self, option_string):
960 if self.format == HTML:
961 options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',
963 options = [re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)', '\g<1>\g<3>', opt)
967 return re.split (format_res[self.format]['option_sep'],
971 def do_options (self, option_string, type):
972 self.option_dict = {}
974 options = self.split_options (option_string)
976 for option in options:
978 (key, value) = re.split ('\s*=\s*', option)
979 self.option_dict[key] = value
981 if option in no_options:
982 if no_options[option] in self.option_dict:
983 del self.option_dict[no_options[option]]
985 self.option_dict[option] = None
987 has_line_width = self.option_dict.has_key (LINE_WIDTH)
988 no_line_width_value = 0
990 # If LINE_WIDTH is used without parameter, set it to default.
991 if has_line_width and self.option_dict[LINE_WIDTH] == None:
992 no_line_width_value = 1
993 del self.option_dict[LINE_WIDTH]
995 for k in default_ly_options:
996 if k not in self.option_dict:
997 self.option_dict[k] = default_ly_options[k]
999 # RELATIVE does not work without FRAGMENT;
1000 # make RELATIVE imply FRAGMENT
1001 has_relative = self.option_dict.has_key (RELATIVE)
1002 if has_relative and not self.option_dict.has_key (FRAGMENT):
1003 self.option_dict[FRAGMENT] = None
1005 if not has_line_width:
1006 if type == 'lilypond' or FRAGMENT in self.option_dict:
1007 self.option_dict[RAGGED_RIGHT] = None
1009 if type == 'lilypond':
1010 if LINE_WIDTH in self.option_dict:
1011 del self.option_dict[LINE_WIDTH]
1013 if RAGGED_RIGHT in self.option_dict:
1014 if LINE_WIDTH in self.option_dict:
1015 del self.option_dict[LINE_WIDTH]
1017 if QUOTE in self.option_dict or type == 'lilypond':
1018 if LINE_WIDTH in self.option_dict:
1019 del self.option_dict[LINE_WIDTH]
1021 if not INDENT in self.option_dict:
1022 self.option_dict[INDENT] = '0\\mm'
1024 # The QUOTE pattern from ly_options only emits the `line-width'
1026 if has_line_width and QUOTE in self.option_dict:
1027 if no_line_width_value:
1028 del self.option_dict[LINE_WIDTH]
1030 del self.option_dict[QUOTE]
1032 def compose_ly (self, code):
1033 if FRAGMENT in self.option_dict:
1041 # The original concept of the `exampleindent' option is broken.
1042 # It is not possible to get a sane value for @exampleindent at all
1043 # without processing the document itself. Saying
1051 # causes ugly results with the DVI backend of texinfo since the
1052 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
1053 # value). Executing the above code changes the environment
1054 # indentation to an unknown value because we don't know the amount
1055 # of 1em in advance since it is font-dependent. Modifying
1056 # @exampleindent in the middle of a document is simply not
1057 # supported within texinfo.
1059 # As a consequence, the only function of @exampleindent is now to
1060 # specify the amount of indentation for the `quote' option.
1062 # To set @exampleindent locally to zero, we use the @format
1063 # environment for non-quoted snippets.
1064 override[EXAMPLEINDENT] = r'0.4\in'
1065 override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
1066 override.update (default_ly_options)
1069 for (key, value) in self.option_dict.items ():
1071 option_list.append (key)
1073 option_list.append (key + '=' + value)
1074 option_string = ','.join (option_list)
1077 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
1078 for a in compose_types:
1079 compose_dict[a] = []
1081 for (key, value) in self.option_dict.items ():
1082 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
1086 _ ("deprecated ly-option used: %s=%s") % (key, value))
1088 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
1091 _ ("deprecated ly-option used: %s") % key)
1093 _ ("compatibility mode translation: %s") % c_key)
1095 (key, value) = (c_key, c_value)
1098 override[key] = value
1100 if not override.has_key (key):
1101 override[key] = None
1104 for type in compose_types:
1105 if ly_options[type].has_key (key):
1106 compose_dict[type].append (ly_options[type][key])
1110 if not found and key not in simple_options:
1111 warning (_ ("ignoring unknown ly option: %s") % key)
1114 if RELATIVE in override and override[RELATIVE]:
1115 relative = int (override[RELATIVE])
1117 relative_quotes = ''
1121 relative_quotes += ',' * (- relative)
1123 relative_quotes += "'" * relative
1125 paper_string = '\n '.join (compose_dict[PAPER]) % override
1126 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
1127 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
1128 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
1129 padding_mm = global_options.padding_mm
1130 font_dump_setting = ''
1131 if FONTLOAD in self.option_dict:
1132 font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1134 d = globals().copy()
1136 return (PREAMBLE_LY + body) % d
1138 def get_checksum (self):
1139 if not self.checksum:
1140 hash = md5.md5 (self.relevant_contents (self.full_ly ()))
1142 ## let's not create too long names.
1143 self.checksum = hash.hexdigest ()[:10]
1145 return self.checksum
1147 def basename (self):
1148 cs = self.get_checksum ()
1149 name = '%s/lily-%s' % (cs[:2], cs[2:10])
1152 def write_ly (self):
1153 base = self.basename ()
1154 path = os.path.join (global_options.lily_output_dir, base)
1155 directory = os.path.split(path)[0]
1156 if not os.path.isdir (directory):
1157 os.makedirs (directory)
1158 out = file (path + '.ly', 'w')
1159 out.write (self.full_ly ())
1160 file (path + '.txt', 'w').write ('image of music')
1162 def relevant_contents (self, ly):
1163 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
1165 def link_all_output_files (self, output_dir, output_dir_files, destination):
1166 existing, missing = self.all_output_files (output_dir, output_dir_files)
1168 print '\nMissing', missing
1169 raise CompileError(self.basename())
1170 for name in existing:
1172 os.unlink (os.path.join (destination, name))
1176 src = os.path.join (output_dir, name)
1177 dst = os.path.join (destination, name)
1178 dst_path = os.path.split(dst)[0]
1179 if not os.path.isdir (dst_path):
1180 os.makedirs (dst_path)
1184 def all_output_files (self, output_dir, output_dir_files):
1185 """Return all files generated in lily_output_dir, a set.
1187 output_dir_files is the list of files in the output directory.
1191 base = self.basename()
1192 full = os.path.join (output_dir, base)
1193 def consider_file (name):
1194 if name in output_dir_files:
1197 def require_file (name):
1198 if name in output_dir_files:
1203 # UGH - junk global_options
1204 skip_lily = global_options.skip_lilypond_run
1205 for required in [base + '.ly',
1207 require_file (required)
1209 require_file (base + '-systems.count')
1211 if 'ddump-profile' in global_options.process_cmd:
1212 require_file (base + '.profile')
1213 if 'dseparate-log-file' in global_options.process_cmd:
1214 require_file (base + '.log')
1216 map (consider_file, [base + '.tex',
1220 base + '-systems.texi',
1221 base + '-systems.tex',
1222 base + '-systems.pdftexi'])
1223 if document_language:
1225 [base + '.texidoc' + document_language,
1226 base + '.doctitle' + document_language])
1228 # UGH - junk global_options
1229 if (base + '.eps' in result and self.format in (HTML, TEXINFO)
1230 and not global_options.skip_png_check):
1231 page_count = ps_page_count (full + '.eps')
1233 require_file (base + '.png')
1235 for page in range (1, page_count + 1):
1236 require_file (base + '-page%d.png' % page)
1239 if not skip_lily and not missing:
1240 system_count = int(file (full + '-systems.count').read())
1242 for number in range(1, system_count + 1):
1243 systemfile = '%s-%d' % (base, number)
1244 require_file (systemfile + '.eps')
1245 consider_file (systemfile + '.pdf')
1247 # We can't require signatures, since books and toplevel
1248 # markups do not output a signature.
1249 if 'ddump-signature' in global_options.process_cmd:
1250 consider_file (systemfile + '.signature')
1253 return (result, missing)
1255 def is_outdated (self, output_dir, current_files):
1256 found, missing = self.all_output_files (output_dir, current_files)
1259 def filter_text (self):
1260 """Run snippet bodies through a command (say: convert-ly).
1262 This functionality is rarely used, and this code must have bitrot.
1264 code = self.substring ('code')
1265 s = filter_pipe (code, global_options.filter_cmd)
1268 'options': self.match.group ('options')
1271 return output[self.format][FILTER] % d
1273 def replacement_text (self):
1274 func = LilypondSnippet.__dict__['output_' + self.format]
1277 def get_images (self):
1278 base = self.basename ()
1280 single = '%(base)s.png' % vars ()
1281 multiple = '%(base)s-page1.png' % vars ()
1283 if (os.path.exists (multiple)
1284 and (not os.path.exists (single)
1285 or (os.stat (multiple)[stat.ST_MTIME]
1286 > os.stat (single)[stat.ST_MTIME]))):
1287 count = ps_page_count ('%(base)s.eps' % vars ())
1288 images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)]
1289 images = tuple (images)
1293 def output_docbook (self):
1295 base = self.basename ()
1296 for image in self.get_images ():
1297 (base, ext) = os.path.splitext (image)
1298 str += output[DOCBOOK][OUTPUT] % vars ()
1299 str += self.output_print_filename (DOCBOOK)
1300 if (self.substring('inline') == 'inline'):
1301 str = '<inlinemediaobject>' + str + '</inlinemediaobject>'
1303 str = '<mediaobject>' + str + '</mediaobject>'
1304 if VERBATIM in self.option_dict:
1305 verb = verbatim_html (self.verb_ly ())
1306 str = output[DOCBOOK][VERBATIM] % vars () + str
1309 def output_html (self):
1311 base = self.basename ()
1312 if self.format == HTML:
1313 str += self.output_print_filename (HTML)
1314 if VERBATIM in self.option_dict:
1315 verb = verbatim_html (self.verb_ly ())
1316 str += output[HTML][VERBATIM] % vars ()
1317 if QUOTE in self.option_dict:
1318 str = output[HTML][QUOTE] % vars ()
1320 str += output[HTML][BEFORE] % vars ()
1321 for image in self.get_images ():
1322 (base, ext) = os.path.splitext (image)
1323 alt = self.option_dict[ALT]
1324 str += output[HTML][OUTPUT] % vars ()
1325 str += output[HTML][AFTER] % vars ()
1328 def output_info (self):
1330 for image in self.get_images ():
1331 (base, ext) = os.path.splitext (image)
1333 # URG, makeinfo implicitly prepends dot to extension.
1334 # Specifying no extension is most robust.
1336 alt = self.option_dict[ALT]
1337 info_image_path = os.path.join (global_options.info_images_dir, base)
1338 str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1340 base = self.basename ()
1341 str += output[self.format][OUTPUT] % vars ()
1344 def output_latex (self):
1346 base = self.basename ()
1347 if self.format == LATEX:
1348 str += self.output_print_filename (LATEX)
1349 if VERBATIM in self.option_dict:
1350 verb = self.verb_ly ()
1351 str += (output[LATEX][VERBATIM] % vars ())
1353 str += (output[LATEX][OUTPUT] % vars ())
1355 ## todo: maintain breaks
1357 breaks = self.ly ().count ("\n")
1358 str += "".ljust (breaks, "\n").replace ("\n","%\n")
1360 if QUOTE in self.option_dict:
1361 str = output[LATEX][QUOTE] % vars ()
1364 def output_print_filename (self, format):
1366 if PRINTFILENAME in self.option_dict:
1367 base = self.basename ()
1368 filename = os.path.basename (self.substring ('filename'))
1369 str = output[format][PRINTFILENAME] % vars ()
1373 def output_texinfo (self):
1374 str = self.output_print_filename (TEXINFO)
1375 base = self.basename ()
1376 if DOCTITLE in self.option_dict:
1377 doctitle = base + '.doctitle'
1378 translated_doctitle = doctitle + document_language
1379 if os.path.exists (translated_doctitle):
1380 str += '@lydoctitle %s\n' % open (translated_doctitle).read ()
1381 elif os.path.exists (doctitle):
1382 str += '@lydoctitle %s\n' % open (doctitle).read ()
1383 if TEXIDOC in self.option_dict:
1384 texidoc = base + '.texidoc'
1385 translated_texidoc = texidoc + document_language
1386 if os.path.exists (translated_texidoc):
1387 str += '@include %(translated_texidoc)s\n\n' % vars ()
1388 elif os.path.exists (texidoc):
1389 str += '@include %(texidoc)s\n\n' % vars ()
1392 if VERBATIM in self.option_dict:
1394 if ADDVERSION in self.option_dict:
1395 version = output[TEXINFO][ADDVERSION]
1396 verb = self.verb_ly ()
1397 substr = output[TEXINFO][VERBATIM] % vars ()
1398 substr += self.output_info ()
1399 if LILYQUOTE in self.option_dict:
1400 substr = output[TEXINFO][QUOTE] % {'str':substr}
1403 # str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1404 # str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1405 # str += ('@html\n' + self.output_html () + '\n@end html\n')
1407 if QUOTE in self.option_dict:
1408 str = output[TEXINFO][QUOTE] % vars ()
1410 # need par after image
1415 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
1416 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
1418 class LilypondFileSnippet (LilypondSnippet):
1419 def __init__ (self, type, match, format, line_number):
1420 LilypondSnippet.__init__ (self, type, match, format, line_number)
1421 self.contents = file (find_file (self.substring ('filename'))).read ()
1425 s = re_begin_verbatim.split (s)[-1]
1426 s = re_end_verbatim.split (s)[0]
1427 return verb_ly_gettext (s)
1430 name = self.substring ('filename')
1431 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
1432 % (name, self.contents))
1435 snippet_type_to_class = {
1436 'lilypond_file': LilypondFileSnippet,
1437 'lilypond_block': LilypondSnippet,
1438 'lilypond': LilypondSnippet,
1439 'include': IncludeSnippet,
1442 def find_linestarts (s):
1447 i = s.find ('\n', start)
1455 nls.append (len (s))
1458 def find_toplevel_snippets (input_string, format, types):
1461 res[t] = re.compile (snippet_res[format][t])
1465 found = dict ([(t, None) for t in types])
1467 line_starts = find_linestarts (input_string)
1469 # We want to search for multiple regexes, without searching
1470 # the string multiple times for one regex.
1471 # Hence, we use earlier results to limit the string portion
1473 # Since every part of the string is traversed at most once for
1474 # every type of snippet, this is linear.
1480 if not found[type] or found[type][0] < index:
1483 m = res[type].search (input_string[index:endex])
1488 if type in snippet_type_to_class:
1489 klass = snippet_type_to_class[type]
1491 start = index + m.start ('match')
1492 line_number = line_start_idx
1493 while (line_starts[line_number] < start):
1497 snip = klass (type, m, format, line_number)
1499 found[type] = (start, snip)
1503 or found[type][0] < found[first][0])):
1508 # Limiting the search space is a cute
1509 # idea, but this *requires* to search
1510 # for possible containing blocks
1511 # first, at least as long as we do not
1512 # search for the start of blocks, but
1513 # always/directly for the entire
1514 # @block ... @end block.
1516 endex = found[first][0]
1519 snippets.append (Substring (input_string, index, len (input_string), line_start_idx))
1522 while (start > line_starts[line_start_idx+1]):
1525 (start, snip) = found[first]
1526 snippets.append (Substring (input_string, index, start, line_start_idx + 1))
1527 snippets.append (snip)
1529 index = start + len (snip.match.group ('match'))
1533 def filter_pipe (input, cmd):
1534 """Pass input through cmd, and return the result."""
1536 if global_options.verbose:
1537 progress (_ ("Opening filter `%s'") % cmd)
1539 (stdin, stdout, stderr) = os.popen3 (cmd)
1541 status = stdin.close ()
1545 output = stdout.read ()
1546 status = stdout.close ()
1547 error = stderr.read ()
1551 signal = 0x0f & status
1552 if status or (not output and error):
1553 exit_status = status >> 8
1554 error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1555 error (_ ("The error log is as follows:"))
1556 ly.stderr_write (error)
1557 ly.stderr_write (stderr.read ())
1560 if global_options.verbose:
1565 def system_in_directory (cmd, directory):
1566 """Execute a command in a different directory.
1568 Because of win32 compatibility, we can't simply use subprocess.
1571 current = os.getcwd()
1572 os.chdir (directory)
1573 ly.system(cmd, be_verbose=global_options.verbose,
1578 def process_snippets (cmd, snippets,
1579 format, lily_output_dir):
1580 """Run cmd on all of the .ly files from snippets."""
1585 if format in (HTML, TEXINFO) and '--formats' not in cmd:
1586 cmd += ' --formats=png '
1587 elif format in (DOCBOOK) and '--formats' not in cmd:
1588 cmd += ' --formats=png,pdf '
1590 checksum = snippet_list_checksum (snippets)
1591 contents = '\n'.join (['snippet-map-%d.ly' % checksum]
1592 + [snip.basename() + '.ly' for snip in snippets])
1593 name = os.path.join (lily_output_dir,
1594 'snippet-names-%d.ly' % checksum)
1595 file (name, 'wb').write (contents)
1597 system_in_directory (' '.join ([cmd, name]),
1602 # Retrieve dimensions from LaTeX
1603 LATEX_INSPECTION_DOCUMENT = r'''
1607 \typeout{textwidth=\the\textwidth}
1608 \typeout{columnsep=\the\columnsep}
1609 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1613 # Do we need anything else besides `textwidth'?
1614 def get_latex_textwidth (source):
1615 m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1617 warning (_ ("cannot find \\begin{document} in LaTeX document"))
1619 ## what's a sensible default?
1622 preamble = source[:m.start (0)]
1623 latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1625 (handle, tmpfile) = tempfile.mkstemp('.tex')
1626 logfile = os.path.splitext (tmpfile)[0] + '.log'
1627 logfile = os.path.split (logfile)[1]
1629 tmp_handle = os.fdopen (handle,'w')
1630 tmp_handle.write (latex_document)
1633 ly.system ('%s %s' % (global_options.latex_program, tmpfile),
1634 be_verbose=global_options.verbose)
1635 parameter_string = file (logfile).read()
1641 m = re.search ('columns=([0-9.]*)', parameter_string)
1643 columns = int (m.group (1))
1646 m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1648 columnsep = float (m.group (1))
1651 m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1653 textwidth = float (m.group (1))
1655 textwidth = (textwidth - columnsep) / columns
1659 def modify_preamble (chunk):
1660 str = chunk.replacement_text ()
1661 if (re.search (r"\\begin *{document}", str)
1662 and not re.search ("{graphic[sx]", str)):
1663 str = re.sub (r"\\begin{document}",
1664 r"\\usepackage{graphics}" + '\n'
1665 + r"\\begin{document}",
1667 chunk.override_text = str
1672 # TEXINFO: '.texinfo',
1678 class CompileError(Exception):
1681 def snippet_list_checksum (snippets):
1682 return hash (' '.join([l.basename() for l in snippets]))
1684 def write_file_map (lys, name):
1685 snippet_map = file (os.path.join (
1686 global_options.lily_output_dir,
1687 'snippet-map-%d.ly' % snippet_list_checksum (lys)), 'w')
1689 snippet_map.write ("""
1690 #(define version-seen #t)
1691 #(define output-empty-score-list #f)
1692 #(ly:add-file-name-alist '(%s
1694 """ % '\n'.join(['("%s.ly" . "%s")\n' % (ly.basename (), name)
1697 def split_output_files(directory):
1698 """Returns directory entries in DIRECTORY/XX/ , where XX are hex digits.
1700 Return value is a set of strings.
1703 for subdir in glob.glob (os.path.join (directory, '[a-f0-9][a-f0-9]')):
1704 base_subdir = os.path.split (subdir)[1]
1705 sub_files = [os.path.join (base_subdir, name)
1706 for name in os.listdir (subdir)]
1710 def do_process_cmd (chunks, input_name, options):
1711 snippets = [c for c in chunks if isinstance (c, LilypondSnippet)]
1713 output_files = split_output_files (options.lily_output_dir)
1714 outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)]
1716 write_file_map (outdated, input_name)
1717 progress (_ ("Writing snippets..."))
1718 for snippet in outdated:
1723 progress (_ ("Processing..."))
1725 process_snippets (options.process_cmd, outdated,
1726 options.format, options.lily_output_dir)
1729 progress (_ ("All snippets are up to date..."))
1731 if options.lily_output_dir != options.output_dir:
1732 output_files = split_output_files (options.lily_output_dir)
1733 for snippet in snippets:
1734 snippet.link_all_output_files (options.lily_output_dir,
1742 # Format guessing data
1751 '.texinfo': TEXINFO,
1756 def guess_format (input_filename):
1758 e = os.path.splitext (input_filename)[1]
1761 format = ext2format[e]
1763 error (_ ("cannot determine format for: %s"
1768 def write_if_updated (file_name, lines):
1770 f = file (file_name)
1772 new_str = ''.join (lines)
1773 if oldstr == new_str:
1774 progress (_ ("%s is up to date.") % file_name)
1777 # this prevents make from always rerunning lilypond-book:
1778 # output file must be touched in order to be up to date
1779 os.utime (file_name, None)
1784 output_dir = os.path.dirname (file_name)
1785 if not os.path.exists (output_dir):
1786 os.makedirs (output_dir)
1788 progress (_ ("Writing `%s'...") % file_name)
1789 file (file_name, 'w').writelines (lines)
1793 def note_input_file (name, inputs=[]):
1794 ## hack: inputs is mutable!
1795 inputs.append (name)
1798 def samefile (f1, f2):
1800 return os.path.samefile (f1, f2)
1801 except AttributeError: # Windoze
1802 f1 = re.sub ("//*", "/", f1)
1803 f2 = re.sub ("//*", "/", f2)
1806 def do_file (input_filename, included=False):
1808 if not input_filename or input_filename == '-':
1809 in_handle = sys.stdin
1810 input_fullname = '<stdin>'
1812 if os.path.exists (input_filename):
1813 input_fullname = input_filename
1814 elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1815 input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1817 input_fullname = find_file (input_filename)
1819 note_input_file (input_fullname)
1820 in_handle = file (input_fullname)
1822 if input_filename == '-':
1823 input_base = 'stdin'
1825 input_base = os.path.splitext (input_filename)[0]
1827 input_base = os.path.basename (
1828 os.path.splitext (input_filename)[0])
1830 # don't complain when global_options.output_dir is existing
1831 if not global_options.output_dir:
1832 global_options.output_dir = os.getcwd()
1834 global_options.output_dir = os.path.abspath(global_options.output_dir)
1836 if not os.path.isdir (global_options.output_dir):
1837 os.mkdir (global_options.output_dir, 0777)
1838 os.chdir (global_options.output_dir)
1840 output_filename = os.path.join(global_options.output_dir,
1841 input_base + format2ext[global_options.format])
1842 if (os.path.exists (input_filename)
1843 and os.path.exists (output_filename)
1844 and samefile (output_filename, input_fullname)):
1846 _ ("Output would overwrite input file; use --output."))
1850 progress (_ ("Reading %s...") % input_fullname)
1851 source = in_handle.read ()
1854 set_default_options (source, default_ly_options, global_options.format)
1857 # FIXME: Containing blocks must be first, see
1858 # find_toplevel_snippets.
1860 'multiline_comment',
1864 'singleline_comment',
1869 progress (_ ("Dissecting..."))
1870 chunks = find_toplevel_snippets (source, global_options.format, snippet_types)
1872 if global_options.format == LATEX:
1874 if (c.is_plain () and
1875 re.search (r"\\begin *{document}", c.replacement_text())):
1880 if global_options.filter_cmd:
1881 write_if_updated (output_filename,
1882 [c.filter_text () for c in chunks])
1883 elif global_options.process_cmd:
1884 do_process_cmd (chunks, input_fullname, global_options)
1885 progress (_ ("Compiling %s...") % output_filename)
1887 write_if_updated (output_filename,
1888 [s.replacement_text ()
1891 def process_include (snippet):
1892 os.chdir (original_dir)
1893 name = snippet.substring ('filename')
1894 progress (_ ("Processing include: %s") % name)
1896 return do_file (name, included=True)
1898 include_chunks = map (process_include,
1899 filter (lambda x: isinstance (x, IncludeSnippet),
1902 return chunks + reduce (lambda x, y: x + y, include_chunks, [])
1904 except CompileError:
1905 os.chdir (original_dir)
1906 progress (_ ("Removing `%s'") % output_filename)
1911 global global_options
1913 opt_parser = get_option_parser()
1914 (global_options, args) = opt_parser.parse_args ()
1915 if global_options.format in ('texi-html', 'texi'):
1916 global_options.format = TEXINFO
1918 global_options.include_path = map (os.path.abspath, global_options.include_path)
1920 if global_options.warranty:
1923 if not args or len (args) > 1:
1924 opt_parser.print_help ()
1930 # FIXME: 85 lines of `main' macramee??
1931 files = do_options ()
1933 basename = os.path.splitext (files[0])[0]
1934 basename = os.path.split (basename)[1]
1936 if not global_options.format:
1937 global_options.format = guess_format (files[0])
1940 if global_options.format in (TEXINFO, HTML, DOCBOOK):
1943 if global_options.process_cmd == '':
1944 global_options.process_cmd = (lilypond_binary
1945 + ' --formats=%s -dbackend=eps ' % formats)
1947 if global_options.process_cmd:
1948 includes = global_options.include_path
1949 if global_options.lily_output_dir:
1950 # This must be first, so lilypond prefers to read .ly
1951 # files in the other lybookdb dir.
1952 includes = [os.path.abspath(global_options.lily_output_dir)] + includes
1953 global_options.process_cmd += ' '.join ([' -I %s' % ly.mkarg (p)
1956 if global_options.format in (TEXINFO, LATEX):
1957 ## prevent PDF from being switched on by default.
1958 global_options.process_cmd += ' --formats=eps '
1959 if global_options.create_pdf:
1960 global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts "
1962 if global_options.verbose:
1963 global_options.process_cmd += " --verbose "
1965 if global_options.padding_mm:
1966 global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm
1968 global_options.process_cmd += " -dread-file-list -dno-strip-output-dir"
1970 if global_options.lily_output_dir:
1971 global_options.lily_output_dir = os.path.abspath(global_options.lily_output_dir)
1972 if not os.path.isdir (global_options.lily_output_dir):
1973 os.makedirs (global_options.lily_output_dir)
1975 global_options.lily_output_dir = os.path.abspath(global_options.output_dir)
1980 chunks = do_file (files[0])
1981 except CompileError:
1984 inputs = note_input_file ('')
1987 base_file_name = os.path.splitext (os.path.basename (files[0]))[0]
1988 dep_file = os.path.join (global_options.output_dir, base_file_name + '.dep')
1989 final_output_file = os.path.join (global_options.output_dir,
1991 + '.%s' % global_options.format)
1993 os.chdir (original_dir)
1994 file (dep_file, 'w').write ('%s: %s'
1995 % (final_output_file, ' '.join (inputs)))
1997 if __name__ == '__main__':