python/lilylib.py

   1 ################################################################
   2 # lilylib.py -- options and stuff
   3 #
   4 # source file of the GNU LilyPond music typesetter
   5 #
   6 # (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 #                 Jan Nieuwenhuizen <janneke@gnu.org>
   8
   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\) *(
  10 ###  replace:\1ly.\2 (
  11
  12 ### subst: \(help_summary\|keep_temp_dir_p\|option_definitions\|original_dir\|program_name\|pseudo_filter_p\|temp_dir\|verbose_p\)
  13
  14 import __main__
  15 import getopt
  16 import glob
  17 import os
  18 import re
  19 import shutil
  20 import string
  21 import sys
  22 import tempfile
  23 import optparse
  24
  25 ################################################################
  26 # Users of python modules should include this snippet
  27 # and customize variables below.
  28
  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)
  33
  34 # If set, LILYPONDPREFIX must take prevalence
  35 # if datadir is not set, we're doing a build and LILYPONDPREFIX
  36
  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:
  43                 datadir= datadir[:-1]
  44
  45 sys.path.insert (0, os.path.join (datadir, 'python'))
  46
  47
  48
  49
  50 localedir = '@localedir@'
  51 try:
  52         import gettext
  53         gettext.bindtextdomain ('lilypond', localedir)
  54         gettext.textdomain ('lilypond')
  55         _ = gettext.gettext
  56 except:
  57         def _ (s):
  58                 return s
  59 underscore = _
  60
  61 def identify (port):
  62         port.write ('%s (GNU LilyPond) %s\n' % (__main__.program_name, __main__.program_version))
  63
  64 def warranty ():
  65         identify (sys.stdout)
  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')
  75
  76 def progress (s):
  77         sys.stderr.write (s)
  78
  79 def warning (s):
  80         sys.stderr.write (__main__.program_name + ": " + _ ("warning: %s") % s + '\n')
  81
  82 def error (s):
  83         sys.stderr.write (__main__.program_name + ": " + _ ("error: %s") % s + '\n')
  84
  85 def exit (i):
  86         if be_verbose:
  87                 raise _ ('Exiting (%d)...') % i
  88         else:
  89                 sys.exit (i)
  90
  91 def getopt_args (opts):
  92         '''Construct arguments (LONG, SHORT) for getopt from  list of options.'''
  93         short = ''
  94         long = []
  95         for o in opts:
  96                 if o[1]:
  97                         short = short + o[1]
  98                         if o[0]:
  99                                 short = short + ':'
 100                 if o[2]:
 101                         l = o[2]
 102                         if o[0]:
 103                                 l = l + '='
 104                         long.append (l)
 105         return (short, long)
 106
 107 def option_help_str (o):
 108         '''Transform one option description (4-tuple) into neatly formatted string'''
 109         sh = '  '
 110         if o[1]:
 111                 sh = '-%s' % o[1]
 112
 113         sep = '  '
 114         if o[1] and o[2]:
 115                 sep = ', '
 116
 117         long = ''
 118         if o[2]:
 119                 long= '--%s' % o[2]
 120
 121         arg = ''
 122         if o[0]:
 123                 if o[2]:
 124                         arg = '='
 125                 arg = arg + o[0]
 126         return '  ' + sh + sep + long + arg
 127
 128
 129 def options_help_str (opts):
 130         '''Convert a list of options into a neatly formatted string'''
 131         w = 0
 132         strs =[]
 133         helps = []
 134
 135         for o in opts:
 136                 s = option_help_str (o)
 137                 strs.append ((s, o[3]))
 138                 if len (s) > w:
 139                         w = len (s)
 140
 141         str = ''
 142         for s in strs:
 143                 first = 1
 144                 for ss in re.split ('\n\s*', s[1]):
 145                         if first:
 146                                 str = str + '%s%s%s\n' \
 147                                         % (s[0], ' ' * (w - len (s[0]) + 3), ss)
 148                                 first = 0
 149                         else:
 150                                 str = str + '%s%s\n' \
 151                                         % (' ' * (w + 3), ss)
 152         return str
 153
 154 def help ():
 155         ls = [(_ ("Usage: %s [OPTIONS]... FILE") % __main__.program_name),
 156               ('\n\n'),
 157               (__main__.help_summary),
 158               ('\n\n'),
 159               (_ ("Options:")),
 160               ('\n'),
 161               (options_help_str (__main__.option_definitions)),
 162               ('\n\n'),
 163               (_ ("Report bugs to %s.") % 'bug-lilypond@gnu.org'),
 164               ('\n')]
 165         map (sys.stdout.write, ls)
 166
 167 def lilypond_version (binary):
 168         p = read_pipe ('%s --version ' % binary)
 169
 170         ls = p.split ('\n')
 171         v= '<not found>'
 172         for l in ls:
 173                 m = re.search ('GNU LilyPond ([0-9a-z.]+)', p)
 174                 if m:
 175                         v = m.group (1)
 176
 177         return v
 178
 179 def lilypond_version_check (binary, req):
 180         if req[0] <> '@' :
 181                 v = lilypond_version (binary)
 182                 if v <> req:
 183                         error (_("Binary %s has version %s, looking for version %s") % \
 184                                (binary, v, req))
 185                         sys.exit (1)
 186
 187
 188 def setup_temp ():
 189
 190         ''' Create a temporary directory, and return its name. '''
 191
 192         if not __main__.keep_temp_dir_p:
 193                 __main__.temp_dir = tempfile.mktemp (__main__.program_name)
 194         try:
 195                 os.mkdir (__main__.temp_dir, 0700)
 196         except OSError:
 197                 pass
 198
 199         return __main__.temp_dir
 200
 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)
 206
 207 def error_log (name):
 208         name = re.sub('[^a-z]','x', name)
 209         return tempfile.mktemp ('%s.errorlog' % name)
 210
 211 def read_pipe (cmd, mode = 'r'):
 212
 213
 214         redirect = ''
 215         error_log_file = ''
 216         if be_verbose:
 217                 progress (_ ("Opening pipe `%s\'") % cmd)
 218         else:
 219                 error_log_file = error_log (command_name (cmd))
 220                 redirect = ' 2>%s' % error_log_file
 221
 222         pipe = os.popen (cmd + redirect, mode)
 223         output = pipe.read ()
 224         status = pipe.close ()
 225         # successful pipe close returns 'None'
 226         if not status:
 227                 status = 0
 228         signal = 0x0f & status
 229         exit_status = status >> 8
 230
 231         if status:
 232                 error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
 233
 234                 if not be_verbose:
 235                         contents = open (error_log_file).read ()
 236                         if contents:
 237                                 error (_ ("The error log is as follows:"))
 238                                 sys.stderr.write (contents)
 239
 240                 # Ugh. code dup
 241                 if error_log_file:
 242                         os.unlink (error_log_file)
 243
 244                 exit (1)
 245
 246         if be_verbose:
 247                 progress ('\n')
 248
 249         if error_log_file:
 250                 os.unlink (error_log_file)
 251
 252         return output
 253
 254 def get_global_option (old, new):
 255         try:
 256                 return __main__.__dict__[old]
 257         except KeyError:
 258                 return __main__.global_options.__dict__[new]
 259
 260 def system (cmd, ignore_error = 0, progress_p = 0):
 261
 262         '''System CMD.  If IGNORE_ERROR, do not complain when CMD
 263 returns non zero.  If PROGRESS_P, always show progress.
 264
 265 RETURN VALUE
 266
 267 Exit status of CMD '''
 268
 269         name = command_name (cmd)
 270         error_log_file = ''
 271
 272         ## UGH
 273         be_verbose = get_global_option('verbose_p', 'verbose')
 274         pseudo_filter = get_global_option ('pseudo_filter_p', 'pseudo_filter')
 275
 276         if be_verbose:
 277                 progress_p = 1
 278                 progress (_ ("Invoking `%s\'") % cmd)
 279         else:
 280                 progress ( _("Running %s...") % name)
 281
 282         redirect = ''
 283         if not progress_p:
 284                 error_log_file = error_log (name)
 285                 redirect = ' 1>/dev/null 2>' + error_log_file
 286         elif pseudo_filter:
 287                 redirect = ' 1>/dev/null'
 288
 289         status = os.system (cmd + redirect)
 290         signal = 0x0f & status
 291         exit_status = status >> 8
 292
 293         if status:
 294
 295                 exit_type =  'status %d' % exit_status
 296                 if signal:
 297                         exit_type = 'signal %d' % signal
 298
 299                 msg = _ ("`%s\' failed (%s)") % (name, exit_type)
 300                 if ignore_error:
 301                         if be_verbose:
 302                                 warning (msg + ' ' + _ ("(ignored)"))
 303                 else:
 304                         error (msg)
 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 ())
 308                         if error_log_file:
 309                                 os.unlink (error_log_file)
 310                         exit (1)
 311
 312         if error_log_file:
 313                 os.unlink (error_log_file)
 314         progress ('\n')
 315         return status
 316
 317 def cleanup_temp ():
 318         if not __main__.keep_temp_dir_p:
 319                 if be_verbose:
 320                         progress (_ ("Cleaning %s...") % __main__.temp_dir)
 321                 shutil.rmtree (__main__.temp_dir)
 322                 if be_verbose:
 323                         progress ('\n')
 324
 325
 326 def strip_extension (f, ext):
 327         (p, e) = os.path.splitext (f)
 328         if e == ext:
 329                 e = ''
 330         return p + e
 331
 332
 333 def cp_to_dir (pattern, dir):
 334         "Copy files matching re PATTERN from cwd to DIR"
 335
 336         # Duh.  Python style portable: cp *.EXT OUTDIR
 337         # system ('cp *.%s %s' % (ext, outdir), 1)
 338
 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)
 341
 342
 343 def search_exe_path (name):
 344         p = os.environ['PATH']
 345         exe_paths = string.split (p, ':')
 346         for e in exe_paths:
 347                 full = os.path.join (e, name)
 348                 if os.path.exists (full):
 349                         return full
 350         return None
 351
 352
 353 def mkdir_p (dir, mode=0777):
 354         if not os.path.isdir (dir):
 355                 makedirs (dir, mode)
 356
 357 def print_environment ():
 358         for (k,v) in os.environ.items ():
 359                 sys.stderr.write ("%s=\"%s\"\n" % (k, v))
 360
 361
 362 def ps_page_count (ps_name):
 363         header = open (ps_name).read (1024)
 364         m = re.search ('\n%%Pages: ([0-9]+)', header)
 365         if m:
 366                 return string.atoi (m.group (1))
 367         return 0
 368
 369 def make_ps_images (ps_name, resolution = 90, papersize = "a4",
 370                     rename_page1_p = 0):
 371         base = os.path.basename (re.sub (r'\.e?ps', '', ps_name))
 372         header = open (ps_name).read (1024)
 373
 374         png1 = base + '.png'
 375         pngn = base + '-page%d.png'
 376         output_file = pngn
 377         multi_page = re.search ('\n%%Pages: ', header)
 378
 379         # png16m is because Lily produces color nowadays.
 380         if not multi_page:
 381
 382                 # GS can produce empty 2nd page if pngn is used.
 383                 output_file = png1
 384                 cmd = r'''gs\
 385                 -dEPSCrop\
 386                 -dGraphicsAlphaBits=4\
 387                 -dNOPAUSE\
 388                 -dTextAlphaBits=4\
 389                 -sDEVICE=png16m\
 390                 -sOutputFile='%(output_file)s'\
 391                 -sPAPERSIZE=%(papersize)s\
 392                 -q\
 393                 -r%(resolution)d\
 394                 '%(ps_name)s'\
 395                 -c showpage\
 396                 -c quit ''' % vars ()
 397         else:
 398                 cmd = r'''gs\
 399                 -s\
 400                 -dGraphicsAlphaBits=4\
 401                 -dNOPAUSE\
 402                 -dTextAlphaBits=4\
 403                 -sDEVICE=png16m\
 404                 -sOutputFile='%(output_file)s'\
 405                 -sPAPERSIZE=%(papersize)s\
 406                 -q\
 407                 -r%(resolution)d\
 408                 '%(ps_name)s'\
 409                 -c quit''' % vars ()
 410
 411         remove = glob.glob (png1) + glob.glob (base + '-page*.png')
 412         map (os.unlink, remove)
 413
 414         status = system (cmd)
 415         signal = 0xf & status
 416         exit_status = status >> 8
 417
 418         if status:
 419                 remove = glob.glob (png1) + glob.glob (base + '-page*.png')
 420                 map (os.unlink, remove)
 421                 error (_ ("%s exited with status: %d") % ('GS', status))
 422                 exit (1)
 423
 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))
 427         return files
 428
 429 class NonDentedHeadingFormatter (optparse.IndentedHelpFormatter):
 430     def format_heading(self, heading):
 431             if heading:
 432                     return heading[0].upper() + heading[1:] + ':\n'
 433             return ''
 434     def format_option_strings(self, option):
 435             sep = ' '
 436             if option._short_opts and option._long_opts:
 437                     sep = ','
 438
 439             metavar = ''
 440             if option.takes_value():
 441                     metavar = '=%s' % option.metavar or option.dest.upper()
 442
 443             return "%3s%s %s%s" % (" ".join (option._short_opts),
 444                                    sep,
 445                                    " ".join (option._long_opts),
 446                                    metavar)
 447
 448     def format_usage(self, usage):
 449         return _("Usage: %s\n") % usage
 450
 451     def format_description(self, description):
 452             return description
 453
 454 def get_option_parser (*args, **kwargs):
 455         p = optparse.OptionParser (*args, **kwargs)
 456         p.formatter = NonDentedHeadingFormatter ()
 457         return p