python/lilylib.py

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