X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scripts%2Fly2dvi.py;h=2a93542dd03281aa09adc8b412a66823149829d5;hb=c3f1e9e806a3d386f82439130f9593c3537ed08c;hp=56a0450df1c4f31b3ead5f1637cefa34ca0b568b;hpb=9943c08d29026b5a582e15d661c9a0d0b5e37501;p=lilypond.git diff --git a/scripts/ly2dvi.py b/scripts/ly2dvi.py index 56a0450df1..2a93542dd0 100644 --- a/scripts/ly2dvi.py +++ b/scripts/ly2dvi.py @@ -1,4 +1,5 @@ #!@PYTHON@ + # Run lilypond, latex, dvips. # # This is the third incarnation of ly2dvi. @@ -9,8 +10,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 +56,9 @@ TODO: ''' + + + import os import stat import string @@ -58,96 +69,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 = 0 -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.142' - - -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,18 +106,29 @@ 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 user_error (s, e=1): + errorport.write (program_name + ":" + _ ("error: ") + s + '\n') + sys.exit (e) + def error (s): + + + '''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 ... ") @@ -236,18 +188,22 @@ def options_help_str (opts): return str def help (): - sys.stdout.write (_ ("Usage: %s [OPTION]... FILE") % program_name) - sys.stdout.write ('\n\n') - sys.stdout.write (help_summary) - sys.stdout.write ('\n\n') - sys.stdout.write (_ ("Options:")) - sys.stdout.write ('\n') - sys.stdout.write (options_help_str (option_definitions)) - sys.stdout.write ('\n\n') - sys.stdout.write (_ ("Report bugs to %s") % 'bug-gnu-music@gnu.org') - sys.stdout.write ('\n') - + 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-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) @@ -255,13 +211,21 @@ def setup_temp (): os.mkdir (temp_dir, 0777) except OSError: pass - os.chdir (temp_dir) + + 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 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 @@ -280,27 +244,64 @@ def cleanup_temp (): shutil.rmtree (temp_dir) -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")), @@ -309,6 +310,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")), @@ -317,8 +319,93 @@ 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 = '--output=%s.tex' % outbase + opts = '' +# opts = opts + '--output=%s.tex' % outbase opts = opts + ' ' + string.join (map (lambda x : '-I ' + x, include_path)) if paper_p: @@ -335,11 +422,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): @@ -359,6 +449,11 @@ def analyse_lilypond_output (filename, extra): set_setting (extra, x, m.group (1)) def find_tex_files_for_base (base, extra): + + """ + Find the \header fields dumped from BASE. + """ + headerfiles = {} for f in layout_fields: if os.path.exists (base + '.' + f): @@ -375,6 +470,11 @@ def find_tex_files_for_base (base, extra): def find_tex_files (files, extra): + """ + Find all .tex files whose prefixes start with some name in FILES. + + """ + tfiles = [] for f in files: @@ -393,7 +493,8 @@ def find_tex_files (files, extra): x = x + 1 if not x: - warning (_ ("no lilypond output found for %s") % `files`) + fstr = string.join (files, ', ') + warning (_ ("no lilypond output found for %s") % fstr) return tfiles def one_latex_definition (defn, first): @@ -411,7 +512,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 @@ -421,9 +522,9 @@ ly_paper_to_latexpaper = { } def global_latex_definition (tfiles, extra): - '''construct preamble from EXTRA, - dump lily output files after that, and return result. - ''' + + '''construct preamble from EXTRA, dump Latex stuff for each +lily output file in TFILES after that, and return the Latex file constructed. ''' s = "" @@ -434,13 +535,13 @@ def global_latex_definition (tfiles, extra): if extra['papersize']: try: options = '%s' % ly_paper_to_latexpaper[extra['papersize'][0]] - except: + except KeyError: warning (_ ("invalid value: %s") % `extra['papersize'][0]`) pass if extra['latexoptions']: options = options + ',' + extra['latexoptions'][-1] - + s = s + '\\documentclass[%s]{article}\n' % options if extra['language']: @@ -463,65 +564,62 @@ def global_latex_definition (tfiles, extra): 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' - + 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}{\parbox{\textwidth}% - {\mbox{}\textbf{\thepage}\hfill\small\theheader}} -\renewcommand{\@oddhead}{\parbox{\textwidth}% - {\mbox{}\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 def run_latex (files, outbase, extra): - wfs = find_tex_files ([outbase] + files[1:], extra) + + """Construct latex file, for FILES and EXTRA, dump it into +OUTBASE.latex. Run LaTeX on it. + +RETURN VALUE + +None + """ + latex_fn = outbase + '.latex' + + wfs = find_tex_files (files, extra) s = global_latex_definition (wfs, extra) - f = open (outbase + '.latex', 'w') + f = open (latex_fn, 'w') f.write (s) f.close () - if ( os.name == 'posix' ): - cmd = 'latex \\\\nonstopmode \\\\input %s' % outbase + '.latex' - else: - cmd = 'latex \\nonstopmode \\input %s' % outbase + '.latex' + cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn + if not verbose_p: progress ( _("Running %s...") % 'LaTeX') cmd = cmd + ' 1> /dev/null 2> /dev/null' @@ -530,6 +628,14 @@ def run_latex (files, outbase, extra): def run_dvips (outbase, extra): + + """Run dvips using the correct options taken from EXTRA, +leaving a PS file in OUTBASE.ps + +RETURN VALUE + +None. +""" opts = '' if extra['papersize']: opts = opts + ' -t%s' % extra['papersize'][0] @@ -541,8 +647,7 @@ def run_dvips (outbase, extra): if not verbose_p: progress ( _("Running %s...") % 'dvips') - if os.name == 'posix': - cmd = cmd + ' 1> /dev/null 2> /dev/null' + cmd = cmd + ' 1> /dev/null 2> /dev/null' system (cmd) @@ -563,10 +668,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: +except getopt.error, s: + errorport.write ('\n') + errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s)) + errorport.write ('\n') + errorport.write ('\n') help () sys.exit (2) @@ -579,6 +713,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': @@ -592,7 +733,7 @@ for opt in options: targets['MIDI'] = 0 paper_p = 0 elif o == '--output' or o == '-o': - output = a + output_name = a elif o == '--set' or o == '-s': ss = string.split (a, '=') set_setting (extra_init, ss[0], ss[1]) @@ -604,10 +745,10 @@ for opt in options: identify () sys.exit (0) elif o == '--warranty' or o == '-w': - try: - system ('lilypond -w') - except: + status = system ('lilypond -w', ignore_error = 1) + if status: warranty () + sys.exit (0) @@ -640,51 +781,74 @@ def mkdir_p (dir, mode=0777): include_path = map (abspath, include_path) -original_output = output +original_output = output_name -if files and files[0] != '-': +if files and files[0] != '-': + + # Ugh, maybe make a setup () function files = map (lambda x: strip_extension (x, '.ly'), files) - if not output: - output = os.path.basename (files[0]) + # hmmm. Wish I'd 've written comments when I wrote this. + # now it looks complicated. + + (outdir, outbase) = ('','') + if not output_name: + 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 = strip_extension (output, i) - - files = map (abspath, files) - - if os.path.dirname (output) != '.': - dep_prefix = os.path.dirname (output) + output_name = strip_extension (output_name, i) + outbase = strip_extension (outbase, i) + files = map (abspath, files) + + for i in files[:] + [output_name]: + if string.find (i, ' ') >= 0: + user_error (_ ("filename should not contain spaces: `%s'") % i) + + if os.path.dirname (output_name) != '.': + dep_prefix = os.path.dirname (output_name) else: dep_prefix = 0 - reldir = os.path.dirname (output) - (outdir, outbase) = os.path.split (abspath (output)) - + reldir = os.path.dirname (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: 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 + # 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) + run_latex (files, outbase, extra_init) # unless: add --tex, or --latex? del targets['TEX'] del targets['LATEX'] @@ -695,21 +859,24 @@ if files and files[0] != '-': del targets['DVI'] if targets.has_key ('PS'): del targets['PS'] + traceback.print_exc () - # TODO: does dvips ever fail? if targets.has_key ('PS'): - run_dvips (outbase, extra) - - if outdir != '.' and (track_dependencies_p or targets.keys ()): - mkdir_p (outdir, 0777) + 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) @@ -718,22 +885,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 () - progress ('\n') - try: - error (_ ("no FILEs specified, can't invoke as filter")) - except: - pass - sys.exit (2) + user_error (_ ("no files specified on command line."), 2)