]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/lilypond-book.py
* scripts/lilypond-book.py (do_file): put texidoc before image.
[lilypond.git] / scripts / lilypond-book.py
index b336e921dea0ac560d4a33196c407d9762ac7140..e9a133338e511b4a609acb71ce54f9839a0a7d75 100644 (file)
@@ -1,40 +1,54 @@
 #!@PYTHON@
 # vim: set noexpandtab:
-# TODO:
-# * junk --outdir for--output
-# * Figure out clean set of options.
-# *
-# * texinfo: add support for @pagesize
 
-# todo: dimension handling (all the x2y) is clumsy. (tca: Thats
-#       because the values are taken directly from texinfo.tex,
-#       geometry.sty and article.cls. Give me a hint, and I'll
-#       fix it.)
+"""
 
-#
-# TODO: magnification support should also work for texinfo -> html: eg. add as option to dvips.
-#
+  TODO:
+  * junk --outdir for--output
+  * Figure out clean set of options.
+  *
+  * texinfo: add support for @pagesize
 
+  todo: dimension handling (all the x2y) is clumsy. (tca: Thats
+        because the values are taken directly from texinfo.tex,
+        geometry.sty and article.cls. Give me a hint, and I'll
+        fix it.)
 
-#
-# This is a slightly hairy program. The general approach is as follows 
-# The input string is chopped up in chunks, i.e. ,  a list of tuples
-#
-#   with the format  (TAG_STR, MAIN_STR, OPTIONS, TODO, BASE)
-#
-# This list is build step by step: first ignore and verbatim commands are handled,
-# delivering a list of chunks.
-# 
-# then all chunks containing lilypnod commands are chopped up
-#
-# when all chunks have their final form, all bodies from lilypond blocks are 
-# extracted, and if applicable, written do disk and run through lilypond.
-# 
 
+  TODO: magnification support should also work for texinfo -> html: eg. add as option to dvips.
+
+
+
+  This is a slightly hairy program. The general approach is as follows 
+  The input string is chopped up in chunks, i.e. ,  a list of tuples
+
+    with the format  (TAG_STR, MAIN_STR, OPTIONS, TODO, BASE)
+
+  This list is built step by step: first ignore and verbatim commands
+  are handled, delivering a list of chunks.
+  
+  then all chunks containing lilypond commands are chopped up
 
-# This is was the idea for handling of comments:
+  when all chunks have their final form, all bodies from lilypond blocks are 
+  extracted, and if applicable, written do disk and run through lilypond.
+  
 
+tags supported
 
+  ignore
+  lilypond
+  input
+  verb
+  verbatim
+  multicols
+  numcols
+  
+
+
+
+"""
+
+#  This is was the idea for handling of comments:
 #      Multiline comments, @ignore .. @end ignore is scanned for
 #      in read_doc_file, and the chunks are marked as 'ignore', so
 #      lilypond-book will not touch them any more. The content of the
@@ -54,7 +68,7 @@
 #      The the rest of the rexeces are searched for. They don't have to test
 #      if they are on a commented out line.
 
-
+import glob
 import stat
 import string
 
@@ -121,7 +135,6 @@ option_definitions = [
        ('', 'n', 'no-lily', _ ("don't run lilypond")),
        ('', '', 'no-pictures', _ ("don't generate pictures")),
        ('', '', 'no-music', _ ("strip all lilypond blocks from output")),
-       ('', '', 'read-lys', _ ("don't write ly files.")),
        (_ ("FILE"), 'o', 'outname', _ ("filename main output file")),
        (_ ("FILE"), '', 'outdir', _ ("where to place generated files")),
        (_ ('RES'), '', 'preview-resolution',
@@ -161,7 +174,6 @@ g_here_dir = os.getcwd ()
 g_dep_prefix = ''
 g_outdir = ''
 g_force_music_fontsize = 0
-g_read_lys = 0
 g_do_pictures = 1
 g_do_music = 1
 g_make_html = 0
@@ -341,9 +353,6 @@ output_dict= {
 
        'html' : {
 
-               'output-lilypond': '''<lilypond%s>
-%s
-</lilypond>''',
                'output-filename' : r'''
 <!-- %s >
 <a href="%s">
@@ -369,9 +378,7 @@ output_dict= {
                ## inline music doesn't.
                ## possibly other center options?
                'output-html': r'''
-<a href="%(fn)s.png">
-<img align="center" valign="center" border="0" src="%(fn)s.png" alt="[picture of music]"></a>
-''',
+%(pageimages)s''',
                },
 
 
@@ -388,10 +395,7 @@ output_dict= {
 %% %s
 %% %s
 ''',
-               'output-lilypond': r'''\begin[%s]{lilypond}
-%s
-\end{lilypond}
-''',
+
                # verbatim text is always finished with \n
                'output-verbatim': r'''\begin{verbatim}
 %s\end{verbatim}
@@ -420,11 +424,9 @@ output_dict= {
 
        'texi' : {
 
-               'output-lilypond': '''@lilypond[%s]
-%s
-@end lilypond
-''',
-               'output-filename' : r'''@ifnothtml
+
+               'output-filename' : r'''
+@ifnothtml
 @file{%s}:@*
 @end ifnothtml
 @ifhtml
@@ -457,9 +459,8 @@ output_dict= {
 \catcode`\@=0
 @end tex
 @html
-<p><a href="%(fn)s.png">
-<img border=0 src="%(fn)s.png" alt="[picture of music]">
-</a><p>
+<p>%(htmlimages)s
+<p>
 @end html
 ''',
                'output-texi-quoted': r'''@quotation
@@ -470,9 +471,8 @@ output_dict= {
 \catcode`\@=0
 @end tex
 @html
-<a href="%(fn)s.png">
-<img border=0 src="%(fn)s.png" alt="[picture of music]">
-</a>
+<p>%(htmlimages)s
+<p>
 @end html
 @end quotation
 ''',
@@ -567,7 +567,7 @@ re_dict = {
                'verb': r'''(?P<code>@code{.*?})''',
                'lilypond-file': '(?m)^(?P<match>@lilypondfile(\[(?P<options>[^]]*)\])?{(?P<filename>[^}]+)})',
                'lilypond' : '(?m)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?{(?P<code>.*?)})',
-               'lilypond-block': r'''(?ms)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?\s(?P<code>.*?)@end +lilypond)\s''',
+               'lilypond-block': r'''(?ms)^(?P<match>@lilypond(\[(?P<options>[^]]*)\])?\s(?P<code>.*?)@end lilypond)\s''',
                'option-sep' : ',\s*',
                'intertext': r',?\s*intertext=\".*?\"',
                'multiline-comment': r"(?sm)^\s*(?!@c\s+)(?P<code>@ignore\s.*?@end ignore)\s",
@@ -671,9 +671,9 @@ def compose_full_body (body, opts):
        if is_fragment and not 'multiline' in opts:
                opts.append ('singleline')
 
-       if 'singleline' in opts:
+       if 'raggedright' in opts or  'singleline' in opts:
                if not linewidth:
-                       linewidth = 'linewidth = -1.0'
+                       linewidth = 'raggedright = ##t'
                if not indent:
                        indent = 'indent = 0.0\mm'
        elif not linewidth:
@@ -897,14 +897,15 @@ def make_lilypond_file (m):
        '''
 
        if m.group ('options'):
-               options = m.group ('options')
+               options = get_re ('option-sep').split (m.group ('options'))
        else:
-               options = ''
+               options = []
        (content, nm) = find_file (m.group ('filename'))
-       options = "filename=%s," % nm + options
+       options.append ("filename=%s" % nm)
+
 
-       return [('input', get_output ('output-lilypond') %
-                       (options, content))]
+       return [('lilypond', content, options)]
+       
 
 def make_ly2dvi_block (m):
        '''
@@ -970,6 +971,12 @@ def chop_chunks (chunks, re_name, func, use_match=0):
        return newchunks
 
 def determine_format (str):
+       """
+
+       SIDE EFFECT! This sets FORMAT and PAPERGURU
+
+       """
+       
        global format
        if format == '':
                html = re.search ('(?i)<[dh]tml', str[:200])
@@ -1029,14 +1036,16 @@ def unique_file_name (body):
 
 def schedule_lilypond_block (chunk):
        '''Take the body and options from CHUNK, figure out how the
-       real .ly should look, and what should be left MAIN_STR (meant
-       for the main file).  The .ly is written, and scheduled in
+       real .ly should look.  The .ly is written, and scheduled in
        TODO.
 
-       Return: a chunk (TYPE_STR, MAIN_STR, OPTIONS, TODO, BASE)
+       Return: a single chunk.
 
-       TODO has format [basename, extension, extension, ... ]
+       The chunk pertaining to the lilypond output
+       has the format (TYPE_STR, MAIN_STR, OPTIONS, TODO, BASE), 
+       where TODO has format [basename, extension, extension, ... ]
        '''
+
        (type, body, opts) = chunk
        assert type == 'lilypond'
        file_body = compose_full_body (body, opts)
@@ -1053,8 +1062,7 @@ def schedule_lilypond_block (chunk):
                        else:
                                taken_file_names[basename] = taken_file_names[basename] + 1
                                basename = basename + "-%i" % taken_file_names[basename]
-       if not g_read_lys:
-               update_file (file_body, os.path.join (g_outdir, basename) + '.ly')
+       update_file (file_body, os.path.join (g_outdir, basename) + '.ly')
        needed_filetypes = ['tex']
 
        if format == 'html' or g_make_html:
@@ -1079,20 +1087,46 @@ def schedule_lilypond_block (chunk):
                todo.append ('eps')
        if 'png' in needed_filetypes and f (pathbase, '.eps', '.png'):
                todo.append ('png')
-       newbody = ''
 
+       return ('lilypond', body, opts, todo, basename)
+
+def format_lilypond_block (chunk):
+       """
+       
+       Figure out  what should be left MAIN_STR (meant
+       for the main file) from a lilypond chunk: process
+       verbatim, and other options. Return: multiple chunks.
+
+       
+       """
+
+       
+       return_chunks = []
+
+       (type, body, opts, todo, basename) = chunk
+       assert type == 'lilypond'
+
+
+       newbody = ''
+       filename_chunk = None 
        if 'printfilename' in opts:
                for o in opts:
                        m= re.match ("filename=(.*)", o)
                        if m:
-                               newbody = newbody + get_output ("output-filename") % (m.group (1), basename + '.ly', m.group (1))
+                               template = get_output ("output-filename")
+                               b =  basename + '.ly'
+                               human_base = os.path.basename (m.group (1))
+                                                 
+                               ## todo: include path, but strip 
+                               ## first part of the path.
+                               filename_chunk = ('input',  template % (human_base, b,human_base))
                                break
 
 
        if 'smallverbatim' in opts:
-               newbody = newbody + output_verbatim (body, 1)
+               newbody += output_verbatim (body, 1)
        elif 'verbatim' in opts:
-               newbody = newbody + output_verbatim (body, 0)
+               newbody += output_verbatim (body, 0)
 
        for o in opts:
                m = re.search ('intertext="(.*?)"', o)
@@ -1110,20 +1144,62 @@ def schedule_lilypond_block (chunk):
                if 'eps' in opts:
                        s = 'output-eps'
                else:
-                       if 'noquote' in opts:
-                               s = 'output-latex-noquote'
-                       else:
+                       if 'quote' in opts:
                                s = 'output-latex-quoted'
+                       else:
+                               s = 'output-latex-noquote'
        elif format == 'texi':
-               if 'noquote' in opts:
-                       s = 'output-texi-noquote'
-               else:
+               if 'quote' in opts:
                        s = 'output-texi-quoted'
+               else:
+                       s = 'output-texi-noquote'
        else: # format == 'html'
                s = 'output-html'
-       newbody = newbody + get_output (s) % {'fn': basename }
-       return ('lilypond', newbody, opts, todo, basename)
 
+       def html_pages (basename):
+               pat = os.path.join (g_outdir, "%s-page*.png"%  basename)
+               
+               files =  glob.glob (pat)
+               
+               
+               template = '''<img align="center" valign="center"
+               border="0" src="%s" alt="[picture of music]">'''
+
+               str = ''
+               if  files == []:
+                       files = [basename+'.png' ]
+               else:
+                       files = map (os.path.basename, files)
+                       
+               for f in  files:
+                       str += template % f
+
+               str = '<a href="%s.ly">%s</a>' % (basename, str)
+
+               return str
+
+       
+       newbody = newbody + get_output (s) % {'fn': basename,
+                                             'htmlimages': html_pages(basename)
+                                             }
+
+       if filename_chunk:
+               return_chunks += [filename_chunk]
+       
+       return_chunks += [('lilypond', newbody, opts, todo, basename)]
+       
+       return return_chunks
+
+def format_lilypond_output_bodies (chunks):
+       newchunks = []
+       for c in chunks:
+
+               if c[0] == 'lilypond':
+                       newchunks += format_lilypond_block (c)
+               else:
+                       newchunks.append (c)
+
+       return newchunks
 
 
 
@@ -1137,7 +1213,9 @@ def process_lilypond_blocks (chunks):#ugh rename
                        paperguru.m_num_cols = c[2]
                elif c[0] == 'multicols':
                        paperguru.m_multicols = c[2]
+                       
                newchunks.append (c)
+               
        return newchunks
 
 def process_ly2dvi_blocks (chunks):
@@ -1164,11 +1242,14 @@ linking to the menu.
                changed = update_file (content, outname)
 
                preview = base + ".png"
-               if changed or not os.path.isfile (preview):
+               preview_page = base + '-page1.png'
+               
+               if changed or not (os.path.isfile (preview) or
+                                  os.path.isfile (preview_page)):
                        
                        ly.system ('%s --preview --postscript --verbose %s ' % (ly2dvi_binary, base) ) 
 
-                       ly.make_page_images (base)
+                       ly.make_ps_images (base)
                        ly.system ('gzip -9 - < %s.ps > %s.ps.gz' %  (base, base))
                        
                def size_str (fn):
@@ -1189,7 +1270,7 @@ linking to the menu.
                        }
 
                menu = ''
-               page_files = ly.read_pipe ('ls --color=no -1 %s-page*.png' % base)
+               page_files = glob.glob ('%s-page*.png' % base)
 
                for p in string.split (page_files, '\n'):
                        p = p.strip()
@@ -1250,6 +1331,7 @@ def compile_all_files (chunks):
        for c in chunks:
                if c[0] != 'lilypond':
                        continue
+
                base  = c[4]
                exts = c[3]
                for e in exts:
@@ -1309,7 +1391,7 @@ def compile_all_files (chunks):
                ly.system ("dvips -E -o %s.eps %s" % (file, file))
        map (to_eps, eps)
 
-       map (ly.make_preview, png)
+       map (ly.make_ps_images, map (lambda x: x + '.eps', png))
        os.chdir (d)
 
 
@@ -1340,29 +1422,20 @@ def write_deps (fn, target, chunks):
        f.write ('%s%s: ' % (g_dep_prefix, target))
        for d in read_files:
                f.write ('%s ' %  d)
-       basenames=[]
-        for c in chunks:
-               if c[0] == 'lilypond':
-                       (type, body, opts, todo, basename) = c;
-                       basenames.append (basename)
-       for d in basenames:
-               if g_outdir:
-                       d=g_outdir + '/' + d
-               if g_dep_prefix:
-                       #if not os.isfile (d): # thinko?
-                       if not re.search ('/', d):
-                               d = g_dep_prefix + d
-               f.write ('%s.tex ' %  d)
-       f.write ('\n')
-       #if len (basenames):
-       #       for d in basenames:
-       #               f.write ('%s.ly ' %  d)
-       #       f.write (' : %s' % target)
+
+
+       ## There used to be code to write .tex dependencies, but
+       ## that is silly: lilypond-book has its own dependency scheme
+       ## to ensure that all lily-XXX.tex files are there
+               
+
        f.write ('\n')
        f.close ()
        read_files = []
 
 def check_texidoc (chunks):
+       ## TODO: put file name in front of texidoc. 
+       ##
        n = []
         for c in chunks:
                if c[0] == 'lilypond':
@@ -1370,8 +1443,7 @@ def check_texidoc (chunks):
                        pathbase = os.path.join (g_outdir, basename)
                        if os.path.isfile (pathbase + '.texidoc') \
                           and 'notexidoc' not in opts:
-                               body = '\n@include %s.texidoc\n' % basename + body
-                               c = (type, body, opts, todo, basename)
+                               n.append( ('input', '\n@include %s.texidoc\n' % basename))
                n.append (c)
        return n
 
@@ -1416,9 +1488,7 @@ def do_file (input_filename):
        chunks = chop_chunks (chunks, 'preamble-end', do_preamble_end)
        chunks = chop_chunks (chunks, 'numcols', do_columns)
        chunks = chop_chunks (chunks, 'multicols', do_multicols)
-       #print "-" * 50
-       #for c in chunks: print "c:", c;
-       #sys.exit ()
+       
        scan_preamble (chunks)
        chunks = process_lilypond_blocks (chunks)
        chunks = process_ly2dvi_blocks (chunks)
@@ -1429,10 +1499,13 @@ def do_file (input_filename):
                compile_all_files (chunks)
                chunks = fix_epswidth (chunks)
 
+
+       chunks = format_lilypond_output_bodies (chunks)
        global format
        if format == 'texi':
                chunks = check_texidoc (chunks)
 
+
        x = 0
        chunks = completize_preamble (chunks)
 
@@ -1525,8 +1598,6 @@ for opt in options:
                g_do_pictures = 0
        elif o == '--no-music':
                g_do_music = 0
-       elif o == '--read-lys':
-               g_read_lys = 1
        elif o == '--outdir':
                g_outdir = a
        elif o == '--warranty' or o == '-w':
@@ -1550,6 +1621,7 @@ if not files:
 
 ly.setup_environment ()
 
+
 for input_filename in files:
        do_file (input_filename)