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@xs4all.nl>
   7 #                 Jan Nieuwenhuizen <janneke@gnu.org>
   8
   9 import __main__
  10 import glob
  11 import os
  12 import re
  13 import shutil
  14 import string
  15 import sys
  16 import optparse
  17
  18 ################################################################
  19 # Users of python modules should include this snippet
  20 # and customize variables below.
  21
  22 # We'll suffer this path init stuff as long as we don't install our
  23 # python packages in <prefix>/lib/pythonx.y (and don't kludge around
  24 # it as we do with teTeX on Red Hat Linux: set some environment var
  25 # (PYTHONPATH) in profile)
  26
  27 # If set, LILYPONDPREFIX must take prevalence
  28 # if datadir is not set, we're doing a build and LILYPONDPREFIX
  29
  30 datadir = '@local_lilypond_datadir@'
  31 if not os.path.isdir (datadir):
  32     datadir = '@lilypond_datadir@'
  33 if os.environ.has_key ('LILYPONDPREFIX') :
  34     datadir = os.environ['LILYPONDPREFIX']
  35     while datadir[-1] == os.sep:
  36         datadir= datadir[:-1]
  37
  38 sys.path.insert (0, os.path.join (datadir, 'python'))
  39
  40
  41
  42
  43 localedir = '@localedir@'
  44 try:
  45     import gettext
  46     gettext.bindtextdomain ('lilypond', localedir)
  47     gettext.textdomain ('lilypond')
  48     _ = gettext.gettext
  49 except:
  50     def _ (s):
  51         return s
  52 underscore = _
  53 progress = sys.stderr.write
  54
  55 # Modified version of the commands.mkarg(x), which always uses
  56 # double quotes (since Windows can't handle the single quotes:
  57 def mkarg(x):
  58     s = ' "'
  59     for c in x:
  60         if c in '\\$"`':
  61             s = s + '\\'
  62         s = s + c
  63     s = s + '"'
  64     return s
  65
  66 def command_name (cmd):
  67     # Strip all stuf after command,
  68     # deal with "((latex ) >& 1 ) .." too
  69     cmd = re.match ('([\(\)]*)([^\\\ ]*)', cmd).group (2)
  70     return os.path.basename (cmd)
  71
  72 def system (cmd,
  73             ignore_error=False,
  74             progress_p=True,
  75             be_verbose=False,
  76             log_file=None):
  77
  78     import subprocess
  79
  80     show_progress= progress_p
  81     name = command_name (cmd)
  82     error_log_file = ''
  83
  84     if be_verbose:
  85         show_progress = 1
  86         progress (_ ("Invoking `%s\'") % cmd)
  87     else:
  88         progress ( _("Running %s...") % name)
  89
  90
  91     stdout_setting = None
  92     if not show_progress:
  93         stdout_setting = subprocess.PIPE
  94
  95     proc = subprocess.Popen (cmd,
  96                              shell=True,
  97                              universal_newlines=True,
  98                              stdout=stdout_setting,
  99                              stderr=stdout_setting)
 100
 101     log = ''
 102
 103     if show_progress:
 104         retval = proc.wait()
 105     else:
 106         log = proc.communicate ()
 107         retval = proc.returncode
 108
 109
 110     if retval:
 111         print >>sys.stderr, 'command failed:', cmd
 112         if retval < 0:
 113             print >>sys.stderr, "Child was terminated by signal", -retval
 114         elif retval > 0:
 115             print >>sys.stderr, "Child returned", retval
 116
 117         if ignore_error:
 118             print >>sys.stderr, "Error ignored"
 119         else:
 120             if not show_progress:
 121                 print log[0]
 122                 print log[1]
 123             sys.exit (1)
 124
 125     return abs (retval)
 126
 127 def strip_extension (f, ext):
 128     (p, e) = os.path.splitext (f)
 129     if e == ext:
 130         e = ''
 131     return p + e
 132
 133
 134 def search_exe_path (name):
 135     p = os.environ['PATH']
 136     exe_paths = string.split (p, ':')
 137     for e in exe_paths:
 138         full = os.path.join (e, name)
 139         if os.path.exists (full):
 140             return full
 141     return None
 142
 143
 144 def print_environment ():
 145     for (k,v) in os.environ.items ():
 146         sys.stderr.write ("%s=\"%s\"\n" % (k, v))
 147
 148 class NonDentedHeadingFormatter (optparse.IndentedHelpFormatter):
 149     def format_heading(self, heading):
 150         if heading:
 151             return heading[0].upper() + heading[1:] + ':\n'
 152         return ''
 153     def format_option_strings(self, option):
 154         sep = ' '
 155         if option._short_opts and option._long_opts:
 156             sep = ','
 157
 158         metavar = ''
 159         if option.takes_value():
 160             metavar = '=%s' % option.metavar or option.dest.upper()
 161
 162         return "%3s%s %s%s" % (" ".join (option._short_opts),
 163                                sep,
 164                                " ".join (option._long_opts),
 165                                metavar)
 166
 167     def format_usage(self, usage):
 168         return _("Usage: %s\n") % usage
 169
 170     def format_description(self, description):
 171         return description
 172
 173 def get_option_parser (*args, **kwargs):
 174     p = optparse.OptionParser (*args, **kwargs)
 175     p.formatter = NonDentedHeadingFormatter ()
 176     return p