X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scripts%2Flilypond-book.py;h=44ba8e60ff15636d74f967c1c2b3a70483f303fc;hb=c6d314f038629a7054e72b6212bd5b8b7bba2d2c;hp=587879a50aebe828f7ff70d55d4a56aafbb20a80;hpb=998869243e58c9ae1d3c855e9c3b05c620859860;p=lilypond.git
diff --git a/scripts/lilypond-book.py b/scripts/lilypond-book.py
index 587879a50a..44ba8e60ff 100644
--- a/scripts/lilypond-book.py
+++ b/scripts/lilypond-book.py
@@ -1,12 +1,6 @@
#!@PYTHON@
'''
-TODO:
- ly-options: intertext, quote ?
- --linewidth?
- eps in latex?
- check latex parameters, twocolumn, multicolumn?
-
Example usage:
test:
@@ -16,18 +10,31 @@ convert-ly on book:
lilypond-book --filter="convert-ly --no-version --from=1.6.11 -" BOOK
classic lilypond-book:
- lilypond-book --process="lilypond-bin" BOOK.tely
+ lilypond-book --process="lilypond" BOOK.tely
+
+TODO:
+ * ly-options: intertext ?
+ * --linewidth?
+ * eps in latex / eps by lilypond -fps ?
+ * check latex parameters, twocolumn, multicolumn?
+
+ * Converting from lilypond-book source, substitute:
+ @mbinclude foo.itely -> @include foo.itely
+ \mbinput -> \input
- must substitute:
- @mbinclude foo.itely -> @include foo.itely
- \mbinput -> \input
-
'''
import __main__
import glob
+import stat
import string
+#
+# TODO:
+#
+# * use --png --ps --pdf for making images?
+#
+
################################################################
# Users of python modules should include this snippet
# and customize variables below.
@@ -60,17 +67,18 @@ global re;re = ly.re
# lilylib globals
program_version = '@TOPLEVEL_VERSION@'
-program_name = 'lilypond-book'
+program_name = sys.argv[0]
verbose_p = 0
pseudo_filter_p = 0
original_dir = os.getcwd ()
-help_summary = _ ("""Process LilyPond snippets in hybrid HTML, LaTeX or texinfo document. Example usage:
+help_summary = _ ("""Process LilyPond snippets in hybrid HTML, LaTeX or texinfo document.
+Example usage:
lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK
lilypond-book --filter="convert-ly --no-version --from=2.0.0 -" BOOK
- lilypond-book --process='lilypond-bin -I include' BOOK
+ lilypond-book --process='lilypond -I include' BOOK
""")
@@ -90,11 +98,11 @@ option_definitions = [
]
include_path = [ly.abspath (os.getcwd ())]
-lilypond_binary = os.path.join ('@bindir@', 'lilypond-bin')
+lilypond_binary = os.path.join ('@bindir@', 'lilypond')
# only use installed binary when we're installed too.
if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
- lilypond_binary = 'lilypond-bin'
+ lilypond_binary = 'lilypond'
use_hash_p = 1
@@ -102,21 +110,31 @@ format = 0
output_name = 0
latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
filter_cmd = 0
-process_cmd = lilypond_binary
+process_cmd = ''
default_ly_options = {}
+#
+# is this pythonic? Personally, I find this rather #define-nesque. --hwn
+#
AFTER = 'after'
BEFORE = 'before'
+BOOKPAPER = 'bookpaper'
+EXAMPLEINDENT = 'exampleindent'
+FILTER = 'filter'
FRAGMENT = 'fragment'
HTML = 'html'
+INDENT = 'indent'
LATEX = 'latex'
LINEWIDTH = 'linewidth'
NOFRAGMENT = 'nofragment'
+NOINDENT = 'noindent'
NOTES = 'body'
+NOTIME = 'notime'
OUTPUT = 'output'
PAPER = 'paper'
PREAMBLE = 'preamble'
PRINTFILENAME = 'printfilename'
+QUOTE = 'quote'
RAGGEDRIGHT = 'raggedright'
RELATIVE = 'relative'
STAFFSIZE = 'staffsize'
@@ -185,32 +203,48 @@ format_res = {
ly_options = {
NOTES: {
- RELATIVE: r'''\relative c%(relative_quotes)s''',
+ RELATIVE: r'''\relative c%(relative_quotes)s''',
},
- PAPER: {
- 'indent' : r'''
+ BOOKPAPER: {
+ INDENT : r'''
indent = %(indent)s''',
'linewidth' : r'''
linewidth = %(linewidth)s''',
- 'noindent' : r'''
- indent = 0.0\mm''',
- 'notime' : r'''
+ NOINDENT : r'''
+ indent = 0.0\mm''',
+ QUOTE : r'''
+ linewidth = %(linewidth)s - 2.0 * %(exampleindent)s
+''',
+ RAGGEDRIGHT : r'''
+ indent = 0.0\mm
+ raggedright = ##t''',
+ },
+
+ ##
+ PAPER: {
+ EXAMPLEINDENT : '',
+
+ NOTIME : r'''
\context {
- \StaffContext
+ \Staff
\remove Time_signature_engraver
}''',
- RAGGEDRIGHT : r'''
- indent = 0.0\mm
- raggedright = ##t''',
},
+
+ ##
PREAMBLE: {
- STAFFSIZE: r'''
+ STAFFSIZE: r'''
#(set-global-staff-size %(staffsize)s)''',
- },
+ },
}
output = {
HTML : {
+ FILTER: r'''
+%(code)s
+
+''',
+
AFTER: r'''
''',
@@ -221,6 +255,10 @@ output = {
![[image of music]](%(image)s)
''',
PRINTFILENAME:'%(filename)s
',
+ QUOTE: r'''
+%(str)s
+
+''',
VERBATIM: r'''
%(verb)s
''',
},
@@ -230,45 +268,71 @@ output = {
BEFORE: '',
OUTPUT: r'''{\parindent 0pt
\catcode`\@=12
-\ifx\preLilyPondExample\preLilyPondExample\fi
+\ifx\preLilyPondExample\undefined\relax\else\preLilyPondExample\fi
\def\lilypondbook{}
\input %(base)s.tex
-\ifx\preLilyPondExample\postLilyPondExample\fi
+\ifx\postLilyPondExample\undefined\relax\else\postLilyPondExample\fi
\catcode`\@=0}''',
PRINTFILENAME: '''\\texttt{%(filename)s}
''',
- VERBATIM: r'''\begin{verbatim}
+ QUOTE: r'''\begin{quotation}
+%(str)s
+\end{quotation}
+''',
+ VERBATIM: r'''\noindent
+\begin{verbatim}
%(verb)s\end{verbatim}
''',
+ FILTER: r'''\begin{lilypond}[%(options)s]
+%(code)s
+\end{lilypond}''',
},
TEXINFO : {
+ FILTER: r'''@lilypond[%(options)s]
+%(code)s
+@lilypond''',
AFTER: '',
BEFORE: '',
- OUTPUT: r'''
- @image{%(base)s,,,[image of music],%(ext)s}
+ OUTPUT: r'''@noindent
+@image{%(base)s,,,[image of music],%(ext)s}
''',
PRINTFILENAME: '''@file{%(filename)s}
''',
- VERBATIM: r'''@example
+ QUOTE: r'''@quotation
+%(str)s
+@end quotation
+''',
+ # FIXME: @exampleindent 5 is the default...
+ VERBATIM: r'''@exampleindent 0
+@example
%(verb)s@end example
+@exampleindent 5
''',
},
}
-PREAMBLE_LY = r'''%% Generated by %(program_name)s
-%% Options: [%(option_string)s]
+PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
+%%%% Options: [%(option_string)s]
+#(set! toplevel-score-handler ly:parser-print-score)
+#(set! toplevel-music-handler (lambda (p m)
+ (ly:parser-print-score
+ p (ly:music-scorify m p))
+ ))
%(preamble_string)s
-\paper {%(paper_string)s
+\bookpaper {%(bookpaper_string)s
+}
+\paper { %(paper_string)s
}
+
'''
-FRAGMENT_LY = r'''\score{
- \notes%(notes_string)s{
+FRAGMENT_LY = r'''
+ %(notes_string)s{
%(code)s }
-}'''
+'''
FULL_LY = '%(code)s'
texinfo_linewidths = {
@@ -288,11 +352,11 @@ def classic_lilypond_book_compatibility (o):
m = re.match ('([0-9]+)pt', o)
if m:
return 'staffsize=%s' % m.group (1)
- m = re.match ('indent=([-.0-9]+)(cm|in|mm|pt)', o)
+ m = re.match ('indent=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
if m:
f = float (m.group (1))
return 'indent=%f\\%s' % (f, m.group (2))
- m = re.match ('linewidth=([-.0-9]+)(cm|in|mm|pt)', o)
+ m = re.match ('linewidth=([-.0-9]+)(cm|in|mm|pt|staffspace)', o)
if m:
f = float (m.group (1))
return 'linewidth=%f\\%s' % (f, m.group (2))
@@ -304,9 +368,11 @@ def compose_ly (code, options):
if i not in options:
options.append (i)
- m = re.search (r'''\\score''', code)
- if not m and (not options \
- or not NOFRAGMENT in options or FRAGMENT in options):
+ #Hmm
+ if QUOTE in options and LINEWIDTH in options:
+ options.remove (LINEWIDTH)
+
+ if FRAGMENT in options:
if RAGGEDRIGHT not in options:
options.append (RAGGEDRIGHT)
body = FRAGMENT_LY
@@ -314,15 +380,20 @@ def compose_ly (code, options):
body = FULL_LY
# defaults
- relative = 0
+ relative = 1
staffsize = 16
override = {}
override.update (default_ly_options)
+ #FIXME: where to get sane value for exampleindent?
+ override[EXAMPLEINDENT] = r'9.0 \mm'
option_string = string.join (options, ',')
- notes_options = []
- paper_options = []
- preamble_options = []
+
+ options_dict = {}
+ option_types = [NOTES, PREAMBLE, PAPER, BOOKPAPER]
+ for a in option_types:
+ options_dict[a] = []
+
for i in options:
c = classic_lilypond_book_compatibility (i)
if c:
@@ -336,17 +407,19 @@ def compose_ly (code, options):
override[key] = value
else:
key = i
- if i not in override.keys ():
+ if not override.has_key (i):
override[i] = None
- if key in ly_options[NOTES].keys ():
- notes_options.append (ly_options[NOTES][key])
- elif key in ly_options[PREAMBLE].keys ():
- preamble_options.append (ly_options[PREAMBLE][key])
- elif key in ly_options[PAPER].keys ():
- paper_options.append (ly_options[PAPER][key])
- elif key not in (FRAGMENT, NOFRAGMENT, PRINTFILENAME,
- RELATIVE, VERBATIM, TEXIDOC):
+ found = 0
+ for type in option_types:
+ if ly_options[type].has_key (key):
+
+ options_dict[type].append (ly_options[type][key])
+ found = 1
+ break
+
+ if not found and key not in (FRAGMENT, NOFRAGMENT, PRINTFILENAME,
+ RELATIVE, VERBATIM, TEXIDOC):
ly.warning (_("ignoring unknown ly option: %s") % i)
#URGS
@@ -357,18 +430,21 @@ def compose_ly (code, options):
# 1 = central C
if relative < 0:
- relative_quotes += ',' * (- relative - 1)
+ relative_quotes += ',' * (- relative)
elif relative > 0:
relative_quotes += "'" * relative
program_name = __main__.program_name
- paper_string = string.join (paper_options, '\n ') % override
- preamble_string = string.join (preamble_options, '\n ') % override
- notes_string = string.join (notes_options, '\n ') % vars ()
+
+ paper_string = string.join (options_dict[PAPER], '\n ') % override
+ bookpaper_string = string.join (options_dict[BOOKPAPER], '\n ') % override
+ notes_string = string.join (options_dict[NOTES], '\n ') % vars ()
+ preamble_string = string.join (options_dict[PREAMBLE], '\n ') % override
return (PREAMBLE_LY + body) % vars ()
+
# BARF
-# use lilypond-bin for latex (.lytex) books,
+# use lilypond for latex (.lytex) books,
# and lilypond --preview for html, texinfo books?
def to_eps (file):
cmd = r'latex "\nonstopmode \input %s"' % file
@@ -376,15 +452,32 @@ def to_eps (file):
# Redirect to stderr
cmd = '(( %s >&2 ) >&- )' % cmd
ly.system (cmd)
- ly.system ('dvips -Ppdf -u+lilypond.map -E -o %s.eps %s' \
+ ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -E -o %s.eps %s' \
% (file, file))
+
+ # check if it really is EPS.
+ # Otherwise music glyphs disappear from 2nd and following pages.
+
+ # TODO: should run dvips -pp -E per page, then we get proper
+ # cropping as well.
+
+ f = open ('%s.eps' % file)
+ for x in range(0,10) :
+ if re.search ("^%%Pages: ", f.readline ()):
+
+ # make non EPS.
+ ly.system ('dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map -o %s.eps %s' \
+ % (file, file))
+ break
+
+
def find_file (name):
for i in include_path:
full = os.path.join (i, name)
if os.path.exists (full):
return full
- ly.error (_ ('file not found: %s\n' % name))
+ ly.error (_ ('file not found: %s') % name + '\n')
ly.exit (1)
return ''
@@ -405,8 +498,15 @@ def split_options (option_string):
class Chunk:
def replacement_text (self):
return ''
+
+ def filter_text (self):
+ return self.replacement_text ()
+
+
+ def ly_is_outdated (self):
+ return 0
- def is_outdated (self):
+ def png_is_outdated (self):
return 0
class Substring (Chunk):
@@ -432,9 +532,6 @@ class Snippet (Chunk):
def substring (self, s):
return self.match.group (s)
- def filter_code (self):
- pass # todo
-
def __repr__ (self):
return `self.__class__` + " type = " + self.type
@@ -457,19 +554,15 @@ class Lilypond_snippet (Snippet):
self.options = split_options (os)
def ly (self):
- if self.type == 'lilypond_file':
- name = self.substring ('filename')
- return '\\renameinput \"%s\"\n' % name\
- + open (find_file (name)).read ()
- else:
- return self.substring ('code')
+ return self.substring ('code')
def full_ly (self):
s = self.ly ()
if s:
return compose_ly (s, self.options)
return ''
-
+
+ # todo: use md5?
def get_hash (self):
if not self.hash:
self.hash = abs (hash (self.full_ly ()))
@@ -483,22 +576,43 @@ class Lilypond_snippet (Snippet):
def write_ly (self):
outf = open (self.basename () + '.ly', 'w')
outf.write (self.full_ly ())
+
+ open (self.basename() + '.txt', 'w').write("image of music")
+
- def is_outdated (self):
+ def ly_is_outdated (self):
base = self.basename ()
- ## FIXME: adding PNG to is_outdated test fixes
- ## interrupted (web) builds.
- ## should only do this if PNG is actually target
- if os.path.exists (base + '.ly') \
- and os.path.exists (base + '.tex') \
- and os.path.exists (base + '.png') \
- and (use_hash_p \
- or self.ly () == open (base + '.ly').read ()):
+
+ tex_file = '%s.tex' % base
+ ly_file = '%s.ly' % base
+ ok = os.path.exists (ly_file) and os.path.exists (tex_file)\
+ and os.stat (tex_file)[stat.ST_SIZE] \
+ and open (tex_file).readlines ()[-1][1:-1] \
+ == 'lilypondend'
+
+ if ok and (use_hash_p or self.ly () == open (ly_file).read ()):
# TODO: something smart with target formats
# (ps, png) and m/ctimes
return None
return self
+ def png_is_outdated (self):
+ base = self.basename ()
+ ok = self.ly_is_outdated ()
+ if format == HTML or format == TEXINFO:
+ ok = ok and (os.path.exists (base + '.png')
+ or glob.glob (base + '-page*.png'))
+ return not ok
+
+ def filter_text (self):
+ code = self.substring ('code')
+ s = run_filter (code)
+ d = {'code' : s,
+ 'options': self.match.group ('options')
+ }
+ # TODO
+ return output[self.format][FILTER] % d
+
def replacement_text (self):
func = Lilypond_snippet.__dict__ ['output_' + self.format]
return func (self)
@@ -517,12 +631,15 @@ class Lilypond_snippet (Snippet):
return images
def output_html (self):
- str = self.output_print_filename (HTML)
+ str = ''
base = self.basename ()
if format == HTML:
+ str += self.output_print_filename (HTML)
if VERBATIM in self.options:
verb = verbatim_html (self.substring ('code'))
str += write (output[HTML][VERBATIM] % vars ())
+ if QUOTE in self.options:
+ str = output[HTML][QUOTE] % vars ()
str += output[HTML][BEFORE] % vars ()
for image in self.get_images ():
@@ -536,6 +653,7 @@ class Lilypond_snippet (Snippet):
str = output[TEXINFO][BEFORE] % vars ()
for image in self.get_images ():
base, ext = os.path.splitext (image)
+
# URG, makeinfo implicitely prepends dot to ext
# specifying no extension is most robust
ext = ''
@@ -544,12 +662,16 @@ class Lilypond_snippet (Snippet):
return str
def output_latex (self):
- str = self.output_print_filename (LATEX)
+ str = ''
base = self.basename ()
if format == LATEX:
+ str += self.output_print_filename (LATEX)
if VERBATIM in self.options:
verb = self.substring ('code')
str += (output[LATEX][VERBATIM] % vars ())
+ if QUOTE in self.options:
+ str = output[LATEX][QUOTE] % vars ()
+
str += (output[LATEX][BEFORE]
+ (output[LATEX][OUTPUT] % vars ())
+ output[LATEX][AFTER])
@@ -565,26 +687,40 @@ class Lilypond_snippet (Snippet):
def output_texinfo (self):
str = ''
+ # self.output_print_filename (TEXINFO)
+ str += ('@html\n' + self.output_print_filename (HTML)
+ + '\n@end html\n')
+ str += ('@tex\n' + self.output_print_filename (LATEX)
+ + '\n@end tex\n')
base = self.basename ()
if TEXIDOC in self.options:
texidoc = base + '.texidoc'
if os.path.exists (texidoc):
- str += '@include %(texidoc)s\n' % vars ()
+ str += '@include %(texidoc)s\n\n' % vars ()
- if VERBATIM in self.options:
+ if VERBATIM in self.options:
verb = verbatim_texinfo (self.substring ('code'))
str += (output[TEXINFO][VERBATIM] % vars ())
str += ('@ifinfo\n' + self.output_info () + '\n@end ifinfo\n')
str += ('@tex\n' + self.output_latex () + '\n@end tex\n')
str += ('@html\n' + self.output_html () + '\n@end html\n')
+
+ if QUOTE in self.options:
+ str = output[TEXINFO][QUOTE] % vars ()
+
# need par after image
str += '\n'
return str
+
+class Lilypond_file_snippet (Lilypond_snippet):
+ def ly (self):
+ name = self.substring ('filename')
+ return '\\renameinput \"%s\"\n%s' % (name, open (find_file (name)).read ())
snippet_type_to_class = {
- 'lilypond_file' : Lilypond_snippet,
+ 'lilypond_file' : Lilypond_file_snippet,
'lilypond_block' : Lilypond_snippet,
'lilypond' : Lilypond_snippet,
'include' : Include_snippet,
@@ -687,16 +823,31 @@ def filter_pipe (input, cmd):
def run_filter (s):
return filter_pipe (s, filter_cmd)
-def process_snippets (cmd, snippets):
- names = filter (lambda x: x, map (Lilypond_snippet.basename, snippets))
- if names:
- ly.system (string.join ([cmd] + names))
+def is_derived_class (cl, baseclass):
+ if cl == baseclass:
+ return 1
+ for b in cl.__bases__:
+ if is_derived_class (b, baseclass):
+ return 1
+ return 0
+
+
+def process_snippets (cmd, ly_snippets, png_snippets):
+ ly_names = filter (lambda x: x, map (Lilypond_snippet.basename, ly_snippets))
+ png_names = filter (lambda x: x, map (Lilypond_snippet.basename, png_snippets))
+
+ if ly_names:
+ ly.system (string.join ([cmd] + ly_names), progress_p = 1)
if format == HTML or format == TEXINFO:
- for i in names:
- if os.path.exists (i + '.tex'):
+ for i in png_names:
+ if not os.path.exists (i + '.eps') and os.path.exists (i + '.tex'):
to_eps (i)
ly.make_ps_images (i + '.eps', resolution=110)
+
+# elif os.path.exists (i + '.ps'):
+# ly.make_ps_images (i + '.ps', resolution=110)
+
LATEX_DOCUMENT = r'''
%(preamble)s
@@ -827,7 +978,7 @@ def do_file (input_filename):
global default_ly_options
textwidth = 0
- if LINEWIDTH not in default_ly_options.keys ():
+ if not default_ly_options.has_key (LINEWIDTH):
if format == LATEX:
textwidth = get_latex_textwidth (source)
default_ly_options[LINEWIDTH] = '''%.0f\\pt''' \
@@ -843,17 +994,22 @@ def do_file (input_filename):
break
if filter_cmd:
- pass # todo
+ output_file.writelines ([c.filter_text () for c in chunks])
+
+
elif process_cmd:
- outdated = filter (lambda x: x.__class__ == Lilypond_snippet \
- and x.is_outdated (), chunks)
+ ly_outdated = filter (lambda x: is_derived_class (x.__class__, Lilypond_snippet) \
+ and x.ly_is_outdated (), chunks)
+ png_outdated = filter (lambda x: is_derived_class (x.__class__, Lilypond_snippet) \
+ and x.png_is_outdated (), chunks)
+
ly.progress (_ ("Writing snippets..."))
- map (Lilypond_snippet.write_ly, outdated)
+ map (Lilypond_snippet.write_ly, ly_outdated)
ly.progress ('\n')
- if outdated:
+ if ly_outdated:
ly.progress (_ ("Processing..."))
- process_snippets (process_cmd, outdated)
+ process_snippets (process_cmd, ly_outdated, png_outdated)
else:
ly.progress (_ ("All snippets are up to date..."))
ly.progress ('\n')
@@ -871,7 +1027,7 @@ def do_file (input_filename):
do_file (name)
map (process_include,
- filter (lambda x: x.__class__ == Include_snippet, chunks))
+ filter (lambda x: is_derived_class (x.__class__, Include_snippet), chunks))
def do_options ():
global format, output_name
@@ -927,6 +1083,9 @@ def do_options ():
def main ():
files = do_options ()
global process_cmd
+ if process_cmd == '':
+ process_cmd = lilypond_binary + " -f tex "
+
if process_cmd:
process_cmd += string.join ([(' -I %s' % p)
for p in include_path])