]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/lilypond-book.py
* flower/string.cc (Module): excise flower array & string
[lilypond.git] / scripts / lilypond-book.py
index 116d5a07ca1e5346754f38f4e26002fe57aad2fb..c6fdb3ab00217d6ce4898c3fdeff2790503b0d03 100644 (file)
@@ -17,7 +17,7 @@ TODO:
     *  this script is too complex. Modularize.
     
     *  ly-options: intertext?
-    *  --linewidth?
+    *  --line-width?
     *  eps in latex / eps by lilypond -b ps?
     *  check latex parameters, twocolumn, multicolumn?
     *  use --png --ps --pdf for making images?
@@ -33,6 +33,7 @@ import glob
 import stat
 import string
 import tempfile
+import commands
 
 # Users of python modules should include this snippet
 # and customize variables below.
@@ -50,7 +51,9 @@ if os.environ.has_key ('LILYPONDPREFIX'):
        datadir = os.environ['LILYPONDPREFIX']
        while datadir[-1] == os.sep:
                datadir= datadir[:-1]
-
+               
+       datadir = os.path.join (datadir, "share/lilypond/current/")
+       
 sys.path.insert (0, os.path.join (datadir, 'python'))
 
 # Customize these.
@@ -96,8 +99,11 @@ option_definitions = [
        (_ ("COMMAND"), 'P', 'process',
          _ ("process ly_files using COMMAND FILE...")),
        ('', '', 'psfonts',
-        _ ('''extract all PostScript fonts into INPUT.psfonts for LaTeX
-        must use this with dvips -h INPUT.psfonts''')),
+         _ ('''extract all PostScript fonts into INPUT.psfonts for LaTeX
+         must use this with dvips -h INPUT.psfonts''')),
+       ('', '', 'keep-line-breaks',
+         _ ('''do not alter the number of newline characters in output
+         .tex files. Useful when the LaTeX package srcltx is used''')),
        ('', 'V', 'verbose',
          _ ("be verbose")),
        ('', 'v', 'version',
@@ -114,10 +120,10 @@ if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
        lilypond_binary = 'lilypond'
 
 psfonts_p = 0
+srcltx_p = 0
 use_hash_p = 1
 format = 0
 output_name = ''
-latex_filter_cmd = 'cat > %(tmpfile)s && latex "\\nonstopmode \input %(tmpfile)s" && rm %(tmpfile)s'
 filter_cmd = 0
 process_cmd = ''
 default_ly_options = { 'alt': "[image of music]" }
@@ -134,7 +140,7 @@ HTML = 'html'
 INDENT = 'indent'
 LATEX = 'latex'
 LAYOUT = 'layout'
-LINEWIDTH = 'linewidth'
+LINE_WIDTH = 'line-width'
 NOFRAGMENT = 'nofragment'
 NOINDENT = 'noindent'
 NOQUOTE = 'noquote'
@@ -147,7 +153,7 @@ PAPER = 'paper'
 PREAMBLE = 'preamble'
 PRINTFILENAME = 'printfilename'
 QUOTE = 'quote'
-RAGGEDRIGHT = 'raggedright'
+RAGGED_RIGHT = 'ragged-right'
 RELATIVE = 'relative'
 STAFFSIZE = 'staffsize'
 TEXIDOC = 'texidoc'
@@ -409,11 +415,11 @@ ly_options = {
        PAPER: {
                INDENT: r'''indent = %(indent)s''',
 
-               LINEWIDTH: r'''linewidth = %(linewidth)s''',
+               LINE_WIDTH: r'''line-width = %(line-width)s''',
 
-               QUOTE: r'''linewidth = %(linewidth)s - 2.0 * %(exampleindent)s''',
+               QUOTE: r'''line-width = %(line-width)s - 2.0 * %(exampleindent)s''',
 
-               RAGGEDRIGHT: r'''raggedright = ##t''',
+               RAGGED_RIGHT: r'''ragged-right = ##t''',
 
                PACKED: r'''packed = ##t''',
        },
@@ -469,7 +475,7 @@ output = {
 
        ##
        LATEX: {
-               OUTPUT: r'''{%%
+               OUTPUT: r'''{
 \parindent 0pt
 \catcode`\@=12
 \ifx\preLilyPondExample \undefined
@@ -477,7 +483,7 @@ output = {
 \else
   \preLilyPondExample
 \fi
-\def\lilypondbook{}%%
+\def\lilypondbook{}
 \input %(base)s-systems.tex
 \ifx\postLilyPondExample \undefined
   \relax
@@ -489,15 +495,11 @@ output = {
                PRINTFILENAME: '''\\texttt{%(filename)s}
        ''',
 
-               QUOTE: r'''\begin{quotation}
-%(str)s
-\end{quotation}
-''',
+               QUOTE: r'''\begin{quotation}%(str)s
+\end{quotation}''',
 
                VERBATIM: r'''\noindent
-\begin{verbatim}
-%(verb)s\end{verbatim}
-''',
+\begin{verbatim}%(verb)s\end{verbatim}''',
 
                FILTER: r'''\begin{lilypond}[%(options)s]
 %(code)s
@@ -548,23 +550,29 @@ output = {
        },
 }
 
-PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
+PREAMBLE_LY = '''%%%% Generated by %(program_name)s
 %%%% Options: [%(option_string)s]
 
 #(set! toplevel-score-handler print-score-with-defaults)
-#(set! toplevel-music-handler (lambda (p m)
-                              (print-score-with-defaults
-                               p (scorify-music m p))))
+#(set! toplevel-music-handler
+  (lambda (p m)
+   (if (not (eq? (ly:music-property m \'void) #t))
+        (print-score-with-defaults
+         p (scorify-music m p)))))
 
 #(ly:set-option (quote no-point-and-click))
-
+#(define inside-lilypond-book #t)
 #(define version-seen? #t)
 %(preamble_string)s
 
 
-%% ********************************
+
+
+
+
+%% ****************************************************************
 %% Start cut-&-pastable-section 
-%% ********************************
+%% ****************************************************************
 
 \paper {
   #(define dump-extents #t)
@@ -580,19 +588,35 @@ PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
 FRAGMENT_LY = r'''
 %(notes_string)s
 {
+
+
+%% ****************************************************************
 %% ly snippet contents follows:
+%% ****************************************************************
 %(code)s
+
+
+%% ****************************************************************
 %% end ly snippet
+%% ****************************************************************
 }
 '''
 
 FULL_LY = '''
+
+
+%% ****************************************************************
 %% ly snippet:
+%% ****************************************************************
 %(code)s
+
+
+%% ****************************************************************
 %% end ly snippet
+%% ****************************************************************
 '''
 
-texinfo_linewidths = {
+texinfo_line_widths = {
        '@afourpaper': '160\\mm',
        '@afourwide': '6.5\\in',
        '@afourlatex': '150\\mm',
@@ -602,7 +626,7 @@ texinfo_linewidths = {
 
 def classic_lilypond_book_compatibility (key, value):
        if key == 'singleline' and value == None:
-               return (RAGGEDRIGHT, None)
+               return (RAGGED_RIGHT, None)
 
        m = re.search ('relative\s*([-0-9])', key)
        if m:
@@ -612,7 +636,7 @@ def classic_lilypond_book_compatibility (key, value):
        if m:
                return ('staffsize', m.group (1))
 
-       if key == 'indent' or key == 'linewidth':
+       if key == 'indent' or key == 'line-width':
                m = re.match ('([-.0-9]+)(cm|in|mm|pt|staffspace)', value)
                if m:
                        f = float (m.group (1))
@@ -652,17 +676,17 @@ def split_options (option_string):
        return []
 
 def invokes_lilypond ():
-       return re.search ('^[\'\"0-9A-Za-z/]*lilypond', process_cmd)
+       return re.search ('^[\'\"0-9A-Za-z/.]*lilypond', process_cmd)
 
 def set_default_options (source):
        global default_ly_options
-       if not default_ly_options.has_key (LINEWIDTH):
+       if not default_ly_options.has_key (LINE_WIDTH):
                if format == LATEX:
                        textwidth = get_latex_textwidth (source)
-                       default_ly_options[LINEWIDTH] = \
+                       default_ly_options[LINE_WIDTH] = \
                          '''%.0f\\pt''' % textwidth
                elif format == TEXINFO:
-                       for (k, v) in texinfo_linewidths.items ():
+                       for (k, v) in texinfo_line_widths.items ():
                                # FIXME: @layout is usually not in
                                # chunk #0:
                                #
@@ -672,7 +696,7 @@ def set_default_options (source):
                                # source.
                                # s = chunks[0].replacement_text ()
                                if re.search (k, source[:1024]):
-                                       default_ly_options[LINEWIDTH] = v
+                                       default_ly_options[LINE_WIDTH] = v
                                        break
 
 class Chunk:
@@ -688,15 +712,25 @@ class Chunk:
        def png_is_outdated (self):
                return 0
 
+       def is_plain (self):
+               return False
+       
 class Substring (Chunk):
        def __init__ (self, source, start, end, line_number):
                self.source = source
                self.start = start
                self.end = end
                self.line_number = line_number
+               self.override_text = None
+               
+       def is_plain (self):
+               return True
 
        def replacement_text (self):
-               return self.source[self.start:self.end]
+               if self.override_text:
+                       return self.override_text
+               else:
+                       return self.source[self.start:self.end]
 
 class Snippet (Chunk):
        def __init__ (self, type, match, format, line_number):
@@ -758,42 +792,42 @@ class Lilypond_snippet (Snippet):
                                else:
                                        self.option_dict[i] = None
 
-               has_linewidth = self.option_dict.has_key (LINEWIDTH)
-               no_linewidth_value = 0
+               has_line_width = self.option_dict.has_key (LINE_WIDTH)
+               no_line_width_value = 0
 
-               # If LINEWIDTH is used without parameter, set it to default.
-               if has_linewidth and self.option_dict[LINEWIDTH] == None:
-                       no_linewidth_value = 1
-                       del self.option_dict[LINEWIDTH]
+               # If LINE_WIDTH is used without parameter, set it to default.
+               if has_line_width and self.option_dict[LINE_WIDTH] == None:
+                       no_line_width_value = 1
+                       del self.option_dict[LINE_WIDTH]
 
                for i in default_ly_options.keys ():
                        if i not in self.option_dict.keys ():
                                self.option_dict[i] = default_ly_options[i]
 
-               if not has_linewidth:
+               if not has_line_width:
                        if type == 'lilypond' or FRAGMENT in self.option_dict.keys ():
-                               self.option_dict[RAGGEDRIGHT] = None
+                               self.option_dict[RAGGED_RIGHT] = None
 
                        if type == 'lilypond':
-                               if LINEWIDTH in self.option_dict.keys ():
-                                       del self.option_dict[LINEWIDTH]
+                               if LINE_WIDTH in self.option_dict.keys ():
+                                       del self.option_dict[LINE_WIDTH]
                        else:
-                               if RAGGEDRIGHT in self.option_dict.keys ():
-                                       if LINEWIDTH in self.option_dict.keys ():
-                                               del self.option_dict[LINEWIDTH]
+                               if RAGGED_RIGHT in self.option_dict.keys ():
+                                       if LINE_WIDTH in self.option_dict.keys ():
+                                               del self.option_dict[LINE_WIDTH]
 
                        if QUOTE in self.option_dict.keys () or type == 'lilypond':
-                               if LINEWIDTH in self.option_dict.keys ():
-                                       del self.option_dict[LINEWIDTH]
+                               if LINE_WIDTH in self.option_dict.keys ():
+                                       del self.option_dict[LINE_WIDTH]
 
                if not INDENT in self.option_dict.keys ():
                        self.option_dict[INDENT] = '0\\mm'
 
-               # The QUOTE pattern from ly_options only emits the `linewidth'
+               # The QUOTE pattern from ly_options only emits the `line-width'
                # keyword.
-               if has_linewidth and QUOTE in self.option_dict.keys ():
-                       if no_linewidth_value:
-                               del self.option_dict[LINEWIDTH]
+               if has_line_width and QUOTE in self.option_dict.keys ():
+                       if no_line_width_value:
+                               del self.option_dict[LINE_WIDTH]
                        else:
                                del self.option_dict[QUOTE]
 
@@ -830,7 +864,7 @@ class Lilypond_snippet (Snippet):
                # To set @exampleindent locally to zero, we use the @format
                # environment for non-quoted snippets.
                override[EXAMPLEINDENT] = r'0.4\in'
-               override[LINEWIDTH] = texinfo_linewidths['@smallbook']
+               override[LINE_WIDTH] = texinfo_line_widths['@smallbook']
                override.update (default_ly_options)
 
                option_list = []
@@ -954,9 +988,20 @@ class Lilypond_snippet (Snippet):
                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'))
+                       ok = ok and os.path.exists (base + '.eps')
+
+                       page_count = 0
+                       if ok:
+                               page_count = ly.ps_page_count (base + '.eps')
+                       
+                       if page_count == 1:
+                               ok = ok and os.path.exists (base + '.png')
+                       elif page_count > 1:
+                               for a in range (1, page_count + 1):
+                                               ok = ok and os.path.exists (base + '-page%d.png' % a)
+                               
                return not ok
+       
        def texstr_is_outdated (self):
                if backend == 'ps':
                        return 0
@@ -990,7 +1035,9 @@ class Lilypond_snippet (Snippet):
                   and (not os.path.exists (single) \
                        or (os.stat (multiple)[stat.ST_MTIME] \
                            > os.stat (single)[stat.ST_MTIME])):
-                       images = glob.glob ('%(base)s-page*.png' % vars ())
+                       count = ly.ps_page_count ('%(base)s.eps' % vars ())
+                       images = ['%s-page%d.png' % (base, a) for a in range (1, count+1)]
+                       images = tuple (images)
                return images
 
        def output_html (self):
@@ -1035,10 +1082,12 @@ class Lilypond_snippet (Snippet):
                        if VERBATIM in self.option_dict:
                                verb = self.substring ('code')
                                str += (output[LATEX][VERBATIM] % vars ())
-                       if QUOTE in self.option_dict:
-                               str = output[LATEX][QUOTE] % vars ()
-
+                       elif srcltx_p:
+                               breaks = self.ly ().count ("\n")
+                               str += "".ljust (breaks, "\n").replace ("\n","%\n")
                str += (output[LATEX][OUTPUT] % vars ())
+               if QUOTE in self.option_dict:
+                       str = output[LATEX][QUOTE] % vars ()
                return str
 
        def output_print_filename (self, format):
@@ -1088,7 +1137,7 @@ class Lilypond_snippet (Snippet):
 class Lilypond_file_snippet (Lilypond_snippet):
        def ly (self):
                name = self.substring ('filename')
-               return '\\renameinput \"%s\"\n%s' \
+               return '\\sourcefilename \"%s\"\n%s' \
                         % (name, open (find_file (name)).read ())
 
 snippet_type_to_class = {
@@ -1254,7 +1303,7 @@ def process_snippets (cmd, ly_snippets, texstr_snippets, png_snippets):
        # UGH
        # the --process=CMD switch is a bad idea
        # it is too generic for lilypond-book.
-       if texstr_names and invokes_lilypond:
+       if texstr_names and invokes_lilypond ():
                my_system (string.join ([cmd, '--backend texstr',
                                         'snippet-map.ly'] + texstr_names))
                for l in texstr_names:
@@ -1263,7 +1312,8 @@ def process_snippets (cmd, ly_snippets, texstr_snippets, png_snippets):
        if ly_names:
                my_system (string.join ([cmd, 'snippet-map.ly'] + ly_names))
 
-LATEX_DOCUMENT = r'''
+LATEX_INSPECTION_DOCUMENT = r'''
+\nonstopmode
 %(preamble)s
 \begin{document}
 \typeout{textwidth=\the\textwidth}
@@ -1276,12 +1326,16 @@ LATEX_DOCUMENT = r'''
 def get_latex_textwidth (source):
        m = re.search (r'''(?P<preamble>\\begin\s*{document})''', source)
        preamble = source[:m.start (0)]
-       latex_document = LATEX_DOCUMENT % vars ()
+       latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
        # Workaround problems with unusable $TMP on Cygwin:
        tempfile.tempdir = ''
        tmpfile = tempfile.mktemp('.tex')
-       cmd = latex_filter_cmd % vars ()
-       parameter_string = filter_pipe (latex_document, cmd)
+       logfile = os.path.splitext (tmpfile)[0] + '.log'
+       open (tmpfile,'w').write (latex_document)
+       ly.system ('latex %s' % tmpfile)
+       parameter_string = open (logfile).read()
+       os.unlink (tmpfile)
+       os.unlink (logfile)
 
        columns = 0
        m = re.search ('columns=([0-9.]*)', parameter_string)
@@ -1302,6 +1356,18 @@ def get_latex_textwidth (source):
 
        return textwidth
 
+def modify_preamble (chunk):
+       str = chunk.replacement_text ()
+       if (re.search (r"\\begin *{document}", str)
+           and not re.search ("{graphic[sx]", str)):
+               str = re.sub (r"\\begin{document}",
+                             r"\\usepackage{graphics}" + '\n'
+                             + r"\\begin{document}",
+                             str)
+               chunk.override_text = str 
+               
+       
+
 ext2format = {
        '.html': HTML,
        '.itely': TEXINFO,
@@ -1464,6 +1530,13 @@ def do_file (input_filename):
                )
                ly.progress (_ ("Dissecting..."))
                chunks = find_toplevel_snippets (source, snippet_types)
+
+               if format == LATEX:
+                       for c in chunks:
+                               if (c.is_plain () and
+                                   re.search (r"\\begin *{document}", c.replacement_text())):
+                                       modify_preamble (c)
+                                       break
                ly.progress ('\n')
 
                if filter_cmd:
@@ -1499,7 +1572,7 @@ def do_file (input_filename):
                raise Compile_error
 
 def do_options ():
-       global format, output_name, psfonts_p
+       global format, output_name, psfonts_p, srcltx_p
        global filter_cmd, process_cmd, verbose_p
 
        (sh, long) = ly.getopt_args (option_definitions)
@@ -1545,6 +1618,10 @@ def do_options ():
                        verbose_p = 1
                elif o == '--psfonts':
                        psfonts_p = 1 
+               elif o == '--keep-line-breaks':
+                       srcltx_p = 1 
+                       for s in (OUTPUT, QUOTE, VERBATIM):
+                               output[LATEX][s] = output[LATEX][s].replace("\n"," ")
                elif o == '--warranty' or o == '-w':
                        if 1 or status:
                                ly.warranty ()
@@ -1574,7 +1651,7 @@ def main ():
                              + ' --formats=%s --backend eps ' % formats
 
        if process_cmd:
-               process_cmd += string.join ([(' -I %s' % p)
+               process_cmd += string.join ([(' -I %s' % commands.mkarg (p))
                                             for p in include_path])
 
        ly.identify (sys.stderr)