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?
63 sys.path.append (datadir + '/python')
66 gettext.bindtextdomain ('lilypond', '@localedir@')
67 gettext.textdomain('lilypond')
74 layout_fields = ['title', 'subtitle', 'subsubtitle', 'footer', 'head',
75 'composer', 'arranger', 'instrument', 'opus', 'piece', 'metre',
79 # init to empty; values here take precedence over values in the file
83 'latexpackages' : ['geometry'],
92 extra_fields = extra_init.keys ()
94 fields = layout_fields + extra_fields
95 program_name = 'ly2dvi'
96 help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
110 track_dependencies_p = 0
111 dependency_files = []
114 # lily_py.py -- options and stuff
116 # source file of the GNU LilyPond music typesetter
118 # BEGIN Library for these?
119 # cut-n-paste from ly2dvi
121 program_version = '@TOPLEVEL_VERSION@'
122 if program_version == '@' + 'TOPLEVEL_VERSION' + '@':
123 program_version = '1.3.142'
126 original_dir = os.getcwd ()
127 temp_dir = '%s.dir' % program_name
132 # Try to cater for bad installations of LilyPond, that have
133 # broken TeX setup. Just hope this doesn't hurt good TeX
134 # setups. Maybe we should check if kpsewhich can find
135 # feta16.{afm,mf,tex,tfm}, and only set env upon failure.
138 'MFINPUTS' : datadir + '/mf:',
139 'TEXINPUTS': datadir + '/tex:' + datadir + '/ps:.:',
140 'TFMFONTS' : datadir + '/tfm:',
141 'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
142 'GS_LIB' : datadir + '/ps',
145 def setup_environment ():
146 for key in environment.keys ():
147 val = environment[key]
148 if os.environ.has_key (key):
149 val = val + os.pathsep + os.environ[key]
150 os.environ[key] = val
153 sys.stdout.write ('%s (GNU LilyPond) %s\n' % (program_name, program_version))
157 sys.stdout.write ('\n')
158 sys.stdout.write (_ ('Copyright (c) %s by' % ' 2001'))
159 sys.stdout.write ('\n')
160 sys.stdout.write (' Han-Wen Nienhuys')
161 sys.stdout.write (' Jan Nieuwenhuizen')
162 sys.stdout.write ('\n')
163 sys.stdout.write (_ (r'''
164 Distributed under terms of the GNU General Public License. It comes with
166 sys.stdout.write ('\n')
168 if ( os.name == 'posix' ):
174 errorport.write (s + '\n')
177 progress (_ ("warning: ") + s)
180 progress (_ ("error: ") + s)
181 raise _ ("Exiting ... ")
183 def getopt_args (opts):
184 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
199 def option_help_str (o):
200 '''Transform one option description (4-tuple ) into neatly formatted string'''
218 return ' ' + sh + sep + long + arg
221 def options_help_str (opts):
222 '''Convert a list of options into a neatly formatted string'''
228 s = option_help_str (o)
229 strs.append ((s, o[3]))
235 str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0]) + 3), s[1])
239 sys.stdout.write (_ ("Usage: %s [OPTION]... FILE") % program_name)
240 sys.stdout.write ('\n\n')
241 sys.stdout.write (help_summary)
242 sys.stdout.write ('\n\n')
243 sys.stdout.write (_ ("Options:"))
244 sys.stdout.write ('\n')
245 sys.stdout.write (options_help_str (option_definitions))
246 sys.stdout.write ('\n\n')
247 sys.stdout.write (_ ("Report bugs to %s") % 'bug-gnu-music@gnu.org')
248 sys.stdout.write ('\n')
252 if not keep_temp_dir_p:
253 temp_dir = tempfile.mktemp (program_name)
255 os.mkdir (temp_dir, 0777)
261 def system (cmd, ignore_error = 0):
263 progress (_ ("Invoking `%s\'") % cmd)
264 st = os.system (cmd) >> 8
266 name = re.match ('[ \t]*([^ \t]*)', cmd).group (1)
267 msg = name + ': ' + _ ("command exited with value %d") % st
269 warning (msg + ' ' + _ ("(ignored)") + ' ')
277 if not keep_temp_dir_p:
279 progress (_ ("Cleaning %s...") % temp_dir)
280 shutil.rmtree (temp_dir)
283 def set_setting (dict, key, val):
285 val = string.atof (val)
287 #warning (_ ("invalid value: %s") % `val`)
291 dict[key].append (val)
293 warning (_ ("no such setting: %s") % `key`)
296 def strip_extension (f, ext):
297 (p, e) = os.path.splitext (f)
304 option_definitions = [
305 ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
306 ('', 'h', 'help', _ ("this help")),
307 (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
308 ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
309 ('', '', 'no-lily', _ ("don't run LilyPond")),
310 ('', 'm', 'no-paper', _ ("produce MIDI output only")),
311 (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
313 ('', 'P', 'postscript', _ ("generate PostScript output")),
314 (_ ("KEY=VAL"), 's', 'set', _ ("change global setting KEY to VAL")),
315 ('', 'V', 'verbose', _ ("verbose")),
316 ('', 'v', 'version', _ ("print version number")),
317 ('', 'w', 'warranty', _ ("show warranty and copyright")),
320 def run_lilypond (files, outbase, dep_prefix):
321 opts = '--output=%s.tex' % outbase
322 opts = opts + ' ' + string.join (map (lambda x : '-I ' + x,
325 opts = opts + ' ' + string.join (map (lambda x : '-H ' + x,
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 do not 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 if ( os.name == 'posix' ):
522 cmd = 'latex \\\\nonstopmode \\\\input %s' % outbase + '.latex'
524 cmd = 'latex \\nonstopmode \\input %s' % outbase + '.latex'
526 progress ( _("Running %s...") % 'LaTeX')
527 cmd = cmd + ' 1> /dev/null 2> /dev/null'
531 def run_dvips (outbase, extra):
534 if extra['papersize']:
535 opts = opts + ' -t%s' % extra['papersize'][0]
537 if extra['orientation'] and extra['orientation'][0] == 'landscape':
538 opts = opts + ' -tlandscape'
540 cmd = 'dvips %s -o%s %s' % (opts, outbase + '.ps', outbase + '.dvi')
543 progress ( _("Running %s...") % 'dvips')
544 if os.name == 'posix':
545 cmd = cmd + ' 1> /dev/null 2> /dev/null'
549 def generate_dependency_file (depfile, outname):
550 df = open (depfile, 'w')
551 df.write (outname + ':' )
553 for d in dependency_files:
555 s = re.sub ('#[^\n]*\n', '', s)
556 s = re.sub (r'\\\n', ' ', s)
557 m = re.search ('.*:(.*)\n', s)
559 # ugh. Different targets?
561 df.write ( m.group (1) + ' ' )
566 (sh, long) = getopt_args (__main__.option_definitions)
568 (options, files) = getopt.getopt(sys.argv[1:], sh, long)
579 elif o == '--help' or o == '-h':
582 elif o == '--include' or o == '-I':
583 include_path.append (a)
584 elif o == '--postscript' or o == '-P':
586 elif o == '--keep' or o == '-k':
588 elif o == '--no-lily':
590 elif o == '--no-paper' or o == '-m':
594 elif o == '--output' or o == '-o':
596 elif o == '--set' or o == '-s':
597 ss = string.split (a, '=')
598 set_setting (extra_init, ss[0], ss[1])
599 elif o == '--dependencies' or o == '-d':
600 track_dependencies_p = 1
601 elif o == '--verbose' or o == '-V':
603 elif o == '--version' or o == '-v':
606 elif o == '--warranty' or o == '-w':
608 system ('lilypond -w')
614 def cp_to_dir (pattern, dir):
615 "Copy files matching re PATTERN from cwd to DIR"
616 # Duh. Python style portable: cp *.EXT OUTDIR
617 # system ('cp *.%s %s' % (ext, outdir), 1)
618 files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
619 map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
621 # Python < 1.5.2 compatibility
623 # On most platforms, this is equivalent to
624 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
625 if os.path.__dict__.has_key ('abspath'):
626 abspath = os.path.abspath
629 return os.path.normpath (os.path.join (os.getcwd (), path))
631 if os.__dict__.has_key ('makedirs'):
632 makedirs = os.makedirs
634 def makedirs (dir, mode=0777):
635 system ('mkdir -p %s' % dir)
637 def mkdir_p (dir, mode=0777):
638 if not os.path.isdir (dir):
641 include_path = map (abspath, include_path)
643 original_output = output
645 if files and files[0] != '-':
647 files = map (lambda x: strip_extension (x, '.ly'), files)
650 output = os.path.basename (files[0])
652 for i in ('.dvi', '.latex', '.ly', '.ps', '.tex'):
653 output = strip_extension (output, i)
655 files = map (abspath, files)
657 if os.path.dirname (output) != '.':
658 dep_prefix = os.path.dirname (output)
662 reldir = os.path.dirname (output)
663 (outdir, outbase) = os.path.split (abspath (output))
672 run_lilypond (files, outbase, dep_prefix)
674 # TODO: friendly message about LilyPond setup/failing?
676 # TODO: lilypond should fail with different
678 # - guile setup/startup failure
679 # - font setup failure
680 # - init.ly setup failure
681 # - parse error in .ly
682 # - unexpected: assert/core dump
685 if targets.has_key ('DVI') or targets.has_key ('PS'):
687 run_latex (files, outbase, extra)
688 # unless: add --tex, or --latex?
692 # TODO: friendly message about TeX/LaTeX setup,
693 # trying to run tex/latex by hand
694 if targets.has_key ('DVI'):
696 if targets.has_key ('PS'):
699 # TODO: does dvips ever fail?
700 if targets.has_key ('PS'):
701 run_dvips (outbase, extra)
703 if outdir != '.' and (track_dependencies_p or targets.keys ()):
704 mkdir_p (outdir, 0777)
706 # add DEP to targets?
707 if track_dependencies_p:
708 depfile = os.path.join (outdir, outbase + '.dep')
709 generate_dependency_file (depfile, depfile)
710 if os.path.isfile (depfile):
711 progress (_ ("dependencies output to %s...") % depfile)
713 for i in targets.keys ():
714 ext = string.lower (i)
715 cp_to_dir ('.*\.%s$' % ext, outdir)
716 outname = outbase + '.' + string.lower (i)
717 abs = os.path.join (outdir, outname)
719 outname = os.path.join (reldir, outname)
720 if os.path.isfile (abs):
721 progress (_ ("%s output to %s...") % (i, outname))
723 warning (_ ("can't find file: `%s'") % outname)
725 os.chdir (original_dir)
733 error (_ ("no FILEs specified, can't invoke as filter"))