1 ################################################################
2 # lilylib.py -- options and stuff
4 # source file of the GNU LilyPond music typesetter
6 # (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 # Jan Nieuwenhuizen <janneke@gnu.org>
9 ### subst:\(^\|[^._a-z]\)\(abspath\|identify\|warranty\|progress\|warning\|error\|exit\|getopt_args\|option_help_str\|options_help_str\|help\|setup_temp\|read_pipe\|system\|cleanup_temp\|strip_extension\|cp_to_dir\|mkdir_p\|init\) *(
12 ### subst: \(help_summary\|keep_temp_dir_p\|option_definitions\|original_dir\|program_name\|pseudo_filter_p\|temp_dir\|verbose_p\)
21 ################################################################
22 # Users of python modules should include this snippet
23 # and customize variables below.
25 # We'll suffer this path init stuff as long as we don't install our
26 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
27 # it as we do with teTeX on Red Hat Linux: set some environment var
28 # (PYTHONPATH) in profile)
30 # If set, LILYPONDPREFIX must take prevalence
31 # if datadir is not set, we're doing a build and LILYPONDPREFIX
33 import getopt, os, sys
34 datadir = '@local_lilypond_datadir@'
35 if not os.path.isdir (datadir):
36 datadir = '@lilypond_datadir@'
37 if os.environ.has_key ('LILYPONDPREFIX') :
38 datadir = os.environ['LILYPONDPREFIX']
39 while datadir[-1] == os.sep:
42 sys.path.insert (0, os.path.join (datadir, 'python'))
47 if __name__ == '__main__':
53 program_name = 'unset'
55 original_dir = os.getcwd ()
56 temp_dir = os.path.join (original_dir, '%s.dir' % program_name)
60 help_summary = _ ("lilylib module")
62 option_definitions = [
63 ('', 'h', 'help', _ ("print this help")),
67 ################################################################
69 # Handle bug in Python 1.6-2.1
71 # there are recursion limits for some patterns in Python 1.6 til 2.1.
72 # fix this by importing pre instead. Fix by Mats.
74 if float (sys.version[0:3]) <= 2.1:
84 # Attempt to fix problems with limited stack size set by Python!
85 # Sets unlimited stack size. Note that the resource module only
86 # is available on UNIX.
89 resource.setrlimit (resource.RLIMIT_STACK, (-1, -1))
93 localedir = '@localedir@'
96 gettext.bindtextdomain ('lilypond', localedir)
97 gettext.textdomain ('lilypond')
105 port.write ('%s (GNU LilyPond) %s\n' % (__main__.program_name, __main__.program_version))
108 identify (sys.stdout)
109 sys.stdout.write ('\n')
110 sys.stdout.write (_ ("Copyright (c) %s by") % '1998--2004')
111 sys.stdout.write ('\n')
112 map (lambda x: sys.stdout.write (' %s\n' % x), __main__.copyright)
113 sys.stdout.write ('\n')
114 sys.stdout.write (_ ("Distributed under terms of the GNU General Public License."))
115 sys.stdout.write ('\n')
116 sys.stdout.write (_ ("It comes with NO WARRANTY."))
117 sys.stdout.write ('\n')
123 sys.stderr.write (__main__.program_name + ": " + _ ("warning: %s") % s + '\n')
126 sys.stderr.write (__main__.program_name + ": " + _ ("error: %s") % s + '\n')
129 if __main__.verbose_p:
130 raise _ ('Exiting (%d)...') % i
134 def getopt_args (opts):
135 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
150 def option_help_str (o):
151 '''Transform one option description (4-tuple ) into neatly formatted string'''
169 return ' ' + sh + sep + long + arg
172 def options_help_str (opts):
173 '''Convert a list of options into a neatly formatted string'''
179 s = option_help_str (o)
180 strs.append ((s, o[3]))
186 str = str + '%s%s%s\n' % (s[0], ' ' * (w - len(s[0]) + 3), s[1])
190 ls = [(_ ("Usage: %s [OPTIONS]... FILE") % __main__.program_name),
192 (__main__.help_summary),
196 (options_help_str (__main__.option_definitions)),
198 (_ ("Report bugs to %s.") % 'bug-lilypond@gnu.org'),
200 map (sys.stdout.write, ls)
202 def lilypond_version (binary):
203 p = read_pipe ('%s --version ' % binary)
208 m = re.search ('GNU LilyPond ([0-9a-z.]+)', p)
214 def lilypond_version_check (binary, req):
216 v = lilypond_version (binary)
218 error (_("Binary %s has version %s, looking for version %s") % \
225 ''' Create a temporary directory, and return its name. '''
227 if not __main__.keep_temp_dir_p:
228 __main__.temp_dir = tempfile.mktemp (__main__.program_name)
230 os.mkdir (__main__.temp_dir, 0700)
234 return __main__.temp_dir
236 def command_name (cmd):
238 # deal with "((latex ) >& 1 ) .." too
239 cmd = re.match ("([\(\)]*)([^ ]*)", cmd).group(2)
240 return os.path.split (cmd)[1]
242 def error_log (name):
243 name = re.sub('[^a-z]','x', name)
244 return tempfile.mktemp ('%s.errorlog' % name)
246 def read_pipe (cmd, mode = 'r'):
251 if __main__.verbose_p:
252 progress (_ ("Opening pipe `%s\'") % cmd)
254 error_log_file = error_log (command_name (cmd))
255 redirect = ' 2>%s' % error_log_file
257 pipe = os.popen (cmd + redirect, mode)
258 output = pipe.read ()
259 status = pipe.close ()
260 # successful pipe close returns 'None'
263 signal = 0x0f & status
264 exit_status = status >> 8
267 error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
269 if not __main__.verbose_p:
270 contents = open (error_log_file).read ()
272 error (_ ("The error log is as follows:"))
273 sys.stderr.write (contents)
277 os.unlink (error_log_file)
281 if __main__.verbose_p:
285 os.unlink (error_log_file)
289 def system (cmd, ignore_error = 0, progress_p = 0):
291 '''System CMD. If IGNORE_ERROR, do not complain when CMD
292 returns non zero. If PROGRESS_P, always show progress.
296 Exit status of CMD '''
298 name = command_name (cmd)
301 if __main__.verbose_p:
303 progress (_ ("Invoking `%s\'") % cmd)
305 progress ( _("Running %s...") % name)
309 error_log_file = error_log (name)
310 redirect = ' 1>/dev/null 2>' + error_log_file
311 elif __main__.pseudo_filter_p:
312 redirect = ' 1>/dev/null'
314 status = os.system (cmd + redirect)
315 signal = 0x0f & status
316 exit_status = status >> 8
320 exit_type = 'status %d' % exit_status
322 exit_type = 'signal %d' % signal
324 msg = _ ("`%s\' failed (%s)") % (name, exit_type)
326 if __main__.verbose_p:
327 warning (msg + ' ' + _ ("(ignored)"))
330 if not progress_p and error_log_file:
331 error (_ ("The error log is as follows:"))
332 sys.stderr.write (open (error_log_file).read ())
334 os.unlink (error_log_file)
338 os.unlink (error_log_file)
343 if not __main__.keep_temp_dir_p:
344 if __main__.verbose_p:
345 progress (_ ("Cleaning %s...") % __main__.temp_dir)
346 shutil.rmtree (__main__.temp_dir)
347 if __main__.verbose_p:
351 def strip_extension (f, ext):
352 (p, e) = os.path.splitext (f)
358 def cp_to_dir (pattern, dir):
359 "Copy files matching re PATTERN from cwd to DIR"
361 # Duh. Python style portable: cp *.EXT OUTDIR
362 # system ('cp *.%s %s' % (ext, outdir), 1)
364 files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
365 map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
368 # Python < 1.5.2 compatibility
370 # On most platforms, this is equivalent to
371 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
373 if os.path.__dict__.has_key ('abspath'):
374 abspath = os.path.abspath
377 return os.path.normpath (os.path.join (os.getcwd (), path))
379 if os.__dict__.has_key ('makedirs'):
380 makedirs = os.makedirs
382 def makedirs (dir, mode=0777):
383 system ('mkdir -p %s' % dir)
386 def mkdir_p (dir, mode=0777):
387 if not os.path.isdir (dir):
393 # tex needs lots of memory, more than it gets by default on Debian
394 non_path_environment = {
395 'extra_mem_top' : '1000000',
396 'extra_mem_bottom' : '1000000',
397 'pool_size' : '250000',
400 def setup_environment ():
403 kpse = read_pipe ('kpsexpand \$TEXMF')
404 texmf = re.sub ('[ \t\n]+$','', kpse)
405 type1_paths = read_pipe ('kpsewhich -expand-path=\$T1FONTS')
408 # TODO: * prevent multiple addition.
409 # * clean TEXINPUTS, MFINPUTS, TFMFONTS,
410 # as these take prevalence over $TEXMF
411 # and thus may break tex run?
413 'TEXMF' : "{%s,%s}" % (datadir, texmf) ,
414 'GS_FONTPATH' : type1_paths,
415 'GS_LIB' : datadir + '/ps',
418 # $TEXMF is special, previous value is already taken care of
419 if os.environ.has_key ('TEXMF'):
420 del os.environ['TEXMF']
422 for key in environment.keys ():
423 val = environment[key]
424 if os.environ.has_key (key):
425 val = os.environ[key] + os.pathsep + val
426 os.environ[key] = val
428 for key in non_path_environment.keys ():
429 val = non_path_environment[key]
430 os.environ[key] = val
432 def print_environment ():
433 for (k,v) in os.environ.items ():
434 sys.stderr.write ("%s=\"%s\"\n" % (k, v))
436 def get_bbox (filename):
437 bbox = filename + '.bbox'
438 ## -sOutputFile does not work with bbox?
439 cmd = 'gs -sDEVICE=bbox -q -dNOPAUSE %s -c quit 2>%s' % \
441 system (cmd, progress_p = 1)
442 box = open (bbox).read ()
443 m = re.match ('^%%BoundingBox: ([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)',
447 gr = map (string.atoi, m.groups ())
452 def make_ps_images (ps_name, resolution = 90):
454 ## have better algorithm for deciding when to crop page,
455 ## and when to show full page
456 base = re.sub (r'\.e?ps', '', ps_name)
458 header = open (ps_name).read (1024)
459 multi_page = re.search ('\n%%Pages: ', header)
462 if multi_page == None:
463 bbox = get_bbox (ps_name)
464 trans_ps = ps_name + '.trans.ps'
465 output_file = re.sub (r'\.e?ps', '.png', ps_name)
469 # need to have margin, otherwise edges of letters will
473 fo = open (trans_ps, 'w')
474 fo.write ('%d %d translate\n' % (-bbox[0] + margin,
478 x = (2* margin + bbox[2] - bbox[0]) \
480 y = (2* margin + bbox[3] - bbox[1]) \
487 cmd = r'''gs -g%dx%d -sDEVICE=pnggray -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=%s -r%d -dNOPAUSE %s %s -c quit ''' % \
488 (x, y, output_file, resolution, trans_ps, ps_name)
490 rms = glob.glob (base + '-page*.png')
493 output_file = re.sub (r'\.e?ps', '-page%d.png', ps_name)
495 rmfile = base + '.png'
496 if os.path.isfile (rmfile):
499 cmd = r'''gs -s -sDEVICE=pnggray -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=%s -dNOPAUSE -r%d %s -c quit''' % (output_file,
502 status = system (cmd)
503 signal = 0xf & status
504 exit_status = status >> 8
509 error (_ ("Removing output file"))