1 ################################################################
2 # lilylib.py -- options and stuff
4 # source file of the GNU LilyPond music typesetter
6 # (c) 1998--2006 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\)
25 ################################################################
26 # Users of python modules should include this snippet
27 # and customize variables below.
29 # We'll suffer this path init stuff as long as we don't install our
30 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
31 # it as we do with teTeX on Red Hat Linux: set some environment var
32 # (PYTHONPATH) in profile)
34 # If set, LILYPONDPREFIX must take prevalence
35 # if datadir is not set, we're doing a build and LILYPONDPREFIX
37 datadir = '@local_lilypond_datadir@'
38 if not os.path.isdir (datadir):
39 datadir = '@lilypond_datadir@'
40 if os.environ.has_key ('LILYPONDPREFIX') :
41 datadir = os.environ['LILYPONDPREFIX']
42 while datadir[-1] == os.sep:
45 sys.path.insert (0, os.path.join (datadir, 'python'))
50 localedir = '@localedir@'
53 gettext.bindtextdomain ('lilypond', localedir)
54 gettext.textdomain ('lilypond')
62 port.write ('%s (GNU LilyPond) %s\n' % (__main__.program_name, __main__.program_version))
66 sys.stdout.write ('\n')
67 sys.stdout.write (_ ("Copyright (c) %s by") % '1998--2006')
68 sys.stdout.write ('\n')
69 map (lambda x: sys.stdout.write (' %s\n' % x), __main__.copyright)
70 sys.stdout.write ('\n')
71 sys.stdout.write (_ ("Distributed under terms of the GNU General Public License."))
72 sys.stdout.write ('\n')
73 sys.stdout.write (_ ("It comes with NO WARRANTY."))
74 sys.stdout.write ('\n')
80 sys.stderr.write (__main__.program_name + ": " + _ ("warning: %s") % s + '\n')
83 sys.stderr.write (__main__.program_name + ": " + _ ("error: %s") % s + '\n')
87 raise _ ('Exiting (%d)...') % i
91 def getopt_args (opts):
92 '''Construct arguments (LONG, SHORT) for getopt from list of options.'''
107 def option_help_str (o):
108 '''Transform one option description (4-tuple) into neatly formatted string'''
126 return ' ' + sh + sep + long + arg
129 def options_help_str (opts):
130 '''Convert a list of options into a neatly formatted string'''
136 s = option_help_str (o)
137 strs.append ((s, o[3]))
144 for ss in re.split ('\n\s*', s[1]):
146 str = str + '%s%s%s\n' \
147 % (s[0], ' ' * (w - len (s[0]) + 3), ss)
150 str = str + '%s%s\n' \
151 % (' ' * (w + 3), ss)
155 ls = [(_ ("Usage: %s [OPTIONS]... FILE") % __main__.program_name),
157 (__main__.help_summary),
161 (options_help_str (__main__.option_definitions)),
163 (_ ("Report bugs to %s.") % 'bug-lilypond@gnu.org'),
165 map (sys.stdout.write, ls)
167 def lilypond_version (binary):
168 p = read_pipe ('%s --version ' % binary)
173 m = re.search ('GNU LilyPond ([0-9a-z.]+)', p)
179 def lilypond_version_check (binary, req):
181 v = lilypond_version (binary)
183 error (_("Binary %s has version %s, looking for version %s") % \
190 ''' Create a temporary directory, and return its name. '''
192 if not __main__.keep_temp_dir_p:
193 __main__.temp_dir = tempfile.mktemp (__main__.program_name)
195 os.mkdir (__main__.temp_dir, 0700)
199 return __main__.temp_dir
201 def command_name (cmd):
202 # Strip all stuf after command,
203 # deal with "((latex ) >& 1 ) .." too
204 cmd = re.match ('([\(\)]*)([^\\\ ]*)', cmd).group (2)
205 return os.path.basename (cmd)
207 def error_log (name):
208 name = re.sub('[^a-z]','x', name)
209 return tempfile.mktemp ('%s.errorlog' % name)
211 def read_pipe (cmd, mode = 'r'):
217 progress (_ ("Opening pipe `%s\'") % cmd)
219 error_log_file = error_log (command_name (cmd))
220 redirect = ' 2>%s' % error_log_file
222 pipe = os.popen (cmd + redirect, mode)
223 output = pipe.read ()
224 status = pipe.close ()
225 # successful pipe close returns 'None'
228 signal = 0x0f & status
229 exit_status = status >> 8
232 error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
235 contents = open (error_log_file).read ()
237 error (_ ("The error log is as follows:"))
238 sys.stderr.write (contents)
242 os.unlink (error_log_file)
250 os.unlink (error_log_file)
254 def get_global_option (old, new):
256 return __main__.__dict__[old]
258 return __main__.global_options.__dict__[new]
260 def system (cmd, ignore_error = 0, progress_p = 0):
262 '''System CMD. If IGNORE_ERROR, do not complain when CMD
263 returns non zero. If PROGRESS_P, always show progress.
267 Exit status of CMD '''
269 name = command_name (cmd)
273 be_verbose = get_global_option('verbose_p', 'verbose')
274 pseudo_filter = get_global_option ('pseudo_filter_p', 'pseudo_filter')
278 progress (_ ("Invoking `%s\'") % cmd)
280 progress ( _("Running %s...") % name)
284 error_log_file = error_log (name)
285 redirect = ' 1>/dev/null 2>' + error_log_file
287 redirect = ' 1>/dev/null'
289 status = os.system (cmd + redirect)
290 signal = 0x0f & status
291 exit_status = status >> 8
295 exit_type = 'status %d' % exit_status
297 exit_type = 'signal %d' % signal
299 msg = _ ("`%s\' failed (%s)") % (name, exit_type)
302 warning (msg + ' ' + _ ("(ignored)"))
305 if not progress_p and error_log_file:
306 error (_ ("The error log is as follows:"))
307 sys.stderr.write (open (error_log_file).read ())
309 os.unlink (error_log_file)
313 os.unlink (error_log_file)
318 if not __main__.keep_temp_dir_p:
320 progress (_ ("Cleaning %s...") % __main__.temp_dir)
321 shutil.rmtree (__main__.temp_dir)
326 def strip_extension (f, ext):
327 (p, e) = os.path.splitext (f)
333 def cp_to_dir (pattern, dir):
334 "Copy files matching re PATTERN from cwd to DIR"
336 # Duh. Python style portable: cp *.EXT OUTDIR
337 # system ('cp *.%s %s' % (ext, outdir), 1)
339 files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
340 map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
343 def search_exe_path (name):
344 p = os.environ['PATH']
345 exe_paths = string.split (p, ':')
347 full = os.path.join (e, name)
348 if os.path.exists (full):
353 def mkdir_p (dir, mode=0777):
354 if not os.path.isdir (dir):
357 def print_environment ():
358 for (k,v) in os.environ.items ():
359 sys.stderr.write ("%s=\"%s\"\n" % (k, v))
362 def ps_page_count (ps_name):
363 header = open (ps_name).read (1024)
364 m = re.search ('\n%%Pages: ([0-9]+)', header)
366 return string.atoi (m.group (1))
369 def make_ps_images (ps_name, resolution = 90, papersize = "a4",
371 base = os.path.basename (re.sub (r'\.e?ps', '', ps_name))
372 header = open (ps_name).read (1024)
375 pngn = base + '-page%d.png'
377 multi_page = re.search ('\n%%Pages: ', header)
379 # png16m is because Lily produces color nowadays.
382 # GS can produce empty 2nd page if pngn is used.
386 -dGraphicsAlphaBits=4\
390 -sOutputFile='%(output_file)s'\
391 -sPAPERSIZE=%(papersize)s\
396 -c quit ''' % vars ()
400 -dGraphicsAlphaBits=4\
404 -sOutputFile='%(output_file)s'\
405 -sPAPERSIZE=%(papersize)s\
411 remove = glob.glob (png1) + glob.glob (base + '-page*.png')
412 map (os.unlink, remove)
414 status = system (cmd)
415 signal = 0xf & status
416 exit_status = status >> 8
419 remove = glob.glob (png1) + glob.glob (base + '-page*.png')
420 map (os.unlink, remove)
421 error (_ ("%s exited with status: %d") % ('GS', status))
424 if rename_page1_p and multi_page:
425 os.rename (pngn % 1, png1)
426 files = glob.glob (png1) + glob.glob (re.sub ('%d', '*', pngn))
429 class NonDentedHeadingFormatter (optparse.IndentedHelpFormatter):
430 def format_heading(self, heading):
432 return heading[0].upper() + heading[1:] + ':\n'
434 def format_option_strings(self, option):
436 if option._short_opts and option._long_opts:
440 if option.takes_value():
441 metavar = '=%s' % option.metavar or option.dest.upper()
443 return "%3s%s %s%s" % (" ".join (option._short_opts),
445 " ".join (option._long_opts),
448 def format_usage(self, usage):
449 return _("Usage: %s\n") % usage
451 def format_description(self, description):
454 def get_option_parser (*args, **kwargs):
455 p = optparse.OptionParser (*args, **kwargs)
456 p.formatter = NonDentedHeadingFormatter ()