]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/ly2dvi.py
release: 1.5.19
[lilypond.git] / scripts / ly2dvi.py
index 1b9a948292eaf52dad6ecdb18bece3c13f214b86..22a9a2245b65a1ba14e94fd69198ba53f546423f 100644 (file)
@@ -9,8 +9,15 @@
 #
 
 
+# 
+# TODO: should allow to set a central pk cache directory from the command line.
+# TODO: should allow to switch off pk cache.
+#
+
+
 # Note: gettext work best if we use ' for docstrings and "
-# for gettextable strings
+#       for gettextable strings.
+#       --> DO NOT USE """ for docstrings.
 
 '''
 TODO:
@@ -48,6 +55,9 @@ TODO:
 '''
 
 
+
+
+
 import os
 import stat
 import string
@@ -58,96 +68,26 @@ import shutil
 import __main__
 import operator
 import tempfile
+import traceback
+
+
+################################################################
+# lilylib.py -- options and stuff
+# 
+# source file of the GNU LilyPond music typesetter
 
-datadir = '@datadir@'
-sys.path.append (datadir + '/python')
 try:
        import gettext
-       gettext.bindtextdomain ('lilypond', '@localedir@')
-       gettext.textdomain('lilypond')
+       gettext.bindtextdomain ('lilypond', localedir)
+       gettext.textdomain ('lilypond')
        _ = gettext.gettext
 except:
        def _ (s):
                return s
 
-
-layout_fields = ['title', 'subtitle', 'subsubtitle', 'footer', 'head',
-         'composer', 'arranger', 'instrument', 'opus', 'piece', 'metre',
-         'meter', 'poet']
-
-
-# init to empty; values here take precedence over values in the file 
-extra_init = {
-       'language' : [],
-       'latexheaders' : [],
-       'latexpackages' :  ['geometry'],
-       'latexoptions' : [],
-       'papersize' : [],
-       'pagenumber' : [1],
-       'textheight' : [], 
-       'linewidth' : [],
-       'orientation' : []
-}
-
-extra_fields = extra_init.keys ()
-
-fields = layout_fields + extra_fields
-program_name = 'ly2dvi'
-help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
-
-include_path = ['.']
-lily_p = 1
-paper_p = 1
-
-output_name = ''
-targets = {
-       'DVI' : 0,
-       'LATEX' : 0,
-       'MIDI' : 0,
-       'TEX' : 0,
-       }
-
-track_dependencies_p = 0
-dependency_files = []
-
-
-# lily_py.py -- options and stuff
-# 
-# source file of the GNU LilyPond music typesetter
-
-# BEGIN Library for these?
-# cut-n-paste from ly2dvi
-
 program_version = '@TOPLEVEL_VERSION@'
 if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
-       program_version = '1.3.148'
-
-
-original_dir = os.getcwd ()
-temp_dir = '%s.dir' % program_name
-keep_temp_dir_p = 0
-verbose_p = 0
-
-#
-# Try to cater for bad installations of LilyPond, that have
-# broken TeX setup.  Just hope this doesn't hurt good TeX
-# setups.  Maybe we should check if kpsewhich can find
-# feta16.{afm,mf,tex,tfm}, and only set env upon failure.
-#
-environment = {
-       'MFINPUTS' : datadir + '/mf:',
-       'TEXINPUTS': datadir + '/tex:' + datadir + '/ps:.:',
-       'TFMFONTS' : datadir + '/tfm:',
-       'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
-       'GS_LIB' : datadir + '/ps',
-}
-
-def setup_environment ():
-       for key in environment.keys ():
-               val = environment[key]
-               if os.environ.has_key (key):
-                       val = val + os.pathsep + os.environ[key]
-               os.environ[key] = val
+       program_version = '1.5.17'
 
 def identify ():
        sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
@@ -165,11 +105,6 @@ Distributed under terms of the GNU General Public License. It comes with
 NO WARRANTY.'''))
        sys.stdout.write ('\n')
 
-if ( os.name == 'posix' ):
-       errorport=sys.stderr
-else:
-       errorport=sys.stdout
-
 def progress (s):
        errorport.write (s + '\n')
 
@@ -179,15 +114,15 @@ def warning (s):
 def error (s):
 
 
-       """Report the error S.  Exit by raising an exception. Please
-       do not abuse by trying to catch this error. If you donn't want
+       '''Report the error S.  Exit by raising an exception. Please
+       do not abuse by trying to catch this error. If you do not want
        a stack trace, write to the output directly.
 
        RETURN VALUE
 
        None
        
-       """
+       '''
        
        progress (_ ("error: ") + s)
        raise _ ("Exiting ... ")
@@ -256,11 +191,14 @@ def help ():
                ('\n'),
                (options_help_str (option_definitions)),
                ('\n\n'),
-               (_ ("Report bugs to %s") % 'bug-gnu-music@gnu.org'),
+               (_ ("Report bugs to %s") % 'bug-lilypond@gnu.org'),
                ('\n')]
        map (sys.stdout.write, ls)
        
 def setup_temp ():
+       """
+       Create a temporary directory, and return its name. 
+       """
        global temp_dir
        if not keep_temp_dir_p:
                temp_dir = tempfile.mktemp (program_name)
@@ -268,7 +206,8 @@ def setup_temp ():
                os.mkdir (temp_dir, 0777)
        except OSError:
                pass
-       os.chdir (temp_dir)
+
+       return temp_dir
 
 
 def system (cmd, ignore_error = 0):
@@ -279,11 +218,9 @@ def system (cmd, ignore_error = 0):
        Exit status of CMD
        """
        
-        if ( os.name != 'posix' ):
-               cmd = "sh -c \'%s\'" % cmd
        if verbose_p:
                progress (_ ("Invoking `%s\'") % cmd)
-       st = os.system (cmd) >> 8
+       st = os.system (cmd)
        if st:
                name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
                msg = name + ': ' + _ ("command exited with value %d") % st
@@ -302,29 +239,64 @@ def cleanup_temp ():
                shutil.rmtree (temp_dir)
 
 
-#what a name.
-def set_setting (dict, key, val):
-       try:
-               val = string.atof (val)
-       except ValueError:
-               #warning (_ ("invalid value: %s") % `val`)
-               pass
-
-       try:
-               dict[key].append (val)
-       except KeyError:
-               warning (_ ("no such setting: %s") % `key`)
-               dict[key] = [val]
-
-
 def strip_extension (f, ext):
        (p, e) = os.path.splitext (f)
        if e == ext:
                e = ''
        return p + e
 
+################################################################
 # END Library
 
+
+
+
+
+
+# if set, LILYPONDPREFIX must take prevalence
+# if datadir is not set, we're doing a build and LILYPONDPREFIX 
+datadir = '@datadir@'
+
+
+if os.environ.has_key ('LILYPONDPREFIX') :
+# huh ? this always leads to exception.
+# or '@datadir@' == '@' + 'datadir' + '@':   
+       datadir = os.environ['LILYPONDPREFIX']
+else:
+       datadir = '@datadir@'
+
+
+while datadir[-1] == os.sep:
+       datadir= datadir[:-1]
+
+program_name = 'ly2dvi'
+
+original_dir = os.getcwd ()
+temp_dir = os.path.join (original_dir,  '%s.dir' % program_name)
+errorport = sys.stderr
+keep_temp_dir_p = 0
+verbose_p = 0
+
+try:
+       import gettext
+       gettext.bindtextdomain ('lilypond', '@localedir@')
+       gettext.textdomain ('lilypond')
+       _ = gettext.gettext
+except:
+       def _ (s):
+               return s
+
+# Attempt to fix problems with limited stack size set by Python!
+# Sets unlimited stack size. Note that the resource module only
+# is available on UNIX.
+try:
+       import resource
+       resource.setrlimit (resource.RLIMIT_STACK, (-1, -1))
+except:
+       pass
+
+help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
+
 option_definitions = [
        ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
        ('', 'h', 'help', _ ("this help")),
@@ -333,6 +305,7 @@ option_definitions = [
        ('', '', 'no-lily', _ ("don't run LilyPond")),
        ('', 'm', 'no-paper', _ ("produce MIDI output only")),
        (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
+       (_ ("FILE"), 'f', 'find-pfa', _ ("find pfa fonts used in FILE")),
        # why capital P?
        ('', 'P', 'postscript', _ ("generate PostScript output")),
        (_ ("KEY=VAL"), 's', 'set', _ ("change global setting KEY to VAL")),
@@ -341,6 +314,90 @@ option_definitions = [
        ('', 'w', 'warranty', _ ("show warranty and copyright")),
        ]
 
+layout_fields = ['dedication', 'title', 'subtitle', 'subsubtitle',
+         'footer', 'head', 'composer', 'arranger', 'instrument',
+         'opus', 'piece', 'metre', 'meter', 'poet', 'texttranslator']
+
+
+# init to empty; values here take precedence over values in the file
+
+## TODO: change name.
+extra_init = {
+       'language' : [],
+       'latexheaders' : [],
+       'latexpackages' :  ['geometry'],
+       'latexoptions' : [],
+       'papersize' : [],
+       'pagenumber' : [1],
+       'textheight' : [], 
+       'linewidth' : [],
+       'orientation' : []
+}
+
+extra_fields = extra_init.keys ()
+fields = layout_fields + extra_fields
+
+include_path = ['.']
+lily_p = 1
+paper_p = 1
+cache_pks_p = 1
+
+PK_PATTERN='feta.*\.[0-9]+pk'
+
+output_name = ''
+targets = {
+       'DVI' : 0,
+       'LATEX' : 0,
+       'MIDI' : 0,
+       'TEX' : 0,
+       }
+
+track_dependencies_p = 0
+dependency_files = []
+
+
+#
+# Try to cater for bad installations of LilyPond, that have
+# broken TeX setup.  Just hope this doesn't hurt good TeX
+# setups.  Maybe we should check if kpsewhich can find
+# feta16.{afm,mf,tex,tfm}, and only set env upon failure.
+#
+environment = {
+       'MFINPUTS' : datadir + '/mf' + ':',
+       'TEXINPUTS': datadir + '/tex:' + datadir + '/ps:' + '.:'
+               + os.getcwd() + ':',
+       'TFMFONTS' : datadir + '/tfm' + ':',
+       'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
+       'GS_LIB' : datadir + '/ps',
+}
+
+
+def setup_environment ():
+       for key in environment.keys ():
+               val = environment[key]
+               if os.environ.has_key (key):
+                       val = os.environ[key] + os.pathsep + val 
+               os.environ[key] = val
+
+#what a name.
+def set_setting (dict, key, val):
+       try:
+               val = string.atof (val)
+       except ValueError:
+               #warning (_ ("invalid value: %s") % `val`)
+               pass
+
+       try:
+               dict[key].append (val)
+       except KeyError:
+               warning (_ ("no such setting: %s") % `key`)
+               dict[key] = [val]
+
+
+def print_environment ():
+       for (k,v) in os.environ.items ():
+               sys.stderr.write ("%s=\"%s\"\n" % (k,v)) 
+
 def run_lilypond (files, outbase, dep_prefix):
        opts = ''
 #      opts = opts + '--output=%s.tex' % outbase
@@ -360,11 +417,14 @@ def run_lilypond (files, outbase, dep_prefix):
        fs = string.join (files)
 
        if not verbose_p:
-               progress ( _("Running %s...") % 'LilyPond')
                # cmd = cmd + ' 1> /dev/null 2> /dev/null'
+               progress ( _("Running %s...") % 'LilyPond')
        else:
                opts = opts + ' --verbose'
-       
+
+               # for better debugging!
+               print_environment ()
+       print opts, fs  
        system ('lilypond %s %s ' % (opts, fs))
 
 def analyse_lilypond_output (filename, extra):
@@ -447,7 +507,7 @@ def one_latex_definition (defn, first):
        else:
                s = s + '\\def\\mustmakelilypondpiecetitle{}\n'
                
-       s = s + '\\input %s' % defn[0]
+       s = s + '\\input %s\n' % defn[0] # The final \n seems important here. It ensures that the footers and taglines end up on the right page.
        return s
 
 
@@ -499,11 +559,13 @@ lily output file in TFILES after that, and return the Latex file constructed.  '
                orientation = extra['orientation'][0]
 
        # set sane geometry width (a4-width) for linewidth = -1.
-       if not extra['linewidth'] or extra['linewidth'][0] < 0:
-               linewidth = 597
+       maxlw = max (extra['linewidth'] + [-1])
+       if maxlw < 0:
+               # who the hell is 597 ?
+               linewidth = '597'
        else:
-               linewidth = extra['linewidth'][0]
-       s = s + '\geometry{width=%spt%s,headheight=2mm,headsep=12pt,footskip=2mm,%s}\n' % (linewidth, textheight, orientation)
+               linewidth = maxlw
+       s = s + '\geometry{width=%spt%s,headheight=2mm,footskip=2mm,%s}\n' % (linewidth, textheight, orientation)
 
        if extra['latexoptions']:
                s = s + '\geometry{twosideshift=4mm}\n'
@@ -511,35 +573,24 @@ lily output file in TFILES after that, and return the Latex file constructed.  '
        s = s + r'''
 \usepackage[latin1]{inputenc}
 \input{titledefs}
-\makeatletter
-\renewcommand{\@oddfoot}{\parbox{\textwidth}{\mbox{}\thefooter}}%
-\renewcommand{\@evenfoot}{\parbox{\textwidth}{\mbox{}\thefooter}}%
 '''
        
        if extra['pagenumber'] and extra['pagenumber'][-1] and extra['pagenumber'][-1] != 'no':
-               s = s + r'''
-\renewcommand{\@evenhead}{\hbox to\textwidth{\textbf{\thepage}\hfill{\small\theheader}}}
-\renewcommand{\@oddhead}{\hbox to \textwidth{{\small\theheader}\hfill\textbf{\thepage}}}
-'''
+               s = s + '\setcounter{page}{%s}\n' % (extra['pagenumber'][-1])
+                s = s + '\\pagestyle{plain}\n'
        else:
                s = s + '\\pagestyle{empty}\n'
 
-       s = s + '\\makeatother\n'
        s = s + '\\begin{document}\n'
-
+       s = s + '\\thispagestyle{firstpage}\n'
 
        first = 1
        for t in tfiles:
                s = s + one_latex_definition (t, first)
                first = 0
 
-       s = s + r'''
-% I do not see why we want to clobber the footer here
-\vfill\hfill\parbox{\textwidth}{\mbox{}\makelilypondtagline}
-%\makeatletter
-%\renewcommand{\@oddfoot}{\parbox{\textwidth}{\mbox{}\makelilypondtagline}}%
-%\makeatother
-'''
+
+       s = s + '\\thispagestyle{lastpage}\n'
        s = s + '\\end{document}'
 
        return s
@@ -562,10 +613,7 @@ None
        f.write (s)
        f.close ()
 
-        if ( os.name == 'posix' ):
-               cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn
-       else:
-               cmd = 'latex \\\\\\\\nonstopmode \\\\\\\\input %s' % latex_fn
+       cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn
 
        if not verbose_p:
                progress ( _("Running %s...") % 'LaTeX')
@@ -615,11 +663,39 @@ def generate_dependency_file (depfile, outname):
        df.write ('\n')
        df.close ();
 
-(sh, long) = getopt_args (__main__.option_definitions)
+def find_file_in_path (path, name):
+       for d in string.split (path, os.pathsep):
+               if name in os.listdir (d):
+                       return os.path.join (d, name)
+
+# Added as functionality to ly2dvi, because ly2dvi may well need to do this
+# in future too.
+PS = '%!PS-Adobe'
+def find_pfa_fonts (name):
+       s = open (name).read ()
+       if s[:len (PS)] != PS:
+               # no ps header?
+               errorport.write (_( "error: ") + _ ("not a PostScript file: `%s\'" % name))
+               errorport.write ('\n')
+               sys.exit (1)
+       here = 0
+       m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
+       pfa = []
+       while m:
+               here = m.end (1)
+               pfa.append (m.group (1))
+               m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
+       return pfa
+
+       
+(sh, long) = getopt_args (option_definitions)
 try:
        (options, files) = getopt.getopt(sys.argv[1:], sh, long)
-except getopt.error, s: 
-       errorport.write ("\nerror: getopt says `%s\'\n\n" % s)
+except getopt.error, s:
+       errorport.write ('\n')
+       errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
+       errorport.write ('\n')
+       errorport.write ('\n')
        help ()
        sys.exit (2)
        
@@ -632,6 +708,13 @@ for opt in options:
        elif o == '--help' or o == '-h':
                help ()
                sys.exit (0)
+       elif o == '--find-pfa' or o == '-f':
+               fonts = map (lambda x: x + '.pfa', find_pfa_fonts (a))
+               files = map (lambda x:
+                            find_file_in_path (os.environ['GS_FONTPATH'], x),
+                            fonts)
+               print string.join (files, ' ')
+               sys.exit (0)
        elif o == '--include' or o == '-I':
                include_path.append (a)
        elif o == '--postscript' or o == '-P':
@@ -695,17 +778,29 @@ include_path = map (abspath, include_path)
 
 original_output = output_name
 
+
 if files and files[0] != '-':
 
+       # Ugh, maybe make a setup () function
        files = map (lambda x: strip_extension (x, '.ly'), files)
 
+       # hmmm. Wish I'd 've written comments when I wrote this.
+       # now it looks complicated.
+       
+       (outdir, outbase) = ('','')
        if not output_name:
-               output_name = os.path.basename (files[0])
+               outbase = os.path.basename (files[0])
+               outdir = abspath('.')
+       elif output_name[-1] == os.sep:
+               outdir = abspath (output_name)
+               outbase = os.path.basename (files[0])
+       else:
+               (outdir, outbase) = os.path.split (abspath (output_name))
 
        for i in ('.dvi', '.latex', '.ly', '.ps', '.tex'):
                output_name = strip_extension (output_name, i)
-
-       files = map (abspath, files) 
+               outbase = strip_extension (outbase, i)
+       files = map (abspath, files)
 
        if os.path.dirname (output_name) != '.':
                dep_prefix = os.path.dirname (output_name)
@@ -713,56 +808,66 @@ if files and files[0] != '-':
                dep_prefix = 0
 
        reldir = os.path.dirname (output_name)
-       (outdir, outbase) = os.path.split (abspath (output_name))
-       
+       if outdir != '.' and (track_dependencies_p or targets.keys ()):
+               mkdir_p (outdir, 0777)
+
        setup_environment ()
-       setup_temp ()
-       
-       extra = extra_init
+       tmpdir = setup_temp ()
+       if cache_pks_p :
+               os.chdir (outdir)
+               cp_to_dir (PK_PATTERN, tmpdir)
+
+       # to be sure, add tmpdir *in front* of inclusion path.
+       #os.environ['TEXINPUTS'] =  tmpdir + ':' + os.environ['TEXINPUTS']
+       os.chdir (tmpdir)
        
        if lily_p:
-##             try:
+               try:
                        run_lilypond (files, outbase, dep_prefix)
-## #           except:
-##                     # TODO: friendly message about LilyPond setup/failing?
-##                     #
-##                     # TODO: lilypond should fail with different
-##                     # error codes for:
-##                     #   - guile setup/startup failure
-##                     #   - font setup failure
-##                     #   - init.ly setup failure
-##                     #   - parse error in .ly
-##                     #   - unexpected: assert/core dump
-## #                   targets = {}
+               except:
+                       # TODO: friendly message about LilyPond setup/failing?
+                       #
+                       # TODO: lilypond should fail with different
+                       # error codes for:
+                       #   - guile setup/startup failure
+                       #   - font setup failure
+                       #   - init.ly setup failure
+                       #   - parse error in .ly
+                       #   - unexpected: assert/core dump
+                       targets = {}
+                       traceback.print_exc ()
 
        if targets.has_key ('DVI') or targets.has_key ('PS'):
-#              try:
-                       run_latex (files, outbase, extra)
+               try:
+                       run_latex (files, outbase, extra_init)
                        # unless: add --tex, or --latex?
                        del targets['TEX']
                        del targets['LATEX']
-#              except Foobar:
-#                      # TODO: friendly message about TeX/LaTeX setup,
-#                      # trying to run tex/latex by hand
-#                      if targets.has_key ('DVI'):
-#                              del targets['DVI']
-#                      if targets.has_key ('PS'):
-#                              del targets['PS']
-
-       # TODO: does dvips ever fail?
-       if targets.has_key ('PS'):
-               run_dvips (outbase, extra)
+               except:
+                       # TODO: friendly message about TeX/LaTeX setup,
+                       # trying to run tex/latex by hand
+                       if targets.has_key ('DVI'):
+                               del targets['DVI']
+                       if targets.has_key ('PS'):
+                               del targets['PS']
+                       traceback.print_exc ()
 
-       if outdir != '.' and (track_dependencies_p or targets.keys ()):
-               mkdir_p (outdir, 0777)
+       if targets.has_key ('PS'):
+               try:
+                       run_dvips (outbase, extra_init)
+               except: 
+                       if targets.has_key ('PS'):
+                               del targets['PS']
+                       traceback.print_exc ()
 
        # add DEP to targets?
        if track_dependencies_p:
                depfile = os.path.join (outdir, outbase + '.dep')
                generate_dependency_file (depfile, depfile)
                if os.path.isfile (depfile):
-                       progress (_ ("dependencies output to %s...") % depfile)
+                       progress (_ ("dependencies output to `%s'...") % depfile)
 
+       # Hmm, if this were a function, we could call it the except: clauses
        for i in targets.keys ():
                ext = string.lower (i)
                cp_to_dir ('.*\.%s$' % ext, outdir)
@@ -771,17 +876,20 @@ if files and files[0] != '-':
                if reldir != '.':
                        outname = os.path.join (reldir, outname)
                if os.path.isfile (abs):
-                       progress (_ ("%s output to %s...") % (i, outname))
+                       progress (_ ("%s output to `%s'...") % (i, outname))
                elif verbose_p:
                        warning (_ ("can't find file: `%s'") % outname)
-
+                       
+               if cache_pks_p:
+                       cp_to_dir (PK_PATTERN, outdir)
+               
        os.chdir (original_dir)
        cleanup_temp ()
        
 else:
-       # FIXME
+       # FIXME: read from stdin when files[0] = '-'
        help ()
-       errorport.write ("ly2dvi: error: " + _ ("no files specified on command line.\n"))
+       errorport.write (program_name + ":" + _ ("error: ") + _ ("no files specified on command line.") + '\n')
        sys.exit (2)