]> git.donarmstrong.com Git - lilypond.git/blobdiff - python/lilylib.py
Merge branch 'master' of git://git.savannah.gnu.org/lilypond.git
[lilypond.git] / python / lilylib.py
index 3bdfa1c35cb48a1b5b6c84ca96dac767f821d86e..c3eb98bc6fda38f815b5bc9ebf8d41f91dd46a85 100644 (file)
@@ -1,6 +1,6 @@
 # This file is part of LilyPond, the GNU music typesetter.
 #
-# Copyright (C) 1998--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+# Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
 #                Jan Nieuwenhuizen <janneke@gnu.org>
 #
 # LilyPond is free software: you can redistribute it and/or modify
@@ -23,6 +23,7 @@ import re
 import shutil
 import sys
 import optparse
+import time
 
 ################################################################
 # Users of python modules should include this snippet
@@ -41,25 +42,54 @@ try:
     _ = t.ugettext
 except:
     def _ (s):
-       return s
+        return s
 underscore = _
 
 # Urg, Python 2.4 does not define stderr/stdout encoding
 # Maybe guess encoding from LANG/LC_ALL/LC_CTYPE?
 
+reload (sys)
+sys.setdefaultencoding ('utf-8')
+import codecs
+sys.stdout = codecs.getwriter ('utf8') (sys.stdout)
+sys.stderr = codecs.getwriter ('utf8') (sys.stderr)
+
 def encoded_write(f, s):
-    f.write (s.encode (f.encoding or 'utf_8'))
+    f.write (s.encode (f.encoding or 'utf-8', 'replace'))
 
 # ugh, Python 2.5 optparse requires Unicode strings in some argument
 # functions, and refuse them in some other places
 def display_encode (s):
-    return s.encode (sys.stderr.encoding or 'utf_8')
+    return s.encode (sys.stderr.encoding or 'utf-8', 'replace')
+
+# Lilylib globals.
+program_version = '@TOPLEVEL_VERSION@'
+program_name = os.path.basename (sys.argv[0])
+
+
+# Check if program_version contains @ characters. This will be the case if
+# the .py file is called directly while building the lilypond documentation.
+# If so, try to check for the env var LILYPOND_VERSION, which is set by our
+# makefiles and use its value.
+at_re = re.compile (r'@')
+if at_re.match (program_version):
+    if os.environ.has_key('LILYPOND_VERSION'):
+        program_version = os.environ['LILYPOND_VERSION']
+    else:
+        program_version = "unknown"
 
 def stderr_write (s):
     encoded_write (sys.stderr, s)
 
+def warning (s):
+    stderr_write (program_name + ": " + _ ("warning: %s") % s + '\n')
+
+def error (s):
+    stderr_write (program_name + ": " + _ ("error: %s") % s + '\n')
+
 progress = stderr_write
 
+
 def require_python_version ():
     if sys.hexversion < 0x02040000:
         stderr_write ("Python 2.4 or newer is required to run this program.\n\
@@ -68,7 +98,7 @@ please read 'Setup for MacOS X' in Application Usage.")
         os.system ("open http://python.org/download/")
         sys.exit (2)
 
-# Modified version of the commands.mkarg(x), which always uses 
+# Modified version of the commands.mkarg(x), which always uses
 # double quotes (since Windows can't handle the single quotes:
 def mkarg(x):
     s = ' "'
@@ -89,53 +119,69 @@ def subprocess_system (cmd,
                        ignore_error=False,
                        progress_p=True,
                        be_verbose=False,
+                       redirect_output=False,
                        log_file=None):
     import subprocess
 
-    show_progress= progress_p 
+    show_progress= progress_p
     name = command_name (cmd)
     error_log_file = ''
 
-    if be_verbose:
-       show_progress = 1
-       progress (_ ("Invoking `%s\'") % cmd)
+    if redirect_output:
+        progress (_ ("Processing %s.ly") % log_file)
     else:
-       progress ( _("Running %s...") % name)
-
+        if be_verbose:
+            show_progress = 1
+            progress (_ ("Invoking `%s\'") % cmd)
+        else:
+            progress ( _("Running %s...") % name)
 
     stdout_setting = None
+    stderr_setting = None
     if not show_progress:
-       stdout_setting = subprocess.PIPE
+        stdout_setting = subprocess.PIPE
+
+    if redirect_output:
+        stdout_filename = ' '.join([log_file, '.log'])
+        stderr_filename = ' '.join([log_file, '.err.log'])
+        stdout_setting = open(stdout_filename, 'w')
+        stderr_setting = open(stderr_filename, 'w')
 
     proc = subprocess.Popen (cmd,
-                            shell=True,
-                            universal_newlines=True,
-                            stdout=stdout_setting,
-                            stderr=stdout_setting)
+                             shell=True,
+                             universal_newlines=True,
+                             stdout=stdout_setting,
+                             stderr=stderr_setting)
 
     log = ''
 
-    if show_progress:
-       retval = proc.wait()
+    if redirect_output:
+        while proc.poll()==None:
+            time.sleep(1)
+        retval = proc.returncode
+        stdout_setting.close()
+        stderr_setting.close()
     else:
-       log = proc.communicate ()
-       retval = proc.returncode
-
+        if show_progress:
+            retval = proc.wait()
+        else:
+            log = proc.communicate ()
+            retval = proc.returncode
 
     if retval:
-       print >>sys.stderr, 'command failed:', cmd
-       if retval < 0:
-           print >>sys.stderr, "Child was terminated by signal", -retval
-       elif retval > 0:
-           print >>sys.stderr, "Child returned", retval
-
-       if ignore_error:
-           print >>sys.stderr, "Error ignored"
-       else:
-           if not show_progress:
-               print log[0]
-               print log[1]
-           sys.exit (1)
+        print >>sys.stderr, 'command failed:', cmd
+        if retval < 0:
+            print >>sys.stderr, "Child was terminated by signal", -retval
+        elif retval > 0:
+            print >>sys.stderr, "Child returned", retval
+
+        if ignore_error:
+            print >>sys.stderr, "Error ignored"
+        else:
+            if not show_progress:
+                print log[0]
+                print log[1]
+            sys.exit (1)
 
     return abs (retval)
 
@@ -148,37 +194,37 @@ def ossystem_system (cmd,
 
     name = command_name (cmd)
     if be_verbose:
-       show_progress = 1
-       progress (_ ("Invoking `%s\'") % cmd)
+        show_progress = 1
+        progress (_ ("Invoking `%s\'") % cmd)
     else:
-       progress ( _("Running %s...") % name)
+        progress ( _("Running %s...") % name)
 
     retval = os.system (cmd)
     if retval:
-       print >>sys.stderr, 'command failed:', cmd
-       if retval < 0:
-           print >>sys.stderr, "Child was terminated by signal", -retval
-       elif retval > 0:
-           print >>sys.stderr, "Child returned", retval
+        print >>sys.stderr, 'command failed:', cmd
+        if retval < 0:
+            print >>sys.stderr, "Child was terminated by signal", -retval
+        elif retval > 0:
+            print >>sys.stderr, "Child returned", retval
 
-       if ignore_error:
-           print >>sys.stderr, "Error ignored"
-       else:
-           sys.exit (1)
+        if ignore_error:
+            print >>sys.stderr, "Error ignored"
+        else:
+            sys.exit (1)
 
     return abs (retval)
 
 
 system = subprocess_system
 if sys.platform == 'mingw32':
-    
+
     ## subprocess x-compile doesn't work.
     system = ossystem_system
 
 def strip_extension (f, ext):
     (p, e) = os.path.splitext (f)
     if e == ext:
-       e = ''
+        e = ''
     return p + e
 
 
@@ -186,42 +232,54 @@ def search_exe_path (name):
     p = os.environ['PATH']
     exe_paths = p.split (':')
     for e in exe_paths:
-       full = os.path.join (e, name)
-       if os.path.exists (full):
-           return full
+        full = os.path.join (e, name)
+        if os.path.exists (full):
+            return full
     return None
 
 
 def print_environment ():
     for (k,v) in os.environ.items ():
-       sys.stderr.write ("%s=\"%s\"\n" % (k, v)) 
+        sys.stderr.write ("%s=\"%s\"\n" % (k, v))
 
 class NonDentedHeadingFormatter (optparse.IndentedHelpFormatter):
     def format_heading(self, heading):
-       if heading:
-           return heading[0].upper() + heading[1:] + ':\n'
-       return ''
+        if heading:
+            return heading[0].upper() + heading[1:] + ':\n'
+        return ''
     def format_option_strings(self, option):
-       sep = ' '
-       if option._short_opts and option._long_opts:
-           sep = ','
-
-       metavar = ''
-       if option.takes_value():
-           metavar = '=%s' % option.metavar or option.dest.upper()
-
-       return "%3s%s %s%s" % (" ".join (option._short_opts),
-                              sep,
-                              " ".join (option._long_opts),
-                              metavar)
+        sep = ' '
+        if option._short_opts and option._long_opts:
+            sep = ','
+
+        metavar = ''
+        if option.takes_value():
+            metavar = '=%s' % option.metavar or option.dest.upper()
+
+        return "%3s%s %s%s" % (" ".join (option._short_opts),
+                               sep,
+                               " ".join (option._long_opts),
+                               metavar)
+
+    # Only use one level of indentation (even for groups and nested groups),
+    # since we don't indent the headeings, either
+    def indent(self):
+        self.current_indent = self.indent_increment
+        self.level += 1
+    def dedent(self):
+        self.level -= 1
+        if self.level <= 0:
+            self.current_indent = ''
+            self.level = 0;
 
     def format_usage(self, usage):
         return _("Usage: %s") % usage + '\n'
 
     def format_description(self, description):
-       return description
+        return description
 
-def get_option_parser (*args, **kwargs): 
+def get_option_parser (*args, **kwargs):
     p = optparse.OptionParser (*args, **kwargs)
-    p.formatter = NonDentedHeadingFormatter () 
+    p.formatter = NonDentedHeadingFormatter ()
+    p.formatter.set_parser (p)
     return p