2 # Run lilypond, latex, dvips.
4 # This is the third incarnation of ly2dvi.
6 # Earlier incarnations of ly2dvi were written by
7 # Jeffrey B. Reed<daboys@austin.rr.com> (Python version)
8 # Jan Arne Fagertun <Jan.A.Fagertun@@energy.sintef.no> (Bourne shell script)
12 # Note: gettext work best if we use ' for docstrings and "
13 # for gettextable strings
18 * figure out which set of command line options should make ly2dvi:
21 na: create latex only?
22 na: create tex and latex
23 default: create dvi only
24 na: create tex, latex and dvi
30 for foo.ly, rename ly2dvi.dir to out-ly2dvi, foo.ly2dvi, foo.dir ?
32 * move versatile taglines,
35 beginfooter=\mutopiaPD
36 endfooter=\tagline -> 'lily was here <version>'
39 lilytagline (->lily was here), usertagline, copyright etc.
41 * head/header tagline/endfooter
43 * dvi from lilypond .tex output? This is hairy, because we create dvi
44 from lilypond .tex *and* header output.
46 * multiple \score blocks?
48 * windows-sans-cygwin compatibility? rm -rf, cp file... dir
64 sys.path.append (datadir + '/python')
67 gettext.bindtextdomain ('lilypond', '@localedir@')
68 gettext.textdomain('lilypond')
75 layout_fields = ['title', 'subtitle', 'subsubtitle', 'footer', 'head',
76 'composer', 'arranger', 'instrument', 'opus', 'piece', 'metre',
80 # init to empty; values here take precedence over values in the file
84 'latexpackages' : ['geometry'],
93 extra_fields = extra_init.keys ()
95 fields = layout_fields + extra_fields
96 program_name = 'ly2dvi'
97 help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
111 track_dependencies_p = 0
112 dependency_files = []
118 # lily_py.py -- options and stuff
120 # source file of the GNU LilyPond music typesetter
122 # BEGIN Library for these?
123 # cut-n-paste from ly2dvi
125 program_version = '@TOPLEVEL_VERSION@'
126 if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
127 program_version = '1.3.142'
130 original_dir = os.getcwd ()
131 temp_dir = '%s.dir' % program_name
136 # Try to cater for bad installations of LilyPond, that have
137 # broken TeX setup. Just hope this doesn't hurt good TeX
138 # setups. Maybe we should check if kpsewhich can find
139 # feta16.{afm,mf,tex,tfm}, and only set env upon failure.
142 'MFINPUTS' : datadir + '/mf:',
143 'TEXINPUTS': datadir + '/tex:' + datadir + '/ps:.:',
144 'TFMFONTS' : datadir + '/tfm:',
145 'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
146 'GS_LIB' : datadir + '/ps',
149 def setup_environment ():
150 for key in environment.keys ():
151 val = environment[key]
152 if os.environ.has_key (key):
153 val = val + os.pathsep + os.environ[key]
154 os.environ[key] = val
157 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
161 sys.stdout.write ('\n')
162 sys.stdout.write (_ ('Copyright (c) %s by' % ' 2001'))
163 sys.stdout.write ('\n')
164 sys.stdout.write (' Han-Wen Nienhuys')
165 sys.stdout.write (' Jan Nieuwenhuizen')
166 sys.stdout.write ('\n')
167 sys.stdout.write (_ (r'''
168 Distributed under terms of the GNU General Public License. It comes with
170 sys.stdout.write ('\n')
173 sys.stderr.write (s + '\n')
176 sys.stderr.write (_ ("warning: ") + s)
177 sys.stderr.write ('\n')
181 sys.stderr.write (_ ("error: ") + s)
182 sys.stderr.write ('\n')
183 raise _ ("Exiting ... ")
185 def getopt_args (opts):
186 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
201 def option_help_str (o):
202 '''Transform one option description (4-tuple ) into neatly formatted string'''
220 return ' ' + sh + sep + long + arg
223 def options_help_str (opts):
224 '''Convert a list of options into a neatly formatted string'''
230 s = option_help_str (o)
231 strs.append ((s, o[3]))
237 str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0]) + 3), s[1])
241 sys.stdout.write (_ ("Usage: %s [OPTION]... FILE") % program_name)
242 sys.stdout.write ('\n\n')
243 sys.stdout.write (help_summary)
244 sys.stdout.write ('\n\n')
245 sys.stdout.write (_ ("Options:"))
246 sys.stdout.write ('\n')
247 sys.stdout.write (options_help_str (option_definitions))
248 sys.stdout.write ('\n\n')
249 sys.stdout.write (_ ("Report bugs to %s") % 'bug-gnu-music@gnu.org')
250 sys.stdout.write ('\n')
254 if not keep_temp_dir_p:
255 temp_dir = tempfile.mktemp (program_name)
257 os.mkdir (temp_dir, 0777)
263 def system (cmd, ignore_error = 0):
265 progress (_ ("Invoking `%s\'") % cmd)
266 st = os.system (cmd) >> 8
268 name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
269 msg = name + ': ' + _ ("command exited with value %d") % st
271 warning (msg + ' ' + _ ("(ignored)") + ' ')
279 if not keep_temp_dir_p:
281 progress (_ ("Cleaning %s...") % temp_dir)
282 system ('rm -rf %s' % temp_dir)
285 def set_setting (dict, key, val):
287 val = string.atof (val)
289 #warning (_ ("invalid value: %s") % `val`)
293 dict[key].append (val)
295 warning (_ ("no such setting: %s") % `key`)
298 def strip_extension (f, ext):
299 (p, e) = os.path.splitext (f)
306 option_definitions = [
307 ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
308 ('', 'h', 'help', _ ("this help")),
309 (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
310 ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
311 ('', '', 'no-lily', _ ("don't run LilyPond")),
312 ('', 'm', 'no-paper', _ ("produce MIDI output only")),
313 (_ ("FILE"), 'o', 'output', _ ("write ouput to 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 def run_lilypond (files, outbase, dep_prefix):
323 opts = '--output=%s.tex' % outbase
324 opts = opts + ' ' + string.join (map (lambda x : '-I ' + x, include_path))
326 opts = opts + ' ' + string.join (map (lambda x : '-H ' + x, fields))
328 opts = opts + ' --no-paper'
330 if track_dependencies_p:
331 opts = opts + " --dependencies"
333 opts = opts + ' --dep-prefix=%s' % dep_prefix
335 fs = string.join (files)
338 progress ( _("Running %s...") % 'LilyPond')
339 # cmd = cmd + ' 1> /dev/null 2> /dev/null'
341 opts = opts + ' --verbose'
343 system ('lilypond %s %s ' % (opts, fs))
345 def analyse_lilypond_output (filename, extra):
348 '''Grep FILENAME for interesting stuff, and
349 put relevant info into EXTRA.'''
350 filename = filename+'.tex'
351 progress (_ ("Analyzing %s...") % filename)
352 s = open (filename).read ()
354 # search only the first 10k
356 for x in ('textheight', 'linewidth', 'papersize', 'orientation'):
357 m = re.search (r'\\def\\lilypondpaper%s{([^}]*)}'%x, s)
359 set_setting (extra, x, m.group (1))
361 def find_tex_files_for_base (base, extra):
363 for f in layout_fields:
364 if os.path.exists (base + '.' + f):
365 headerfiles[f] = base+'.'+f
367 if os.path.exists (base +'.dep'):
368 dependency_files.append (base + '.dep')
370 for f in extra_fields:
371 if os.path.exists (base + '.' + f):
372 extra[f].append (open (base + '.' + f).read ())
374 return (base +'.tex',headerfiles)
377 def find_tex_files (files, extra):
383 fname = os.path.basename (f)
384 fname = strip_extension (fname, '.ly')
386 fname = fname + '-%d' % x
388 if os.path.exists (fname + '.tex'):
389 tfiles.append (find_tex_files_for_base (fname, extra))
390 analyse_lilypond_output (fname, extra)
396 warning (_ ("no lilypond output found for %s") % `files`)
399 def one_latex_definition (defn, first):
401 for (k,v) in defn[1].items ():
402 val = open (v).read ()
403 if (string.strip (val)):
404 s = s + r'''\def\lilypond%s{%s}''' % (k, val)
406 s = s + r'''\let\lilypond%s\relax''' % k
410 s = s + '\\def\\mustmakelilypondtitle{}\n'
412 s = s + '\\def\\mustmakelilypondpiecetitle{}\n'
414 s = s + '\\input %s' % defn[0]
418 ly_paper_to_latexpaper = {
420 'letter' : 'letterpaper',
423 def global_latex_definition (tfiles, extra):
424 '''construct preamble from EXTRA,
425 dump lily output files after that, and return result.
430 s = s + '% generation tag\n'
434 if extra['papersize']:
436 options = '%s' % ly_paper_to_latexpaper[extra['papersize'][0]]
438 warning (_ ("invalid value: %s") % `extra['papersize'][0]`)
441 if extra['latexoptions']:
442 options = options + ',' + extra['latexoptions'][-1]
444 s = s + '\\documentclass[%s]{article}\n' % options
446 if extra['language']:
447 s = s + r'\usepackage[%s]{babel}\n' % extra['language'][-1]
450 s = s + '\\usepackage{%s}\n' \
451 % string.join (extra['latexpackages'], ',')
453 if extra['latexheaders']:
454 s = s + '\\include{%s}\n' \
455 % string.join (extra['latexheaders'], '}\n\\include{')
458 if extra['textheight']:
459 textheight = ',textheight=%fpt' % extra['textheight'][0]
461 orientation = 'portrait'
462 if extra['orientation']:
463 orientation = extra['orientation'][0]
465 # set sane geometry width (a4-width) for linewidth = -1.
466 if not extra['linewidth'] or extra['linewidth'][0] < 0:
469 linewidth = extra['linewidth'][0]
470 s = s + '\geometry{width=%spt%s,headheight=2mm,headsep=12pt,footskip=2mm,%s}\n' % (linewidth, textheight, orientation)
472 if extra['latexoptions']:
473 s = s + '\geometry{twosideshift=4mm}\n'
476 \usepackage[latin1]{inputenc}
479 \renewcommand{\@oddfoot}{\parbox{\textwidth}{\mbox{}\thefooter}}%
480 \renewcommand{\@evenfoot}{\parbox{\textwidth}{\mbox{}\thefooter}}%
483 if extra['pagenumber'] and extra['pagenumber'][-1] and extra['pagenumber'][-1] != 'no':
485 \renewcommand{\@evenhead}{\parbox{\textwidth}%
486 {\mbox{}\textbf{\thepage}\hfill\small\theheader}}
487 \renewcommand{\@oddhead}{\parbox{\textwidth}%
488 {\mbox{}\small\theheader\hfill\textbf{\thepage}}}
491 s = s + '\\pagestyle{empty}\n'
493 s = s + '\\makeatother\n'
494 s = s + '\\begin{document}\n'
499 s = s + one_latex_definition (t, first)
503 % I don't see why we want to clobber the footer here
504 \vfill\hfill\parbox{\textwidth}{\mbox{}\makelilypondtagline}
506 %\renewcommand{\@oddfoot}{\parbox{\textwidth}{\mbox{}\makelilypondtagline}}%
509 s = s + '\\end{document}'
513 def run_latex (files, outbase, extra):
514 wfs = find_tex_files ([outbase] + files[1:], extra)
515 s = global_latex_definition (wfs, extra)
517 f = open (outbase + '.latex', 'w')
521 cmd = 'latex \\\\nonstopmode \\\\input %s' % outbase + '.latex'
523 progress ( _("Running %s...") % 'LaTeX')
524 cmd = cmd + ' 1> /dev/null 2> /dev/null'
528 def run_dvips (outbase, extra):
531 if extra['papersize']:
532 opts = opts + ' -t %s' % extra['papersize'][0]
534 if extra['orientation'] and extra['orientation'][0] == 'landscape':
535 opts = opts + ' -t landscape'
537 cmd = 'dvips %s -o %s %s' % (opts, outbase + '.ps', outbase + '.dvi')
540 progress ( _("Running %s...") % 'dvips')
541 cmd = cmd + ' 2> /dev/null'
545 def generate_dependency_file (depfile, outname):
546 df = open (depfile, 'w')
547 df.write (outname + ':' )
549 for d in dependency_files:
551 s = re.sub ('#[^\n]*\n', '', s)
552 s = re.sub (r'\\\n', ' ', s)
553 m = re.search ('.*:(.*)\n', s)
555 # ugh. Different targets?
557 df.write ( m.group (1) + ' ' )
562 (sh, long) = getopt_args (__main__.option_definitions)
564 (options, files) = getopt.getopt(sys.argv[1:], sh, long)
575 elif o == '--help' or o == '-h':
578 elif o == '--include' or o == '-I':
579 include_path.append (a)
580 elif o == '--postscript' or o == '-P':
582 elif o == '--keep' or o == '-k':
584 elif o == '--no-lily':
586 elif o == '--no-paper' or o == '-m':
590 elif o == '--output' or o == '-o':
592 elif o == '--set' or o == '-s':
593 ss = string.split (a, '=')
594 set_setting (extra_init, ss[0], ss[1])
595 elif o == '--dependencies' or o == '-d':
596 track_dependencies_p = 1
597 elif o == '--verbose' or o == '-V':
599 elif o == '--version' or o == '-v':
602 elif o == '--warranty' or o == '-w':
604 system ('lilypond -w')
609 # On most platforms, this is equivalent to
610 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
611 def compat_abspath (path):
612 return os.path.normpath (os.path.join (os.getcwd (), path))
614 include_path = map (compat_abspath, include_path)
616 original_output = output
618 if files and files[0] != '-':
620 files = map (lambda x: strip_extension (x, '.ly'), files)
623 output = os.path.basename (files[0])
625 for i in ('.dvi', '.latex', '.ly', '.ps', '.tex'):
626 output = strip_extension (output, i)
628 files = map (compat_abspath, files)
630 if os.path.dirname (output) != '.':
631 dep_prefix = os.path.dirname (output)
635 reldir = os.path.dirname (output)
636 (outdir, outbase) = os.path.split (compat_abspath (output))
645 run_lilypond (files, outbase, dep_prefix)
647 # TODO: friendly message about LilyPond setup/failing?
649 # TODO: lilypond should fail with different
651 # - guile setup/startup failure
652 # - font setup failure
653 # - init.ly setup failure
654 # - parse error in .ly
655 # - unexpected: assert/core dump
658 if targets.has_key ('DVI') or targets.has_key ('PS'):
660 run_latex (files, outbase, extra)
661 # unless: add --tex, or --latex?
665 # TODO: friendly message about TeX/LaTeX setup,
666 # trying to run tex/latex by hand
667 if targets.has_key ('DVI'):
669 if targets.has_key ('PS'):
672 # TODO: does dvips ever fail?
673 if targets.has_key ('PS'):
674 run_dvips (outbase, extra)
676 if outdir != '.' and (track_dependencies_p or targets.keys ()):
677 system ('mkdir -p %s' % outdir)
679 # add DEP to targets?
680 if track_dependencies_p:
681 depfile = os.path.join (outdir, outbase + '.dep')
682 generate_dependency_file (depfile, depfile)
683 if os.path.isfile (depfile):
684 progress (_ ("dependencies output to %s...") % depfile)
686 for i in targets.keys ():
687 ext = string.lower (i)
688 if re.match ('.*[.]%s' % ext, string.join (os.listdir ('.'))):
689 system ('cp *.%s %s' % (ext, outdir))
690 outname = outbase + '.' + string.lower (i)
691 abs = os.path.join (outdir, outname)
693 outname = os.path.join (reldir, outname)
694 if os.path.isfile (abs):
695 progress (_ ("%s output to %s...") % (i, outname))
697 warning (_ ("can't find file: `%s'") % outname)
699 os.chdir (original_dir)
705 sys.stderr.write ('\n')
707 error (_ ("no FILEs specified, can't invoke as filter"))