3 # Run lilypond, latex, dvips.
5 # This is the third incarnation of ly2dvi.
7 # Earlier incarnations of ly2dvi were written by
8 # Jeffrey B. Reed<daboys@austin.rr.com> (Python version)
9 # Jan Arne Fagertun <Jan.A.Fagertun@@energy.sintef.no> (Bourne shell script)
14 # TODO: should allow to set a central pk cache directory from the command line.
15 # TODO: should allow to switch off pk cache.
19 # Note: gettext work best if we use ' for docstrings and "
20 # for gettextable strings.
21 # --> DO NOT USE """ for docstrings.
26 * figure out which set of command line options should make ly2dvi:
29 na: create latex only?
30 na: create tex and latex
31 default: create dvi only
32 na: create tex, latex and dvi
38 for foo.ly, rename ly2dvi.dir to out-ly2dvi, foo.ly2dvi, foo.dir ?
40 * move versatile taglines,
43 beginfooter=\mutopiaPD
44 endfooter=\tagline -> 'lily was here <version>'
47 lilytagline (->lily was here), usertagline, copyright etc.
49 * head/header tagline/endfooter
51 * dvi from lilypond .tex output? This is hairy, because we create dvi
52 from lilypond .tex *and* header output.
54 * multiple \score blocks?
75 ################################################################
76 # lilylib.py -- options and stuff
78 # source file of the GNU LilyPond music typesetter
82 gettext.bindtextdomain ('lilypond', localedir)
83 gettext.textdomain ('lilypond')
89 program_version = '@TOPLEVEL_VERSION@'
90 if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
91 program_version = '1.5.17'
94 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
98 sys.stdout.write ('\n')
99 sys.stdout.write (_ ('Copyright (c) %s by' % ' 2001'))
100 sys.stdout.write ('\n')
101 sys.stdout.write (' Han-Wen Nienhuys')
102 sys.stdout.write (' Jan Nieuwenhuizen')
103 sys.stdout.write ('\n')
104 sys.stdout.write (_ (r'''
105 Distributed under terms of the GNU General Public License. It comes with
107 sys.stdout.write ('\n')
110 errorport.write (s + '\n')
113 progress (_ ("warning: ") + s)
115 def user_error (s, e=1):
116 errorport.write (program_name + ":" + _ ("error: ") + s + '\n')
122 '''Report the error S. Exit by raising an exception. Please
123 do not abuse by trying to catch this error. If you do not want
124 a stack trace, write to the output directly.
132 progress (_ ("error: ") + s)
133 raise _ ("Exiting ... ")
135 def getopt_args (opts):
136 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
151 def option_help_str (o):
152 '''Transform one option description (4-tuple ) into neatly formatted string'''
170 return ' ' + sh + sep + long + arg
173 def options_help_str (opts):
174 '''Convert a list of options into a neatly formatted string'''
180 s = option_help_str (o)
181 strs.append ((s, o[3]))
187 str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0]) + 3), s[1])
191 ls = [(_ ("Usage: %s [OPTION]... FILE") % program_name),
197 (options_help_str (option_definitions)),
199 (_ ("Report bugs to %s") % 'bug-lilypond@gnu.org'),
201 map (sys.stdout.write, ls)
205 Create a temporary directory, and return its name.
208 if not keep_temp_dir_p:
209 temp_dir = tempfile.mktemp (program_name)
211 os.mkdir (temp_dir, 0777)
218 def system (cmd, ignore_error = 0):
219 """Run CMD. If IGNORE_ERROR is set, don't complain when CMD returns non zero.
227 progress (_ ("Invoking `%s\'") % cmd)
230 name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
231 msg = name + ': ' + _ ("command exited with value %d") % st
233 warning (msg + ' ' + _ ("(ignored)") + ' ')
241 if not keep_temp_dir_p:
243 progress (_ ("Cleaning %s...") % temp_dir)
244 shutil.rmtree (temp_dir)
247 def strip_extension (f, ext):
248 (p, e) = os.path.splitext (f)
253 ################################################################
261 # if set, LILYPONDPREFIX must take prevalence
262 # if datadir is not set, we're doing a build and LILYPONDPREFIX
263 datadir = '@datadir@'
266 if os.environ.has_key ('LILYPONDPREFIX') :
267 # huh ? this always leads to exception.
268 # or '@datadir@' == '@' + 'datadir' + '@':
269 datadir = os.environ['LILYPONDPREFIX']
271 datadir = '@datadir@'
274 while datadir[-1] == os.sep:
275 datadir= datadir[:-1]
277 program_name = 'ly2dvi'
279 original_dir = os.getcwd ()
280 temp_dir = os.path.join (original_dir, '%s.dir' % program_name)
281 errorport = sys.stderr
287 gettext.bindtextdomain ('lilypond', '@localedir@')
288 gettext.textdomain ('lilypond')
294 # Attempt to fix problems with limited stack size set by Python!
295 # Sets unlimited stack size. Note that the resource module only
296 # is available on UNIX.
299 resource.setrlimit (resource.RLIMIT_STACK, (-1, -1))
303 help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
305 option_definitions = [
306 ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
307 ('', 'h', 'help', _ ("this help")),
308 (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
309 ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
310 ('', '', 'no-lily', _ ("don't run LilyPond")),
311 ('', 'm', 'no-paper', _ ("produce MIDI output only")),
312 (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
313 (_ ("FILE"), 'f', 'find-pfa', _ ("find pfa fonts used in FILE")),
315 ('', 'P', 'postscript', _ ("generate PostScript output")),
316 (_ ("KEY=VAL"), 's', 'set', _ ("change global setting KEY to VAL")),
317 ('', 'V', 'verbose', _ ("verbose")),
318 ('', 'v', 'version', _ ("print version number")),
319 ('', 'w', 'warranty', _ ("show warranty and copyright")),
322 layout_fields = ['dedication', 'title', 'subtitle', 'subsubtitle',
323 'footer', 'head', 'composer', 'arranger', 'instrument',
324 'opus', 'piece', 'metre', 'meter', 'poet', 'texttranslator']
327 # init to empty; values here take precedence over values in the file
329 ## TODO: change name.
333 'latexpackages' : ['geometry'],
342 extra_fields = extra_init.keys ()
343 fields = layout_fields + extra_fields
350 PK_PATTERN='feta.*\.[0-9]+pk'
360 track_dependencies_p = 0
361 dependency_files = []
365 # Try to cater for bad installations of LilyPond, that have
366 # broken TeX setup. Just hope this doesn't hurt good TeX
367 # setups. Maybe we should check if kpsewhich can find
368 # feta16.{afm,mf,tex,tfm}, and only set env upon failure.
371 'MFINPUTS' : datadir + '/mf' + ':',
372 'TEXINPUTS': datadir + '/tex:' + datadir + '/ps:' + '.:'
374 'TFMFONTS' : datadir + '/tfm' + ':',
375 'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
376 'GS_LIB' : datadir + '/ps',
380 def setup_environment ():
381 for key in environment.keys ():
382 val = environment[key]
383 if os.environ.has_key (key):
384 val = os.environ[key] + os.pathsep + val
385 os.environ[key] = val
388 def set_setting (dict, key, val):
390 val = string.atof (val)
392 #warning (_ ("invalid value: %s") % `val`)
396 dict[key].append (val)
398 warning (_ ("no such setting: %s") % `key`)
402 def print_environment ():
403 for (k,v) in os.environ.items ():
404 sys.stderr.write ("%s=\"%s\"\n" % (k,v))
406 def run_lilypond (files, outbase, dep_prefix):
408 # opts = opts + '--output=%s.tex' % outbase
409 opts = opts + ' ' + string.join (map (lambda x : '-I ' + x,
412 opts = opts + ' ' + string.join (map (lambda x : '-H ' + x,
415 opts = opts + ' --no-paper'
417 if track_dependencies_p:
418 opts = opts + " --dependencies"
420 opts = opts + ' --dep-prefix=%s' % dep_prefix
422 fs = string.join (files)
425 # cmd = cmd + ' 1> /dev/null 2> /dev/null'
426 progress ( _("Running %s...") % 'LilyPond')
428 opts = opts + ' --verbose'
430 # for better debugging!
433 system ('lilypond %s %s ' % (opts, fs))
435 def analyse_lilypond_output (filename, extra):
438 '''Grep FILENAME for interesting stuff, and
439 put relevant info into EXTRA.'''
440 filename = filename+'.tex'
441 progress (_ ("Analyzing %s...") % filename)
442 s = open (filename).read ()
444 # search only the first 10k
446 for x in ('textheight', 'linewidth', 'papersize', 'orientation'):
447 m = re.search (r'\\def\\lilypondpaper%s{([^}]*)}'%x, s)
449 set_setting (extra, x, m.group (1))
451 def find_tex_files_for_base (base, extra):
454 Find the \header fields dumped from BASE.
458 for f in layout_fields:
459 if os.path.exists (base + '.' + f):
460 headerfiles[f] = base+'.'+f
462 if os.path.exists (base +'.dep'):
463 dependency_files.append (base + '.dep')
465 for f in extra_fields:
466 if os.path.exists (base + '.' + f):
467 extra[f].append (open (base + '.' + f).read ())
469 return (base +'.tex',headerfiles)
472 def find_tex_files (files, extra):
474 Find all .tex files whose prefixes start with some name in FILES.
483 fname = os.path.basename (f)
484 fname = strip_extension (fname, '.ly')
486 fname = fname + '-%d' % x
488 if os.path.exists (fname + '.tex'):
489 tfiles.append (find_tex_files_for_base (fname, extra))
490 analyse_lilypond_output (fname, extra)
496 fstr = string.join (files, ', ')
497 warning (_ ("no lilypond output found for %s") % fstr)
500 def one_latex_definition (defn, first):
502 for (k,v) in defn[1].items ():
503 val = open (v).read ()
504 if (string.strip (val)):
505 s = s + r'''\def\lilypond%s{%s}''' % (k, val)
507 s = s + r'''\let\lilypond%s\relax''' % k
511 s = s + '\\def\\mustmakelilypondtitle{}\n'
513 s = s + '\\def\\mustmakelilypondpiecetitle{}\n'
515 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.
519 ly_paper_to_latexpaper = {
521 'letter' : 'letterpaper',
524 def global_latex_definition (tfiles, extra):
526 '''construct preamble from EXTRA, dump Latex stuff for each
527 lily output file in TFILES after that, and return the Latex file constructed. '''
531 s = s + '% generation tag\n'
535 if extra['papersize']:
537 options = '%s' % ly_paper_to_latexpaper[extra['papersize'][0]]
539 warning (_ ("invalid value: %s") % `extra['papersize'][0]`)
542 if extra['latexoptions']:
543 options = options + ',' + extra['latexoptions'][-1]
545 s = s + '\\documentclass[%s]{article}\n' % options
547 if extra['language']:
548 s = s + r'\usepackage[%s]{babel}\n' % extra['language'][-1]
551 s = s + '\\usepackage{%s}\n' \
552 % string.join (extra['latexpackages'], ',')
554 if extra['latexheaders']:
555 s = s + '\\include{%s}\n' \
556 % string.join (extra['latexheaders'], '}\n\\include{')
559 if extra['textheight']:
560 textheight = ',textheight=%fpt' % extra['textheight'][0]
562 orientation = 'portrait'
563 if extra['orientation']:
564 orientation = extra['orientation'][0]
566 # set sane geometry width (a4-width) for linewidth = -1.
567 maxlw = max (extra['linewidth'] + [-1])
569 # who the hell is 597 ?
573 s = s + '\geometry{width=%spt%s,headheight=2mm,footskip=2mm,%s}\n' % (linewidth, textheight, orientation)
575 if extra['latexoptions']:
576 s = s + '\geometry{twosideshift=4mm}\n'
579 \usepackage[latin1]{inputenc}
583 if extra['pagenumber'] and extra['pagenumber'][-1] and extra['pagenumber'][-1] != 'no':
584 s = s + '\setcounter{page}{%s}\n' % (extra['pagenumber'][-1])
585 s = s + '\\pagestyle{plain}\n'
587 s = s + '\\pagestyle{empty}\n'
589 s = s + '\\begin{document}\n'
590 s = s + '\\thispagestyle{firstpage}\n'
594 s = s + one_latex_definition (t, first)
598 s = s + '\\thispagestyle{lastpage}\n'
599 s = s + '\\end{document}'
603 def run_latex (files, outbase, extra):
605 """Construct latex file, for FILES and EXTRA, dump it into
606 OUTBASE.latex. Run LaTeX on it.
612 latex_fn = outbase + '.latex'
614 wfs = find_tex_files (files, extra)
615 s = global_latex_definition (wfs, extra)
617 f = open (latex_fn, 'w')
621 cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn
624 progress ( _("Running %s...") % 'LaTeX')
625 cmd = cmd + ' 1> /dev/null 2> /dev/null'
629 def run_dvips (outbase, extra):
632 """Run dvips using the correct options taken from EXTRA,
633 leaving a PS file in OUTBASE.ps
640 if extra['papersize']:
641 opts = opts + ' -t%s' % extra['papersize'][0]
643 if extra['orientation'] and extra['orientation'][0] == 'landscape':
644 opts = opts + ' -tlandscape'
646 cmd = 'dvips %s -o%s %s' % (opts, outbase + '.ps', outbase + '.dvi')
649 progress ( _("Running %s...") % 'dvips')
650 cmd = cmd + ' 1> /dev/null 2> /dev/null'
654 def generate_dependency_file (depfile, outname):
655 df = open (depfile, 'w')
656 df.write (outname + ':' )
658 for d in dependency_files:
660 s = re.sub ('#[^\n]*\n', '', s)
661 s = re.sub (r'\\\n', ' ', s)
662 m = re.search ('.*:(.*)\n', s)
664 # ugh. Different targets?
666 df.write ( m.group (1) + ' ' )
671 def find_file_in_path (path, name):
672 for d in string.split (path, os.pathsep):
673 if name in os.listdir (d):
674 return os.path.join (d, name)
676 # Added as functionality to ly2dvi, because ly2dvi may well need to do this
679 def find_pfa_fonts (name):
680 s = open (name).read ()
681 if s[:len (PS)] != PS:
683 errorport.write (_( "error: ") + _ ("not a PostScript file: `%s\'" % name))
684 errorport.write ('\n')
687 m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
691 pfa.append (m.group (1))
692 m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
696 (sh, long) = getopt_args (option_definitions)
698 (options, files) = getopt.getopt(sys.argv[1:], sh, long)
699 except getopt.error, s:
700 errorport.write ('\n')
701 errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
702 errorport.write ('\n')
703 errorport.write ('\n')
713 elif o == '--help' or o == '-h':
716 elif o == '--find-pfa' or o == '-f':
717 fonts = map (lambda x: x + '.pfa', find_pfa_fonts (a))
718 files = map (lambda x:
719 find_file_in_path (os.environ['GS_FONTPATH'], x),
721 print string.join (files, ' ')
723 elif o == '--include' or o == '-I':
724 include_path.append (a)
725 elif o == '--postscript' or o == '-P':
727 elif o == '--keep' or o == '-k':
729 elif o == '--no-lily':
731 elif o == '--no-paper' or o == '-m':
735 elif o == '--output' or o == '-o':
737 elif o == '--set' or o == '-s':
738 ss = string.split (a, '=')
739 set_setting (extra_init, ss[0], ss[1])
740 elif o == '--dependencies' or o == '-d':
741 track_dependencies_p = 1
742 elif o == '--verbose' or o == '-V':
744 elif o == '--version' or o == '-v':
747 elif o == '--warranty' or o == '-w':
748 status = system ('lilypond -w', ignore_error = 1)
755 def cp_to_dir (pattern, dir):
756 "Copy files matching re PATTERN from cwd to DIR"
757 # Duh. Python style portable: cp *.EXT OUTDIR
758 # system ('cp *.%s %s' % (ext, outdir), 1)
759 files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
760 map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
762 # Python < 1.5.2 compatibility
764 # On most platforms, this is equivalent to
765 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
766 if os.path.__dict__.has_key ('abspath'):
767 abspath = os.path.abspath
770 return os.path.normpath (os.path.join (os.getcwd (), path))
772 if os.__dict__.has_key ('makedirs'):
773 makedirs = os.makedirs
775 def makedirs (dir, mode=0777):
776 system ('mkdir -p %s' % dir)
778 def mkdir_p (dir, mode=0777):
779 if not os.path.isdir (dir):
782 include_path = map (abspath, include_path)
784 original_output = output_name
787 if files and files[0] != '-':
789 # Ugh, maybe make a setup () function
790 files = map (lambda x: strip_extension (x, '.ly'), files)
792 # hmmm. Wish I'd 've written comments when I wrote this.
793 # now it looks complicated.
795 (outdir, outbase) = ('','')
797 outbase = os.path.basename (files[0])
798 outdir = abspath('.')
799 elif output_name[-1] == os.sep:
800 outdir = abspath (output_name)
801 outbase = os.path.basename (files[0])
803 (outdir, outbase) = os.path.split (abspath (output_name))
805 for i in ('.dvi', '.latex', '.ly', '.ps', '.tex'):
806 output_name = strip_extension (output_name, i)
807 outbase = strip_extension (outbase, i)
808 files = map (abspath, files)
810 for i in files[:] + [output_name]:
811 if string.find (i, ' ') >= 0:
812 user_error (_ ("filename should not contain spaces: `%s'") % i)
814 if os.path.dirname (output_name) != '.':
815 dep_prefix = os.path.dirname (output_name)
819 reldir = os.path.dirname (output_name)
820 if outdir != '.' and (track_dependencies_p or targets.keys ()):
821 mkdir_p (outdir, 0777)
824 tmpdir = setup_temp ()
827 cp_to_dir (PK_PATTERN, tmpdir)
829 # to be sure, add tmpdir *in front* of inclusion path.
830 #os.environ['TEXINPUTS'] = tmpdir + ':' + os.environ['TEXINPUTS']
835 run_lilypond (files, outbase, dep_prefix)
837 # TODO: friendly message about LilyPond setup/failing?
839 # TODO: lilypond should fail with different
841 # - guile setup/startup failure
842 # - font setup failure
843 # - init.ly setup failure
844 # - parse error in .ly
845 # - unexpected: assert/core dump
847 traceback.print_exc ()
849 if targets.has_key ('DVI') or targets.has_key ('PS'):
851 run_latex (files, outbase, extra_init)
852 # unless: add --tex, or --latex?
856 # TODO: friendly message about TeX/LaTeX setup,
857 # trying to run tex/latex by hand
858 if targets.has_key ('DVI'):
860 if targets.has_key ('PS'):
862 traceback.print_exc ()
864 if targets.has_key ('PS'):
866 run_dvips (outbase, extra_init)
868 if targets.has_key ('PS'):
870 traceback.print_exc ()
872 # add DEP to targets?
873 if track_dependencies_p:
874 depfile = os.path.join (outdir, outbase + '.dep')
875 generate_dependency_file (depfile, depfile)
876 if os.path.isfile (depfile):
877 progress (_ ("dependencies output to `%s'...") % depfile)
879 # Hmm, if this were a function, we could call it the except: clauses
880 for i in targets.keys ():
881 ext = string.lower (i)
882 cp_to_dir ('.*\.%s$' % ext, outdir)
883 outname = outbase + '.' + string.lower (i)
884 abs = os.path.join (outdir, outname)
886 outname = os.path.join (reldir, outname)
887 if os.path.isfile (abs):
888 progress (_ ("%s output to `%s'...") % (i, outname))
890 warning (_ ("can't find file: `%s'") % outname)
893 cp_to_dir (PK_PATTERN, outdir)
895 os.chdir (original_dir)
899 # FIXME: read from stdin when files[0] = '-'
901 user_error (_ ("no files specified on command line."), 2)