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--2002'))
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 datadir = os.environ['LILYPONDPREFIX']
269 datadir = '@datadir@'
272 while datadir[-1] == os.sep:
273 datadir= datadir[:-1]
275 program_name = 'ly2dvi'
277 original_dir = os.getcwd ()
278 temp_dir = os.path.join (original_dir, '%s.dir' % program_name)
279 errorport = sys.stderr
285 gettext.bindtextdomain ('lilypond', '@localedir@')
286 gettext.textdomain ('lilypond')
292 # Attempt to fix problems with limited stack size set by Python!
293 # Sets unlimited stack size. Note that the resource module only
294 # is available on UNIX.
297 resource.setrlimit (resource.RLIMIT_STACK, (-1, -1))
301 help_summary = _ ("Generate .dvi with LaTeX for LilyPond")
303 option_definitions = [
304 ('', 'd', 'dependencies', _ ("write Makefile dependencies for every input file")),
305 ('', 'h', 'help', _ ("this help")),
306 (_ ("DIR"), 'I', 'include', _ ("add DIR to LilyPond's search path")),
307 ('', 'k', 'keep', _ ("keep all output, and name the directory %s.dir") % program_name),
308 ('', '', 'no-lily', _ ("don't run LilyPond")),
309 ('', 'm', 'no-paper', _ ("produce MIDI output only")),
310 (_ ("FILE"), 'o', 'output', _ ("write ouput to FILE")),
311 (_ ("FILE"), 'f', 'find-pfa', _ ("find pfa fonts used in 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 layout_fields = ['dedication', 'title', 'subtitle', 'subsubtitle',
321 'footer', 'head', 'composer', 'arranger', 'instrument',
322 'opus', 'piece', 'metre', 'meter', 'poet', 'texttranslator']
325 # init to empty; values here take precedence over values in the file
327 ## TODO: change name.
331 'latexpackages' : ['geometry'],
340 extra_fields = extra_init.keys ()
341 fields = layout_fields + extra_fields
348 PK_PATTERN='feta.*\.[0-9]+pk'
358 track_dependencies_p = 0
359 dependency_files = []
363 kpse = os.popen ('kpsexpand \$TEXMF').read()
364 kpse = re.sub('[ \t\n]+$','', kpse)
367 ## todo: prevent multiple addition.
368 'TEXMF' : "{%s,%s}" % (datadir, kpse) ,
369 'GS_FONTPATH' : datadir + '/afm:' + datadir + '/pfa',
370 'GS_LIB' : datadir + '/ps',
373 # tex needs lots of memory, more than it gets by default on Debian
374 non_path_environment = {
375 'extra_mem_top' : '1000000',
376 'extra_mem_bottom' : '1000000',
377 'pool_size' : '250000',
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
387 for key in non_path_environment.keys ():
388 val = non_path_environment[key]
389 os.environ[key] = val
392 def set_setting (dict, key, val):
394 val = string.atof (val)
396 #warning (_ ("invalid value: %s") % `val`)
400 dict[key].append (val)
402 warning (_ ("no such setting: %s") % `key`)
406 def print_environment ():
407 for (k,v) in os.environ.items ():
408 sys.stderr.write ("%s=\"%s\"\n" % (k,v))
410 def run_lilypond (files, outbase, dep_prefix):
412 # opts = opts + '--output=%s.tex' % outbase
413 opts = opts + ' ' + string.join (map (lambda x : '-I ' + x,
416 opts = opts + ' ' + string.join (map (lambda x : '-H ' + x,
419 opts = opts + ' --no-paper'
421 if track_dependencies_p:
422 opts = opts + " --dependencies"
424 opts = opts + ' --dep-prefix=%s' % dep_prefix
426 fs = string.join (files)
429 # cmd = cmd + ' 1> /dev/null 2> /dev/null'
430 progress ( _("Running %s...") % 'LilyPond')
432 opts = opts + ' --verbose'
434 # for better debugging!
437 system ('lilypond %s %s ' % (opts, fs))
439 def analyse_lilypond_output (filename, extra):
442 '''Grep FILENAME for interesting stuff, and
443 put relevant info into EXTRA.'''
444 filename = filename+'.tex'
445 progress (_ ("Analyzing %s...") % filename)
446 s = open (filename).read ()
448 # search only the first 10k
450 for x in extra_fields:
451 m = re.search (r'\\def\\lilypondpaper%s{([^}]*)}'%x, s)
453 set_setting (extra, x, m.group (1))
455 def find_tex_files_for_base (base, extra):
458 Find the \header fields dumped from BASE.
462 for f in layout_fields:
463 if os.path.exists (base + '.' + f):
464 headerfiles[f] = base+'.'+f
466 if os.path.exists (base +'.dep'):
467 dependency_files.append (base + '.dep')
469 for f in extra_fields:
470 if os.path.exists (base + '.' + f):
471 extra[f].append (open (base + '.' + f).read ())
473 return (base +'.tex',headerfiles)
476 def find_tex_files (files, extra):
478 Find all .tex files whose prefixes start with some name in FILES.
487 fname = os.path.basename (f)
488 fname = strip_extension (fname, '.ly')
490 fname = fname + '-%d' % x
492 if os.path.exists (fname + '.tex'):
493 tfiles.append (find_tex_files_for_base (fname, extra))
494 analyse_lilypond_output (fname, extra)
500 fstr = string.join (files, ', ')
501 warning (_ ("no lilypond output found for %s") % fstr)
504 def one_latex_definition (defn, first):
506 for (k,v) in defn[1].items ():
507 val = open (v).read ()
508 if (string.strip (val)):
509 s = s + r'''\def\lilypond%s{%s}''' % (k, val)
511 s = s + r'''\let\lilypond%s\relax''' % k
515 s = s + '\\def\\mustmakelilypondtitle{}\n'
517 s = s + '\\def\\mustmakelilypondpiecetitle{}\n'
519 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.
523 ly_paper_to_latexpaper = {
525 'letter' : 'letterpaper',
528 def global_latex_definition (tfiles, extra):
530 '''construct preamble from EXTRA, dump Latex stuff for each
531 lily output file in TFILES after that, and return the Latex file constructed. '''
535 s = s + '% generation tag\n'
539 if extra['papersize']:
541 options = '%s' % ly_paper_to_latexpaper[extra['papersize'][0]]
543 warning (_ ("invalid value: %s") % `extra['papersize'][0]`)
546 if extra['latexoptions']:
547 options = options + ',' + extra['latexoptions'][-1]
549 s = s + '\\documentclass[%s]{article}\n' % options
551 if extra['language']:
552 s = s + r'\usepackage[%s]{babel}\n' % extra['language'][-1]
555 s = s + '\\usepackage{%s}\n' \
556 % string.join (extra['latexpackages'], ',')
558 if extra['latexheaders']:
559 s = s + '\\include{%s}\n' \
560 % string.join (extra['latexheaders'], '}\n\\include{')
563 if extra['textheight']:
564 textheight = ',textheight=%fpt' % extra['textheight'][0]
566 orientation = 'portrait'
567 if extra['orientation']:
568 orientation = extra['orientation'][0]
570 # set sane geometry width (a4-width) for linewidth = -1.
571 maxlw = max (extra['linewidth'] + [-1])
573 # who the hell is 597 ?
577 s = s + '\geometry{width=%smm%s,headheight=2mm,footskip=2mm,%s}\n' % (linewidth, textheight, orientation)
579 if extra['latexoptions']:
580 s = s + '\geometry{twosideshift=4mm}\n'
583 \usepackage[latin1]{inputenc}
587 if extra['pagenumber'] and extra['pagenumber'][-1] and extra['pagenumber'][-1] != 'no':
588 s = s + '\setcounter{page}{%s}\n' % (extra['pagenumber'][-1])
589 s = s + '\\pagestyle{plain}\n'
591 s = s + '\\pagestyle{empty}\n'
593 s = s + '\\begin{document}\n'
594 s = s + '\\thispagestyle{firstpage}\n'
598 s = s + one_latex_definition (t, first)
602 s = s + '\\thispagestyle{lastpage}\n'
603 s = s + '\\end{document}'
607 def run_latex (files, outbase, extra):
609 """Construct latex file, for FILES and EXTRA, dump it into
610 OUTBASE.latex. Run LaTeX on it.
616 latex_fn = outbase + '.latex'
618 wfs = find_tex_files (files, extra)
619 s = global_latex_definition (wfs, extra)
621 f = open (latex_fn, 'w')
625 cmd = 'latex \\\\nonstopmode \\\\input %s' % latex_fn
628 progress ( _("Running %s...") % 'LaTeX')
629 cmd = cmd + ' 1> /dev/null 2> /dev/null'
633 def run_dvips (outbase, extra):
636 """Run dvips using the correct options taken from EXTRA,
637 leaving a PS file in OUTBASE.ps
644 if extra['papersize']:
645 opts = opts + ' -t%s' % extra['papersize'][0]
647 if extra['orientation'] and extra['orientation'][0] == 'landscape':
648 opts = opts + ' -tlandscape'
650 cmd = 'dvips %s -o%s %s' % (opts, outbase + '.ps', outbase + '.dvi')
653 progress ( _("Running %s...") % 'dvips')
654 cmd = cmd + ' 1> /dev/null 2> /dev/null'
658 def generate_dependency_file (depfile, outname):
659 df = open (depfile, 'w')
660 df.write (outname + ':' )
662 for d in dependency_files:
664 s = re.sub ('#[^\n]*\n', '', s)
665 s = re.sub (r'\\\n', ' ', s)
666 m = re.search ('.*:(.*)\n', s)
668 # ugh. Different targets?
670 df.write ( m.group (1) + ' ' )
675 def find_file_in_path (path, name):
676 for d in string.split (path, os.pathsep):
677 if name in os.listdir (d):
678 return os.path.join (d, name)
680 # Added as functionality to ly2dvi, because ly2dvi may well need to do this
683 def find_pfa_fonts (name):
684 s = open (name).read ()
685 if s[:len (PS)] != PS:
687 errorport.write (_( "error: ") + _ ("not a PostScript file: `%s\'" % name))
688 errorport.write ('\n')
691 m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
695 pfa.append (m.group (1))
696 m = re.match ('.*?/(feta[-a-z0-9]+) +findfont', s[here:], re.DOTALL)
700 (sh, long) = getopt_args (option_definitions)
702 (options, files) = getopt.getopt(sys.argv[1:], sh, long)
703 except getopt.error, s:
704 errorport.write ('\n')
705 errorport.write (_ ("error: ") + _ ("getopt says: `%s\'" % s))
706 errorport.write ('\n')
707 errorport.write ('\n')
717 elif o == '--help' or o == '-h':
720 elif o == '--find-pfa' or o == '-f':
721 fonts = map (lambda x: x + '.pfa', find_pfa_fonts (a))
722 files = map (lambda x:
723 find_file_in_path (os.environ['GS_FONTPATH'], x),
725 print string.join (files, ' ')
727 elif o == '--include' or o == '-I':
728 include_path.append (a)
729 elif o == '--postscript' or o == '-P':
731 elif o == '--keep' or o == '-k':
733 elif o == '--no-lily':
735 elif o == '--no-paper' or o == '-m':
739 elif o == '--output' or o == '-o':
741 elif o == '--set' or o == '-s':
742 ss = string.split (a, '=')
743 set_setting (extra_init, ss[0], ss[1])
744 elif o == '--dependencies' or o == '-d':
745 track_dependencies_p = 1
746 elif o == '--verbose' or o == '-V':
748 elif o == '--version' or o == '-v':
751 elif o == '--warranty' or o == '-w':
752 status = system ('lilypond -w', ignore_error = 1)
759 def cp_to_dir (pattern, dir):
760 "Copy files matching re PATTERN from cwd to DIR"
761 # Duh. Python style portable: cp *.EXT OUTDIR
762 # system ('cp *.%s %s' % (ext, outdir), 1)
763 files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
764 map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
766 # Python < 1.5.2 compatibility
768 # On most platforms, this is equivalent to
769 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
770 if os.path.__dict__.has_key ('abspath'):
771 abspath = os.path.abspath
774 return os.path.normpath (os.path.join (os.getcwd (), path))
776 if os.__dict__.has_key ('makedirs'):
777 makedirs = os.makedirs
779 def makedirs (dir, mode=0777):
780 system ('mkdir -p %s' % dir)
782 def mkdir_p (dir, mode=0777):
783 if not os.path.isdir (dir):
786 include_path = map (abspath, include_path)
788 original_output = output_name
791 if files and files[0] != '-':
793 # Ugh, maybe make a setup () function
794 files = map (lambda x: strip_extension (x, '.ly'), files)
796 # hmmm. Wish I'd 've written comments when I wrote this.
797 # now it looks complicated.
799 (outdir, outbase) = ('','')
801 outbase = os.path.basename (files[0])
802 outdir = abspath('.')
803 elif output_name[-1] == os.sep:
804 outdir = abspath (output_name)
805 outbase = os.path.basename (files[0])
807 (outdir, outbase) = os.path.split (abspath (output_name))
809 for i in ('.dvi', '.latex', '.ly', '.ps', '.tex'):
810 output_name = strip_extension (output_name, i)
811 outbase = strip_extension (outbase, i)
812 files = map (abspath, files)
814 for i in files[:] + [output_name]:
815 if string.find (i, ' ') >= 0:
816 user_error (_ ("filename should not contain spaces: `%s'") % i)
818 if os.path.dirname (output_name) != '.':
819 dep_prefix = os.path.dirname (output_name)
823 reldir = os.path.dirname (output_name)
824 if outdir != '.' and (track_dependencies_p or targets.keys ()):
825 mkdir_p (outdir, 0777)
828 tmpdir = setup_temp ()
831 cp_to_dir (PK_PATTERN, tmpdir)
833 # to be sure, add tmpdir *in front* of inclusion path.
834 #os.environ['TEXINPUTS'] = tmpdir + ':' + os.environ['TEXINPUTS']
839 run_lilypond (files, outbase, dep_prefix)
841 # TODO: friendly message about LilyPond setup/failing?
843 # TODO: lilypond should fail with different
845 # - guile setup/startup failure
846 # - font setup failure
847 # - init.ly setup failure
848 # - parse error in .ly
849 # - unexpected: assert/core dump
851 traceback.print_exc ()
853 if targets.has_key ('DVI') or targets.has_key ('PS'):
855 run_latex (files, outbase, extra_init)
856 # unless: add --tex, or --latex?
860 # TODO: friendly message about TeX/LaTeX setup,
861 # trying to run tex/latex by hand
862 if targets.has_key ('DVI'):
864 if targets.has_key ('PS'):
866 traceback.print_exc ()
868 if targets.has_key ('PS'):
870 run_dvips (outbase, extra_init)
872 if targets.has_key ('PS'):
874 traceback.print_exc ()
876 # add DEP to targets?
877 if track_dependencies_p:
878 depfile = os.path.join (outdir, outbase + '.dep')
879 generate_dependency_file (depfile, depfile)
880 if os.path.isfile (depfile):
881 progress (_ ("dependencies output to `%s'...") % depfile)
883 # Hmm, if this were a function, we could call it the except: clauses
884 for i in targets.keys ():
885 ext = string.lower (i)
886 cp_to_dir ('.*\.%s$' % ext, outdir)
887 outname = outbase + '.' + string.lower (i)
888 abs = os.path.join (outdir, outname)
890 outname = os.path.join (reldir, outname)
891 if os.path.isfile (abs):
892 progress (_ ("%s output to `%s'...") % (i, outname))
894 warning (_ ("can't find file: `%s'") % outname)
897 cp_to_dir (PK_PATTERN, outdir)
899 os.chdir (original_dir)
903 # FIXME: read from stdin when files[0] = '-'
905 user_error (_ ("no files specified on command line."), 2)