python/lilylib.py

   1 ################################################################
   2 # lilylib.py -- options and stuff
   3 #
   4 # source file of the GNU LilyPond music typesetter
   5 #
   6 # (c) 1998--2005 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 shutil
  16 import string
  17 import sys
  18 import tempfile
  19 import glob
  20
  21 ################################################################
  22 # Users of python modules should include this snippet
  23 # and customize variables below.
  24
  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)
  29
  30 # If set, LILYPONDPREFIX must take prevalence
  31 # if datadir is not set, we're doing a build and LILYPONDPREFIX
  32
  33 import getopt
  34 import os
  35 import sys
  36 datadir = '@local_lilypond_datadir@'
  37 if not os.path.isdir (datadir):
  38         datadir = '@lilypond_datadir@'
  39 if os.environ.has_key ('LILYPONDPREFIX') :
  40         datadir = os.environ['LILYPONDPREFIX']
  41         while datadir[-1] == os.sep:
  42                 datadir= datadir[:-1]
  43
  44 sys.path.insert (0, os.path.join (datadir, 'python'))
  45
  46
  47
  48 # Customize these
  49 if __name__ == '__main__':
  50         import lilylib as ly
  51         global _;_=ly._
  52         global re;re = ly.re
  53
  54         # lilylib globals
  55         program_name = 'unset'
  56         pseudo_filter_p = 0
  57         original_dir = os.getcwd ()
  58         temp_dir = os.path.join (original_dir,  '%s.dir' % program_name)
  59         keep_temp_dir_p = 0
  60         verbose_p = 0
  61
  62         help_summary = _ ("lilylib module")
  63
  64         option_definitions = [
  65                 ('', 'h', 'help', _ ("print this help")),
  66                 ]
  67
  68         from lilylib import *
  69 ################################################################
  70
  71 # Handle bug in Python 1.6-2.1
  72 #
  73 # there are recursion limits for some patterns in Python 1.6 til 2.1.
  74 # fix this by importing pre instead. Fix by Mats.
  75
  76 if float (sys.version[0:3]) <= 2.1:
  77         try:
  78                 import pre
  79                 re = pre
  80                 del pre
  81         except ImportError:
  82                 import re
  83 else:
  84         import re
  85
  86 # Attempt to fix problems with limited stack size set by Python!
  87 # Sets unlimited stack size. Note that the resource module only
  88 # is available on UNIX.
  89 try:
  90        import resource
  91        resource.setrlimit (resource.RLIMIT_STACK, (-1, -1))
  92 except:
  93        pass
  94
  95 localedir = '@localedir@'
  96 try:
  97         import gettext
  98         gettext.bindtextdomain ('lilypond', localedir)
  99         gettext.textdomain ('lilypond')
 100         _ = gettext.gettext
 101 except:
 102         def _ (s):
 103                 return s
 104 underscore = _
 105
 106 def identify (port):
 107         port.write ('%s (GNU LilyPond) %s\n' % (__main__.program_name, __main__.program_version))
 108
 109 def warranty ():
 110         identify (sys.stdout)
 111         sys.stdout.write ('\n')
 112         sys.stdout.write (_ ("Copyright (c) %s by") % '1998--2005')
 113         sys.stdout.write ('\n')
 114         map (lambda x: sys.stdout.write ('  %s\n' % x), __main__.copyright)
 115         sys.stdout.write ('\n')
 116         sys.stdout.write (_ ("Distributed under terms of the GNU General Public License."))
 117         sys.stdout.write ('\n')
 118         sys.stdout.write (_ ("It comes with NO WARRANTY."))
 119         sys.stdout.write ('\n')
 120
 121 def progress (s):
 122         sys.stderr.write (s)
 123
 124 def warning (s):
 125         sys.stderr.write (__main__.program_name + ": " + _ ("warning: %s") % s + '\n')
 126
 127 def error (s):
 128         sys.stderr.write (__main__.program_name + ": " + _ ("error: %s") % s + '\n')
 129
 130 def exit (i):
 131         if __main__.verbose_p:
 132                 raise _ ('Exiting (%d)...') % i
 133         else:
 134                 sys.exit (i)
 135
 136 def getopt_args (opts):
 137         '''Construct arguments (LONG, SHORT) for getopt from  list of options.'''
 138         short = ''
 139         long = []
 140         for o in opts:
 141                 if o[1]:
 142                         short = short + o[1]
 143                         if o[0]:
 144                                 short = short + ':'
 145                 if o[2]:
 146                         l = o[2]
 147                         if o[0]:
 148                                 l = l + '='
 149                         long.append (l)
 150         return (short, long)
 151
 152 def option_help_str (o):
 153         '''Transform one option description (4-tuple ) into neatly formatted string'''
 154         sh = '  '
 155         if o[1]:
 156                 sh = '-%s' % o[1]
 157
 158         sep = '  '
 159         if o[1] and o[2]:
 160                 sep = ', '
 161
 162         long = ''
 163         if o[2]:
 164                 long= '--%s' % o[2]
 165
 166         arg = ''
 167         if o[0]:
 168                 if o[2]:
 169                         arg = '='
 170                 arg = arg + o[0]
 171         return '  ' + sh + sep + long + arg
 172
 173
 174 def options_help_str (opts):
 175         '''Convert a list of options into a neatly formatted string'''
 176         w = 0
 177         strs =[]
 178         helps = []
 179
 180         for o in opts:
 181                 s = option_help_str (o)
 182                 strs.append ((s, o[3]))
 183                 if len (s) > w:
 184                         w = len (s)
 185
 186         str = ''
 187         for s in strs:
 188                 first = 1
 189                 for ss in re.split ('\n\s*', s[1]):
 190                         if first:
 191                                 str = str + '%s%s%s\n' \
 192                                         % (s[0], ' ' * (w - len (s[0]) + 3), ss)
 193                                 first = 0
 194                         else:
 195                                 str = str + '%s%s\n' \
 196                                         % (' ' * (w + 3), ss)
 197         return str
 198
 199 def help ():
 200         ls = [(_ ("Usage: %s [OPTIONS]... FILE") % __main__.program_name),
 201               ('\n\n'),
 202               (__main__.help_summary),
 203               ('\n\n'),
 204               (_ ("Options:")),
 205               ('\n'),
 206               (options_help_str (__main__.option_definitions)),
 207               ('\n\n'),
 208               (_ ("Report bugs to %s.") % 'bug-lilypond@gnu.org'),
 209               ('\n')]
 210         map (sys.stdout.write, ls)
 211
 212 def lilypond_version (binary):
 213         p = read_pipe ('%s --version ' % binary)
 214
 215         ls = p.split ('\n')
 216         v= '<not found>'
 217         for l in ls:
 218                 m = re.search ('GNU LilyPond ([0-9a-z.]+)', p)
 219                 if m:
 220                         v = m.group (1)
 221
 222         return v
 223
 224 def lilypond_version_check (binary, req):
 225         if req[0] <> '@' :
 226                 v = lilypond_version (binary)
 227                 if v <> req:
 228                         error (_("Binary %s has version %s, looking for version %s") % \
 229                                (binary, v, req))
 230                         sys.exit (1)
 231
 232
 233 def setup_temp ():
 234
 235         ''' Create a temporary directory, and return its name. '''
 236
 237         if not __main__.keep_temp_dir_p:
 238                 __main__.temp_dir = tempfile.mktemp (__main__.program_name)
 239         try:
 240                 os.mkdir (__main__.temp_dir, 0700)
 241         except OSError:
 242                 pass
 243
 244         return __main__.temp_dir
 245
 246 def command_name (cmd):
 247         # Strip all stuf after command,
 248         # deal with "((latex ) >& 1 ) .." too
 249         cmd = re.match ('([\(\)]*)([^\\\ ]*)', cmd).group (2)
 250         return os.path.basename (cmd)
 251
 252 def error_log (name):
 253         name = re.sub('[^a-z]','x', name)
 254         return tempfile.mktemp ('%s.errorlog' % name)
 255
 256 def read_pipe (cmd, mode = 'r'):
 257
 258
 259         redirect = ''
 260         error_log_file = ''
 261         if __main__.verbose_p:
 262                 progress (_ ("Opening pipe `%s\'") % cmd)
 263         else:
 264                 error_log_file = error_log (command_name (cmd))
 265                 redirect = ' 2>%s' % error_log_file
 266
 267         pipe = os.popen (cmd + redirect, mode)
 268         output = pipe.read ()
 269         status = pipe.close ()
 270         # successful pipe close returns 'None'
 271         if not status:
 272                 status = 0
 273         signal = 0x0f & status
 274         exit_status = status >> 8
 275
 276         if status:
 277                 error (_ ("`%s\' failed (%d)") % (cmd, exit_status))
 278
 279                 if not __main__.verbose_p:
 280                         contents = open (error_log_file).read ()
 281                         if contents:
 282                                 error (_ ("The error log is as follows:"))
 283                                 sys.stderr.write (contents)
 284
 285                 # Ugh. code dup
 286                 if error_log_file:
 287                         os.unlink (error_log_file)
 288
 289                 exit (1)
 290
 291         if __main__.verbose_p:
 292                 progress ('\n')
 293
 294         if error_log_file:
 295                 os.unlink (error_log_file)
 296
 297         return output
 298
 299 def system (cmd, ignore_error = 0, progress_p = 0):
 300
 301         '''System CMD.  If IGNORE_ERROR, do not complain when CMD
 302 returns non zero.  If PROGRESS_P, always show progress.
 303
 304 RETURN VALUE
 305
 306 Exit status of CMD '''
 307
 308         name = command_name (cmd)
 309         error_log_file = ''
 310
 311         if __main__.verbose_p:
 312                 progress_p = 1
 313                 progress (_ ("Invoking `%s\'") % cmd)
 314         else:
 315                 progress ( _("Running %s...") % name)
 316
 317         redirect = ''
 318         if not progress_p:
 319                 error_log_file = error_log (name)
 320                 redirect = ' 1>/dev/null 2>' + error_log_file
 321         elif __main__.pseudo_filter_p:
 322                 redirect = ' 1>/dev/null'
 323
 324         status = os.system (cmd + redirect)
 325         signal = 0x0f & status
 326         exit_status = status >> 8
 327
 328         if status:
 329
 330                 exit_type =  'status %d' % exit_status
 331                 if signal:
 332                         exit_type = 'signal %d' % signal
 333
 334                 msg = _ ("`%s\' failed (%s)") % (name, exit_type)
 335                 if ignore_error:
 336                         if __main__.verbose_p:
 337                                 warning (msg + ' ' + _ ("(ignored)"))
 338                 else:
 339                         error (msg)
 340                         if not progress_p and error_log_file:
 341                                 error (_ ("The error log is as follows:"))
 342                                 sys.stderr.write (open (error_log_file).read ())
 343                         if error_log_file:
 344                                 os.unlink (error_log_file)
 345                         exit (1)
 346
 347         if error_log_file:
 348                 os.unlink (error_log_file)
 349         progress ('\n')
 350         return status
 351
 352 def cleanup_temp ():
 353         if not __main__.keep_temp_dir_p:
 354                 if __main__.verbose_p:
 355                         progress (_ ("Cleaning %s...") % __main__.temp_dir)
 356                 shutil.rmtree (__main__.temp_dir)
 357                 if __main__.verbose_p:
 358                         progress ('\n')
 359
 360
 361 def strip_extension (f, ext):
 362         (p, e) = os.path.splitext (f)
 363         if e == ext:
 364                 e = ''
 365         return p + e
 366
 367
 368 def cp_to_dir (pattern, dir):
 369         "Copy files matching re PATTERN from cwd to DIR"
 370
 371         # Duh.  Python style portable: cp *.EXT OUTDIR
 372         # system ('cp *.%s %s' % (ext, outdir), 1)
 373
 374         files = filter (lambda x, p=pattern: re.match (p, x), os.listdir ('.'))
 375         map (lambda x, d=dir: shutil.copy2 (x, os.path.join (d, x)), files)
 376
 377
 378 # Python < 1.5.2 compatibility
 379 #
 380 # On most platforms, this is equivalent to
 381 #`normpath(join(os.getcwd()), PATH)'.  *Added in Python version 1.5.2*
 382
 383 if os.path.__dict__.has_key ('abspath'):
 384         abspath = os.path.abspath
 385 else:
 386         def abspath (path):
 387                 return os.path.normpath (os.path.join (os.getcwd (), path))
 388
 389 if os.__dict__.has_key ('makedirs'):
 390         makedirs = os.makedirs
 391 else:
 392         def makedirs (dir, mode=0777):
 393                 system ('mkdir -p %s' % dir)
 394
 395
 396 def mkdir_p (dir, mode=0777):
 397         if not os.path.isdir (dir):
 398                 makedirs (dir, mode)
 399
 400
 401 environment = {}
 402
 403 # tex needs lots of memory, more than it gets by default on Debian
 404 non_path_environment = {
 405         'extra_mem_top' : '1000000',
 406         'extra_mem_bottom' : '1000000',
 407         'pool_size' : '250000',
 408 }
 409
 410 def setup_environment ():
 411         global environment
 412
 413         kpse = read_pipe ('kpsexpand \$TEXMF')
 414         texmf = re.sub ('[ \t\n]+$','', kpse)
 415         type1_paths = read_pipe ('kpsewhich -expand-path=\$T1FONTS')
 416
 417         environment = {
 418                 # TODO: * prevent multiple addition.
 419                 #       * clean TEXINPUTS, MFINPUTS, TFMFONTS,
 420                 #         as these take prevalence over $TEXMF
 421                 #         and thus may break tex run?
 422
 423                 'TEXMF' : "{%s,%s}" % (datadir, texmf) ,
 424
 425                 # 'GS_FONTPATH' : type1_paths,
 426                 # 'GS_LIB' : datadir + '/ps',
 427                 'GS_FONTPATH' : "",
 428                 'GS_LIB' : "",
 429                 }
 430
 431         # $TEXMF is special, previous value is already taken care of
 432         if os.environ.has_key ('TEXMF'):
 433                 del os.environ['TEXMF']
 434
 435         for key in environment.keys ():
 436                 val = environment[key]
 437                 if os.environ.has_key (key):
 438                         val = os.environ[key] + os.pathsep + val
 439                 os.environ[key] = val
 440
 441         for key in non_path_environment.keys ():
 442                 val = non_path_environment[key]
 443                 os.environ[key] = val
 444
 445 def print_environment ():
 446         for (k,v) in os.environ.items ():
 447                 sys.stderr.write ("%s=\"%s\"\n" % (k, v))
 448
 449 BOUNDING_BOX_RE = '^%%BoundingBox: (-?[0-9]+) (-?[0-9]+) (-?[0-9]+) (-?[0-9]+)'
 450 def get_bbox (filename):
 451         bbox = filename + '.bbox'
 452         ## -sOutputFile does not work with bbox?
 453         cmd = 'gs -sDEVICE=bbox -q -dNOPAUSE %s -c showpage -c quit 2>%s' % \
 454               (filename, bbox)
 455         system (cmd, progress_p = 1)
 456         box = open (bbox).read ()
 457         m = re.match (BOUNDING_BOX_RE, box)
 458         gr = []
 459         if m:
 460                 gr = map (string.atoi, m.groups ())
 461
 462         return gr
 463
 464
 465 def make_ps_images (ps_name, resolution = 90, papersize = "a4",
 466                     rename_page1_p = 0):
 467         base = os.path.basename (re.sub (r'\.e?ps', '', ps_name))
 468         header = open (ps_name).read (1024)
 469
 470         png1 = base + '.png'
 471         pngn = base + '-page%d.png'
 472         output_file = pngn
 473         multi_page = re.search ('\n%%Pages: ', header)
 474
 475         # png16m is because Lily produces color nowadays.
 476         if not multi_page:
 477
 478                 # GS can produce empty 2nd page if pngn is used.
 479                 output_file = png1
 480                 cmd = r'''gs\
 481                 -dEPSCrop\
 482                 -dGraphicsAlphaBits=4\
 483                 -dNOPAUSE\
 484                 -dTextAlphaBits=4\
 485                 -sDEVICE=png16m\
 486                 -sOutputFile='%(output_file)s'\
 487                 -sPAPERSIZE=%(papersize)s\
 488                 -q\
 489                 -r%(resolution)d\
 490                 '%(ps_name)s'\
 491                 -c showpage\
 492                 -c quit ''' % vars ()
 493         else:
 494                 cmd = r'''gs\
 495                 -s\
 496                 -dGraphicsAlphaBits=4\
 497                 -dNOPAUSE\
 498                 -dTextAlphaBits=4\
 499                 -sDEVICE=png16m\
 500                 -sOutputFile='%(output_file)s'\
 501                 -sPAPERSIZE=%(papersize)s\
 502                 -q\
 503                 -r%(resolution)d\
 504                 '%(ps_name)s'\
 505                 -c quit''' % vars ()
 506
 507         remove = glob.glob (png1) + glob.glob (base + '-page*.png')
 508         map (os.unlink, remove)
 509
 510         status = system (cmd)
 511         signal = 0xf & status
 512         exit_status = status >> 8
 513
 514         if status:
 515                 remove = glob.glob (png1) + glob.glob (base + '-page*.png')
 516                 map (os.unlink, remove)
 517                 error (_ ("%s exited with status: %d") % ('GS', status))
 518                 exit (1)
 519
 520         if rename_page1_p and multi_page:
 521                 os.rename (pngn % 1, png1)
 522         files = glob.glob (png1) + glob.glob (re.sub ('%d', '*', pngn))
 523         return files