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
48 ly.require_python_version ()
51 program_version = '@TOPLEVEL_VERSION@'
52 program_name = os.path.basename (sys.argv[0])
54 # Check if program_version contains @ characters. This will be the case if
55 # the .py file is called directly while building the lilypond documentation.
56 # If so, try to check for the env var LILYPOND_VERSION, which is set by our
57 # makefiles and use its value.
58 at_re = re.compile (r'@')
59 if at_re.match (program_version):
60 if os.environ.has_key('LILYPOND_VERSION'):
61 program_version = os.environ['LILYPOND_VERSION']
63 program_version = "unknown"
65 original_dir = os.getcwd ()
69 _ ("Process LilyPond snippets in hybrid HTML, LaTeX, texinfo or DocBook document.")
73 $ lilypond-book --filter="tr '[a-z]' '[A-Z]'" %(BOOK)s
74 $ lilypond-book -F "convert-ly --no-version --from=2.0.0 -" %(BOOK)s
75 $ lilypond-book --process='lilypond -I include' %(BOOK)s
76 ''' % {'BOOK': _ ("BOOK")})
78 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
79 'Han-Wen Nienhuys <hanwen@xs4all.nl>')
81 ################################################################
83 if global_options.verbose:
84 raise Exception (_ ('Exiting (%d)...') % i)
89 ly.encoded_write (sys.stdout, '%s (GNU LilyPond) %s\n' % (program_name, program_version))
91 progress = ly.progress
94 ly.stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
97 ly.stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
99 def ps_page_count (ps_name):
100 header = file (ps_name).read (1024)
101 m = re.search ('\n%%Pages: ([0-9]+)', header)
103 return int (m.group (1))
108 ly.encoded_write (sys.stdout, '''
115 ''' % ( _ ('Copyright (c) %s by') % '2001--2009',
116 '\n '.join (authors),
117 _ ("Distributed under terms of the GNU General Public License."),
118 _ ("It comes with NO WARRANTY.")))
120 def get_option_parser ():
121 p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'lilypond-book',
122 description=help_summary,
123 add_help_option=False)
125 p.add_option ('-F', '--filter', metavar=_ ("FILTER"),
128 help=_ ("pipe snippets through FILTER [default: `convert-ly -n -']"),
131 p.add_option ('-f', '--format',
132 help=_ ("use output format FORMAT (texi [default], texi-html, latex, html, docbook)"),
133 metavar=_ ("FORMAT"),
136 p.add_option("-h", "--help",
138 help=_ ("show this help and exit"))
140 p.add_option ("-I", '--include', help=_ ("add DIR to include path"),
142 action='append', dest='include_path',
143 default=[os.path.abspath (os.getcwd ())])
145 p.add_option ('--info-images-dir',
146 help=_ ("format Texinfo output so that Info will "
147 "look for images of music in DIR"),
149 action='store', dest='info_images_dir',
152 p.add_option ('--latex-program',
153 help=_ ("run executable PROG instead of latex"),
155 action='store', dest='latex_program',
158 p.add_option ('--left-padding',
161 help=_ ("pad left side of music to align music inspite of uneven bar numbers (in mm)"),
165 p.add_option ("-o", '--output', help=_ ("write output to DIR"),
167 action='store', dest='output_dir',
170 p.add_option ('--skip-lily-check',
171 help=_ ("do not fail if no lilypond output is found"),
173 action='store_true', dest='skip_lilypond_run',
176 p.add_option ('--skip-png-check',
177 help=_ ("do not fail if no PNG images are found for EPS files"),
179 action='store_true', dest='skip_png_check',
182 p.add_option ('--lily-output-dir',
183 help=_ ("write lily-XXX files to DIR, link into --output dir"),
185 action='store', dest='lily_output_dir',
188 p.add_option ('-P', '--process', metavar=_ ("COMMAND"),
189 help = _ ("process ly_files using COMMAND FILE..."),
191 dest='process_cmd', default='')
193 p.add_option ('--pdf',
196 help=_ ("create PDF files for use with PDFTeX"),
199 p.add_option ('-V', '--verbose', help=_ ("be verbose"),
204 p.version = "@TOPLEVEL_VERSION@"
205 p.add_option("--version",
207 help=_ ("show version number and exit"))
209 p.add_option ('-w', '--warranty',
210 help=_ ("show warranty and copyright"),
212 p.add_option_group ('',
214 _ ("Report bugs via %s")
215 % ' http://post.gmane.org/post.php'
216 '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
219 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
221 # If we are called with full path, try to use lilypond binary
222 # installed in the same path; this is needed in GUB binaries, where
223 # @bindir is always different from the installed binary path.
224 if 'bindir' in globals () and bindir:
225 lilypond_binary = os.path.join (bindir, 'lilypond')
227 # Only use installed binary when we are installed too.
228 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
229 lilypond_binary = 'lilypond'
231 global_options = None
234 default_ly_options = { 'alt': "[image of music]" }
236 document_language = ''
239 # Is this pythonic? Personally, I find this rather #define-nesque. --hwn
241 ADDVERSION = 'addversion'
245 EXAMPLEINDENT = 'exampleindent'
247 FRAGMENT = 'fragment'
253 LINE_WIDTH = 'line-width'
254 LILYQUOTE = 'lilyquote'
255 NOFRAGMENT = 'nofragment'
256 NOGETTEXT = 'nogettext'
257 NOINDENT = 'noindent'
259 NORAGGED_RIGHT = 'noragged-right'
263 OUTPUTIMAGE = 'outputimage'
265 PREAMBLE = 'preamble'
266 PRINTFILENAME = 'printfilename'
268 RAGGED_RIGHT = 'ragged-right'
269 RELATIVE = 'relative'
270 STAFFSIZE = 'staffsize'
271 DOCTITLE = 'doctitle'
274 VERBATIM = 'verbatim'
275 VERSION = 'lilypondversion'
276 FONTLOAD = 'fontload'
277 FILENAME = 'filename'
281 # NOTIME has no opposite so it isn't part of this dictionary.
282 # NOQUOTE is used internally only.
284 NOFRAGMENT: FRAGMENT,
289 # Recognize special sequences in the input.
291 # (?P<name>regex) -- Assign result of REGEX to NAME.
292 # *? -- Match non-greedily.
293 # (?!...) -- Match if `...' doesn't match next (without consuming
296 # (?m) -- Multiline regex: Make ^ and $ match at each line.
297 # (?s) -- Make the dot match all characters including newline.
298 # (?x) -- Ignore whitespace in patterns.
309 <(?P<inline>(inline)?)mediaobject>\s*
311 <programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>
313 </programlisting\s*>\s*
315 </(inline)?mediaobject>)''',
320 <(?P<inline>(inline)?)mediaobject>\s*
322 <programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>
324 </programlisting\s*>\s*
326 </(inline)?mediaobject>)''',
331 <(?P<inline>(inline)?)mediaobject>\s*
334 fileref="(?P<filename>.*?\.ly)"\s*
335 (role="(?P<options>.*?)")?\s*
336 (/>|>\s*</imagedata>)\s*
338 </(inline)?mediaobject>)''',
344 (?P<code><!--\s.*?!-->)
347 'singleline_comment':
368 (\s*(?P<options>.*?)\s*:)?\s*
376 \s*(?P<options>.*?)\s*
385 \s*(?P<options>.*?)\s*
387 \s*(?P<filename>.*?)\s*
394 (?P<code><!--\s.*?!-->)
397 'singleline_comment':
403 (?P<code><pre>.*?</pre>))''',
409 (?P<code><pre>\s.*?</pre>\s))''',
414 <lilypondversion\s*/>)''',
433 \s*(?P<options>.*?)\s*
444 \s*(?P<options>.*?)\s*
448 \\end\s*{lilypond})''',
456 \s*(?P<options>.*?)\s*
464 'singleline_comment':
487 \\end\s*{verbatim}))''',
492 \\lilypondversion)[^a-zA-Z]''',
502 (?P<filename>\S+))''',
506 ^[^\n]*?(?!@c\s+)[^\n]*?
510 \s*(?P<options>.*?)\s*
520 \s*(?P<options>.*?)\s*
523 ^@end\s+lilypond)\s''',
530 \s*(?P<options>.*?)\s*
541 @end\s+ignore))\s''',
543 'singleline_comment':
548 @c([ \t][^\n]*|)\n))''',
550 # Don't do this: It interferes with @code{@{}.
551 # 'verb': r'''(?P<code>@code{.*?})''',
559 @end\s+example\s))''',
564 @lilypondversion)[^a-zA-Z]''',
572 'intertext': r',?\s*intertext=\".*?\"',
576 'intertext': r',?\s*intertext=\".*?\"',
581 'intertext': r',?\s*intertext=\".*?\"',
582 'option_sep': '\s*,\s*',
586 'intertext': r',?\s*intertext=\".*?\"',
587 'option_sep': '\s*,\s*',
592 # Options without a pattern in ly_options.
613 RELATIVE: r'''\relative c%(relative_quotes)s''',
618 INDENT: r'''indent = %(indent)s''',
620 LINE_WIDTH: r'''line-width = %(line-width)s''',
622 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
624 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
626 RAGGED_RIGHT: r'''ragged-right = ##t''',
628 NORAGGED_RIGHT: r'''ragged-right = ##f''',
640 \remove "Time_signature_engraver"
646 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
653 FILTER: r'''<mediaobject>
655 <programlisting language="lilypond"
662 OUTPUT: r'''<imageobject role="latex">
663 <imagedata fileref="%(base)s.pdf" format="PDF"/>
665 <imageobject role="html">
666 <imagedata fileref="%(base)s.png" format="PNG"/>
669 VERBATIM: r'''<programlisting>
670 %(verb)s</programlisting>''',
672 VERSION: program_version,
674 PRINTFILENAME: r'''<textobject>
676 <ulink url="%(base)s.ly">
686 FILTER: r'''<lilypond %(options)s>
696 <a href="%(base)s.ly">''',
704 PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
706 QUOTE: r'''<blockquote>
714 VERSION: program_version,
721 \ifx\preLilyPondExample \undefined
723 \expandafter\preLilyPondExample
725 \def\lilypondbook{}%%
726 \input %(base)s-systems.tex
727 \ifx\postLilyPondExample \undefined
729 \expandafter\postLilyPondExample
733 PRINTFILENAME: '''\\texttt{%(filename)s}
736 QUOTE: r'''\begin{quotation}
740 VERBATIM: r'''\noindent
741 \begin{verbatim}%(verb)s\end{verbatim}
744 VERSION: program_version,
746 FILTER: r'''\begin{lilypond}[%(options)s]
753 FILTER: r'''@lilypond[%(options)s]
759 @include %(base)s-systems.texi
763 OUTPUTIMAGE: r'''@noindent
765 @image{%(info_image_path)s,,,%(alt)s,%(ext)s}
769 <a href="%(base)s.ly">
781 <a href="%(base)s.ly">
789 QUOTE: r'''@quotation
790 %(str)s@end quotation
797 VERBATIM: r'''@exampleindent 0
799 %(verb)s@end verbatim
802 VERSION: program_version,
804 ADDVERSION: r'''@example
805 \version @w{"@version{}"}
812 # Maintain line numbers.
817 for f in [HTML, LATEX]:
818 for s in (QUOTE, VERBATIM):
819 output[f][s] = output[f][s].replace("\n"," ")
822 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
823 %%%% Options: [%(option_string)s]
824 \\include "lilypond-book-preamble.ly"
827 %% ****************************************************************
828 %% Start cut-&-pastable-section
829 %% ****************************************************************
834 #(define dump-extents #t)
835 %(font_dump_setting)s
837 force-assignment = #""
838 line-width = #(- line-width (* mm %(padding_mm)f))
851 %% ****************************************************************
852 %% ly snippet contents follows:
853 %% ****************************************************************
857 %% ****************************************************************
859 %% ****************************************************************
866 %% ****************************************************************
868 %% ****************************************************************
872 %% ****************************************************************
874 %% ****************************************************************
877 texinfo_line_widths = {
878 '@afourpaper': '160\\mm',
879 '@afourwide': '6.5\\in',
880 '@afourlatex': '150\\mm',
881 '@smallbook': '5\\in',
882 '@letterpaper': '6\\in',
885 def classic_lilypond_book_compatibility (key, value):
886 if key == 'singleline' and value == None:
887 return (RAGGED_RIGHT, None)
889 m = re.search ('relative\s*([-0-9])', key)
891 return ('relative', m.group (1))
893 m = re.match ('([0-9]+)pt', key)
895 return ('staffsize', m.group (1))
897 if key == 'indent' or key == 'line-width':
898 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
900 f = float (m.group (1))
901 return (key, '%f\\%s' % (f, m.group (2)))
905 def find_file (name, raise_error=True):
906 for i in global_options.include_path:
907 full = os.path.join (i, name)
908 if os.path.exists (full):
912 error (_ ("file not found: %s") % name + '\n')
916 def verbatim_html (s):
917 return re.sub ('>', '>',
919 re.sub ('&', '&', s)))
921 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
922 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
923 ly_context_id_re = re.compile ('\\\\(?:new|context)\\s+(?:[a-zA-Z]*?(?:Staff\
924 (?:Group)?|Voice|FiguredBass|FretBoards|Names|Devnull))\\s+=\\s+"?([a-zA-Z]+)"?\\s+')
926 def ly_comment_gettext (t, m):
927 return m.group (1) + t (m.group (2))
929 def verb_ly_gettext (s):
930 if not document_language:
933 t = langdefs.translation[document_language]
937 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
939 if langdefs.LANGDICT[document_language].enable_ly_identifier_l10n:
940 for v in ly_var_def_re.findall (s):
941 s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v,
942 "\\1" + t (v) + "\\2",
944 for id in ly_context_id_re.findall (s):
945 s = re.sub (r'(\s+|")%s(\s+|")' % id,
946 "\\1" + t (id) + "\\2",
950 texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)')
951 def set_default_options (source, default_ly_options, format):
952 global document_language
953 if LINE_WIDTH not in default_ly_options:
955 textwidth = get_latex_textwidth (source)
956 default_ly_options[LINE_WIDTH] = '%.0f\\pt' % textwidth
957 elif format == TEXINFO:
958 m = texinfo_lang_re.search (source)
959 if m and not m.group (1).startswith ('en'):
960 document_language = m.group (1)
962 document_language = ''
963 for regex in texinfo_line_widths:
964 # FIXME: @layout is usually not in
967 # \input texinfo @c -*-texinfo-*-
969 # Bluntly search first K items of
971 # s = chunks[0].replacement_text ()
972 if re.search (regex, source[:1024]):
973 default_ly_options[LINE_WIDTH] = texinfo_line_widths[regex]
977 def replacement_text (self):
980 def filter_text (self):
981 return self.replacement_text ()
986 class Substring (Chunk):
987 """A string that does not require extra memory."""
988 def __init__ (self, source, start, end, line_number):
992 self.line_number = line_number
993 self.override_text = None
998 def replacement_text (self):
999 if self.override_text:
1000 return self.override_text
1002 return self.source[self.start:self.end]
1004 class Snippet (Chunk):
1005 def __init__ (self, type, match, format, line_number):
1009 self.option_dict = {}
1010 self.format = format
1011 self.line_number = line_number
1013 def replacement_text (self):
1014 return self.match.group ('match')
1016 def substring (self, s):
1017 return self.match.group (s)
1019 def __repr__ (self):
1020 return `self.__class__` + ' type = ' + self.type
1022 class IncludeSnippet (Snippet):
1023 def processed_filename (self):
1024 f = self.substring ('filename')
1025 return os.path.splitext (f)[0] + format2ext[self.format]
1027 def replacement_text (self):
1028 s = self.match.group ('match')
1029 f = self.substring ('filename')
1031 return re.sub (f, self.processed_filename (), s)
1033 class LilypondSnippet (Snippet):
1034 def __init__ (self, type, match, format, line_number):
1035 Snippet.__init__ (self, type, match, format, line_number)
1036 os = match.group ('options')
1037 self.do_options (os, self.type)
1040 if NOGETTEXT in self.option_dict:
1041 return self.substring ('code')
1043 return verb_ly_gettext (self.substring ('code'))
1046 contents = self.substring ('code')
1047 return ('\\sourcefileline %d\n%s'
1048 % (self.line_number - 1, contents))
1053 return self.compose_ly (s)
1056 def split_options (self, option_string):
1058 if self.format == HTML:
1059 options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',
1061 options = [re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)', '\g<1>\g<3>', opt)
1065 return re.split (format_res[self.format]['option_sep'],
1069 def do_options (self, option_string, type):
1070 self.option_dict = {}
1072 options = self.split_options (option_string)
1074 for option in options:
1076 (key, value) = re.split ('\s*=\s*', option)
1077 self.option_dict[key] = value
1079 if option in no_options:
1080 if no_options[option] in self.option_dict:
1081 del self.option_dict[no_options[option]]
1083 self.option_dict[option] = None
1085 has_line_width = self.option_dict.has_key (LINE_WIDTH)
1086 no_line_width_value = 0
1088 # If LINE_WIDTH is used without parameter, set it to default.
1089 if has_line_width and self.option_dict[LINE_WIDTH] == None:
1090 no_line_width_value = 1
1091 del self.option_dict[LINE_WIDTH]
1093 for k in default_ly_options:
1094 if k not in self.option_dict:
1095 self.option_dict[k] = default_ly_options[k]
1097 # RELATIVE does not work without FRAGMENT;
1098 # make RELATIVE imply FRAGMENT
1099 has_relative = self.option_dict.has_key (RELATIVE)
1100 if has_relative and not self.option_dict.has_key (FRAGMENT):
1101 self.option_dict[FRAGMENT] = None
1103 if not has_line_width:
1104 if type == 'lilypond' or FRAGMENT in self.option_dict:
1105 self.option_dict[RAGGED_RIGHT] = None
1107 if type == 'lilypond':
1108 if LINE_WIDTH in self.option_dict:
1109 del self.option_dict[LINE_WIDTH]
1111 if RAGGED_RIGHT in self.option_dict:
1112 if LINE_WIDTH in self.option_dict:
1113 del self.option_dict[LINE_WIDTH]
1115 if QUOTE in self.option_dict or type == 'lilypond':
1116 if LINE_WIDTH in self.option_dict:
1117 del self.option_dict[LINE_WIDTH]
1119 if not INDENT in self.option_dict:
1120 self.option_dict[INDENT] = '0\\mm'
1122 # The QUOTE pattern from ly_options only emits the `line-width'
1124 if has_line_width and QUOTE in self.option_dict:
1125 if no_line_width_value:
1126 del self.option_dict[LINE_WIDTH]
1128 del self.option_dict[QUOTE]
1130 def compose_ly (self, code):
1131 if FRAGMENT in self.option_dict:
1139 # The original concept of the `exampleindent' option is broken.
1140 # It is not possible to get a sane value for @exampleindent at all
1141 # without processing the document itself. Saying
1149 # causes ugly results with the DVI backend of texinfo since the
1150 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
1151 # value). Executing the above code changes the environment
1152 # indentation to an unknown value because we don't know the amount
1153 # of 1em in advance since it is font-dependent. Modifying
1154 # @exampleindent in the middle of a document is simply not
1155 # supported within texinfo.
1157 # As a consequence, the only function of @exampleindent is now to
1158 # specify the amount of indentation for the `quote' option.
1160 # To set @exampleindent locally to zero, we use the @format
1161 # environment for non-quoted snippets.
1162 override[EXAMPLEINDENT] = r'0.4\in'
1163 override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
1164 override.update (default_ly_options)
1167 for (key, value) in self.option_dict.items ():
1169 option_list.append (key)
1171 option_list.append (key + '=' + value)
1172 option_string = ','.join (option_list)
1175 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
1176 for a in compose_types:
1177 compose_dict[a] = []
1179 for (key, value) in self.option_dict.items ():
1180 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
1184 _ ("deprecated ly-option used: %s=%s") % (key, value))
1186 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
1189 _ ("deprecated ly-option used: %s") % key)
1191 _ ("compatibility mode translation: %s") % c_key)
1193 (key, value) = (c_key, c_value)
1196 override[key] = value
1198 if not override.has_key (key):
1199 override[key] = None
1202 for type in compose_types:
1203 if ly_options[type].has_key (key):
1204 compose_dict[type].append (ly_options[type][key])
1208 if not found and key not in simple_options:
1209 warning (_ ("ignoring unknown ly option: %s") % key)
1212 if RELATIVE in override and override[RELATIVE]:
1213 relative = int (override[RELATIVE])
1215 relative_quotes = ''
1219 relative_quotes += ',' * (- relative)
1221 relative_quotes += "'" * relative
1223 paper_string = '\n '.join (compose_dict[PAPER]) % override
1224 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
1225 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
1226 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
1227 padding_mm = global_options.padding_mm
1228 font_dump_setting = ''
1229 if FONTLOAD in self.option_dict:
1230 font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1232 d = globals().copy()
1234 return (PREAMBLE_LY + body) % d
1236 def get_checksum (self):
1237 if not self.checksum:
1238 hash = md5.md5 (self.relevant_contents (self.full_ly ()))
1240 ## let's not create too long names.
1241 self.checksum = hash.hexdigest ()[:10]
1243 return self.checksum
1245 def basename (self):
1246 cs = self.get_checksum ()
1247 name = '%s/lily-%s' % (cs[:2], cs[2:10])
1250 def write_ly (self):
1251 base = self.basename ()
1252 path = os.path.join (global_options.lily_output_dir, base)
1253 directory = os.path.split(path)[0]
1254 if not os.path.isdir (directory):
1255 os.makedirs (directory)
1256 out = file (path + '.ly', 'w')
1257 out.write (self.full_ly ())
1258 file (path + '.txt', 'w').write ('image of music')
1260 def relevant_contents (self, ly):
1261 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n|' +
1262 NOGETTEXT + '[,\]]', '', ly)
1264 def link_all_output_files (self, output_dir, output_dir_files, destination):
1265 existing, missing = self.all_output_files (output_dir, output_dir_files)
1267 print '\nMissing', missing
1268 raise CompileError(self.basename())
1269 for name in existing:
1271 os.unlink (os.path.join (destination, name))
1275 src = os.path.join (output_dir, name)
1276 dst = os.path.join (destination, name)
1277 dst_path = os.path.split(dst)[0]
1278 if not os.path.isdir (dst_path):
1279 os.makedirs (dst_path)
1283 def all_output_files (self, output_dir, output_dir_files):
1284 """Return all files generated in lily_output_dir, a set.
1286 output_dir_files is the list of files in the output directory.
1290 base = self.basename()
1291 full = os.path.join (output_dir, base)
1292 def consider_file (name):
1293 if name in output_dir_files:
1296 def require_file (name):
1297 if name in output_dir_files:
1302 # UGH - junk global_options
1303 skip_lily = global_options.skip_lilypond_run
1304 for required in [base + '.ly',
1306 require_file (required)
1308 require_file (base + '-systems.count')
1310 if 'ddump-profile' in global_options.process_cmd:
1311 require_file (base + '.profile')
1312 if 'dseparate-log-file' in global_options.process_cmd:
1313 require_file (base + '.log')
1315 map (consider_file, [base + '.tex',
1319 base + '-systems.texi',
1320 base + '-systems.tex',
1321 base + '-systems.pdftexi'])
1322 if document_language:
1324 [base + '.texidoc' + document_language,
1325 base + '.doctitle' + document_language])
1327 # UGH - junk global_options
1328 if (base + '.eps' in result and self.format in (HTML, TEXINFO)
1329 and not global_options.skip_png_check):
1330 page_count = ps_page_count (full + '.eps')
1332 require_file (base + '.png')
1334 for page in range (1, page_count + 1):
1335 require_file (base + '-page%d.png' % page)
1338 if not skip_lily and not missing:
1339 system_count = int(file (full + '-systems.count').read())
1341 for number in range(1, system_count + 1):
1342 systemfile = '%s-%d' % (base, number)
1343 require_file (systemfile + '.eps')
1344 consider_file (systemfile + '.pdf')
1346 # We can't require signatures, since books and toplevel
1347 # markups do not output a signature.
1348 if 'ddump-signature' in global_options.process_cmd:
1349 consider_file (systemfile + '.signature')
1352 return (result, missing)
1354 def is_outdated (self, output_dir, current_files):
1355 found, missing = self.all_output_files (output_dir, current_files)
1358 def filter_text (self):
1359 """Run snippet bodies through a command (say: convert-ly).
1361 This functionality is rarely used, and this code must have bitrot.
1363 code = self.substring ('code')
1364 s = filter_pipe (code, global_options.filter_cmd)
1367 'options': self.match.group ('options')
1370 return output[self.format][FILTER] % d
1372 def replacement_text (self):
1373 func = LilypondSnippet.__dict__['output_' + self.format]
1376 def get_images (self):
1377 base = self.basename ()
1379 single = '%(base)s.png' % vars ()
1380 multiple = '%(base)s-page1.png' % vars ()
1382 if (os.path.exists (multiple)
1383 and (not os.path.exists (single)
1384 or (os.stat (multiple)[stat.ST_MTIME]
1385 > os.stat (single)[stat.ST_MTIME]))):
1386 count = ps_page_count ('%(base)s.eps' % vars ())
1387 images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)]
1388 images = tuple (images)
1392 def output_docbook (self):
1394 base = self.basename ()
1395 for image in self.get_images ():
1396 (base, ext) = os.path.splitext (image)
1397 str += output[DOCBOOK][OUTPUT] % vars ()
1398 str += self.output_print_filename (DOCBOOK)
1399 if (self.substring('inline') == 'inline'):
1400 str = '<inlinemediaobject>' + str + '</inlinemediaobject>'
1402 str = '<mediaobject>' + str + '</mediaobject>'
1403 if VERBATIM in self.option_dict:
1404 verb = verbatim_html (self.verb_ly ())
1405 str = output[DOCBOOK][VERBATIM] % vars () + str
1408 def output_html (self):
1410 base = self.basename ()
1411 if self.format == HTML:
1412 str += self.output_print_filename (HTML)
1413 if VERBATIM in self.option_dict:
1414 verb = verbatim_html (self.verb_ly ())
1415 str += output[HTML][VERBATIM] % vars ()
1416 if QUOTE in self.option_dict:
1417 str = output[HTML][QUOTE] % vars ()
1419 str += output[HTML][BEFORE] % vars ()
1420 for image in self.get_images ():
1421 (base, ext) = os.path.splitext (image)
1422 alt = self.option_dict[ALT]
1423 str += output[HTML][OUTPUT] % vars ()
1424 str += output[HTML][AFTER] % vars ()
1427 def output_info (self):
1429 for image in self.get_images ():
1430 (base, ext) = os.path.splitext (image)
1432 # URG, makeinfo implicitly prepends dot to extension.
1433 # Specifying no extension is most robust.
1435 alt = self.option_dict[ALT]
1436 info_image_path = os.path.join (global_options.info_images_dir, base)
1437 str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1439 base = self.basename ()
1440 str += output[self.format][OUTPUT] % vars ()
1443 def output_latex (self):
1445 base = self.basename ()
1446 if self.format == LATEX:
1447 str += self.output_print_filename (LATEX)
1448 if VERBATIM in self.option_dict:
1449 verb = self.verb_ly ()
1450 str += (output[LATEX][VERBATIM] % vars ())
1452 str += (output[LATEX][OUTPUT] % vars ())
1454 ## todo: maintain breaks
1456 breaks = self.ly ().count ("\n")
1457 str += "".ljust (breaks, "\n").replace ("\n","%\n")
1459 if QUOTE in self.option_dict:
1460 str = output[LATEX][QUOTE] % vars ()
1463 def output_print_filename (self, format):
1465 if PRINTFILENAME in self.option_dict:
1466 base = self.basename ()
1467 filename = os.path.basename (self.substring ('filename'))
1468 str = output[format][PRINTFILENAME] % vars ()
1472 def output_texinfo (self):
1473 str = self.output_print_filename (TEXINFO)
1474 base = self.basename ()
1475 if DOCTITLE in self.option_dict:
1476 doctitle = base + '.doctitle'
1477 translated_doctitle = doctitle + document_language
1478 if os.path.exists (translated_doctitle):
1479 str += '@lydoctitle %s\n\n' % open (translated_doctitle).read ()
1480 elif os.path.exists (doctitle):
1481 str += '@lydoctitle %s\n\n' % open (doctitle).read ()
1482 if TEXIDOC in self.option_dict:
1483 texidoc = base + '.texidoc'
1484 translated_texidoc = texidoc + document_language
1485 if os.path.exists (translated_texidoc):
1486 str += '@include %(translated_texidoc)s\n\n' % vars ()
1487 elif os.path.exists (texidoc):
1488 str += '@include %(texidoc)s\n\n' % vars ()
1491 if VERBATIM in self.option_dict:
1493 if ADDVERSION in self.option_dict:
1494 version = output[TEXINFO][ADDVERSION]
1495 verb = self.verb_ly ()
1496 substr = output[TEXINFO][VERBATIM] % vars ()
1497 substr += self.output_info ()
1498 if LILYQUOTE in self.option_dict:
1499 substr = output[TEXINFO][QUOTE] % {'str':substr}
1502 # str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1503 # str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1504 # str += ('@html\n' + self.output_html () + '\n@end html\n')
1506 if QUOTE in self.option_dict:
1507 str = output[TEXINFO][QUOTE] % vars ()
1509 # need par after image
1514 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
1515 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
1517 class LilypondFileSnippet (LilypondSnippet):
1518 def __init__ (self, type, match, format, line_number):
1519 LilypondSnippet.__init__ (self, type, match, format, line_number)
1520 self.contents = file (find_file (self.substring ('filename'))).read ()
1524 s = re_begin_verbatim.split (s)[-1]
1525 s = re_end_verbatim.split (s)[0]
1526 return verb_ly_gettext (s)
1529 name = self.substring ('filename')
1530 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
1531 % (name, self.contents))
1534 class LilyPondVersionString (Snippet):
1535 """A string that does not require extra memory."""
1536 def __init__ (self, type, match, format, line_number):
1537 Snippet.__init__ (self, type, match, format, line_number)
1539 def replacement_text (self):
1540 return output[self.format][self.type]
1543 snippet_type_to_class = {
1544 'lilypond_file': LilypondFileSnippet,
1545 'lilypond_block': LilypondSnippet,
1546 'lilypond': LilypondSnippet,
1547 'include': IncludeSnippet,
1548 'lilypondversion': LilyPondVersionString,
1551 def find_linestarts (s):
1556 i = s.find ('\n', start)
1564 nls.append (len (s))
1567 def find_toplevel_snippets (input_string, format, types):
1570 res[t] = re.compile (snippet_res[format][t])
1574 found = dict ([(t, None) for t in types])
1576 line_starts = find_linestarts (input_string)
1578 # We want to search for multiple regexes, without searching
1579 # the string multiple times for one regex.
1580 # Hence, we use earlier results to limit the string portion
1582 # Since every part of the string is traversed at most once for
1583 # every type of snippet, this is linear.
1589 if not found[type] or found[type][0] < index:
1592 m = res[type].search (input_string[index:endex])
1597 if type in snippet_type_to_class:
1598 klass = snippet_type_to_class[type]
1600 start = index + m.start ('match')
1601 line_number = line_start_idx
1602 while (line_starts[line_number] < start):
1606 snip = klass (type, m, format, line_number)
1608 found[type] = (start, snip)
1612 or found[type][0] < found[first][0])):
1617 # Limiting the search space is a cute
1618 # idea, but this *requires* to search
1619 # for possible containing blocks
1620 # first, at least as long as we do not
1621 # search for the start of blocks, but
1622 # always/directly for the entire
1623 # @block ... @end block.
1625 endex = found[first][0]
1628 snippets.append (Substring (input_string, index, len (input_string), line_start_idx))
1631 while (start > line_starts[line_start_idx+1]):
1634 (start, snip) = found[first]
1635 snippets.append (Substring (input_string, index, start, line_start_idx + 1))
1636 snippets.append (snip)
1638 index = start + len (snip.match.group ('match'))
1642 def filter_pipe (input, cmd):
1643 """Pass input through cmd, and return the result."""
1645 if global_options.verbose:
1646 progress (_ ("Opening filter `%s'") % cmd)
1648 (stdin, stdout, stderr) = os.popen3 (cmd)
1650 status = stdin.close ()
1654 output = stdout.read ()
1655 status = stdout.close ()
1656 error = stderr.read ()
1660 signal = 0x0f & status
1661 if status or (not output and error):
1662 exit_status = status >> 8
1663 error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1664 error (_ ("The error log is as follows:"))
1665 ly.stderr_write (error)
1666 ly.stderr_write (stderr.read ())
1669 if global_options.verbose:
1674 def system_in_directory (cmd, directory):
1675 """Execute a command in a different directory.
1677 Because of win32 compatibility, we can't simply use subprocess.
1680 current = os.getcwd()
1681 os.chdir (directory)
1682 ly.system(cmd, be_verbose=global_options.verbose,
1687 def process_snippets (cmd, snippets,
1688 format, lily_output_dir):
1689 """Run cmd on all of the .ly files from snippets."""
1694 if format in (HTML, TEXINFO) and '--formats' not in cmd:
1695 cmd += ' --formats=png '
1696 elif format in (DOCBOOK) and '--formats' not in cmd:
1697 cmd += ' --formats=png,pdf '
1699 checksum = snippet_list_checksum (snippets)
1700 contents = '\n'.join (['snippet-map-%d.ly' % checksum]
1701 + [snip.basename() + '.ly' for snip in snippets])
1702 name = os.path.join (lily_output_dir,
1703 'snippet-names-%d.ly' % checksum)
1704 file (name, 'wb').write (contents)
1706 system_in_directory (' '.join ([cmd, ly.mkarg (name)]),
1711 # Retrieve dimensions from LaTeX
1712 LATEX_INSPECTION_DOCUMENT = r'''
1716 \typeout{textwidth=\the\textwidth}
1717 \typeout{columnsep=\the\columnsep}
1718 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1722 # Do we need anything else besides `textwidth'?
1723 def get_latex_textwidth (source):
1724 m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1726 warning (_ ("cannot find \\begin{document} in LaTeX document"))
1728 ## what's a sensible default?
1731 preamble = source[:m.start (0)]
1732 latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1734 (handle, tmpfile) = tempfile.mkstemp('.tex')
1735 logfile = os.path.splitext (tmpfile)[0] + '.log'
1736 logfile = os.path.split (logfile)[1]
1738 tmp_handle = os.fdopen (handle,'w')
1739 tmp_handle.write (latex_document)
1742 ly.system ('%s %s' % (global_options.latex_program, tmpfile),
1743 be_verbose=global_options.verbose)
1744 parameter_string = file (logfile).read()
1750 m = re.search ('columns=([0-9.]*)', parameter_string)
1752 columns = int (m.group (1))
1755 m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1757 columnsep = float (m.group (1))
1760 m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1762 textwidth = float (m.group (1))
1764 textwidth = (textwidth - columnsep) / columns
1768 def modify_preamble (chunk):
1769 str = chunk.replacement_text ()
1770 if (re.search (r"\\begin *{document}", str)
1771 and not re.search ("{graphic[sx]", str)):
1772 str = re.sub (r"\\begin{document}",
1773 r"\\usepackage{graphics}" + '\n'
1774 + r"\\begin{document}",
1776 chunk.override_text = str
1781 # TEXINFO: '.texinfo',
1787 class CompileError(Exception):
1790 def snippet_list_checksum (snippets):
1791 return hash (' '.join([l.basename() for l in snippets]))
1793 def write_file_map (lys, name):
1794 snippet_map = file (os.path.join (
1795 global_options.lily_output_dir,
1796 'snippet-map-%d.ly' % snippet_list_checksum (lys)), 'w')
1798 snippet_map.write ("""
1799 #(define version-seen #t)
1800 #(define output-empty-score-list #f)
1801 #(ly:add-file-name-alist '(%s
1803 """ % '\n'.join(['("%s.ly" . "%s")\n' % (ly.basename (), name)
1806 def split_output_files(directory):
1807 """Returns directory entries in DIRECTORY/XX/ , where XX are hex digits.
1809 Return value is a set of strings.
1812 for subdir in glob.glob (os.path.join (directory, '[a-f0-9][a-f0-9]')):
1813 base_subdir = os.path.split (subdir)[1]
1814 sub_files = [os.path.join (base_subdir, name)
1815 for name in os.listdir (subdir)]
1819 def do_process_cmd (chunks, input_name, options):
1820 snippets = [c for c in chunks if isinstance (c, LilypondSnippet)]
1822 output_files = split_output_files (options.lily_output_dir)
1823 outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)]
1825 write_file_map (outdated, input_name)
1826 progress (_ ("Writing snippets..."))
1827 for snippet in outdated:
1832 progress (_ ("Processing..."))
1834 process_snippets (options.process_cmd, outdated,
1835 options.format, options.lily_output_dir)
1838 progress (_ ("All snippets are up to date..."))
1840 if options.lily_output_dir != options.output_dir:
1841 output_files = split_output_files (options.lily_output_dir)
1842 for snippet in snippets:
1843 snippet.link_all_output_files (options.lily_output_dir,
1851 # Format guessing data
1860 '.texinfo': TEXINFO,
1865 def guess_format (input_filename):
1867 e = os.path.splitext (input_filename)[1]
1870 format = ext2format[e]
1872 error (_ ("cannot determine format for: %s"
1877 def write_if_updated (file_name, lines):
1879 f = file (file_name)
1881 new_str = ''.join (lines)
1882 if oldstr == new_str:
1883 progress (_ ("%s is up to date.") % file_name)
1886 # this prevents make from always rerunning lilypond-book:
1887 # output file must be touched in order to be up to date
1888 os.utime (file_name, None)
1893 output_dir = os.path.dirname (file_name)
1894 if not os.path.exists (output_dir):
1895 os.makedirs (output_dir)
1897 progress (_ ("Writing `%s'...") % file_name)
1898 file (file_name, 'w').writelines (lines)
1902 def note_input_file (name, inputs=[]):
1903 ## hack: inputs is mutable!
1904 inputs.append (name)
1907 def samefile (f1, f2):
1909 return os.path.samefile (f1, f2)
1910 except AttributeError: # Windoze
1911 f1 = re.sub ("//*", "/", f1)
1912 f2 = re.sub ("//*", "/", f2)
1915 def do_file (input_filename, included=False):
1917 if not input_filename or input_filename == '-':
1918 in_handle = sys.stdin
1919 input_fullname = '<stdin>'
1921 if os.path.exists (input_filename):
1922 input_fullname = input_filename
1923 elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1924 input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1926 input_fullname = find_file (input_filename)
1928 note_input_file (input_fullname)
1929 in_handle = file (input_fullname)
1931 if input_filename == '-':
1932 input_base = 'stdin'
1934 input_base = os.path.splitext (input_filename)[0]
1936 input_base = os.path.basename (
1937 os.path.splitext (input_filename)[0])
1939 # don't complain when global_options.output_dir is existing
1940 if not global_options.output_dir:
1941 global_options.output_dir = os.getcwd()
1943 global_options.output_dir = os.path.abspath(global_options.output_dir)
1945 if not os.path.isdir (global_options.output_dir):
1946 os.mkdir (global_options.output_dir, 0777)
1947 os.chdir (global_options.output_dir)
1949 output_filename = os.path.join(global_options.output_dir,
1950 input_base + format2ext[global_options.format])
1951 if (os.path.exists (input_filename)
1952 and os.path.exists (output_filename)
1953 and samefile (output_filename, input_fullname)):
1955 _ ("Output would overwrite input file; use --output."))
1959 progress (_ ("Reading %s...") % input_fullname)
1960 source = in_handle.read ()
1963 set_default_options (source, default_ly_options, global_options.format)
1966 # FIXME: Containing blocks must be first, see
1967 # find_toplevel_snippets.
1969 'multiline_comment',
1973 'singleline_comment',
1979 progress (_ ("Dissecting..."))
1980 chunks = find_toplevel_snippets (source, global_options.format, snippet_types)
1982 if global_options.format == LATEX:
1984 if (c.is_plain () and
1985 re.search (r"\\begin *{document}", c.replacement_text())):
1990 if global_options.filter_cmd:
1991 write_if_updated (output_filename,
1992 [c.filter_text () for c in chunks])
1993 elif global_options.process_cmd:
1994 do_process_cmd (chunks, input_fullname, global_options)
1995 progress (_ ("Compiling %s...") % output_filename)
1997 write_if_updated (output_filename,
1998 [s.replacement_text ()
2001 def process_include (snippet):
2002 os.chdir (original_dir)
2003 name = snippet.substring ('filename')
2004 progress (_ ("Processing include: %s") % name)
2006 return do_file (name, included=True)
2008 include_chunks = map (process_include,
2009 filter (lambda x: isinstance (x, IncludeSnippet),
2012 return chunks + reduce (lambda x, y: x + y, include_chunks, [])
2014 except CompileError:
2015 os.chdir (original_dir)
2016 progress (_ ("Removing `%s'") % output_filename)
2021 global global_options
2023 opt_parser = get_option_parser()
2024 (global_options, args) = opt_parser.parse_args ()
2025 if global_options.format in ('texi-html', 'texi'):
2026 global_options.format = TEXINFO
2028 global_options.include_path = map (os.path.abspath, global_options.include_path)
2030 if global_options.warranty:
2033 if not args or len (args) > 1:
2034 opt_parser.print_help ()
2040 # FIXME: 85 lines of `main' macramee??
2041 files = do_options ()
2043 basename = os.path.splitext (files[0])[0]
2044 basename = os.path.split (basename)[1]
2046 if not global_options.format:
2047 global_options.format = guess_format (files[0])
2050 if global_options.format in (TEXINFO, HTML, DOCBOOK):
2053 if global_options.process_cmd == '':
2054 global_options.process_cmd = (lilypond_binary
2055 + ' --formats=%s -dbackend=eps ' % formats)
2057 if global_options.process_cmd:
2058 includes = global_options.include_path
2059 if global_options.lily_output_dir:
2060 # This must be first, so lilypond prefers to read .ly
2061 # files in the other lybookdb dir.
2062 includes = [os.path.abspath(global_options.lily_output_dir)] + includes
2063 global_options.process_cmd += ' '.join ([' -I %s' % ly.mkarg (p)
2066 if global_options.format in (TEXINFO, LATEX):
2067 ## prevent PDF from being switched on by default.
2068 global_options.process_cmd += ' --formats=eps '
2069 if global_options.create_pdf:
2070 global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts "
2072 if global_options.verbose:
2073 global_options.process_cmd += " --verbose "
2075 if global_options.padding_mm:
2076 global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm
2078 global_options.process_cmd += " -dread-file-list -dno-strip-output-dir"
2080 if global_options.lily_output_dir:
2081 global_options.lily_output_dir = os.path.abspath(global_options.lily_output_dir)
2082 if not os.path.isdir (global_options.lily_output_dir):
2083 os.makedirs (global_options.lily_output_dir)
2085 global_options.lily_output_dir = os.path.abspath(global_options.output_dir)
2090 chunks = do_file (files[0])
2091 except CompileError:
2094 inputs = note_input_file ('')
2097 base_file_name = os.path.splitext (os.path.basename (files[0]))[0]
2098 dep_file = os.path.join (global_options.output_dir, base_file_name + '.dep')
2099 final_output_file = os.path.join (global_options.output_dir,
2101 + '.%s' % global_options.format)
2103 os.chdir (original_dir)
2104 file (dep_file, 'w').write ('%s: %s'
2105 % (final_output_file, ' '.join (inputs)))
2107 if __name__ == '__main__':