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
47 ly.require_python_version ()
50 program_version = '@TOPLEVEL_VERSION@'
51 program_name = os.path.basename (sys.argv[0])
53 # Check if program_version contains @ characters. This will be the case if
54 # the .py file is called directly while building the lilypond documentation.
55 # If so, try to check for the env var LILYPOND_VERSION, which is set by our
56 # makefiles and use its value.
57 at_re = re.compile (r'@')
58 if at_re.match (program_version):
59 if os.environ.has_key('LILYPOND_VERSION'):
60 program_version = os.environ['LILYPOND_VERSION']
62 program_version = "unknown"
64 original_dir = os.getcwd ()
68 _ ("Process LilyPond snippets in hybrid HTML, LaTeX, texinfo or DocBook document.")
72 $ lilypond-book --filter="tr '[a-z]' '[A-Z]'" %(BOOK)s
73 $ lilypond-book -F "convert-ly --no-version --from=2.0.0 -" %(BOOK)s
74 $ lilypond-book --process='lilypond -I include' %(BOOK)s
75 ''' % {'BOOK': _ ("BOOK")})
77 authors = ('Jan Nieuwenhuizen <janneke@gnu.org>',
78 'Han-Wen Nienhuys <hanwen@xs4all.nl>')
80 ################################################################
82 if global_options.verbose:
83 raise Exception (_ ('Exiting (%d)...') % i)
88 ly.encoded_write (sys.stdout, '%s (GNU LilyPond) %s\n' % (program_name, program_version))
90 progress = ly.progress
93 ly.stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
96 ly.stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
98 def ps_page_count (ps_name):
99 header = file (ps_name).read (1024)
100 m = re.search ('\n%%Pages: ([0-9]+)', header)
102 return int (m.group (1))
107 ly.encoded_write (sys.stdout, '''
114 ''' % ( _ ('Copyright (c) %s by') % '2001--2009',
115 '\n '.join (authors),
116 _ ("Distributed under terms of the GNU General Public License."),
117 _ ("It comes with NO WARRANTY.")))
119 def get_option_parser ():
120 p = ly.get_option_parser (usage=_ ("%s [OPTION]... FILE") % 'lilypond-book',
121 description=help_summary,
122 add_help_option=False)
124 p.add_option ('-F', '--filter', metavar=_ ("FILTER"),
127 help=_ ("pipe snippets through FILTER [default: `convert-ly -n -']"),
130 p.add_option ('-f', '--format',
131 help=_ ("use output format FORMAT (texi [default], texi-html, latex, html, docbook)"),
132 metavar=_ ("FORMAT"),
135 p.add_option("-h", "--help",
137 help=_ ("show this help and exit"))
139 p.add_option ("-I", '--include', help=_ ("add DIR to include path"),
141 action='append', dest='include_path',
142 default=[os.path.abspath (os.getcwd ())])
144 p.add_option ('--info-images-dir',
145 help=_ ("format Texinfo output so that Info will "
146 "look for images of music in DIR"),
148 action='store', dest='info_images_dir',
151 p.add_option ('--latex-program',
152 help=_ ("run executable PROG instead of latex"),
154 action='store', dest='latex_program',
157 p.add_option ('--left-padding',
160 help=_ ("pad left side of music to align music inspite of uneven bar numbers (in mm)"),
164 p.add_option ("-o", '--output', help=_ ("write output to DIR"),
166 action='store', dest='output_dir',
169 p.add_option ('--skip-lily-check',
170 help=_ ("do not fail if no lilypond output is found"),
172 action='store_true', dest='skip_lilypond_run',
175 p.add_option ('--skip-png-check',
176 help=_ ("do not fail if no PNG images are found for EPS files"),
178 action='store_true', dest='skip_png_check',
181 p.add_option ('--lily-output-dir',
182 help=_ ("write lily-XXX files to DIR, link into --output dir"),
184 action='store', dest='lily_output_dir',
187 p.add_option ('-P', '--process', metavar=_ ("COMMAND"),
188 help = _ ("process ly_files using COMMAND FILE..."),
190 dest='process_cmd', default='')
192 p.add_option ('--pdf',
195 help=_ ("create PDF files for use with PDFTeX"),
198 p.add_option ('-V', '--verbose', help=_ ("be verbose"),
203 p.version = "@TOPLEVEL_VERSION@"
204 p.add_option("--version",
206 help=_ ("show version number and exit"))
208 p.add_option ('-w', '--warranty',
209 help=_ ("show warranty and copyright"),
211 p.add_option_group ('',
213 _ ("Report bugs via %s")
214 % ' http://post.gmane.org/post.php'
215 '?group=gmane.comp.gnu.lilypond.bugs') + '\n')
218 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
220 # If we are called with full path, try to use lilypond binary
221 # installed in the same path; this is needed in GUB binaries, where
222 # @bindir is always different from the installed binary path.
223 if 'bindir' in globals () and bindir:
224 lilypond_binary = os.path.join (bindir, 'lilypond')
226 # Only use installed binary when we are installed too.
227 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
228 lilypond_binary = 'lilypond'
230 global_options = None
233 default_ly_options = { 'alt': "[image of music]" }
235 document_language = ''
238 # Is this pythonic? Personally, I find this rather #define-nesque. --hwn
240 ADDVERSION = 'addversion'
244 EXAMPLEINDENT = 'exampleindent'
246 FRAGMENT = 'fragment'
252 LINE_WIDTH = 'line-width'
253 LILYQUOTE = 'lilyquote'
254 NOFRAGMENT = 'nofragment'
255 NOGETTEXT = 'nogettext'
256 NOINDENT = 'noindent'
258 NORAGGED_RIGHT = 'noragged-right'
262 OUTPUTIMAGE = 'outputimage'
264 PREAMBLE = 'preamble'
265 PRINTFILENAME = 'printfilename'
267 RAGGED_RIGHT = 'ragged-right'
268 RELATIVE = 'relative'
269 STAFFSIZE = 'staffsize'
270 DOCTITLE = 'doctitle'
273 VERBATIM = 'verbatim'
274 VERSION = 'lilypondversion'
275 FONTLOAD = 'fontload'
276 FILENAME = 'filename'
280 # NOTIME has no opposite so it isn't part of this dictionary.
281 # NOQUOTE is used internally only.
283 NOFRAGMENT: FRAGMENT,
288 # Recognize special sequences in the input.
290 # (?P<name>regex) -- Assign result of REGEX to NAME.
291 # *? -- Match non-greedily.
292 # (?!...) -- Match if `...' doesn't match next (without consuming
295 # (?m) -- Multiline regex: Make ^ and $ match at each line.
296 # (?s) -- Make the dot match all characters including newline.
297 # (?x) -- Ignore whitespace in patterns.
308 <(?P<inline>(inline)?)mediaobject>\s*
310 <programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>
312 </programlisting\s*>\s*
314 </(inline)?mediaobject>)''',
319 <(?P<inline>(inline)?)mediaobject>\s*
321 <programlisting\s+language="lilypond".*?(role="(?P<options>.*?)")?>
323 </programlisting\s*>\s*
325 </(inline)?mediaobject>)''',
330 <(?P<inline>(inline)?)mediaobject>\s*
333 fileref="(?P<filename>.*?\.ly)"\s*
334 (role="(?P<options>.*?)")?\s*
335 (/>|>\s*</imagedata>)\s*
337 </(inline)?mediaobject>)''',
343 (?P<code><!--\s.*?!-->)
346 'singleline_comment':
367 (\s*(?P<options>.*?)\s*:)?\s*
375 \s*(?P<options>.*?)\s*
384 \s*(?P<options>.*?)\s*
386 \s*(?P<filename>.*?)\s*
393 (?P<code><!--\s.*?!-->)
396 'singleline_comment':
402 (?P<code><pre>.*?</pre>))''',
408 (?P<code><pre>\s.*?</pre>\s))''',
413 <lilypondversion\s*/>)''',
432 \s*(?P<options>.*?)\s*
443 \s*(?P<options>.*?)\s*
447 \\end\s*{lilypond})''',
455 \s*(?P<options>.*?)\s*
463 'singleline_comment':
486 \\end\s*{verbatim}))''',
491 \\lilypondversion)[^a-zA-Z]''',
501 (?P<filename>\S+))''',
505 ^[^\n]*?(?!@c\s+)[^\n]*?
509 \s*(?P<options>.*?)\s*
519 \s*(?P<options>.*?)\s*
522 ^@end\s+lilypond)\s''',
529 \s*(?P<options>.*?)\s*
540 @end\s+ignore))\s''',
542 'singleline_comment':
547 @c([ \t][^\n]*|)\n))''',
549 # Don't do this: It interferes with @code{@{}.
550 # 'verb': r'''(?P<code>@code{.*?})''',
558 @end\s+example\s))''',
563 @lilypondversion)[^a-zA-Z]''',
571 'intertext': r',?\s*intertext=\".*?\"',
575 'intertext': r',?\s*intertext=\".*?\"',
580 'intertext': r',?\s*intertext=\".*?\"',
581 'option_sep': '\s*,\s*',
585 'intertext': r',?\s*intertext=\".*?\"',
586 'option_sep': '\s*,\s*',
591 # Options without a pattern in ly_options.
612 RELATIVE: r'''\relative c%(relative_quotes)s''',
617 INDENT: r'''indent = %(indent)s''',
619 LINE_WIDTH: r'''line-width = %(line-width)s''',
621 QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
623 LILYQUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
625 RAGGED_RIGHT: r'''ragged-right = ##t''',
627 NORAGGED_RIGHT: r'''ragged-right = ##f''',
639 \remove "Time_signature_engraver"
645 STAFFSIZE: r'''#(set-global-staff-size %(staffsize)s)''',
652 FILTER: r'''<mediaobject>
654 <programlisting language="lilypond"
661 OUTPUT: r'''<imageobject role="latex">
662 <imagedata fileref="%(base)s.pdf" format="PDF"/>
664 <imageobject role="html">
665 <imagedata fileref="%(base)s.png" format="PNG"/>
668 VERBATIM: r'''<programlisting>
669 %(verb)s</programlisting>''',
671 VERSION: program_version,
673 PRINTFILENAME: r'''<textobject>
675 <ulink url="%(base)s.ly">
685 FILTER: r'''<lilypond %(options)s>
695 <a href="%(base)s.ly">''',
703 PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
705 QUOTE: r'''<blockquote>
713 VERSION: program_version,
720 \ifx\preLilyPondExample \undefined
722 \expandafter\preLilyPondExample
724 \def\lilypondbook{}%%
725 \input %(base)s-systems.tex
726 \ifx\postLilyPondExample \undefined
728 \expandafter\postLilyPondExample
732 PRINTFILENAME: '''\\texttt{%(filename)s}
735 QUOTE: r'''\begin{quotation}
739 VERBATIM: r'''\noindent
740 \begin{verbatim}%(verb)s\end{verbatim}
743 VERSION: program_version,
745 FILTER: r'''\begin{lilypond}[%(options)s]
752 FILTER: r'''@lilypond[%(options)s]
758 @include %(base)s-systems.texi
762 OUTPUTIMAGE: r'''@noindent
764 @image{%(info_image_path)s,,,%(alt)s,%(ext)s}
768 <a href="%(base)s.ly">
780 <a href="%(base)s.ly">
788 QUOTE: r'''@quotation
789 %(str)s@end quotation
796 VERBATIM: r'''@exampleindent 0
798 %(verb)s@end verbatim
801 VERSION: program_version,
803 ADDVERSION: r'''@example
804 \version @w{"@version{}"}
811 # Maintain line numbers.
816 for f in [HTML, LATEX]:
817 for s in (QUOTE, VERBATIM):
818 output[f][s] = output[f][s].replace("\n"," ")
821 PREAMBLE_LY = '''%%%% Generated by %(program_name)s
822 %%%% Options: [%(option_string)s]
823 \\include "lilypond-book-preamble.ly"
826 %% ****************************************************************
827 %% Start cut-&-pastable-section
828 %% ****************************************************************
833 #(define dump-extents #t)
834 %(font_dump_setting)s
836 force-assignment = #""
837 line-width = #(- line-width (* mm %(padding_mm)f))
850 %% ****************************************************************
851 %% ly snippet contents follows:
852 %% ****************************************************************
856 %% ****************************************************************
858 %% ****************************************************************
865 %% ****************************************************************
867 %% ****************************************************************
871 %% ****************************************************************
873 %% ****************************************************************
876 texinfo_line_widths = {
877 '@afourpaper': '160\\mm',
878 '@afourwide': '6.5\\in',
879 '@afourlatex': '150\\mm',
880 '@smallbook': '5\\in',
881 '@letterpaper': '6\\in',
884 def classic_lilypond_book_compatibility (key, value):
885 if key == 'singleline' and value == None:
886 return (RAGGED_RIGHT, None)
888 m = re.search ('relative\s*([-0-9])', key)
890 return ('relative', m.group (1))
892 m = re.match ('([0-9]+)pt', key)
894 return ('staffsize', m.group (1))
896 if key == 'indent' or key == 'line-width':
897 m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
899 f = float (m.group (1))
900 return (key, '%f\\%s' % (f, m.group (2)))
904 def find_file (name, raise_error=True):
905 for i in global_options.include_path:
906 full = os.path.join (i, name)
907 if os.path.exists (full):
911 error (_ ("file not found: %s") % name + '\n')
915 def verbatim_html (s):
916 return re.sub ('>', '>',
918 re.sub ('&', '&', s)))
920 ly_var_def_re = re.compile (r'^([a-zA-Z]+)[\t ]*=', re.M)
921 ly_comment_re = re.compile (r'(%+[\t ]*)(.*)$', re.M)
922 ly_context_id_re = re.compile ('\\\\(?:new|context)\\s+(?:[a-zA-Z]*?(?:Staff\
923 (?:Group)?|Voice|FiguredBass|FretBoards|Names|Devnull))\\s+=\\s+"?([a-zA-Z]+)"?\\s+')
925 def ly_comment_gettext (t, m):
926 return m.group (1) + t (m.group (2))
928 def verb_ly_gettext (s):
929 if not document_language:
932 t = langdefs.translation[document_language]
936 s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s)
938 for v in ly_var_def_re.findall (s):
939 s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v,
940 "\\1" + t (v) + "\\2",
942 for id in ly_context_id_re.findall (s):
943 s = re.sub (r'(\s+|")%s(\s+|")' % id,
944 "\\1" + t (id) + "\\2",
948 texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)')
949 def set_default_options (source, default_ly_options, format):
950 global document_language
951 if LINE_WIDTH not in default_ly_options:
953 textwidth = get_latex_textwidth (source)
954 default_ly_options[LINE_WIDTH] = '%.0f\\pt' % textwidth
955 elif format == TEXINFO:
956 m = texinfo_lang_re.search (source)
957 if m and not m.group (1).startswith ('en'):
958 document_language = m.group (1)
960 document_language = ''
961 for regex in texinfo_line_widths:
962 # FIXME: @layout is usually not in
965 # \input texinfo @c -*-texinfo-*-
967 # Bluntly search first K items of
969 # s = chunks[0].replacement_text ()
970 if re.search (regex, source[:1024]):
971 default_ly_options[LINE_WIDTH] = texinfo_line_widths[regex]
975 def replacement_text (self):
978 def filter_text (self):
979 return self.replacement_text ()
984 class Substring (Chunk):
985 """A string that does not require extra memory."""
986 def __init__ (self, source, start, end, line_number):
990 self.line_number = line_number
991 self.override_text = None
996 def replacement_text (self):
997 if self.override_text:
998 return self.override_text
1000 return self.source[self.start:self.end]
1002 class Snippet (Chunk):
1003 def __init__ (self, type, match, format, line_number):
1007 self.option_dict = {}
1008 self.format = format
1009 self.line_number = line_number
1011 def replacement_text (self):
1012 return self.match.group ('match')
1014 def substring (self, s):
1015 return self.match.group (s)
1017 def __repr__ (self):
1018 return `self.__class__` + ' type = ' + self.type
1020 class IncludeSnippet (Snippet):
1021 def processed_filename (self):
1022 f = self.substring ('filename')
1023 return os.path.splitext (f)[0] + format2ext[self.format]
1025 def replacement_text (self):
1026 s = self.match.group ('match')
1027 f = self.substring ('filename')
1029 return re.sub (f, self.processed_filename (), s)
1031 class LilypondSnippet (Snippet):
1032 def __init__ (self, type, match, format, line_number):
1033 Snippet.__init__ (self, type, match, format, line_number)
1034 os = match.group ('options')
1035 self.do_options (os, self.type)
1038 if NOGETTEXT in self.option_dict:
1039 return self.substring ('code')
1041 return verb_ly_gettext (self.substring ('code'))
1044 contents = self.substring ('code')
1045 return ('\\sourcefileline %d\n%s'
1046 % (self.line_number - 1, contents))
1051 return self.compose_ly (s)
1054 def split_options (self, option_string):
1056 if self.format == HTML:
1057 options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',
1059 options = [re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)', '\g<1>\g<3>', opt)
1063 return re.split (format_res[self.format]['option_sep'],
1067 def do_options (self, option_string, type):
1068 self.option_dict = {}
1070 options = self.split_options (option_string)
1072 for option in options:
1074 (key, value) = re.split ('\s*=\s*', option)
1075 self.option_dict[key] = value
1077 if option in no_options:
1078 if no_options[option] in self.option_dict:
1079 del self.option_dict[no_options[option]]
1081 self.option_dict[option] = None
1083 has_line_width = self.option_dict.has_key (LINE_WIDTH)
1084 no_line_width_value = 0
1086 # If LINE_WIDTH is used without parameter, set it to default.
1087 if has_line_width and self.option_dict[LINE_WIDTH] == None:
1088 no_line_width_value = 1
1089 del self.option_dict[LINE_WIDTH]
1091 for k in default_ly_options:
1092 if k not in self.option_dict:
1093 self.option_dict[k] = default_ly_options[k]
1095 # RELATIVE does not work without FRAGMENT;
1096 # make RELATIVE imply FRAGMENT
1097 has_relative = self.option_dict.has_key (RELATIVE)
1098 if has_relative and not self.option_dict.has_key (FRAGMENT):
1099 self.option_dict[FRAGMENT] = None
1101 if not has_line_width:
1102 if type == 'lilypond' or FRAGMENT in self.option_dict:
1103 self.option_dict[RAGGED_RIGHT] = None
1105 if type == 'lilypond':
1106 if LINE_WIDTH in self.option_dict:
1107 del self.option_dict[LINE_WIDTH]
1109 if RAGGED_RIGHT in self.option_dict:
1110 if LINE_WIDTH in self.option_dict:
1111 del self.option_dict[LINE_WIDTH]
1113 if QUOTE in self.option_dict or type == 'lilypond':
1114 if LINE_WIDTH in self.option_dict:
1115 del self.option_dict[LINE_WIDTH]
1117 if not INDENT in self.option_dict:
1118 self.option_dict[INDENT] = '0\\mm'
1120 # The QUOTE pattern from ly_options only emits the `line-width'
1122 if has_line_width and QUOTE in self.option_dict:
1123 if no_line_width_value:
1124 del self.option_dict[LINE_WIDTH]
1126 del self.option_dict[QUOTE]
1128 def compose_ly (self, code):
1129 if FRAGMENT in self.option_dict:
1137 # The original concept of the `exampleindent' option is broken.
1138 # It is not possible to get a sane value for @exampleindent at all
1139 # without processing the document itself. Saying
1147 # causes ugly results with the DVI backend of texinfo since the
1148 # default value for @exampleindent isn't 5em but 0.4in (or a smaller
1149 # value). Executing the above code changes the environment
1150 # indentation to an unknown value because we don't know the amount
1151 # of 1em in advance since it is font-dependent. Modifying
1152 # @exampleindent in the middle of a document is simply not
1153 # supported within texinfo.
1155 # As a consequence, the only function of @exampleindent is now to
1156 # specify the amount of indentation for the `quote' option.
1158 # To set @exampleindent locally to zero, we use the @format
1159 # environment for non-quoted snippets.
1160 override[EXAMPLEINDENT] = r'0.4\in'
1161 override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
1162 override.update (default_ly_options)
1165 for (key, value) in self.option_dict.items ():
1167 option_list.append (key)
1169 option_list.append (key + '=' + value)
1170 option_string = ','.join (option_list)
1173 compose_types = [NOTES, PREAMBLE, LAYOUT, PAPER]
1174 for a in compose_types:
1175 compose_dict[a] = []
1177 for (key, value) in self.option_dict.items ():
1178 (c_key, c_value) = classic_lilypond_book_compatibility (key, value)
1182 _ ("deprecated ly-option used: %s=%s") % (key, value))
1184 _ ("compatibility mode translation: %s=%s") % (c_key, c_value))
1187 _ ("deprecated ly-option used: %s") % key)
1189 _ ("compatibility mode translation: %s") % c_key)
1191 (key, value) = (c_key, c_value)
1194 override[key] = value
1196 if not override.has_key (key):
1197 override[key] = None
1200 for type in compose_types:
1201 if ly_options[type].has_key (key):
1202 compose_dict[type].append (ly_options[type][key])
1206 if not found and key not in simple_options:
1207 warning (_ ("ignoring unknown ly option: %s") % key)
1210 if RELATIVE in override and override[RELATIVE]:
1211 relative = int (override[RELATIVE])
1213 relative_quotes = ''
1217 relative_quotes += ',' * (- relative)
1219 relative_quotes += "'" * relative
1221 paper_string = '\n '.join (compose_dict[PAPER]) % override
1222 layout_string = '\n '.join (compose_dict[LAYOUT]) % override
1223 notes_string = '\n '.join (compose_dict[NOTES]) % vars ()
1224 preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override
1225 padding_mm = global_options.padding_mm
1226 font_dump_setting = ''
1227 if FONTLOAD in self.option_dict:
1228 font_dump_setting = '#(define-public force-eps-font-include #t)\n'
1230 d = globals().copy()
1232 return (PREAMBLE_LY + body) % d
1234 def get_checksum (self):
1235 if not self.checksum:
1236 # Work-around for md5 module deprecation warning in python 2.5+:
1238 from hashlib import md5
1242 hash = md5 (self.relevant_contents (self.full_ly ()))
1244 ## let's not create too long names.
1245 self.checksum = hash.hexdigest ()[:10]
1247 return self.checksum
1249 def basename (self):
1250 cs = self.get_checksum ()
1251 name = '%s/lily-%s' % (cs[:2], cs[2:10])
1254 def write_ly (self):
1255 base = self.basename ()
1256 path = os.path.join (global_options.lily_output_dir, base)
1257 directory = os.path.split(path)[0]
1258 if not os.path.isdir (directory):
1259 os.makedirs (directory)
1260 out = file (path + '.ly', 'w')
1261 out.write (self.full_ly ())
1262 file (path + '.txt', 'w').write ('image of music')
1264 def relevant_contents (self, ly):
1265 return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n|' +
1266 NOGETTEXT + '[,\]]', '', ly)
1268 def link_all_output_files (self, output_dir, output_dir_files, destination):
1269 existing, missing = self.all_output_files (output_dir, output_dir_files)
1271 print '\nMissing', missing
1272 raise CompileError(self.basename())
1273 for name in existing:
1275 os.unlink (os.path.join (destination, name))
1279 src = os.path.join (output_dir, name)
1280 dst = os.path.join (destination, name)
1281 dst_path = os.path.split(dst)[0]
1282 if not os.path.isdir (dst_path):
1283 os.makedirs (dst_path)
1287 def all_output_files (self, output_dir, output_dir_files):
1288 """Return all files generated in lily_output_dir, a set.
1290 output_dir_files is the list of files in the output directory.
1294 base = self.basename()
1295 full = os.path.join (output_dir, base)
1296 def consider_file (name):
1297 if name in output_dir_files:
1300 def require_file (name):
1301 if name in output_dir_files:
1306 # UGH - junk global_options
1307 skip_lily = global_options.skip_lilypond_run
1308 for required in [base + '.ly',
1310 require_file (required)
1312 require_file (base + '-systems.count')
1314 if 'ddump-profile' in global_options.process_cmd:
1315 require_file (base + '.profile')
1316 if 'dseparate-log-file' in global_options.process_cmd:
1317 require_file (base + '.log')
1319 map (consider_file, [base + '.tex',
1323 base + '-systems.texi',
1324 base + '-systems.tex',
1325 base + '-systems.pdftexi'])
1326 if document_language:
1328 [base + '.texidoc' + document_language,
1329 base + '.doctitle' + document_language])
1331 # UGH - junk global_options
1332 if (base + '.eps' in result and self.format in (HTML, TEXINFO)
1333 and not global_options.skip_png_check):
1334 page_count = ps_page_count (full + '.eps')
1336 require_file (base + '.png')
1338 for page in range (1, page_count + 1):
1339 require_file (base + '-page%d.png' % page)
1342 if not skip_lily and not missing:
1343 system_count = int(file (full + '-systems.count').read())
1345 for number in range(1, system_count + 1):
1346 systemfile = '%s-%d' % (base, number)
1347 require_file (systemfile + '.eps')
1348 consider_file (systemfile + '.pdf')
1350 # We can't require signatures, since books and toplevel
1351 # markups do not output a signature.
1352 if 'ddump-signature' in global_options.process_cmd:
1353 consider_file (systemfile + '.signature')
1356 return (result, missing)
1358 def is_outdated (self, output_dir, current_files):
1359 found, missing = self.all_output_files (output_dir, current_files)
1362 def filter_text (self):
1363 """Run snippet bodies through a command (say: convert-ly).
1365 This functionality is rarely used, and this code must have bitrot.
1367 code = self.substring ('code')
1368 s = filter_pipe (code, global_options.filter_cmd)
1371 'options': self.match.group ('options')
1374 return output[self.format][FILTER] % d
1376 def replacement_text (self):
1377 func = LilypondSnippet.__dict__['output_' + self.format]
1380 def get_images (self):
1381 base = self.basename ()
1383 single = '%(base)s.png' % vars ()
1384 multiple = '%(base)s-page1.png' % vars ()
1386 if (os.path.exists (multiple)
1387 and (not os.path.exists (single)
1388 or (os.stat (multiple)[stat.ST_MTIME]
1389 > os.stat (single)[stat.ST_MTIME]))):
1390 count = ps_page_count ('%(base)s.eps' % vars ())
1391 images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)]
1392 images = tuple (images)
1396 def output_docbook (self):
1398 base = self.basename ()
1399 for image in self.get_images ():
1400 (base, ext) = os.path.splitext (image)
1401 str += output[DOCBOOK][OUTPUT] % vars ()
1402 str += self.output_print_filename (DOCBOOK)
1403 if (self.substring('inline') == 'inline'):
1404 str = '<inlinemediaobject>' + str + '</inlinemediaobject>'
1406 str = '<mediaobject>' + str + '</mediaobject>'
1407 if VERBATIM in self.option_dict:
1408 verb = verbatim_html (self.verb_ly ())
1409 str = output[DOCBOOK][VERBATIM] % vars () + str
1412 def output_html (self):
1414 base = self.basename ()
1415 if self.format == HTML:
1416 str += self.output_print_filename (HTML)
1417 if VERBATIM in self.option_dict:
1418 verb = verbatim_html (self.verb_ly ())
1419 str += output[HTML][VERBATIM] % vars ()
1420 if QUOTE in self.option_dict:
1421 str = output[HTML][QUOTE] % vars ()
1423 str += output[HTML][BEFORE] % vars ()
1424 for image in self.get_images ():
1425 (base, ext) = os.path.splitext (image)
1426 alt = self.option_dict[ALT]
1427 str += output[HTML][OUTPUT] % vars ()
1428 str += output[HTML][AFTER] % vars ()
1431 def output_info (self):
1433 for image in self.get_images ():
1434 (base, ext) = os.path.splitext (image)
1436 # URG, makeinfo implicitly prepends dot to extension.
1437 # Specifying no extension is most robust.
1439 alt = self.option_dict[ALT]
1440 info_image_path = os.path.join (global_options.info_images_dir, base)
1441 str += output[TEXINFO][OUTPUTIMAGE] % vars ()
1443 base = self.basename ()
1444 str += output[self.format][OUTPUT] % vars ()
1447 def output_latex (self):
1449 base = self.basename ()
1450 if self.format == LATEX:
1451 str += self.output_print_filename (LATEX)
1452 if VERBATIM in self.option_dict:
1453 verb = self.verb_ly ()
1454 str += (output[LATEX][VERBATIM] % vars ())
1456 str += (output[LATEX][OUTPUT] % vars ())
1458 ## todo: maintain breaks
1460 breaks = self.ly ().count ("\n")
1461 str += "".ljust (breaks, "\n").replace ("\n","%\n")
1463 if QUOTE in self.option_dict:
1464 str = output[LATEX][QUOTE] % vars ()
1467 def output_print_filename (self, format):
1469 if PRINTFILENAME in self.option_dict:
1470 base = self.basename ()
1471 filename = os.path.basename (self.substring ('filename'))
1472 str = output[format][PRINTFILENAME] % vars ()
1476 def output_texinfo (self):
1477 str = self.output_print_filename (TEXINFO)
1478 base = self.basename ()
1479 if DOCTITLE in self.option_dict:
1480 doctitle = base + '.doctitle'
1481 translated_doctitle = doctitle + document_language
1482 if os.path.exists (translated_doctitle):
1483 str += '@lydoctitle %s\n\n' % open (translated_doctitle).read ()
1484 elif os.path.exists (doctitle):
1485 str += '@lydoctitle %s\n\n' % open (doctitle).read ()
1486 if TEXIDOC in self.option_dict:
1487 texidoc = base + '.texidoc'
1488 translated_texidoc = texidoc + document_language
1489 if os.path.exists (translated_texidoc):
1490 str += '@include %(translated_texidoc)s\n\n' % vars ()
1491 elif os.path.exists (texidoc):
1492 str += '@include %(texidoc)s\n\n' % vars ()
1495 if VERBATIM in self.option_dict:
1497 if ADDVERSION in self.option_dict:
1498 version = output[TEXINFO][ADDVERSION]
1499 verb = self.verb_ly ()
1500 substr = output[TEXINFO][VERBATIM] % vars ()
1501 substr += self.output_info ()
1502 if LILYQUOTE in self.option_dict:
1503 substr = output[TEXINFO][QUOTE] % {'str':substr}
1506 # str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
1507 # str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
1508 # str += ('@html\n' + self.output_html () + '\n@end html\n')
1510 if QUOTE in self.option_dict:
1511 str = output[TEXINFO][QUOTE] % vars ()
1513 # need par after image
1518 re_begin_verbatim = re.compile (r'\s+%.*?begin verbatim.*\n*', re.M)
1519 re_end_verbatim = re.compile (r'\s+%.*?end verbatim.*$', re.M)
1521 class LilypondFileSnippet (LilypondSnippet):
1522 def __init__ (self, type, match, format, line_number):
1523 LilypondSnippet.__init__ (self, type, match, format, line_number)
1524 self.contents = file (find_file (self.substring ('filename'))).read ()
1528 s = re_begin_verbatim.split (s)[-1]
1529 s = re_end_verbatim.split (s)[0]
1530 return verb_ly_gettext (s)
1533 name = self.substring ('filename')
1534 return ('\\sourcefilename \"%s\"\n\\sourcefileline 0\n%s'
1535 % (name, self.contents))
1538 class LilyPondVersionString (Snippet):
1539 """A string that does not require extra memory."""
1540 def __init__ (self, type, match, format, line_number):
1541 Snippet.__init__ (self, type, match, format, line_number)
1543 def replacement_text (self):
1544 return output[self.format][self.type]
1547 snippet_type_to_class = {
1548 'lilypond_file': LilypondFileSnippet,
1549 'lilypond_block': LilypondSnippet,
1550 'lilypond': LilypondSnippet,
1551 'include': IncludeSnippet,
1552 'lilypondversion': LilyPondVersionString,
1555 def find_linestarts (s):
1560 i = s.find ('\n', start)
1568 nls.append (len (s))
1571 def find_toplevel_snippets (input_string, format, types):
1574 res[t] = re.compile (snippet_res[format][t])
1578 found = dict ([(t, None) for t in types])
1580 line_starts = find_linestarts (input_string)
1582 # We want to search for multiple regexes, without searching
1583 # the string multiple times for one regex.
1584 # Hence, we use earlier results to limit the string portion
1586 # Since every part of the string is traversed at most once for
1587 # every type of snippet, this is linear.
1593 if not found[type] or found[type][0] < index:
1596 m = res[type].search (input_string[index:endex])
1601 if type in snippet_type_to_class:
1602 klass = snippet_type_to_class[type]
1604 start = index + m.start ('match')
1605 line_number = line_start_idx
1606 while (line_starts[line_number] < start):
1610 snip = klass (type, m, format, line_number)
1612 found[type] = (start, snip)
1616 or found[type][0] < found[first][0])):
1621 # Limiting the search space is a cute
1622 # idea, but this *requires* to search
1623 # for possible containing blocks
1624 # first, at least as long as we do not
1625 # search for the start of blocks, but
1626 # always/directly for the entire
1627 # @block ... @end block.
1629 endex = found[first][0]
1632 snippets.append (Substring (input_string, index, len (input_string), line_start_idx))
1635 while (start > line_starts[line_start_idx+1]):
1638 (start, snip) = found[first]
1639 snippets.append (Substring (input_string, index, start, line_start_idx + 1))
1640 snippets.append (snip)
1642 index = start + len (snip.match.group ('match'))
1646 def filter_pipe (input, cmd):
1647 """Pass input through cmd, and return the result."""
1649 if global_options.verbose:
1650 progress (_ ("Opening filter `%s'") % cmd)
1652 (stdin, stdout, stderr) = os.popen3 (cmd)
1654 status = stdin.close ()
1658 output = stdout.read ()
1659 status = stdout.close ()
1660 error = stderr.read ()
1664 signal = 0x0f & status
1665 if status or (not output and error):
1666 exit_status = status >> 8
1667 error (_ ("`%s' failed (%d)") % (cmd, exit_status))
1668 error (_ ("The error log is as follows:"))
1669 ly.stderr_write (error)
1670 ly.stderr_write (stderr.read ())
1673 if global_options.verbose:
1678 def system_in_directory (cmd, directory):
1679 """Execute a command in a different directory.
1681 Because of win32 compatibility, we can't simply use subprocess.
1684 current = os.getcwd()
1685 os.chdir (directory)
1686 ly.system(cmd, be_verbose=global_options.verbose,
1691 def process_snippets (cmd, snippets,
1692 format, lily_output_dir):
1693 """Run cmd on all of the .ly files from snippets."""
1698 if format in (HTML, TEXINFO) and '--formats' not in cmd:
1699 cmd += ' --formats=png '
1700 elif format in (DOCBOOK) and '--formats' not in cmd:
1701 cmd += ' --formats=png,pdf '
1703 checksum = snippet_list_checksum (snippets)
1704 contents = '\n'.join (['snippet-map-%d.ly' % checksum]
1705 + [snip.basename() + '.ly' for snip in snippets])
1706 name = os.path.join (lily_output_dir,
1707 'snippet-names-%d.ly' % checksum)
1708 file (name, 'wb').write (contents)
1710 system_in_directory (' '.join ([cmd, ly.mkarg (name)]),
1715 # Retrieve dimensions from LaTeX
1716 LATEX_INSPECTION_DOCUMENT = r'''
1720 \typeout{textwidth=\the\textwidth}
1721 \typeout{columnsep=\the\columnsep}
1722 \makeatletter\if@twocolumn\typeout{columns=2}\fi\makeatother
1726 # Do we need anything else besides `textwidth'?
1727 def get_latex_textwidth (source):
1728 m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
1730 warning (_ ("cannot find \\begin{document} in LaTeX document"))
1732 ## what's a sensible default?
1735 preamble = source[:m.start (0)]
1736 latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
1738 (handle, tmpfile) = tempfile.mkstemp('.tex')
1739 logfile = os.path.splitext (tmpfile)[0] + '.log'
1740 logfile = os.path.split (logfile)[1]
1742 tmp_handle = os.fdopen (handle,'w')
1743 tmp_handle.write (latex_document)
1746 ly.system ('%s %s' % (global_options.latex_program, tmpfile),
1747 be_verbose=global_options.verbose)
1748 parameter_string = file (logfile).read()
1754 m = re.search ('columns=([0-9.]*)', parameter_string)
1756 columns = int (m.group (1))
1759 m = re.search ('columnsep=([0-9.]*)pt', parameter_string)
1761 columnsep = float (m.group (1))
1764 m = re.search ('textwidth=([0-9.]*)pt', parameter_string)
1766 textwidth = float (m.group (1))
1768 textwidth = (textwidth - columnsep) / columns
1772 def modify_preamble (chunk):
1773 str = chunk.replacement_text ()
1774 if (re.search (r"\\begin *{document}", str)
1775 and not re.search ("{graphic[sx]", str)):
1776 str = re.sub (r"\\begin{document}",
1777 r"\\usepackage{graphics}" + '\n'
1778 + r"\\begin{document}",
1780 chunk.override_text = str
1785 # TEXINFO: '.texinfo',
1791 class CompileError(Exception):
1794 def snippet_list_checksum (snippets):
1795 return hash (' '.join([l.basename() for l in snippets]))
1797 def write_file_map (lys, name):
1798 snippet_map = file (os.path.join (
1799 global_options.lily_output_dir,
1800 'snippet-map-%d.ly' % snippet_list_checksum (lys)), 'w')
1802 snippet_map.write ("""
1803 #(define version-seen #t)
1804 #(define output-empty-score-list #f)
1805 #(ly:add-file-name-alist '(%s
1807 """ % '\n'.join(['("%s.ly" . "%s")\n' % (ly.basename (), name)
1810 def split_output_files(directory):
1811 """Returns directory entries in DIRECTORY/XX/ , where XX are hex digits.
1813 Return value is a set of strings.
1816 for subdir in glob.glob (os.path.join (directory, '[a-f0-9][a-f0-9]')):
1817 base_subdir = os.path.split (subdir)[1]
1818 sub_files = [os.path.join (base_subdir, name)
1819 for name in os.listdir (subdir)]
1823 def do_process_cmd (chunks, input_name, options):
1824 snippets = [c for c in chunks if isinstance (c, LilypondSnippet)]
1826 output_files = split_output_files (options.lily_output_dir)
1827 outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)]
1829 write_file_map (outdated, input_name)
1830 progress (_ ("Writing snippets..."))
1831 for snippet in outdated:
1836 progress (_ ("Processing..."))
1838 process_snippets (options.process_cmd, outdated,
1839 options.format, options.lily_output_dir)
1842 progress (_ ("All snippets are up to date..."))
1844 if options.lily_output_dir != options.output_dir:
1845 output_files = split_output_files (options.lily_output_dir)
1846 for snippet in snippets:
1847 snippet.link_all_output_files (options.lily_output_dir,
1855 # Format guessing data
1864 '.texinfo': TEXINFO,
1869 def guess_format (input_filename):
1871 e = os.path.splitext (input_filename)[1]
1874 format = ext2format[e]
1876 error (_ ("cannot determine format for: %s"
1881 def write_if_updated (file_name, lines):
1883 f = file (file_name)
1885 new_str = ''.join (lines)
1886 if oldstr == new_str:
1887 progress (_ ("%s is up to date.") % file_name)
1890 # this prevents make from always rerunning lilypond-book:
1891 # output file must be touched in order to be up to date
1892 os.utime (file_name, None)
1897 output_dir = os.path.dirname (file_name)
1898 if not os.path.exists (output_dir):
1899 os.makedirs (output_dir)
1901 progress (_ ("Writing `%s'...") % file_name)
1902 file (file_name, 'w').writelines (lines)
1906 def note_input_file (name, inputs=[]):
1907 ## hack: inputs is mutable!
1908 inputs.append (name)
1911 def samefile (f1, f2):
1913 return os.path.samefile (f1, f2)
1914 except AttributeError: # Windoze
1915 f1 = re.sub ("//*", "/", f1)
1916 f2 = re.sub ("//*", "/", f2)
1919 def do_file (input_filename, included=False):
1921 if not input_filename or input_filename == '-':
1922 in_handle = sys.stdin
1923 input_fullname = '<stdin>'
1925 if os.path.exists (input_filename):
1926 input_fullname = input_filename
1927 elif global_options.format == LATEX and ly.search_exe_path ('kpsewhich'):
1928 input_fullname = os.popen ('kpsewhich ' + input_filename).read()[:-1]
1930 input_fullname = find_file (input_filename)
1932 note_input_file (input_fullname)
1933 in_handle = file (input_fullname)
1935 if input_filename == '-':
1936 input_base = 'stdin'
1938 input_base = os.path.splitext (input_filename)[0]
1940 input_base = os.path.basename (
1941 os.path.splitext (input_filename)[0])
1943 # don't complain when global_options.output_dir is existing
1944 if not global_options.output_dir:
1945 global_options.output_dir = os.getcwd()
1947 global_options.output_dir = os.path.abspath(global_options.output_dir)
1949 if not os.path.isdir (global_options.output_dir):
1950 os.mkdir (global_options.output_dir, 0777)
1951 os.chdir (global_options.output_dir)
1953 output_filename = os.path.join(global_options.output_dir,
1954 input_base + format2ext[global_options.format])
1955 if (os.path.exists (input_filename)
1956 and os.path.exists (output_filename)
1957 and samefile (output_filename, input_fullname)):
1959 _ ("Output would overwrite input file; use --output."))
1963 progress (_ ("Reading %s...") % input_fullname)
1964 source = in_handle.read ()
1967 set_default_options (source, default_ly_options, global_options.format)
1970 # FIXME: Containing blocks must be first, see
1971 # find_toplevel_snippets.
1973 'multiline_comment',
1977 'singleline_comment',
1983 progress (_ ("Dissecting..."))
1984 chunks = find_toplevel_snippets (source, global_options.format, snippet_types)
1986 if global_options.format == LATEX:
1988 if (c.is_plain () and
1989 re.search (r"\\begin *{document}", c.replacement_text())):
1994 if global_options.filter_cmd:
1995 write_if_updated (output_filename,
1996 [c.filter_text () for c in chunks])
1997 elif global_options.process_cmd:
1998 do_process_cmd (chunks, input_fullname, global_options)
1999 progress (_ ("Compiling %s...") % output_filename)
2001 write_if_updated (output_filename,
2002 [s.replacement_text ()
2005 def process_include (snippet):
2006 os.chdir (original_dir)
2007 name = snippet.substring ('filename')
2008 progress (_ ("Processing include: %s") % name)
2010 return do_file (name, included=True)
2012 include_chunks = map (process_include,
2013 filter (lambda x: isinstance (x, IncludeSnippet),
2016 return chunks + reduce (lambda x, y: x + y, include_chunks, [])
2018 except CompileError:
2019 os.chdir (original_dir)
2020 progress (_ ("Removing `%s'") % output_filename)
2025 global global_options
2027 opt_parser = get_option_parser()
2028 (global_options, args) = opt_parser.parse_args ()
2029 if global_options.format in ('texi-html', 'texi'):
2030 global_options.format = TEXINFO
2032 global_options.include_path = map (os.path.abspath, global_options.include_path)
2034 if global_options.warranty:
2037 if not args or len (args) > 1:
2038 opt_parser.print_help ()
2044 # FIXME: 85 lines of `main' macramee??
2045 files = do_options ()
2047 basename = os.path.splitext (files[0])[0]
2048 basename = os.path.split (basename)[1]
2050 if not global_options.format:
2051 global_options.format = guess_format (files[0])
2054 if global_options.format in (TEXINFO, HTML, DOCBOOK):
2057 if global_options.process_cmd == '':
2058 global_options.process_cmd = (lilypond_binary
2059 + ' --formats=%s -dbackend=eps ' % formats)
2061 if global_options.process_cmd:
2062 includes = global_options.include_path
2063 if global_options.lily_output_dir:
2064 # This must be first, so lilypond prefers to read .ly
2065 # files in the other lybookdb dir.
2066 includes = [os.path.abspath(global_options.lily_output_dir)] + includes
2067 global_options.process_cmd += ' '.join ([' -I %s' % ly.mkarg (p)
2070 if global_options.format in (TEXINFO, LATEX):
2071 ## prevent PDF from being switched on by default.
2072 global_options.process_cmd += ' --formats=eps '
2073 if global_options.create_pdf:
2074 global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts "
2076 if global_options.verbose:
2077 global_options.process_cmd += " --verbose "
2079 if global_options.padding_mm:
2080 global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm
2082 global_options.process_cmd += " -dread-file-list -dno-strip-output-dir"
2084 if global_options.lily_output_dir:
2085 global_options.lily_output_dir = os.path.abspath(global_options.lily_output_dir)
2086 if not os.path.isdir (global_options.lily_output_dir):
2087 os.makedirs (global_options.lily_output_dir)
2089 global_options.lily_output_dir = os.path.abspath(global_options.output_dir)
2094 chunks = do_file (files[0])
2095 except CompileError:
2098 inputs = note_input_file ('')
2101 base_file_name = os.path.splitext (os.path.basename (files[0]))[0]
2102 dep_file = os.path.join (global_options.output_dir, base_file_name + '.dep')
2103 final_output_file = os.path.join (global_options.output_dir,
2105 + '.%s' % global_options.format)
2107 os.chdir (original_dir)
2108 file (dep_file, 'w').write ('%s: %s'
2109 % (final_output_file, ' '.join (inputs)))
2111 if __name__ == '__main__':