]> git.donarmstrong.com Git - lilypond.git/blobdiff - scripts/ly2dvi.py
patch::: 1.5.18.jcn1
[lilypond.git] / scripts / ly2dvi.py
index 81011a87ab46e558412f5307da618fe02fe04036..d442753fe9ed6663b23100a761e968f40beb18ad 100644 (file)
@@ -16,7 +16,8 @@
 
 
 # Note: gettext work best if we use ' for docstrings and "
-# for gettextable strings
+#       for gettextable strings.
+#       --> DO NOT USE """ for docstrings.
 
 '''
 TODO:
@@ -64,18 +65,66 @@ import shutil
 import __main__
 import operator
 import tempfile
+import traceback
 
+# if set, LILYPONDPREFIX must take prevalence
+# if datadir is not set, we're doing a build and LILYPONDPREFIX 
 datadir = '@datadir@'
-sys.path.append (datadir + '/python')
+if os.environ.has_key ('LILYPONDPREFIX') \
+   or '@datadir@' == '@' + 'datadir' + '@':
+       datadir = os.environ['LILYPONDPREFIX']
+else:
+       datadir = '@datadir@'
+
+sys.path.append (os.path.join (datadir, 'python'))
+sys.path.append (os.path.join (datadir, 'python/out'))
+
+program_name = 'ly2dvi'
+program_version = '@TOPLEVEL_VERSION@'
+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.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")),
+       (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
+       ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
+       ('', '', '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")),
+       ('', 'V', 'verbose', _ ("verbose")),
+       ('', 'v', 'version', _ ("print version number")),
+       ('', 'w', 'warranty', _ ("show warranty and copyright")),
+       ]
+
+from lilylib import *
 
 layout_fields = ['dedication', 'title', 'subtitle', 'subsubtitle',
          'footer', 'head', 'composer', 'arranger', 'instrument',
@@ -98,10 +147,7 @@ extra_init = {
 }
 
 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
@@ -122,24 +168,6 @@ 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 = os.path.join (original_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
@@ -147,13 +175,15 @@ verbose_p = 0
 # feta16.{afm,mf,tex,tfm}, and only set env upon failure.
 #
 environment = {
-       'MFINPUTS' : ':' + datadir + '/mf',
-       'TEXINPUTS': ':' + datadir + '/tex:' + datadir + '/ps',
-       'TFMFONTS' : ':' + datadir + '/tfm',
+       '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]
@@ -161,166 +191,6 @@ def setup_environment ():
                        val = os.environ[key] + os.pathsep + val 
                os.environ[key] = val
 
-def identify ():
-       sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
-
-def warranty ():
-       identify ()
-       sys.stdout.write ('\n')
-       sys.stdout.write (_ ('Copyright (c) %s by' % ' 2001'))
-       sys.stdout.write ('\n')
-       sys.stdout.write ('  Han-Wen Nienhuys')
-       sys.stdout.write ('  Jan Nieuwenhuizen')
-       sys.stdout.write ('\n')
-       sys.stdout.write (_ (r'''
-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')
-
-def warning (s):
-       progress (_ ("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
-       a stack trace, write to the output directly.
-
-       RETURN VALUE
-
-       None
-       
-       """
-       
-       progress (_ ("error: ") + s)
-       raise _ ("Exiting ... ")
-
-def getopt_args (opts):
-       '''Construct arguments (LONG, SHORT) for getopt from  list of options.'''
-       short = ''
-       long = []
-       for o in opts:
-               if o[1]:
-                       short = short + o[1]
-                       if o[0]:
-                               short = short + ':'
-               if o[2]:
-                       l = o[2]
-                       if o[0]:
-                               l = l + '='
-                       long.append (l)
-       return (short, long)
-
-def option_help_str (o):
-       '''Transform one option description (4-tuple ) into neatly formatted string'''
-       sh = '  '       
-       if o[1]:
-               sh = '-%s' % o[1]
-
-       sep = ' '
-       if o[1] and o[2]:
-               sep = ','
-               
-       long = ''
-       if o[2]:
-               long= '--%s' % o[2]
-
-       arg = ''
-       if o[0]:
-               if o[2]:
-                       arg = '='
-               arg = arg + o[0]
-       return '  ' + sh + sep + long + arg
-
-
-def options_help_str (opts):
-       '''Convert a list of options into a neatly formatted string'''
-       w = 0
-       strs =[]
-       helps = []
-
-       for o in opts:
-               s = option_help_str (o)
-               strs.append ((s, o[3]))
-               if len (s) > w:
-                       w = len (s)
-
-       str = ''
-       for s in strs:
-               str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0])  + 3), s[1])
-       return str
-
-def help ():
-       ls = [(_ ("Usage: %s [OPTION]... FILE") % program_name),
-               ('\n\n'),
-               (help_summary),
-               ('\n\n'),
-               (_ ("Options:")),
-               ('\n'),
-               (options_help_str (option_definitions)),
-               ('\n\n'),
-               (_ ("Report bugs to %s") % 'bug-gnu-music@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)
-       try:
-               os.mkdir (temp_dir, 0777)
-       except OSError:
-               pass
-
-       return temp_dir
-
-
-def system (cmd, ignore_error = 0):
-       """Run CMD. If IGNORE_ERROR is set, don't complain when CMD returns non zero.
-
-       RETURN VALUE
-
-       Exit status of CMD
-       """
-       
-        if ( os.name != 'posix' ):
-               cmd = re.sub (r'''\\''', r'''\\\\\\''', cmd)
-               cmd = "sh -c \'%s\'" % cmd
-
-               
-       if verbose_p:
-               progress (_ ("Invoking `%s\'") % cmd)
-       st = os.system (cmd)
-       if st:
-               name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
-               msg = name + ': ' + _ ("command exited with value %d") % st
-               if ignore_error:
-                       warning (msg + ' ' + _ ("(ignored)") + ' ')
-               else:
-                       error (msg)
-
-       return st
-
-
-def cleanup_temp ():
-       if not keep_temp_dir_p:
-               if verbose_p:
-                       progress (_ ("Cleaning %s...") % temp_dir)
-               shutil.rmtree (temp_dir)
-
-
 #what a name.
 def set_setting (dict, key, val):
        try:
@@ -336,29 +206,9 @@ def set_setting (dict, key, val):
                dict[key] = [val]
 
 
-def strip_extension (f, ext):
-       (p, e) = os.path.splitext (f)
-       if e == ext:
-               e = ''
-       return p + e
-
-# END Library
-
-option_definitions = [
-       ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
-       ('', 'h', 'help', _ ("this help")),
-       (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
-       ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
-       ('', '', 'no-lily', _ ("don't run LilyPond")),
-       ('', 'm', 'no-paper', _ ("produce MIDI output only")),
-       (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
-       # why capital P?
-       ('', 'P', 'postscript', _ ("generate PostScript output")),
-       (_ ("KEY=VAL"), 's', 'set', _ ("change global setting KEY to VAL")),
-       ('', 'V', 'verbose', _ ("verbose")),
-       ('', 'v', 'version', _ ("print version number")),
-       ('', 'w', 'warranty', _ ("show warranty and copyright")),
-       ]
+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 = ''
@@ -379,11 +229,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):
@@ -532,49 +385,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}
-%% Well, maybe you don't submit music to mutopia?
-%% I would not object to this kind of change, but I don't know how
-%% to get the last mutopia tagline right (ie: no footer on last page)
-%% Please check that mutopia footers and endfooter are OK before changing
-%% this again. -- jcn
-% the \mbox{} helps latex if people do stupid things in tagline
-\makeatletter
-\if@twoside
-  \ifodd\thepage
-   \renewcommand{\@oddfoot}{\parbox{\textwidth}{\mbox{}\makelilypondtagline}}%
-  \else
-   \renewcommand{\@evenfoot}{\parbox{\textwidth}{\mbox{}\makelilypondtagline}}%
-  \fi
- \else
-  \renewcommand{\@thefoot}{\parbox{\textwidth}{\mbox{}\makelilypondtagline}}%
-\fi
-\makeatother
-'''
+
+       s = s + '\\thispagestyle{lastpage}\n'
        s = s + '\\end{document}'
 
        return s
@@ -599,7 +427,7 @@ None
 
        cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn
 
-       if not verbose_p and os.name == 'posix':
+       if not verbose_p:
                progress ( _("Running %s...") % 'LaTeX')
                cmd = cmd + ' 1> /dev/null 2> /dev/null'
 
@@ -624,7 +452,7 @@ None.
 
        cmd = 'dvips %s -o%s %s' % (opts, outbase + '.ps', outbase + '.dvi')
        
-       if not verbose_p and os.name == 'posix':
+       if not verbose_p:
                progress ( _("Running %s...") % 'dvips')
                cmd = cmd + ' 1> /dev/null 2> /dev/null'
                
@@ -647,11 +475,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)
        
@@ -664,6 +520,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':
@@ -727,8 +590,10 @@ 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)
 
        (outdir, outbase) = ('','')
@@ -761,42 +626,48 @@ if files and files[0] != '-':
                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)
        
-       extra = extra_init
-       
        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?
+               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 targets.has_key ('PS'):
-               run_dvips (outbase, extra)
+               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:
@@ -805,6 +676,7 @@ if files and files[0] != '-':
                if os.path.isfile (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)
@@ -824,9 +696,9 @@ if files and files[0] != '-':
        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)