]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/lilypond-book.py
(main): use commands.mkarg () to quote
[lilypond.git] / scripts / lilypond-book.py
index 0592d020ad7c76926923fc7dcea6675ff2dfbc76..d349c29bc3e46fd1497ba820f2ee27ac2810c60c 100644 (file)
@@ -13,6 +13,9 @@ classic lilypond-book:
      lilypond-book --process="lilypond" BOOK.tely
 
 TODO:
+
+    *  this script is too complex. Modularize.
+    
     *  ly-options: intertext?
     *  --linewidth?
     *  eps in latex / eps by lilypond -b ps?
@@ -29,14 +32,14 @@ import __main__
 import glob
 import stat
 import string
+import tempfile
+import commands
 
 # Users of python modules should include this snippet
 # and customize variables below.
 
 # We'll suffer this path initialization stuff as long as we don't install
-# our python packages in <prefix>/lib/pythonX.Y (and don't kludge around
-# it as we do with teTeX on Red Hat Linux: set some environment variables
-# (PYTHONPATH) in `etc/profile').
+# our python packages in <prefix>/lib/pythonX.Y
 
 # If set, LILYPONDPREFIX must take prevalence.
 # if datadir is not set, we're doing a build and LILYPONDPREFIX.
@@ -48,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.
@@ -61,7 +66,7 @@ global re;re = ly.re
 
 # Lilylib globals.
 program_version = '@TOPLEVEL_VERSION@'
-program_name = sys.argv[0]
+program_name = os.path.basename (sys.argv[0])
 verbose_p = 0
 pseudo_filter_p = 0
 original_dir = os.getcwd ()
@@ -93,8 +98,9 @@ option_definitions = [
          _ ("write output to DIR")),
        (_ ("COMMAND"), 'P', 'process',
          _ ("process ly_files using COMMAND FILE...")),
-       (_('FILE'), '', 'psfonts',
-        _('extract all PS snippet fonts into FILE')),
+       ('', '', 'psfonts',
+        _ ('''extract all PostScript fonts into INPUT.psfonts for LaTeX
+        must use this with dvips -h INPUT.psfonts''')),
        ('', 'V', 'verbose',
          _ ("be verbose")),
        ('', 'v', 'version',
@@ -103,21 +109,20 @@ option_definitions = [
          _ ("show warranty and copyright")),
 ]
 
-include_path = [ly.abspath (os.getcwd ())]
+include_path = [os.path.abspath (os.getcwd ())]
 lilypond_binary = os.path.join ('@bindir@', 'lilypond')
 
 # Only use installed binary when we are installed too.
 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
        lilypond_binary = 'lilypond'
 
-psfonts_file = ''
+psfonts_p = 0
 use_hash_p = 1
 format = 0
-output_name = 0
-latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
+output_name = ''
 filter_cmd = 0
 process_cmd = ''
-default_ly_options = {}
+default_ly_options = { 'alt': "[image of music]" }
 
 #
 # Is this pythonic?  Personally, I find this rather #define-nesque. --hwn
@@ -151,6 +156,8 @@ TEXIDOC = 'texidoc'
 TEXINFO = 'texinfo'
 VERBATIM = 'verbatim'
 FONTLOAD = 'fontload'
+FILENAME = 'filename'
+ALT = 'alt'
 
 
 # NOTIME has no opposite so it isn't part of this dictionary.
@@ -389,7 +396,9 @@ simple_options = [
        PRINTFILENAME,
        TEXIDOC,
        VERBATIM,
-       FONTLOAD
+       FONTLOAD,
+       FILENAME,
+       ALT
 ]
 
 ly_options = {
@@ -413,7 +422,12 @@ ly_options = {
 
        ##
        LAYOUT: {
-               NOTIME: r'''\context {
+               NOTIME: r'''
+  \context {
+    \Score
+    timing = ##f
+  }
+  \context {
     \Staff
     \remove Time_signature_engraver
   }''',
@@ -442,7 +456,7 @@ output = {
 
                OUTPUT: r'''
     <img align="center" valign="center"
-        border="0" src="%(image)s" alt="[image of music]">''',
+        border="0" src="%(image)s" alt="%(alt)s">''',
 
                PRINTFILENAME: '<p><tt><a href="%(base)s.ly">%(filename)s</a></tt></p>',
 
@@ -506,13 +520,13 @@ output = {
 
                OUTPUTIMAGE: r'''@noindent
 @ifinfo
-@image{%(base)s,,,[image of music],%(ext)s}
+@image{%(base)s,,,%(alt)s,%(ext)s}
 @end ifinfo
 @html
 <p>
   <a href="%(base)s.ly">
     <img align="center" valign="center"
-        border="0" src="%(image)s" alt="[image of music]">
+        border="0" src="%(image)s" alt="%(alt)s">
   </a>
 </p>
 @end html
@@ -539,14 +553,25 @@ output = {
 PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
 %%%% Options: [%(option_string)s]
 
-#(set! toplevel-score-handler ly:parser-print-score)
+#(set! toplevel-score-handler print-score-with-defaults)
 #(set! toplevel-music-handler (lambda (p m)
-                              (ly:parser-print-score
-                               p (ly:music-scorify m p))))
+                              (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)
   %(font_dump_setting)s
@@ -561,16 +586,32 @@ 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 = {
@@ -622,10 +663,40 @@ def verbatim_texinfo (s):
 
 def split_options (option_string):
        if option_string:
-               return re.split (format_res[format]['option_sep'],
-                                option_string)
+               if format == HTML:
+                       options = re.findall('[\w\.-:]+(?:\s*=\s*(?:"[^"]*"|\'[^\']*\'|\S+))?',option_string)
+                       for i in range(len(options)):
+                               options[i] = re.sub('^([^=]+=\s*)(?P<q>["\'])(.*)(?P=q)','\g<1>\g<3>',options[i])
+                       return options
+               else:
+                       return re.split (format_res[format]['option_sep'],
+                                        option_string)
        return []
 
+def invokes_lilypond ():
+       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 format == LATEX:
+                       textwidth = get_latex_textwidth (source)
+                       default_ly_options[LINEWIDTH] = \
+                         '''%.0f\\pt''' % textwidth
+               elif format == TEXINFO:
+                       for (k, v) in texinfo_linewidths.items ():
+                               # FIXME: @layout is usually not in
+                               # chunk #0:
+                               #
+                               #  \input texinfo @c -*-texinfo-*-
+                               #
+                               # Bluntly search first K items of
+                               # source.
+                               # s = chunks[0].replacement_text ()
+                               if re.search (k, source[:1024]):
+                                       default_ly_options[LINEWIDTH] = v
+                                       break
+
 class Chunk:
        def replacement_text (self):
                return ''
@@ -645,9 +716,13 @@ class Substring (Chunk):
                self.start = start
                self.end = end
                self.line_number = line_number
+               self.override_text = None
 
        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):
@@ -682,8 +757,7 @@ class Lilypond_snippet (Snippet):
        def __init__ (self, type, match, format, line_number):
                Snippet.__init__ (self, type, match, format, line_number)
                os = match.group ('options')
-               if os:
-                       self.do_options (os, self.type)
+               self.do_options (os, self.type)
 
        def ly (self):
                return self.substring ('code')
@@ -871,6 +945,8 @@ class Lilypond_snippet (Snippet):
                return self.hash
 
        def basename (self):
+               if FILENAME in self.option_dict:
+                       return self.option_dict[FILENAME]
                if use_hash_p:
                        return 'lily-%d' % self.get_hash ()
                raise 'to be done'
@@ -892,8 +968,9 @@ class Lilypond_snippet (Snippet):
                     and os.path.exists (system_file)\
                     and os.stat (system_file)[stat.ST_SIZE] \
                     and re.match ('% eof', open (system_file).readlines ()[-1])
-               if ok and (use_hash_p \
-                          or self.ly () == open (ly_file).read ()):
+               if ok and (not use_hash_p or FILENAME in self.option_dict):
+                       ok = (self.full_ly () == open (ly_file).read ())
+               if ok:
                        # TODO: Do something smart with target formats
                        #       (ps, png) and m/ctimes.
                        return None
@@ -903,9 +980,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
@@ -939,7 +1027,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):
@@ -956,6 +1046,7 @@ class Lilypond_snippet (Snippet):
                str += output[HTML][BEFORE] % vars ()
                for image in self.get_images ():
                        (base, ext) = os.path.splitext (image)
+                       alt = self.option_dict[ALT]
                        str += output[HTML][OUTPUT] % vars ()
                str += output[HTML][AFTER] % vars ()
                return str
@@ -968,6 +1059,7 @@ class Lilypond_snippet (Snippet):
                        # URG, makeinfo implicitly prepends dot to extension.
                        # Specifying no extension is most robust.
                        ext = ''
+                       alt = self.option_dict[ALT]
                        str += output[TEXINFO][OUTPUTIMAGE] % vars ()
 
                base = self.basename ()
@@ -982,10 +1074,10 @@ 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 ()
 
                str += (output[LATEX][OUTPUT] % vars ())
+               if QUOTE in self.option_dict:
+                       str = output[LATEX][QUOTE] % vars ()
                return str
 
        def output_print_filename (self, format):
@@ -1201,8 +1293,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 re.search ('^[0-9A-Za-z/]*lilypond', cmd):
-
+       if texstr_names and invokes_lilypond:
                my_system (string.join ([cmd, '--backend texstr',
                                         'snippet-map.ly'] + texstr_names))
                for l in texstr_names:
@@ -1211,7 +1302,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}
@@ -1224,8 +1316,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 ()
-       parameter_string = filter_pipe (latex_document, latex_filter_cmd)
+       latex_document = LATEX_INSPECTION_DOCUMENT % vars ()
+       # Workaround problems with unusable $TMP on Cygwin:
+       tempfile.tempdir = ''
+       tmpfile = tempfile.mktemp('.tex')
+       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)
@@ -1246,6 +1346,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"\\RequirePackage{graphics}" + '\n'
+                             + r"\\begin{document}",
+                             str)
+               chunk.override_text = str 
+               
+       
+
 ext2format = {
        '.html': HTML,
        '.itely': TEXINFO,
@@ -1334,14 +1446,16 @@ def write_if_updated (file_name, lines):
                f = open (file_name)
                oldstr = f.read ()
                new_str = string.join (lines, '')
-               if old == new_str:
-                       ly.progress (_ ("Output file is up to date."))
+               if oldstr == new_str:
+                       ly.progress (_ ("%s is up to date.") % file_name)
+                       ly.progress ('\n')
                        return
        except:
                pass
 
-       ly.progress (_ ("Writing output file."))
+       ly.progress (_ ("Writing `%s'...") % file_name)
        open (file_name, 'w').writelines (lines)
+       ly.progress ('\n')
 
 def do_file (input_filename):
        # Ugh.
@@ -1351,7 +1465,7 @@ def do_file (input_filename):
        else:
                if os.path.exists (input_filename):
                        input_fullname = input_filename
-               elif format == LATEX:
+               elif format == LATEX and ly.search_exe_path ('kpsewhich'): 
                        # urg python interface to libkpathsea?
                        input_fullname = ly.read_pipe ('kpsewhich '
                                                       + input_filename)[:-1]
@@ -1370,24 +1484,28 @@ def do_file (input_filename):
                output_filename = '-'
                output_file = sys.stdout
        else:
+               # don't complain when output_name is existing
+               output_filename = input_base + format2ext[format]
                if output_name:
                        if not os.path.isdir (output_name):
                                os.mkdir (output_name, 0777)
                        os.chdir (output_name)
-
-               output_filename = input_base + format2ext[format]
-               if os.path.exists (input_filename) \
-                  and os.path.exists (output_filename) \
-                  and os.path.samefile (output_filename, input_fullname):
-                       ly.error (
-                         _ ("Output would overwrite input file; use --output."))
-                       ly.exit (2)
+               else: 
+                       if os.path.exists (input_filename) \
+                          and os.path.exists (output_filename) \
+                          and os.path.samefile (output_filename, input_fullname):
+                          ly.error (
+                          _ ("Output would overwrite input file; use --output."))
+                          ly.exit (2)
 
        try:
                ly.progress (_ ("Reading %s...") % input_fullname)
                source = in_handle.read ()
                ly.progress ('\n')
 
+               set_default_options (source)
+
+
                # FIXME: Containing blocks must be first, see
                #        find_toplevel_snippets.
                snippet_types = (
@@ -1402,28 +1520,12 @@ def do_file (input_filename):
                )
                ly.progress (_ ("Dissecting..."))
                chunks = find_toplevel_snippets (source, snippet_types)
-               ly.progress ('\n')
 
-               global default_ly_options
-               textwidth = 0
-               if not default_ly_options.has_key (LINEWIDTH):
-                       if format == LATEX:
-                               textwidth = get_latex_textwidth (source)
-                               default_ly_options[LINEWIDTH] = \
-                                 '''%.0f\\pt''' % textwidth
-                       elif format == TEXINFO:
-                               for (k, v) in texinfo_linewidths.items ():
-                                       # FIXME: @layout is usually not in
-                                       # chunk #0:
-                                       #
-                                       #  \input texinfo @c -*-texinfo-*-
-                                       #
-                                       # Bluntly search first K items of
-                                       # source.
-                                       # s = chunks[0].replacement_text ()
-                                       if re.search (k, source[:1024]):
-                                               default_ly_options[LINEWIDTH] = v
-                                               break
+               if format == LATEX: 
+                       modify_preamble (chunks[0])
+                       
+               
+               ly.progress ('\n')
 
                if filter_cmd:
                        write_if_updated (output_filename,
@@ -1431,13 +1533,11 @@ def do_file (input_filename):
                elif process_cmd:
                        do_process_cmd (chunks, input_fullname)
                        ly.progress (_ ("Compiling %s...") % output_filename)
+                       ly.progress ('\n')
                        write_if_updated (output_filename,
                                          [s.replacement_text ()
                                           for s in chunks])
-                       ly.progress ('\n')
-
                
-
                def process_include (snippet):
                        os.chdir (original_dir)
                        name = snippet.substring ('filename')
@@ -1460,7 +1560,7 @@ def do_file (input_filename):
                raise Compile_error
 
 def do_options ():
-       global format, output_name, psfonts_file
+       global format, output_name, psfonts_p
        global filter_cmd, process_cmd, verbose_p
 
        (sh, long) = ly.getopt_args (option_definitions)
@@ -1493,11 +1593,9 @@ def do_options ():
                        sys.exit (0)
                elif o == '--include' or o == '-I':
                        include_path.append (os.path.join (original_dir,
-                                                          ly.abspath (a)))
+                                                          os.path.abspath (a)))
                elif o == '--output' or o == '-o':
                        output_name = a
-               elif o == '--outdir':
-                       output_name = a
                elif o == '--process' or o == '-P':
                        process_cmd = a
                        filter_cmd = 0
@@ -1507,7 +1605,7 @@ def do_options ():
                elif o == '--verbose' or o == '-V':
                        verbose_p = 1
                elif o == '--psfonts':
-                       psfonts_file = a
+                       psfonts_p = 1 
                elif o == '--warranty' or o == '-w':
                        if 1 or status:
                                ly.warranty ()
@@ -1516,11 +1614,15 @@ def do_options ():
 
 def main ():
        files = do_options ()
-       if not files:
-               ly.warning ("Need to have command line option")
+       if not files or len (files) > 1:
+               ly.help ()
                ly.exit (2)
 
        file = files[0]
+
+       basename = os.path.splitext (file)[0]
+       basename = os.path.split (basename)[1]
+       
        global process_cmd, format
        if not format:
                format = guess_format (files[0])
@@ -1533,26 +1635,44 @@ 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)
-       ly.setup_environment ()
 
        try:
                chunks = do_file (file)
-               if psfonts_file:
+               if psfonts_p and invokes_lilypond ():
                        fontextract.verbose = verbose_p
                        snippet_chunks = filter (lambda x: is_derived_class (x.__class__,
                                                                              Lilypond_snippet),
                                                 chunks)
+
+                       psfonts_file = basename + '.psfonts' 
+                       if not verbose_p:
+                               ly.progress (_ ("Writing fonts to %s...") % psfonts_file)
                        fontextract.extract_fonts (psfonts_file,
                                                   [x.basename() + '.eps'
                                                    for x in snippet_chunks])
+                       if not verbose_p:
+                               ly.progress ('\n')
                        
        except Compile_error:
                ly.exit (1)
 
+       if format == TEXINFO or format == LATEX:
+               if not psfonts_p:
+                       ly.warning (_ ("option --psfonts not used"))
+                       ly.warning (_ ("processing with dvips will have no fonts"))
+
+               psfonts_file = os.path.join (output_name, basename + '.psfonts')
+               output = os.path.join (output_name, basename +  '.dvi' )
+               
+               ly.progress ('\n')
+               ly.progress (_ ("DVIPS usage:"))
+               ly.progress ('\n')
+               ly.progress ("    dvips -h %(psfonts_file)s %(output)s" % vars ())
+               ly.progress ('\n')
 
 if __name__ == '__main__':
        main ()