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'
241 OUTPUTIMAGE = 'outputimage'
244 PREAMBLE = 'preamble'
245 PRINTFILENAME = 'printfilename'
247 RAGGED_RIGHT = 'ragged-right'
248 RELATIVE = 'relative'
249 STAFFSIZE = 'staffsize'
250 DOCTITLE = 'doctitle'
253 VERBATIM = 'verbatim'
254 FONTLOAD = 'fontload'
255 FILENAME = 'filename'
259 # NOTIME has no opposite so it isn't part of this dictionary.
260 # NOQUOTE is used internally only.
262 NOFRAGMENT: FRAGMENT,
267 # Recognize special sequences in the input.
269 # (?P<name>regex) -- Assign result of REGEX to NAME.
270 # *? -- Match non-greedily.
271 # (?m) -- Multiline regex: Make ^ and $ match at each line.
272 # (?s) -- Make the dot match all characters including newline.
273 # (?x) -- Ignore whitespace in patterns.
284 <(?P<inline>(inline)?)mediaobject>\s*<textobject.*?>\s*<programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>(?P<code>.*?)</programlisting\s*>\s*</textobject\s*>\s*</(inline)?mediaobject>)''',
289 <(?P<inline>(inline)?)mediaobject>\s*<textobject.*?>\s*<programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>(?P<code>.*?)</programlisting\s*>\s*</textobject\s*>\s*</(inline)?mediaobject>)''',
294 <(?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>)''',
300 (?P<code><!--\s.*?!-->)
303 'singleline_comment':
322 (\s*(?P<options>.*?)\s*:)?\s*
330 \s*(?P<options>.*?)\s*
339 \s*(?P<options>.*?)\s*
341 \s*(?P<filename>.*?)\s*
348 (?P<code><!--\s.*?!-->)
351 'singleline_comment':
357 (?P<code><pre>.*?</pre>))''',
363 (?P<code><pre>\s.*?</pre>\s))''',
382 \s*(?P<options>.*?)\s*
393 \s*(?P<options>.*?)\s*
397 \\end\s*{lilypond})''',
405 \s*(?P<options>.*?)\s*
413 'singleline_comment':
436 \\end\s*{verbatim}))''',
445 (?P<filename>\S+))''',
449 ^[^\n]*?(?!@c\s+)[^\n]*?
453 \s*(?P<options>.*?)\s*
463 \s*(?P<options>.*?)\s*
466 ^@end\s+lilypond)\s''',
473 \s*(?P<options>.*?)\s*
484 @end\s+ignore))\s''',
486 'singleline_comment':
491 @c([ \t][^\n]*|)\n))''',
493 # Don't do this: It interferes with @code{@{}.
494 # 'verb': r'''(?P<code>@code{.*?})''',
502 @end\s+example\s))''',
511 'intertext': r',?\s*intertext=\".*?\"',
515 'intertext': r',?\s*intertext=\".*?\"',
520 'intertext': r',?\s*intertext=\".*?\"',
521 'option_sep': '\s*,\s*',
525 'intertext': r',?\s*intertext=\".*?\"',
526 'option_sep': '\s*,\s*',
530 # Options without a pattern in ly_options.
550 RELATIVE: r'''\relative c%(relative_quotes)s''',
555 INDENT: r'''indent = %(indent)s''',
557 LINE_WIDTH: r'''line-width = %(line-width)s''',
559 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
561 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
563 RAGGED_RIGHT: r'''ragged-right = ##t''',
565 PACKED: r'''packed = ##t''',
577 \remove Time_signature_engraver
583 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
590 FILTER: r'''<mediaobject><textobject><programlisting language="lilypond" role="%(options)s">%(code)s</programlisting></textobject></mediaobject>''',
593 <imageobject role="latex">
594 <imagedata fileref="%(base)s.pdf" format="PDF"/>
596 <imageobject role="html">
597 <imagedata fileref="%(base)s.png" format="PNG"/></imageobject>''',
599 VERBATIM: r'''<programlisting>%(verb)s</programlisting>''',
601 PRINTFILENAME: '<textobject><simpara><ulink url="%(base)s.ly"><filename>%(filename)s</filename></ulink></simpara></textobject>'
605 FILTER: r'''<lilypond %(options)s>
615 <a href="%(base)s.ly">''',
619 border="0" src="%(image)s" alt="%(alt)s">''',
621 PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
623 QUOTE: r'''<blockquote>
636 \ifx\preLilyPondExample \undefined%%
639 \preLilyPondExample%%
641 \def\lilypondbook{}%%
642 \input %(base)s-systems.tex%%
643 \ifx\postLilyPondExample \undefined%%
646 \postLilyPondExample%%
650 PRINTFILENAME: '''\\texttt{%(filename)s}
653 QUOTE: r'''\begin{quotation}%(str)s
656 VERBATIM: r'''\noindent
657 \begin{verbatim}%(verb)s\end{verbatim}''',
659 FILTER: r'''\begin{lilypond}[%(options)s]
666 FILTER: r'''@lilypond[%(options)s]
672 @include %(base)s-systems.texi
676 OUTPUTIMAGE: r'''@noindent
678 @image{%(info_image_path)s,,,%(alt)s,%(ext)s}
682 <a href="%(base)s.ly">
684 border="0" src="%(image)s" alt="%(alt)s">
692 <a href="%(base)s.ly">
700 QUOTE: r'''@quotation
701 %(str)s@end quotation
708 VERBATIM: r'''@exampleindent 0
710 %(verb)s@end verbatim
713 ADDVERSION: r'''@example
714 \version @w{"@version{}"}
721 # Maintain line numbers.
726 for f in [HTML, LATEX]:
727 for s in (QUOTE, VERBATIM):
728 output[f][s] = output[f][s].replace("\n"," ")
731 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
732 %%%% Options: [%(option_string)s]
733 \\include "lilypond-book-preamble.ly"
736 %% ****************************************************************
737 %% Start cut-&-pastable-section
738 %% ****************************************************************
743 #(define dump-extents #t)
744 %(font_dump_setting)s
746 force-assignment = #""
747 line-width = #(- line-width (* mm %(padding_mm)f))
760 %% ****************************************************************
761 %% ly snippet contents follows:
762 %% ****************************************************************
766 %% ****************************************************************
768 %% ****************************************************************
775 %% ****************************************************************
777 %% ****************************************************************
781 %% ****************************************************************
783 %% ****************************************************************
786 texinfo_line_widths = {
787 '@afourpaper': '160\\mm',
788 '@afourwide': '6.5\\in',
789 '@afourlatex': '150\\mm',
790 '@smallbook': '5\\in',
791 '@letterpaper': '6\\in',
794 def classic_lilypond_book_compatibility (key, value):
795 if key == 'singleline' and value == None:
796 return (RAGGED_RIGHT, None)
798 m = re.search ('relative\s*([-0-9])', key)
800 return ('relative', m.group (1))
802 m = re.match ('([0-9]+)pt', key)
804 return ('staffsize', m.group (1))
806 if key == 'indent' or key == 'line-width':
807 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
809 f = float (m.group (1))
810 return (key, '%f\\%s' % (f, m.group (2)))
814 def find_file (name, raise_error=True):
815 for i in global_options.include_path:
816 full = os.path.join (i, name)
817 if os.path.exists (full):
821 error (_ ("file not found: %s") % name + '\n')
825 def verbatim_html (s):
826 return re.sub ('>', '>',
828 re.sub ('&', '&', s)))
830 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
831 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
833 def ly_comment_gettext (t, m):
834 return m.group (1) + t (m.group (2))
836 def verb_ly_gettext (s):
837 if not document_language:
840 t = langdefs.translation[document_language]
844 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
846 for v in ly_var_def_re.findall (s):
847 s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v,
848 "\\1" + t (v) + "\\2",
852 texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)')
853 def set_default_options (source, default_ly_options, format):
854 global document_language
855 if LINE_WIDTH not in default_ly_options:
857 textwidth = get_latex_textwidth (source)
858 default_ly_options[LINE_WIDTH] = '%.0f\\pt' % textwidth
859 elif format == TEXINFO:
860 m = texinfo_lang_re.search (source)
861 if m and not m.group (1).startswith ('en'):
862 document_language = m.group (1)
864 document_language = ''
865 for regex in texinfo_line_widths:
866 # FIXME: @layout is usually not in
869 # \input texinfo @c -*-texinfo-*-
871 # Bluntly search first K items of
873 # s = chunks[0].replacement_text ()
874 if re.search (regex, source[:1024]):
875 default_ly_options[LINE_WIDTH] = texinfo_line_widths[regex]
879 def replacement_text (self):
882 def filter_text (self):
883 return self.replacement_text ()
888 class Substring (Chunk):
889 """A string that does not require extra memory."""
890 def __init__ (self, source, start, end, line_number):
894 self.line_number = line_number
895 self.override_text = None
900 def replacement_text (self):
901 if self.override_text:
902 return self.override_text
904 return self.source[self.start:self.end]
906 class Snippet (Chunk):
907 def __init__ (self, type, match, format, line_number):
911 self.option_dict = {}
913 self.line_number = line_number
915 def replacement_text (self):
916 return self.match.group ('match')
918 def substring (self, s):
919 return self.match.group (s)
922 return `self.__class__` + ' type = ' + self.type
924 class IncludeSnippet (Snippet):
925 def processed_filename (self):
926 f = self.substring ('filename')
927 return os.path.splitext (f)[0] + format2ext[self.format]
929 def replacement_text (self):
930 s = self.match.group ('match')
931 f = self.substring ('filename')
933 return re.sub (f, self.processed_filename (), s)
935 class LilypondSnippet (Snippet):
936 def __init__ (self, type, match, format, line_number):
937 Snippet.__init__ (self, type, match, format, line_number)
938 os = match.group ('options')
939 self.do_options (os, self.type)
942 return verb_ly_gettext (self.substring ('code'))
945 contents = self.substring ('code')
946 return ('\\sourcefileline %d\n%s'
947 % (self.line_number - 1, contents))
952 return self.compose_ly (s)
955 def split_options (self, option_string):
957 if self.format == HTML:
958 options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',
960 options = [re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)', '\g<1>\g<3>', opt)
964 return re.split (format_res[self.format]['option_sep'],
968 def do_options (self, option_string, type):
969 self.option_dict = {}
971 options = self.split_options (option_string)
973 for option in options:
975 (key, value) = re.split ('\s*=\s*', option)
976 self.option_dict[key] = value
978 if option in no_options:
979 if no_options[option] in self.option_dict:
980 del self.option_dict[no_options[option]]
982 self.option_dict[option] = None
984 has_line_width = self.option_dict.has_key (LINE_WIDTH)
985 no_line_width_value = 0
987 # If LINE_WIDTH is used without parameter, set it to default.
988 if has_line_width and self.option_dict[LINE_WIDTH] == None:
989 no_line_width_value = 1
990 del self.option_dict[LINE_WIDTH]
992 for k in default_ly_options:
993 if k not in self.option_dict:
994 self.option_dict[k] = default_ly_options[k]
996 # RELATIVE does not work without FRAGMENT;
997 # make RELATIVE imply FRAGMENT
998 has_relative = self.option_dict.has_key (RELATIVE)
999 if has_relative and not self.option_dict.has_key (FRAGMENT):
1000 self.option_dict[FRAGMENT] = None
1002 if not has_line_width:
1003 if type == 'lilypond' or FRAGMENT in self.option_dict:
1004 self.option_dict[RAGGED_RIGHT] = None
1006 if type == 'lilypond':
1007 if LINE_WIDTH in self.option_dict:
1008 del self.option_dict[LINE_WIDTH]
1010 if RAGGED_RIGHT in self.option_dict:
1011 if LINE_WIDTH in self.option_dict:
1012 del self.option_dict[LINE_WIDTH]
1014 if QUOTE in self.option_dict or type == 'lilypond':
1015 if LINE_WIDTH in self.option_dict:
1016 del self.option_dict[LINE_WIDTH]
1018 if not INDENT in self.option_dict:
1019 self.option_dict[INDENT] = '0\\mm'
1021 # The QUOTE pattern from ly_options only emits the `line-width'
1023 if has_line_width and QUOTE in self.option_dict:
1024 if no_line_width_value:
1025 del self.option_dict[LINE_WIDTH]
1027 del self.option_dict[QUOTE]
1029 def compose_ly (self, code):
1030 if FRAGMENT in self.option_dict:
1038 # The original concept of the `exampleindent' option is broken.
1039 # It is not possible to get a sane value for @exampleindent at all
1040 # without processing the document itself. Saying
1048 # causes ugly results with the DVI backend of texinfo since the
1049 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
1050 # value). Executing the above code changes the environment
1051 # indentation to an unknown value because we don't know the amount
1052 # of 1em in advance since it is font-dependent. Modifying
1053 # @exampleindent in the middle of a document is simply not
1054 # supported within texinfo.
1056 # As a consequence, the only function of @exampleindent is now to
1057 # specify the amount of indentation for the `quote' option.
1059 # To set @exampleindent locally to zero, we use the @format
1060 # environment for non-quoted snippets.
1061 override[EXAMPLEINDENT] = r'0.4\in'
1062 override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
1063 override.update (default_ly_options)
1066 for (key, value) in self.option_dict.items ():
1068 option_list.append (key)
1070 option_list.append (key + '=' + value)
1071 option_string = ','.join (option_list)
1074 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
1075 for a in compose_types:
1076 compose_dict[a] = []
1078 for (key, value) in self.option_dict.items ():
1079 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
1083 _ ("deprecated ly-option used: %s=%s") % (key, value))
1085 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
1088 _ ("deprecated ly-option used: %s") % key)
1090 _ ("compatibility mode translation: %s") % c_key)
1092 (key, value) = (c_key, c_value)
1095 override[key] = value
1097 if not override.has_key (key):
1098 override[key] = None
1101 for type in compose_types:
1102 if ly_options[type].has_key (key):
1103 compose_dict[type].append (ly_options[type][key])
1107 if not found and key not in simple_options:
1108 warning (_ ("ignoring unknown ly option: %s") % key)
1111 if RELATIVE in override and override[RELATIVE]:
1112 relative = int (override[RELATIVE])
1114 relative_quotes = ''
1118 relative_quotes += ',' * (- relative)
1120 relative_quotes += "'" * relative
1122 paper_string = '\n '.join (compose_dict[PAPER]) % override
1123 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
1124 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
1125 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
1126 padding_mm = global_options.padding_mm
1127 font_dump_setting = ''
1128 if FONTLOAD in self.option_dict:
1129 font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1131 d = globals().copy()
1133 return (PREAMBLE_LY + body) % d
1135 def get_checksum (self):
1136 if not self.checksum:
1137 hash = md5.md5 (self.relevant_contents (self.full_ly ()))
1139 ## let's not create too long names.
1140 self.checksum = hash.hexdigest ()[:10]
1142 return self.checksum
1144 def basename (self):
1145 cs = self.get_checksum ()
1146 name = '%s/lily-%s' % (cs[:2], cs[2:10])
1149 def write_ly (self):
1150 base = self.basename ()
1151 path = os.path.join (global_options.lily_output_dir, base)
1152 directory = os.path.split(path)[0]
1153 if not os.path.isdir (directory):
1154 os.makedirs (directory)
1155 out = file (path + '.ly', 'w')
1156 out.write (self.full_ly ())
1157 file (path + '.txt', 'w').write ('image of music')
1159 def relevant_contents (self, ly):
1160 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly)
1162 def link_all_output_files (self, output_dir, output_dir_files, destination):
1163 existing, missing = self.all_output_files (output_dir, output_dir_files)
1165 print '\nMissing', missing
1166 raise CompileError(self.basename())
1167 for name in existing:
1169 os.unlink (os.path.join (destination, name))
1173 src = os.path.join (output_dir, name)
1174 dst = os.path.join (destination, name)
1175 dst_path = os.path.split(dst)[0]
1176 if not os.path.isdir (dst_path):
1177 os.makedirs (dst_path)
1181 def all_output_files (self, output_dir, output_dir_files):
1182 """Return all files generated in lily_output_dir, a set.
1184 output_dir_files is the list of files in the output directory.
1188 base = self.basename()
1189 full = os.path.join (output_dir, base)
1190 def consider_file (name):
1191 if name in output_dir_files:
1194 def require_file (name):
1195 if name in output_dir_files:
1200 # UGH - junk global_options
1201 skip_lily = global_options.skip_lilypond_run
1202 for required in [base + '.ly',
1204 require_file (required)
1206 require_file (base + '-systems.count')
1208 map (consider_file, [base + '.tex',
1212 base + '-systems.texi',
1213 base + '-systems.tex',
1214 base + '-systems.pdftexi'])
1215 if document_language:
1217 [base + '.texidoc' + document_language,
1218 base + '.doctitle' + document_language])
1220 # UGH - junk global_options
1221 if (base + '.eps' in result and self.format in (HTML, TEXINFO)
1222 and not global_options.skip_png_check):
1223 page_count = ps_page_count (full + '.eps')
1225 require_file (base + '.png')
1227 for page in range (1, page_count + 1):
1228 require_file (base + '-page%d.png' % page)
1231 if not skip_lily and not missing:
1232 system_count = int(file (full + '-systems.count').read())
1233 for number in range(1, system_count + 1):
1234 systemfile = '%s-%d' % (base, number)
1235 require_file (systemfile + '.eps')
1236 consider_file (systemfile + '.pdf')
1238 return (result, missing)
1240 def is_outdated (self, output_dir, current_files):
1241 found, missing = self.all_output_files (output_dir, current_files)
1244 def filter_text (self):
1245 """Run snippet bodies through a command (say: convert-ly).
1247 This functionality is rarely used, and this code must have bitrot.
1249 code = self.substring ('code')
1250 s = filter_pipe (code, global_options.filter_cmd)
1253 'options': self.match.group ('options')
1256 return output[self.format][FILTER] % d
1258 def replacement_text (self):
1259 func = LilypondSnippet.__dict__['output_' + self.format]
1262 def get_images (self):
1263 base = self.basename ()
1265 single = '%(base)s.png' % vars ()
1266 multiple = '%(base)s-page1.png' % vars ()
1268 if (os.path.exists (multiple)
1269 and (not os.path.exists (single)
1270 or (os.stat (multiple)[stat.ST_MTIME]
1271 > os.stat (single)[stat.ST_MTIME]))):
1272 count = ps_page_count ('%(base)s.eps' % vars ())
1273 images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)]
1274 images = tuple (images)
1278 def output_docbook (self):
1280 base = self.basename ()
1281 for image in self.get_images ():
1282 (base, ext) = os.path.splitext (image)
1283 str += output[DOCBOOK][OUTPUT] % vars ()
1284 str += self.output_print_filename (DOCBOOK)
1285 if (self.substring('inline') == 'inline'):
1286 str = '<inlinemediaobject>' + str + '</inlinemediaobject>'
1288 str = '<mediaobject>' + str + '</mediaobject>'
1289 if VERBATIM in self.option_dict:
1290 verb = verbatim_html (self.verb_ly ())
1291 str = output[DOCBOOK][VERBATIM] % vars () + str
1294 def output_html (self):
1296 base = self.basename ()
1297 if self.format == HTML:
1298 str += self.output_print_filename (HTML)
1299 if VERBATIM in self.option_dict:
1300 verb = verbatim_html (self.verb_ly ())
1301 str += output[HTML][VERBATIM] % vars ()
1302 if QUOTE in self.option_dict:
1303 str = output[HTML][QUOTE] % vars ()
1305 str += output[HTML][BEFORE] % vars ()
1306 for image in self.get_images ():
1307 (base, ext) = os.path.splitext (image)
1308 alt = self.option_dict[ALT]
1309 str += output[HTML][OUTPUT] % vars ()
1310 str += output[HTML][AFTER] % vars ()
1313 def output_info (self):
1315 for image in self.get_images ():
1316 (base, ext) = os.path.splitext (image)
1318 # URG, makeinfo implicitly prepends dot to extension.
1319 # Specifying no extension is most robust.
1321 alt = self.option_dict[ALT]
1322 info_image_path = os.path.join (global_options.info_images_dir, base)
1323 str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1325 base = self.basename ()
1326 str += output[self.format][OUTPUT] % vars ()
1329 def output_latex (self):
1331 base = self.basename ()
1332 if self.format == LATEX:
1333 str += self.output_print_filename (LATEX)
1334 if VERBATIM in self.option_dict:
1335 verb = self.verb_ly ()
1336 str += (output[LATEX][VERBATIM] % vars ())
1338 str += (output[LATEX][OUTPUT] % vars ())
1340 ## todo: maintain breaks
1342 breaks = self.ly ().count ("\n")
1343 str += "".ljust (breaks, "\n").replace ("\n","%\n")
1345 if QUOTE in self.option_dict:
1346 str = output[LATEX][QUOTE] % vars ()
1349 def output_print_filename (self, format):
1351 if PRINTFILENAME in self.option_dict:
1352 base = self.basename ()
1353 filename = os.path.basename (self.substring ('filename'))
1354 str = output[format][PRINTFILENAME] % vars ()
1358 def output_texinfo (self):
1359 str = self.output_print_filename (TEXINFO)
1360 base = self.basename ()
1361 if DOCTITLE in self.option_dict:
1362 doctitle = base + '.doctitle'
1363 translated_doctitle = doctitle + document_language
1364 if os.path.exists (translated_doctitle):
1365 str += '@lydoctitle %s\n' % open (translated_doctitle).read ()
1366 elif os.path.exists (doctitle):
1367 str += '@lydoctitle %s\n' % open (doctitle).read ()
1368 if TEXIDOC in self.option_dict:
1369 texidoc = base + '.texidoc'
1370 translated_texidoc = texidoc + document_language
1371 if os.path.exists (translated_texidoc):
1372 str += '@include %(translated_texidoc)s\n\n' % vars ()
1373 elif os.path.exists (texidoc):
1374 str += '@include %(texidoc)s\n\n' % vars ()
1377 if VERBATIM in self.option_dict:
1379 if ADDVERSION in self.option_dict:
1380 version = output[TEXINFO][ADDVERSION]
1381 verb = self.verb_ly ()
1382 substr = output[TEXINFO][VERBATIM] % vars ()
1383 substr += self.output_info ()
1384 if LILYQUOTE in self.option_dict:
1385 substr = output[TEXINFO][QUOTE] % {'str':substr}
1388 # str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1389 # str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1390 # str += ('@html\n' + self.output_html () + '\n@end html\n')
1392 if QUOTE in self.option_dict:
1393 str = output[TEXINFO][QUOTE] % vars ()
1395 # need par after image
1400 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
1401 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
1403 class LilypondFileSnippet (LilypondSnippet):
1404 def __init__ (self, type, match, format, line_number):
1405 LilypondSnippet.__init__ (self, type, match, format, line_number)
1406 self.contents = file (find_file (self.substring ('filename'))).read ()
1410 s = re_begin_verbatim.split (s)[-1]
1411 s = re_end_verbatim.split (s)[0]
1412 return verb_ly_gettext (s)
1415 name = self.substring ('filename')
1416 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
1417 % (name, self.contents))
1420 snippet_type_to_class = {
1421 'lilypond_file': LilypondFileSnippet,
1422 'lilypond_block': LilypondSnippet,
1423 'lilypond': LilypondSnippet,
1424 'include': IncludeSnippet,
1427 def find_linestarts (s):
1432 i = s.find ('\n', start)
1440 nls.append (len (s))
1443 def find_toplevel_snippets (input_string, format, types):
1446 res[t] = re.compile (snippet_res[format][t])
1450 found = dict ([(t, None) for t in types])
1452 line_starts = find_linestarts (input_string)
1454 # We want to search for multiple regexes, without searching
1455 # the string multiple times for one regex.
1456 # Hence, we use earlier results to limit the string portion
1458 # Since every part of the string is traversed at most once for
1459 # every type of snippet, this is linear.
1465 if not found[type] or found[type][0] < index:
1468 m = res[type].search (input_string[index:endex])
1473 if type in snippet_type_to_class:
1474 klass = snippet_type_to_class[type]
1476 start = index + m.start ('match')
1477 line_number = line_start_idx
1478 while (line_starts[line_number] < start):
1482 snip = klass (type, m, format, line_number)
1484 found[type] = (start, snip)
1488 or found[type][0] < found[first][0])):
1493 # Limiting the search space is a cute
1494 # idea, but this *requires* to search
1495 # for possible containing blocks
1496 # first, at least as long as we do not
1497 # search for the start of blocks, but
1498 # always/directly for the entire
1499 # @block ... @end block.
1501 endex = found[first][0]
1504 snippets.append (Substring (input_string, index, len (input_string), line_start_idx))
1507 while (start > line_starts[line_start_idx+1]):
1510 (start, snip) = found[first]
1511 snippets.append (Substring (input_string, index, start, line_start_idx + 1))
1512 snippets.append (snip)
1514 index = start + len (snip.match.group ('match'))
1518 def filter_pipe (input, cmd):
1519 """Pass input through cmd, and return the result."""
1521 if global_options.verbose:
1522 progress (_ ("Opening filter `%s'") % cmd)
1524 (stdin, stdout, stderr) = os.popen3 (cmd)
1526 status = stdin.close ()
1530 output = stdout.read ()
1531 status = stdout.close ()
1532 error = stderr.read ()
1536 signal = 0x0f & status
1537 if status or (not output and error):
1538 exit_status = status >> 8
1539 error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1540 error (_ ("The error log is as follows:"))
1541 ly.stderr_write (error)
1542 ly.stderr_write (stderr.read ())
1545 if global_options.verbose:
1550 def system_in_directory (cmd, directory):
1551 """Execute a command in a different directory.
1553 Because of win32 compatibility, we can't simply use subprocess.
1556 current = os.getcwd()
1557 os.chdir (directory)
1558 ly.system(cmd, be_verbose=global_options.verbose,
1563 def process_snippets (cmd, snippets,
1564 format, lily_output_dir):
1565 """Run cmd on all of the .ly files from snippets."""
1570 if format in (HTML, TEXINFO) and '--formats' not in cmd:
1571 cmd += ' --formats=png '
1572 elif format in (DOCBOOK) and '--formats' not in cmd:
1573 cmd += ' --formats=png,pdf '
1575 checksum = snippet_list_checksum (snippets)
1576 contents = '\n'.join (['snippet-map-%d.ly' % checksum]
1577 + [snip.basename() + '.ly' for snip in snippets])
1578 name = os.path.join (lily_output_dir,
1579 'snippet-names-%d.ly' % checksum)
1580 file (name, 'wb').write (contents)
1582 system_in_directory (' '.join ([cmd, name]),
1587 # Retrieve dimensions from LaTeX
1588 LATEX_INSPECTION_DOCUMENT = r'''
1592 \typeout{textwidth=\the\textwidth}
1593 \typeout{columnsep=\the\columnsep}
1594 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1598 # Do we need anything else besides `textwidth'?
1599 def get_latex_textwidth (source):
1600 m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1602 warning (_ ("cannot find \\begin{document} in LaTeX document"))
1604 ## what's a sensible default?
1607 preamble = source[:m.start (0)]
1608 latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1610 (handle, tmpfile) = tempfile.mkstemp('.tex')
1611 logfile = os.path.splitext (tmpfile)[0] + '.log'
1612 logfile = os.path.split (logfile)[1]
1614 tmp_handle = os.fdopen (handle,'w')
1615 tmp_handle.write (latex_document)
1618 ly.system ('%s %s' % (global_options.latex_program, tmpfile),
1619 be_verbose=global_options.verbose)
1620 parameter_string = file (logfile).read()
1626 m = re.search ('columns=([0-9.]*)', parameter_string)
1628 columns = int (m.group (1))
1631 m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1633 columnsep = float (m.group (1))
1636 m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1638 textwidth = float (m.group (1))
1640 textwidth = (textwidth - columnsep) / columns
1644 def modify_preamble (chunk):
1645 str = chunk.replacement_text ()
1646 if (re.search (r"\\begin *{document}", str)
1647 and not re.search ("{graphic[sx]", str)):
1648 str = re.sub (r"\\begin{document}",
1649 r"\\usepackage{graphics}" + '\n'
1650 + r"\\begin{document}",
1652 chunk.override_text = str
1657 # TEXINFO: '.texinfo',
1663 class CompileError(Exception):
1666 def snippet_list_checksum (snippets):
1667 return hash (' '.join([l.basename() for l in snippets]))
1669 def write_file_map (lys, name):
1670 snippet_map = file (os.path.join (
1671 global_options.lily_output_dir,
1672 'snippet-map-%d.ly' % snippet_list_checksum (lys)), 'w')
1674 snippet_map.write ("""
1675 #(define version-seen #t)
1676 #(define output-empty-score-list #f)
1677 #(ly:add-file-name-alist '(%s
1679 """ % '\n'.join(['("%s.ly" . "%s")\n' % (ly.basename (), name)
1682 def split_output_files(directory):
1683 """Returns directory entries in DIRECTORY/XX/ , where XX are hex digits.
1685 Return value is a set of strings.
1688 for subdir in glob.glob (os.path.join (directory, '[a-f0-9][a-f0-9]')):
1689 base_subdir = os.path.split (subdir)[1]
1690 sub_files = [os.path.join (base_subdir, name)
1691 for name in os.listdir (subdir)]
1695 def do_process_cmd (chunks, input_name, options):
1696 snippets = [c for c in chunks if isinstance (c, LilypondSnippet)]
1698 output_files = split_output_files (options.lily_output_dir)
1699 outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)]
1701 write_file_map (outdated, input_name)
1702 progress (_ ("Writing snippets..."))
1703 for snippet in outdated:
1708 progress (_ ("Processing..."))
1710 process_snippets (options.process_cmd, outdated,
1711 options.format, options.lily_output_dir)
1714 progress (_ ("All snippets are up to date..."))
1716 if options.lily_output_dir != options.output_dir:
1717 output_files = split_output_files (options.lily_output_dir)
1718 for snippet in snippets:
1719 snippet.link_all_output_files (options.lily_output_dir,
1727 # Format guessing data
1736 '.texinfo': TEXINFO,
1741 def guess_format (input_filename):
1743 e = os.path.splitext (input_filename)[1]
1746 format = ext2format[e]
1748 error (_ ("cannot determine format for: %s"
1753 def write_if_updated (file_name, lines):
1755 f = file (file_name)
1757 new_str = ''.join (lines)
1758 if oldstr == new_str:
1759 progress (_ ("%s is up to date.") % file_name)
1762 # this prevents make from always rerunning lilypond-book:
1763 # output file must be touched in order to be up to date
1764 os.utime (file_name, None)
1769 output_dir = os.path.dirname (file_name)
1770 if not os.path.exists (output_dir):
1771 os.makedirs (output_dir)
1773 progress (_ ("Writing `%s'...") % file_name)
1774 file (file_name, 'w').writelines (lines)
1778 def note_input_file (name, inputs=[]):
1779 ## hack: inputs is mutable!
1780 inputs.append (name)
1783 def samefile (f1, f2):
1785 return os.path.samefile (f1, f2)
1786 except AttributeError: # Windoze
1787 f1 = re.sub ("//*", "/", f1)
1788 f2 = re.sub ("//*", "/", f2)
1791 def do_file (input_filename, included=False):
1793 if not input_filename or input_filename == '-':
1794 in_handle = sys.stdin
1795 input_fullname = '<stdin>'
1797 if os.path.exists (input_filename):
1798 input_fullname = input_filename
1799 elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1800 input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1802 input_fullname = find_file (input_filename)
1804 note_input_file (input_fullname)
1805 in_handle = file (input_fullname)
1807 if input_filename == '-':
1808 input_base = 'stdin'
1810 input_base = os.path.splitext (input_filename)[0]
1812 input_base = os.path.basename (
1813 os.path.splitext (input_filename)[0])
1815 # don't complain when global_options.output_dir is existing
1816 if not global_options.output_dir:
1817 global_options.output_dir = os.getcwd()
1819 global_options.output_dir = os.path.abspath(global_options.output_dir)
1821 if not os.path.isdir (global_options.output_dir):
1822 os.mkdir (global_options.output_dir, 0777)
1823 os.chdir (global_options.output_dir)
1825 output_filename = os.path.join(global_options.output_dir,
1826 input_base + format2ext[global_options.format])
1827 if (os.path.exists (input_filename)
1828 and os.path.exists (output_filename)
1829 and samefile (output_filename, input_fullname)):
1831 _ ("Output would overwrite input file; use --output."))
1835 progress (_ ("Reading %s...") % input_fullname)
1836 source = in_handle.read ()
1839 set_default_options (source, default_ly_options, global_options.format)
1842 # FIXME: Containing blocks must be first, see
1843 # find_toplevel_snippets.
1845 'multiline_comment',
1849 'singleline_comment',
1854 progress (_ ("Dissecting..."))
1855 chunks = find_toplevel_snippets (source, global_options.format, snippet_types)
1857 if global_options.format == LATEX:
1859 if (c.is_plain () and
1860 re.search (r"\\begin *{document}", c.replacement_text())):
1865 if global_options.filter_cmd:
1866 write_if_updated (output_filename,
1867 [c.filter_text () for c in chunks])
1868 elif global_options.process_cmd:
1869 do_process_cmd (chunks, input_fullname, global_options)
1870 progress (_ ("Compiling %s...") % output_filename)
1872 write_if_updated (output_filename,
1873 [s.replacement_text ()
1876 def process_include (snippet):
1877 os.chdir (original_dir)
1878 name = snippet.substring ('filename')
1879 progress (_ ("Processing include: %s") % name)
1881 return do_file (name, included=True)
1883 include_chunks = map (process_include,
1884 filter (lambda x: isinstance (x, IncludeSnippet),
1887 return chunks + reduce (lambda x, y: x + y, include_chunks, [])
1889 except CompileError:
1890 os.chdir (original_dir)
1891 progress (_ ("Removing `%s'") % output_filename)
1896 global global_options
1898 opt_parser = get_option_parser()
1899 (global_options, args) = opt_parser.parse_args ()
1900 if global_options.format in ('texi-html', 'texi'):
1901 global_options.format = TEXINFO
1903 global_options.include_path = map (os.path.abspath, global_options.include_path)
1905 if global_options.warranty:
1908 if not args or len (args) > 1:
1909 opt_parser.print_help ()
1915 # FIXME: 85 lines of `main' macramee??
1916 files = do_options ()
1918 basename = os.path.splitext (files[0])[0]
1919 basename = os.path.split (basename)[1]
1921 if not global_options.format:
1922 global_options.format = guess_format (files[0])
1925 if global_options.format in (TEXINFO, HTML, DOCBOOK):
1928 if global_options.process_cmd == '':
1929 global_options.process_cmd = (lilypond_binary
1930 + ' --formats=%s -dbackend=eps ' % formats)
1932 if global_options.process_cmd:
1933 global_options.process_cmd += ' '.join ([(' -I %s' % ly.mkarg (p))
1934 for p in global_options.include_path])
1936 if global_options.format in (TEXINFO, LATEX):
1937 ## prevent PDF from being switched on by default.
1938 global_options.process_cmd += ' --formats=eps '
1939 if global_options.create_pdf:
1940 global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts "
1942 if global_options.verbose:
1943 global_options.process_cmd += " --verbose "
1945 if global_options.padding_mm:
1946 global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm
1948 global_options.process_cmd += " -dread-file-list -dno-strip-output-dir"
1950 if global_options.lily_output_dir:
1951 global_options.lily_output_dir = os.path.abspath(global_options.lily_output_dir)
1952 if not os.path.isdir (global_options.lily_output_dir):
1953 os.makedirs (global_options.lily_output_dir)
1955 global_options.lily_output_dir = os.path.abspath(global_options.output_dir)
1960 chunks = do_file (files[0])
1961 except CompileError:
1964 inputs = note_input_file ('')
1967 base_file_name = os.path.splitext (os.path.basename (files[0]))[0]
1968 dep_file = os.path.join (global_options.output_dir, base_file_name + '.dep')
1969 final_output_file = os.path.join (global_options.output_dir,
1971 + '.%s' % global_options.format)
1973 os.chdir (original_dir)
1974 file (dep_file, 'w').write ('%s: %s'
1975 % (final_output_file, ' '.join (inputs)))
1977 if __name__ == '__main__':