]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/lilypond-book.py
(Paper size): \paper is in
[lilypond.git] / scripts / lilypond-book.py
index f43f6bccca949349c6475ad6e0a528ef3c9c8055..e3e62de2dabee0d492cf4094bcc15b025a778457 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?
@@ -34,9 +37,7 @@ import string
 # 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.
@@ -55,12 +56,13 @@ sys.path.insert (0, os.path.join (datadir, 'python'))
 #if __name__ == '__main__':
 
 import lilylib as ly
+import fontextract
 global _;_=ly._
 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 ()
@@ -79,8 +81,8 @@ copyright = ('Jan Nieuwenhuizen <janneke@gnu.org>',
             'Han-Wen Nienhuys <hanwen@cs.uu.nl>')
 
 option_definitions = [
-       (_ ("EXT"), 'f', 'format',
-         _ ('''use output format EXT (texi [default], texi-html,
+       (_ ("FMT"), 'f', 'format',
+         _ ('''use output format FMT (texi [default], texi-html,
                latex, html)''')),
        (_ ("FILTER"), 'F', 'filter',
          _ ("pipe snippets through FILTER [convert-ly -n -]")),
@@ -92,6 +94,9 @@ option_definitions = [
          _ ("write output to DIR")),
        (_ ("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''')),
        ('', 'V', 'verbose',
          _ ("be verbose")),
        ('', 'v', 'version',
@@ -107,13 +112,14 @@ lilypond_binary = os.path.join ('@bindir@', 'lilypond')
 if '@bindir@' == ('@' + 'bindir@') or not os.path.exists (lilypond_binary):
        lilypond_binary = 'lilypond'
 
+psfonts_p = 0
 use_hash_p = 1
 format = 0
-output_name = 0
+output_name = ''
 latex_filter_cmd = 'latex "\\nonstopmode \input /dev/stdin"'
 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
@@ -147,6 +153,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.
@@ -156,6 +164,7 @@ no_options = {
        NOINDENT: INDENT,
 }
 
+
 # Recognize special sequences in the input.
 #
 #   (?P<name>regex) -- Assign result of REGEX to NAME.
@@ -384,7 +393,9 @@ simple_options = [
        PRINTFILENAME,
        TEXIDOC,
        VERBATIM,
-       FONTLOAD
+       FONTLOAD,
+       FILENAME,
+       ALT
 ]
 
 ly_options = {
@@ -408,7 +419,12 @@ ly_options = {
 
        ##
        LAYOUT: {
-               NOTIME: r'''\context {
+               NOTIME: r'''
+  \context {
+    \Score
+    timing = ##f
+  }
+  \context {
     \Staff
     \remove Time_signature_engraver
   }''',
@@ -437,7 +453,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>',
 
@@ -501,13 +517,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,9 +555,16 @@ PREAMBLE_LY = r'''%%%% Generated by %(program_name)s
                               (ly:parser-print-score
                                p (ly:music-scorify m p))))
 
+#(ly:set-option (quote no-point-and-click))
+
 #(define version-seen? #t)
 %(preamble_string)s
 
+
+%% ********************************
+%% Start cut-&-pastable-section 
+%% ********************************
+
 \paper {
   #(define dump-extents #t)
   %(font_dump_setting)s
@@ -617,10 +640,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 ''
@@ -677,8 +730,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')
@@ -866,6 +918,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'
@@ -887,8 +941,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
@@ -951,6 +1006,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
@@ -963,6 +1019,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 ()
@@ -1196,8 +1253,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:
@@ -1270,7 +1326,7 @@ def write_file_map (lys, name):
 #(ly:add-file-name-alist '(
 """)
        for ly in lys:
-               snippet_map.write ('("%s.ly" . "%s:%d (%s.ly)")\n' \
+               snippet_map.write ('("%s.ly" . "%s:%d (%s.ly)")\n'
                                   % (ly.basename (),
                                      name,
                                      ly.line_number,
@@ -1319,11 +1375,27 @@ def guess_format (input_filename):
                # FIXME
                format = ext2format[e]
        else:
-               ly.error (_ ("cannot determine format for: %s" \
+               ly.error (_ ("can't determine format for: %s" \
                             % input_filename))
                ly.exit (1)
        return format
 
+def write_if_updated (file_name, lines):
+       try:
+               f = open (file_name)
+               oldstr = f.read ()
+               new_str = string.join (lines, '')
+               if oldstr == new_str:
+                       ly.progress (_ ("%s is up to date.") % file_name)
+                       ly.progress ('\n')
+                       return
+       except:
+               pass
+
+       ly.progress (_ ("Writing `%s'...") % file_name)
+       open (file_name, 'w').writelines (lines)
+       ly.progress ('\n')
+
 def do_file (input_filename):
        # Ugh.
        if not input_filename or input_filename == '-':
@@ -1351,15 +1423,12 @@ def do_file (input_filename):
                output_filename = '-'
                output_file = sys.stdout
        else:
-               if not output_name:
-                       output_filename = input_base + format2ext[format]
-               else:
+               if output_name:
                        if not os.path.isdir (output_name):
                                os.mkdir (output_name, 0777)
-                       output_filename = (output_name
-                                          + '/' + input_base
-                                          + format2ext[format])
+                       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):
@@ -1367,14 +1436,14 @@ def do_file (input_filename):
                          _ ("Output would overwrite input file; use --output."))
                        ly.exit (2)
 
-               output_file = open (output_filename, 'w')
-               if output_name:
-                       os.chdir (output_name)
        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 = (
@@ -1391,59 +1460,40 @@ def do_file (input_filename):
                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 filter_cmd:
-                       output_file.writelines ([c.filter_text () \
-                                                for c in chunks])
-
+                       write_if_updated (output_filename,
+                                         [c.filter_text () for c in chunks])
                elif process_cmd:
                        do_process_cmd (chunks, input_fullname)
                        ly.progress (_ ("Compiling %s...") % output_filename)
-                       output_file.writelines ([s.replacement_text () \
-                                                for s in chunks])
                        ly.progress ('\n')
-
+                       write_if_updated (output_filename,
+                                         [s.replacement_text ()
+                                          for s in chunks])
+               
                def process_include (snippet):
                        os.chdir (original_dir)
                        name = snippet.substring ('filename')
                        ly.progress (_ ("Processing include: %s") % name)
                        ly.progress ('\n')
-                       do_file (name)
+                       return do_file (name)
+
+               include_chunks = map (process_include,
+                                     filter (lambda x: is_derived_class (x.__class__,
+                                                                         Include_snippet),
+                                             chunks))
 
-               map (process_include,
-                    filter (lambda x: is_derived_class (x.__class__,
-                                                        Include_snippet),
-                            chunks))
+
+               return chunks + reduce (lambda x,y: x + y, include_chunks, [])
+               
        except Compile_error:
                os.chdir (original_dir)
                ly.progress (_ ("Removing `%s'") % output_filename)
                ly.progress ('\n')
-
-               os.unlink (output_filename)
                raise Compile_error
 
 def do_options ():
-       global format, output_name
+       global format, output_name, psfonts_p
        global filter_cmd, process_cmd, verbose_p
 
        (sh, long) = ly.getopt_args (option_definitions)
@@ -1479,8 +1529,6 @@ def do_options ():
                                                           ly.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
@@ -1489,6 +1537,8 @@ def do_options ():
                        sys.exit (0)
                elif o == '--verbose' or o == '-V':
                        verbose_p = 1
+               elif o == '--psfonts':
+                       psfonts_p = 1 
                elif o == '--warranty' or o == '-w':
                        if 1 or status:
                                ly.warranty ()
@@ -1497,11 +1547,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])
@@ -1521,10 +1575,38 @@ def main ():
        ly.setup_environment ()
 
        try:
-               do_file (file)
+               chunks = do_file (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 ()