X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scripts%2Flilypond-book.py;h=392ddd061ebcbf3dabdda25cf7367fb787f32026;hb=62c47998dbe5a2ed29c9784416c1568588a834fd;hp=560f675de26d6ce4a4d6bb239e63614ec0f9c816;hpb=2c1128a20c65a4e4414d4346006ca6f151ea8876;p=lilypond.git diff --git a/scripts/lilypond-book.py b/scripts/lilypond-book.py index 560f675de2..392ddd061e 100644 --- a/scripts/lilypond-book.py +++ b/scripts/lilypond-book.py @@ -1,5 +1,20 @@ #!@TARGET_PYTHON@ +# This file is part of LilyPond, the GNU music typesetter. +# +# LilyPond is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# LilyPond is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with LilyPond. If not, see . + ''' Example usage: @@ -15,7 +30,7 @@ classic lilypond-book: TODO: * this script is too complex. Modularize. - + * ly-options: intertext? * --line-width? * eps in latex / eps by lilypond -b ps? @@ -29,7 +44,6 @@ TODO: ''' import glob -import md5 import os import re import stat @@ -53,7 +67,7 @@ program_name = os.path.basename (sys.argv[0]) # Check if program_version contains @ characters. This will be the case if # the .py file is called directly while building the lilypond documentation. -# If so, try to check for the env var LILYPOND_VERSION, which is set by our +# If so, try to check for the env var LILYPOND_VERSION, which is set by our # makefiles and use its value. at_re = re.compile (r'@') if at_re.match (program_version): @@ -108,12 +122,12 @@ def warranty (): ly.encoded_write (sys.stdout, ''' %s -%s + %s %s %s -''' % ( _ ('Copyright (c) %s by') % '2001--2008', - ' '.join (authors), +''' % ( _ ('Copyright (c) %s by') % '2001--2009', + '\n '.join (authors), _ ("Distributed under terms of the GNU General Public License."), _ ("It comes with NO WARRANTY."))) @@ -155,18 +169,18 @@ def get_option_parser (): action='store', dest='latex_program', default='latex') - p.add_option ('--left-padding', + p.add_option ('--left-padding', metavar=_ ("PAD"), dest="padding_mm", help=_ ("pad left side of music to align music inspite of uneven bar numbers (in mm)"), type="float", default=3.0) - + p.add_option ("-o", '--output', help=_ ("write output to DIR"), metavar=_ ("DIR"), action='store', dest='output_dir', default='') - + p.add_option ('--skip-lily-check', help=_ ("do not fail if no lilypond output is found"), metavar=_ ("DIR"), @@ -178,16 +192,16 @@ def get_option_parser (): metavar=_ ("DIR"), action='store_true', dest='skip_png_check', default=False) - + p.add_option ('--lily-output-dir', help=_ ("write lily-XXX files to DIR, link into --output dir"), metavar=_ ("DIR"), action='store', dest='lily_output_dir', default=None) - + p.add_option ('-P', '--process', metavar=_ ("COMMAND"), help = _ ("process ly_files using COMMAND FILE..."), - action='store', + action='store', dest='process_cmd', default='') p.add_option ('--pdf', @@ -253,6 +267,7 @@ LAYOUT = 'layout' LINE_WIDTH = 'line-width' LILYQUOTE = 'lilyquote' NOFRAGMENT = 'nofragment' +NOGETTEXT = 'nogettext' NOINDENT = 'noindent' NOQUOTE = 'noquote' NORAGGED_RIGHT = 'noragged-right' @@ -272,7 +287,6 @@ TEXIDOC = 'texidoc' TEXINFO = 'texinfo' VERBATIM = 'verbatim' VERSION = 'lilypondversion' -FONTLOAD = 'fontload' FILENAME = 'filename' ALT = 'alt' @@ -289,6 +303,9 @@ no_options = { # # (?Pregex) -- Assign result of REGEX to NAME. # *? -- Match non-greedily. +# (?!...) -- Match if `...' doesn't match next (without consuming +# the string). +# # (?m) -- Multiline regex: Make ^ and $ match at each line. # (?s) -- Make the dot match all characters including newline. # (?x) -- Ignore whitespace in patterns. @@ -302,17 +319,36 @@ snippet_res = { 'lilypond': r'''(?smx) (?P - <(?P(inline)?)mediaobject>\s*\s*.*?)")?>(?P.*?)\s*\s*)''', + <(?P(inline)?)mediaobject>\s* + \s* + .*?)")?> + (?P.*?) + \s* + \s* + )''', 'lilypond_block': r'''(?smx) (?P - <(?P(inline)?)mediaobject>\s*\s*.*?)")?>(?P.*?)\s*\s*)''', + <(?P(inline)?)mediaobject>\s* + \s* + .*?)")?> + (?P.*?) + \s* + \s* + )''', 'lilypond_file': r'''(?smx) (?P - <(?P(inline)?)mediaobject>\s*\s*.*?\.ly)"\s*(role="(?P.*?)")?\s*(/>|>\s*)\s*\s*)''', + <(?P(inline)?)mediaobject>\s* + \s* + |>\s*)\s* + \s* + )''', 'multiline_comment': r'''(?smx) @@ -328,11 +364,11 @@ snippet_res = { no_match, 'verbatim': - no_match, + no_match, 'lilypondversion': no_match, - }, + }, ## HTML: { 'include': @@ -544,13 +580,11 @@ snippet_res = { } - - format_res = { - DOCBOOK: { - 'intertext': r',?\s*intertext=\".*?\"', + DOCBOOK: { + 'intertext': r',?\s*intertext=\".*?\"', 'option_sep': '\s*', - }, + }, HTML: { 'intertext': r',?\s*intertext=\".*?\"', 'option_sep': '\s*', @@ -567,18 +601,19 @@ format_res = { }, } + # Options without a pattern in ly_options. simple_options = [ EXAMPLEINDENT, FRAGMENT, NOFRAGMENT, + NOGETTEXT, NOINDENT, PRINTFILENAME, DOCTITLE, TEXIDOC, LANG, VERBATIM, - FONTLOAD, FILENAME, ALT, ADDVERSION @@ -626,21 +661,37 @@ ly_options = { output = { ## - DOCBOOK: { - FILTER: r'''%(code)s''', - - OUTPUT: r''' - - - - - ''', - - VERBATIM: r'''%(verb)s''', - + DOCBOOK: { + FILTER: r''' + + +%(code)s + + +''', + + OUTPUT: r''' + + + + +''', + + VERBATIM: r''' +%(verb)s''', + VERSION: program_version, - - PRINTFILENAME: '%(filename)s' + + PRINTFILENAME: r''' + + + + %(filename)s + + + +''' }, ## HTML: { @@ -657,8 +708,10 @@ output = { ''', OUTPUT: r''' - %(alt)s''', + %(alt)s''', PRINTFILENAME: '

%(filename)s

', @@ -676,29 +729,29 @@ output = { ## LATEX: { OUTPUT: r'''{%% -\parindent 0pt%% -\ifx\preLilyPondExample \undefined%% - \relax%% -\else%% - \preLilyPondExample%% -\fi%% +\parindent 0pt +\ifx\preLilyPondExample \undefined +\else + \expandafter\preLilyPondExample +\fi \def\lilypondbook{}%% -\input %(base)s-systems.tex%% -\ifx\postLilyPondExample \undefined%% - \relax%% -\else%% - \postLilyPondExample%% -\fi%% +\input %(base)s-systems.tex +\ifx\postLilyPondExample \undefined +\else + \expandafter\postLilyPondExample +\fi }''', PRINTFILENAME: '''\\texttt{%(filename)s} - ''', +''', - QUOTE: r'''\begin{quotation}%(str)s + QUOTE: r'''\begin{quotation} +%(str)s \end{quotation}''', VERBATIM: r'''\noindent -\begin{verbatim}%(verb)s\end{verbatim}''', +\begin{verbatim}%(verb)s\end{verbatim} +''', VERSION: program_version, @@ -727,7 +780,9 @@ output = {

%(alt)s + border="0" + src="%(image)s" + alt="%(alt)s">

@end html @@ -782,14 +837,12 @@ PREAMBLE_LY = '''%%%% Generated by %(program_name)s %% **************************************************************** -%% Start cut-&-pastable-section +%% Start cut-&-pastable-section %% **************************************************************** %(preamble_string)s \paper { - #(define dump-extents #t) - %(font_dump_setting)s %(paper_string)s force-assignment = #"" line-width = #(- line-width (* mm %(padding_mm)f)) @@ -864,7 +917,7 @@ def find_file (name, raise_error=True): full = os.path.join (i, name) if os.path.exists (full): return full - + if raise_error: error (_ ("file not found: %s") % name + '\n') exit (1) @@ -892,15 +945,16 @@ def verb_ly_gettext (s): return s s = ly_comment_re.sub (lambda m: ly_comment_gettext (t, m), s) - - for v in ly_var_def_re.findall (s): - s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v, - "\\1" + t (v) + "\\2", - s) - for id in ly_context_id_re.findall (s): - s = re.sub (r'(\s+|")%s(\s+|")' % id, - "\\1" + t (id) + "\\2", - s) + + if langdefs.LANGDICT[document_language].enable_ly_identifier_l10n: + for v in ly_var_def_re.findall (s): + s = re.sub (r"(?m)(^|[' \\#])%s([^a-zA-Z])" % v, + "\\1" + t (v) + "\\2", + s) + for id in ly_context_id_re.findall (s): + s = re.sub (r'(\s+|")%s(\s+|")' % id, + "\\1" + t (id) + "\\2", + s) return s texinfo_lang_re = re.compile ('(?m)^@documentlanguage (.*?)( |$)') @@ -938,7 +992,7 @@ class Chunk: def is_plain (self): return False - + class Substring (Chunk): """A string that does not require extra memory.""" def __init__ (self, source, start, end, line_number): @@ -947,7 +1001,7 @@ class Substring (Chunk): self.end = end self.line_number = line_number self.override_text = None - + def is_plain (self): return True @@ -993,7 +1047,12 @@ class LilypondSnippet (Snippet): self.do_options (os, self.type) def verb_ly (self): - return verb_ly_gettext (self.substring ('code')) + verb_text = self.substring ('code') + if not NOGETTEXT in self.option_dict: + verb_text = verb_ly_gettext (verb_text) + if not verb_text.endswith ('\n'): + verb_text += '\n' + return verb_text def ly (self): contents = self.substring ('code') @@ -1072,13 +1131,16 @@ class LilypondSnippet (Snippet): if not INDENT in self.option_dict: self.option_dict[INDENT] = '0\\mm' - # The QUOTE pattern from ly_options only emits the `line-width' - # keyword. - if has_line_width and QUOTE in self.option_dict: - if no_line_width_value: - del self.option_dict[LINE_WIDTH] - else: - del self.option_dict[QUOTE] + # Set a default line-width if there is none. We need this, because + # lilypond-book has set left-padding by default and therefore does + # #(define line-width (- line-width (* 3 mm))) + # TODO: Junk this ugly hack if the code gets rewritten to concatenate + # all settings before writing them in the \paper block. + if not LINE_WIDTH in self.option_dict: + if not QUOTE in self.option_dict: + if not LILYQUOTE in self.option_dict: + self.option_dict[LINE_WIDTH] = "#(- paper-width \ +left-margin-default right-margin-default)" def compose_ly (self, code): if FRAGMENT in self.option_dict: @@ -1178,9 +1240,6 @@ class LilypondSnippet (Snippet): notes_string = '\n '.join (compose_dict[NOTES]) % vars () preamble_string = '\n '.join (compose_dict[PREAMBLE]) % override padding_mm = global_options.padding_mm - font_dump_setting = '' - if FONTLOAD in self.option_dict: - font_dump_setting = '#(define-public force-eps-font-include #t)\n' d = globals().copy() d.update (locals()) @@ -1188,11 +1247,19 @@ class LilypondSnippet (Snippet): def get_checksum (self): if not self.checksum: - hash = md5.md5 (self.relevant_contents (self.full_ly ())) + # Work-around for md5 module deprecation warning in python 2.5+: + try: + from hashlib import md5 + except ImportError: + from md5 import md5 + + # We only want to calculate the hash based + # on the snippet code, not the snippet + preamble + hash = md5 (self.relevant_contents (self.ly ())) ## let's not create too long names. self.checksum = hash.hexdigest ()[:10] - + return self.checksum def basename (self): @@ -1211,7 +1278,8 @@ class LilypondSnippet (Snippet): file (path + '.txt', 'w').write ('image of music') def relevant_contents (self, ly): - return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n', '', ly) + return re.sub (r'\\(version|sourcefileline|sourcefilename)[^\n]*\n|' + + NOGETTEXT + '[,\]]', '', ly) def link_all_output_files (self, output_dir, output_dir_files, destination): existing, missing = self.all_output_files (output_dir, output_dir_files) @@ -1231,7 +1299,7 @@ class LilypondSnippet (Snippet): os.makedirs (dst_path) os.link (src, dst) - + def all_output_files (self, output_dir, output_dir_files): """Return all files generated in lily_output_dir, a set. @@ -1244,7 +1312,7 @@ class LilypondSnippet (Snippet): def consider_file (name): if name in output_dir_files: result.add (name) - + def require_file (name): if name in output_dir_files: result.add (name) @@ -1299,14 +1367,14 @@ class LilypondSnippet (Snippet): # markups do not output a signature. if 'ddump-signature' in global_options.process_cmd: consider_file (systemfile + '.signature') - - + + return (result, missing) - + def is_outdated (self, output_dir, current_files): found, missing = self.all_output_files (output_dir, current_files) return missing - + def filter_text (self): """Run snippet bodies through a command (say: convert-ly). @@ -1331,14 +1399,14 @@ class LilypondSnippet (Snippet): single = '%(base)s.png' % vars () multiple = '%(base)s-page1.png' % vars () images = (single,) - if (os.path.exists (multiple) + if (os.path.exists (multiple) and (not os.path.exists (single) or (os.stat (multiple)[stat.ST_MTIME] > os.stat (single)[stat.ST_MTIME]))): count = ps_page_count ('%(base)s.eps' % vars ()) images = ['%s-page%d.png' % (base, page) for page in range (1, count+1)] images = tuple (images) - + return images def output_docbook (self): @@ -1347,8 +1415,8 @@ class LilypondSnippet (Snippet): for image in self.get_images (): (base, ext) = os.path.splitext (image) str += output[DOCBOOK][OUTPUT] % vars () - str += self.output_print_filename (DOCBOOK) - if (self.substring('inline') == 'inline'): + str += self.output_print_filename (DOCBOOK) + if (self.substring('inline') == 'inline'): str = '' + str + '' else: str = '' + str + '' @@ -1356,7 +1424,7 @@ class LilypondSnippet (Snippet): verb = verbatim_html (self.verb_ly ()) str = output[DOCBOOK][VERBATIM] % vars () + str return str - + def output_html (self): str = '' base = self.basename () @@ -1407,7 +1475,7 @@ class LilypondSnippet (Snippet): if 0: breaks = self.ly ().count ("\n") str += "".ljust (breaks, "\n").replace ("\n","%\n") - + if QUOTE in self.option_dict: str = output[LATEX][QUOTE] % vars () return str @@ -1428,9 +1496,9 @@ class LilypondSnippet (Snippet): doctitle = base + '.doctitle' translated_doctitle = doctitle + document_language if os.path.exists (translated_doctitle): - str += '@lydoctitle %s\n' % open (translated_doctitle).read () + str += '@lydoctitle %s\n\n' % open (translated_doctitle).read () elif os.path.exists (doctitle): - str += '@lydoctitle %s\n' % open (doctitle).read () + str += '@lydoctitle %s\n\n' % open (doctitle).read () if TEXIDOC in self.option_dict: texidoc = base + '.texidoc' translated_texidoc = texidoc + document_language @@ -1475,7 +1543,11 @@ class LilypondFileSnippet (LilypondSnippet): s = self.contents s = re_begin_verbatim.split (s)[-1] s = re_end_verbatim.split (s)[0] - return verb_ly_gettext (s) + if not NOGETTEXT in self.option_dict: + s = verb_ly_gettext (s) + if not s.endswith ('\n'): + s += '\n' + return s def ly (self): name = self.substring ('filename') @@ -1540,7 +1612,7 @@ def find_toplevel_snippets (input_string, format, types): for type in types: if not found[type] or found[type][0] < index: found[type] = None - + m = res[type].search (input_string[index:endex]) if not m: continue @@ -1559,8 +1631,8 @@ def find_toplevel_snippets (input_string, format, types): found[type] = (start, snip) - if (found[type] - and (not first + if (found[type] + and (not first or found[type][0] < found[first][0])): first = type @@ -1593,7 +1665,7 @@ def find_toplevel_snippets (input_string, format, types): def filter_pipe (input, cmd): """Pass input through cmd, and return the result.""" - + if global_options.verbose: progress (_ ("Opening filter `%s'") % cmd) @@ -1628,13 +1700,13 @@ def system_in_directory (cmd, directory): Because of win32 compatibility, we can't simply use subprocess. """ - + current = os.getcwd() os.chdir (directory) - ly.system(cmd, be_verbose=global_options.verbose, + ly.system(cmd, be_verbose=global_options.verbose, progress_p=1) os.chdir (current) - + def process_snippets (cmd, snippets, format, lily_output_dir): @@ -1642,14 +1714,14 @@ def process_snippets (cmd, snippets, if not snippets: return - + if format in (HTML, TEXINFO) and '--formats' not in cmd: cmd += ' --formats=png ' elif format in (DOCBOOK) and '--formats' not in cmd: cmd += ' --formats=png,pdf ' checksum = snippet_list_checksum (snippets) - contents = '\n'.join (['snippet-map-%d.ly' % checksum] + contents = '\n'.join (['snippet-map-%d.ly' % checksum] + [snip.basename() + '.ly' for snip in snippets]) name = os.path.join (lily_output_dir, 'snippet-names-%d.ly' % checksum) @@ -1657,8 +1729,8 @@ def process_snippets (cmd, snippets, system_in_directory (' '.join ([cmd, ly.mkarg (name)]), lily_output_dir) - - + + ### # Retrieve dimensions from LaTeX LATEX_INSPECTION_DOCUMENT = r''' @@ -1676,13 +1748,13 @@ def get_latex_textwidth (source): m = re.search (r'''(?P\\begin\s*{document})''', source) if m == None: warning (_ ("cannot find \\begin{document} in LaTeX document")) - + ## what's a sensible default? return 550.0 - + preamble = source[:m.start (0)] latex_document = LATEX_INSPECTION_DOCUMENT % vars () - + (handle, tmpfile) = tempfile.mkstemp('.tex') logfile = os.path.splitext (tmpfile)[0] + '.log' logfile = os.path.split (logfile)[1] @@ -1690,26 +1762,26 @@ def get_latex_textwidth (source): tmp_handle = os.fdopen (handle,'w') tmp_handle.write (latex_document) tmp_handle.close () - + ly.system ('%s %s' % (global_options.latex_program, tmpfile), be_verbose=global_options.verbose) parameter_string = file (logfile).read() - + os.unlink (tmpfile) os.unlink (logfile) columns = 0 - m = re.search ('columns=([0-9.]*)', parameter_string) + m = re.search ('columns=([0-9.]+)', parameter_string) if m: columns = int (m.group (1)) columnsep = 0 - m = re.search ('columnsep=([0-9.]*)pt', parameter_string) + m = re.search ('columnsep=([0-9.]+)pt', parameter_string) if m: columnsep = float (m.group (1)) textwidth = 0 - m = re.search ('textwidth=([0-9.]*)pt', parameter_string) + m = re.search ('textwidth=([0-9.]+)pt', parameter_string) if m: textwidth = float (m.group (1)) if columns: @@ -1725,7 +1797,7 @@ def modify_preamble (chunk): r"\\usepackage{graphics}" + '\n' + r"\\begin{document}", str) - chunk.override_text = str + chunk.override_text = str format2ext = { @@ -1773,8 +1845,8 @@ def do_process_cmd (chunks, input_name, options): output_files = split_output_files (options.lily_output_dir) outdated = [c for c in snippets if c.is_outdated (options.lily_output_dir, output_files)] - - write_file_map (outdated, input_name) + + write_file_map (outdated, input_name) progress (_ ("Writing snippets...")) for snippet in outdated: snippet.write_ly() @@ -1893,15 +1965,15 @@ def do_file (input_filename, included=False): global_options.output_dir = os.getcwd() else: global_options.output_dir = os.path.abspath(global_options.output_dir) - + if not os.path.isdir (global_options.output_dir): os.mkdir (global_options.output_dir, 0777) os.chdir (global_options.output_dir) output_filename = os.path.join(global_options.output_dir, input_base + format2ext[global_options.format]) - if (os.path.exists (input_filename) - and os.path.exists (output_filename) + if (os.path.exists (input_filename) + and os.path.exists (output_filename) and samefile (output_filename, input_fullname)): error ( _ ("Output would overwrite input file; use --output.")) @@ -1949,7 +2021,7 @@ def do_file (input_filename, included=False): write_if_updated (output_filename, [s.replacement_text () for s in chunks]) - + def process_include (snippet): os.chdir (original_dir) name = snippet.substring ('filename') @@ -1962,7 +2034,7 @@ def do_file (input_filename, included=False): chunks)) return chunks + reduce (lambda x, y: x + y, include_chunks, []) - + except CompileError: os.chdir (original_dir) progress (_ ("Removing `%s'") % output_filename) @@ -1978,14 +2050,14 @@ def do_options (): global_options.format = TEXINFO global_options.include_path = map (os.path.abspath, global_options.include_path) - + if global_options.warranty: warranty () exit (0) if not args or len (args) > 1: opt_parser.print_help () exit (2) - + return args def main (): @@ -1994,7 +2066,7 @@ def main (): basename = os.path.splitext (files[0])[0] basename = os.path.split (basename)[1] - + if not global_options.format: global_options.format = guess_format (files[0]) @@ -2003,7 +2075,7 @@ def main (): formats += ',png' if global_options.process_cmd == '': - global_options.process_cmd = (lilypond_binary + global_options.process_cmd = (lilypond_binary + ' --formats=%s -dbackend=eps ' % formats) if global_options.process_cmd: @@ -2020,13 +2092,13 @@ def main (): global_options.process_cmd += ' --formats=eps ' if global_options.create_pdf: global_options.process_cmd += "--pdf -dinclude-eps-fonts -dgs-load-fonts " - + if global_options.verbose: global_options.process_cmd += " --verbose " if global_options.padding_mm: global_options.process_cmd += " -deps-box-padding=%f " % global_options.padding_mm - + global_options.process_cmd += " -dread-file-list -dno-strip-output-dir" if global_options.lily_output_dir: @@ -2035,7 +2107,7 @@ def main (): os.makedirs (global_options.lily_output_dir) else: global_options.lily_output_dir = os.path.abspath(global_options.output_dir) - + identify () try: @@ -2051,7 +2123,7 @@ def main (): final_output_file = os.path.join (global_options.output_dir, base_file_name + '.%s' % global_options.format) - + os.chdir (original_dir) file (dep_file, 'w').write ('%s: %s' % (final_output_file, ' '.join (inputs)))