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--2003'))
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
+ '\n')
126 sys
.stderr
.write (__main__
.program_name
+ ": " + _ ("error: ") + 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
):
237 return re
.match ('^[^a-z0-9_-]*([a-z0-9_-]*)', cmd
).group (1)
239 def error_log (name
):
240 name
= re
.sub('[^a-z]','x',name
)
241 return tempfile
.mktemp ('%s.errorlog' % name
)
243 def read_pipe (cmd
, mode
= 'r'):
248 if __main__
.verbose_p
:
249 progress (_ ("Opening pipe `%s\'") % cmd
)
251 error_log_file
= error_log (command_name (cmd
))
252 redirect
= ' 2>%s' % error_log_file
254 pipe
= os
.popen (cmd
+ redirect
, mode
)
255 output
= pipe
.read ()
256 status
= pipe
.close ()
257 # successful pipe close returns 'None'
260 signal
= 0x0f & status
261 exit_status
= status
>> 8
264 error (_ ("`%s\' failed (%d)") % (cmd
, exit_status
))
266 if not __main__
.verbose_p
:
267 contents
= open (error_log_file
).read ()
269 error (_ ("The error log is as follows:"))
270 sys
.stderr
.write (contents
)
274 os
.unlink (error_log_file
)
278 if __main__
.verbose_p
:
282 os
.unlink (error_log_file
)
286 def system (cmd
, ignore_error
= 0, progress_p
= 0):
288 '''System CMD. If IGNORE_ERROR, do not complain when CMD
289 returns non zero. If PROGRESS_P, always show progress.
293 Exit status of CMD '''
295 name
= command_name (cmd
)
297 if __main__
.verbose_p
:
299 progress (_ ("Invoking `%s\'") % cmd
)
301 progress ( _("Running %s...") % name
)
305 redirect
= ' 1>/dev/null 2>' + error_log (name
)
306 elif __main__
.pseudo_filter_p
:
307 redirect
= ' 1>/dev/null'
309 status
= os
.system (cmd
+ redirect
)
310 signal
= 0x0f & status
311 exit_status
= status
>> 8
315 exit_type
= 'status %d' % exit_status
317 exit_type
= 'signal %d' % signal
319 msg
= _ ("`%s\' failed (%s)") % (name
, exit_type
)
321 if __main__
.verbose_p
:
322 warning (msg
+ ' ' + _ ("(ignored)"))
326 error (_ ("The error log is as follows:"))
327 sys
.stderr
.write (open (error_log (name
)).read ())
334 if not __main__
.keep_temp_dir_p
:
335 if __main__
.verbose_p
:
336 progress (_ ("Cleaning %s...") % __main__
.temp_dir
)
337 shutil
.rmtree (__main__
.temp_dir
)
338 if __main__
.verbose_p
:
342 def strip_extension (f
, ext
):
343 (p
, e
) = os
.path
.splitext (f
)
349 def cp_to_dir (pattern
, dir):
350 "Copy files matching re PATTERN from cwd to DIR"
352 # Duh. Python style portable: cp *.EXT OUTDIR
353 # system ('cp *.%s %s' % (ext, outdir), 1)
355 files
= filter (lambda x
, p
=pattern
: re
.match (p
, x
), os
.listdir ('.'))
356 map (lambda x
, d
=dir: shutil
.copy2 (x
, os
.path
.join (d
, x
)), files
)
359 # Python < 1.5.2 compatibility
361 # On most platforms, this is equivalent to
362 #`normpath(join(os.getcwd()), PATH)'. *Added in Python version 1.5.2*
364 if os
.path
.__dict
__.has_key ('abspath'):
365 abspath
= os
.path
.abspath
368 return os
.path
.normpath (os
.path
.join (os
.getcwd (), path
))
370 if os
.__dict
__.has_key ('makedirs'):
371 makedirs
= os
.makedirs
373 def makedirs (dir, mode
=0777):
374 system ('mkdir -p %s' % dir)
377 def mkdir_p (dir, mode
=0777):
378 if not os
.path
.isdir (dir):
384 # tex needs lots of memory, more than it gets by default on Debian
385 non_path_environment
= {
386 'extra_mem_top' : '1000000',
387 'extra_mem_bottom' : '1000000',
388 'pool_size' : '250000',
391 def setup_environment ():
394 kpse
= read_pipe ('kpsexpand \$TEXMF')
395 texmf
= re
.sub ('[ \t\n]+$','', kpse
)
396 type1_paths
= read_pipe ('kpsewhich -expand-path=\$T1FONTS')
399 # TODO: * prevent multiple addition.
400 # * clean TEXINPUTS, MFINPUTS, TFMFONTS,
401 # as these take prevalence over $TEXMF
402 # and thus may break tex run?
404 'TEXMF' : "{%s,%s}" % (datadir
, texmf
) ,
405 'GS_FONTPATH' : type1_paths
,
406 'GS_LIB' : datadir
+ '/ps',
409 # $TEXMF is special, previous value is already taken care of
410 if os
.environ
.has_key ('TEXMF'):
411 del os
.environ
['TEXMF']
413 for key
in environment
.keys ():
414 val
= environment
[key
]
415 if os
.environ
.has_key (key
):
416 val
= os
.environ
[key
] + os
.pathsep
+ val
417 os
.environ
[key
] = val
419 for key
in non_path_environment
.keys ():
420 val
= non_path_environment
[key
]
421 os
.environ
[key
] = val
423 def print_environment ():
424 for (k
,v
) in os
.environ
.items ():
425 sys
.stderr
.write ("%s=\"%s\"\n" % (k
, v
))
427 def get_bbox (filename
):
428 bbox
= filename
+ '.bbox'
429 ## -sOutputFile does not work with bbox?
430 cmd
= 'gs -sDEVICE=bbox -q -dNOPAUSE %s -c quit 2>%s' % \
432 system (cmd
, progress_p
= 1)
433 box
= open (bbox
).read ()
434 m
= re
.match ('^%%BoundingBox: ([0-9]+) ([0-9]+) ([0-9]+) ([0-9]+)',
438 gr
= map (string
.atoi
, m
.groups ())
443 def make_ps_images (ps_name
, resolution
= 90):
445 ## have better algorithm for deciding when to crop page,
446 ## and when to show full page
447 base
= re
.sub (r
'\.e?ps', '', ps_name
)
449 header
= open (ps_name
).read (1024)
450 multi_page
= re
.search ('\n%%Pages: ', header
)
453 if multi_page
== None:
454 bbox
= get_bbox (ps_name
)
455 trans_ps
= ps_name
+ '.trans.ps'
456 output_file
= re
.sub (r
'\.e?ps', '.png', ps_name
)
460 fo
= open (trans_ps
, 'w')
461 fo
.write ('%d %d translate\n' % (-bbox
[0] + margin
,
465 x
= (2* margin
+ bbox
[2] - bbox
[0]) \
467 y
= (2* margin
+ bbox
[3] - bbox
[1]) \
474 cmd
= r
'''gs -g%dx%d -sDEVICE=pnggray -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=%s -r%d -dNOPAUSE %s %s -c quit ''' % \
475 (x
, y
, output_file
, resolution
, trans_ps
, ps_name
)
477 rms
= glob
.glob (base
+ '-page*.png')
480 output_file
= re
.sub (r
'\.e?ps', '-page%d.png', ps_name
)
481 rmfile
= base
+ '.png'
482 if os
.path
.isfile (rmfile
):
485 cmd
= r
'''gs -s -sDEVICE=pnggray -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=%s -dNOPAUSE -r%d %s -c quit''' % (output_file
,
488 status
= system (cmd
)
489 signal
= 0xf & status
490 exit_status
= status
>> 8
495 error (_ ("Removing output file"))